TNB Library
公開型 | 公開メンバ関数 | 限定公開型 | 限定公開メンバ関数 | 全メンバ一覧
CAbstractButton クラスabstract

ボタンコントロール抽象クラス [詳解]

#include <TnbMfcAbstractButton.h>

+ CAbstractButton の継承関係図

公開型

enum  EPressMode { PM_Unused , PM_Message , PM_Lockable }
 プレスモード種 [詳解]
 

公開メンバ関数

 CAbstractButton (void)
 コンストラクタ [詳解]
 
DWORD GetExStyle (void) const
 [取得] ウィンドウ拡張スタイル取得. [詳解]
 
HWND GetSafeHwnd (void) const
 [取得] ウィンドウハンドル取得. [詳解]
 
UINT GetState (void) const
 [取得] 状態取得. [詳解]
 
DWORD GetStyle (void) const
 [取得] ウィンドウスタイル取得. [詳解]
 
BOOL ModifyStyle (DWORD dwRemove, DWORD dwAdd, UINT nFlags=0)
 [設定] ウィンドウスタイル変更. [詳解]
 
BOOL ModifyStyleEx (DWORD dwRemove, DWORD dwAdd, UINT nFlags=0)
 [設定] ウィンドウ拡張スタイル変更. [詳解]
 
CAbstractButtonoperator= (const CAbstractButton &other)
 コピーオペレータ. [詳解]
 
void SetDefaultButtonStyle (void)
 [設定] デフォルトボタンスタイル設定. [詳解]
 
void SetPressedMode (bool isEnable)
 [設定] プレスモード設定. [詳解]
 
void SetPressedMode (EPressMode pm)
 [設定] プレスモード設定. [詳解]
 
void SetShortcutKey (TCHAR key)
 [設定] ショートカットキー設定. [詳解]
 
BOOL SetWindowPos (const CWnd *pWndInsertAfter, int x, int y, int cx, int cy, UINT nFlags)
 [設定] ウィンドウサイズポジション設定. [詳解]
 
BOOL ShowWindow (int nCmdShow)
 [設定] ウィンドウ表示状態. [詳解]
 
virtual ~CAbstractButton (void)
 デストラクタ [詳解]
 

限定公開型

enum  EState { ES_Normal , ES_Hover , ES_Pushed , ES_Disable }
 状態 [詳解]
 

限定公開メンバ関数

EState GetButtonState (void) const
 [取得] ボタン状態取得. [詳解]
 
virtual bool HasFocus (void) const
 [確認] フォーカスの有無 [詳解]
 
virtual bool IsOnButton (const POINT &po) const
 [確認] ポイントがボタン上にあるか. [詳解]
 
virtual void OnChangeState (EState state)
 [通知] 状態変化通知. [詳解]
 
virtual EState OnCheckState (EState st)
 [通知] 現在の状態確認通知 [詳解]
 
virtual BOOL OnChildNotify (UINT message, WPARAM wParam, LPARAM lParam, LRESULT *_pResult)
 [通知] for notifications from parent [詳解]
 
virtual void OnClickButton (void)
 [通知] クリック. [詳解]
 
virtual void OnDrawButton (CDC *pDC)=0
 [処理] 描画. [詳解]
 
virtual void PreSubclassWindow (void)
 [通知] subclassing/unsubclassing functions. [詳解]
 
void SetButtonState (EState s)
 [設定] ボタン状態設定. [詳解]
 
void SetSendDblClkMode (bool canSendDblClk)
 [設定] ダブルクリックイベントサポート [詳解]
 
virtual LRESULT WindowProc (UINT message, WPARAM wParam, LPARAM lParam)
 [通知] for processing Windows messages. [詳解]
 

詳解

ボタンコントロール抽象クラス

本クラスを継承して自由なボタンコントロールを作成できます。
覚え書き
マウスが上に乗った時に BN_HILITE 、離れた時に BN_UNHILITE を、親に通知しています。
使用例
//= 宣言
BEGIN_MESSAGE_MAP(CXxxDlg, CDialog)
ON_BN_CLICK(IDC_BMP_KAGE2, OnButtonClick) // クリックした時
ON_CONTROL(BN_HILITE, IDC_BMP_KAGE2, OnButtonHover) // 上にマウスが来た時
:
覚え書き
プレスモードの時、プレスした時、 BN_PUSHED_T 、リリース時に BN_UNPUSHED_T を、親に通知しています。
使用例
//= 宣言
BEGIN_MESSAGE_MAP(CXxxDlg, CDialog)
ON_CONTROL(BN_PUSHED_T, IDC_BMP_KAGE2, OnButtonPushed) // プレスした時
ON_CONTROL(BN_UNPUSHED_T, IDC_BMP_KAGE2, OnButtonUnpushed) // リリースした時
:
必要ファイル
TnbMfcAbstractButton.h
日付
07/10/04 新規作成
07/10/11 Enterキーに対応(親がダイアログベース以外は対象外)。
07/10/17 ショートカットに対応。
07/10/19 親に通知する前に処理を入れられるように対応。
07/10/22 マウスホバーで親に通知するようにした。WM_NCPAINT,WM_ENABLE の処理、改善
07/10/26 WM_SETFONT,WM_GETFONT 対応。メソッド名、整理。
07/10/31 WM_PRINTCLIENT に対応。
07/11/07 状態変化通知追加。
07/11/12 WM_COMMAND の LPARAM 内容修正。
07/11/20 Window破棄後のメッセージ受信処理の対応(修正)。
07/12/20 リソースエディタにボタンを適用した時ごみが出るのを修正。
07/12/27 BM_CLICK イベント処理を改善。 OnClickButton() の通知タイミングを改善。
08/02/06 SetDefaultButtonStyle() を追加。
08/02/07 ホバー状態を整理。 BN_DOUBLECLICKED サポート。
08/02/18 プレス時の KillFocus の処理を改善。
08/02/22 フォーカスフラグ,廃止
08/03/03 EP_Message 時、二回親に押下通知されるのを修正。
08/03/10 自分生存確認を強化。
09/09/25 構成変更。
10/11/09 SetPressedMode() を追加。押し、離しのイベントを新規
14/05/20 EPressMode を追加。 SetPressedMode(EPressMode) を追加。

TnbMfcAbstractButton.h80 行目に定義があります。

列挙型メンバ詳解

◆ EPressMode

enum EPressMode

プレスモード種

列挙値
PM_Unused 

通常ボタン

PM_Message 

プレスメッセージ対応

PM_Lockable 

プレスロック機能も有効

TnbMfcAbstractButton.h165 行目に定義があります。

◆ EState

enum EState
protected

状態

列挙値
ES_Normal 

標準状態

ES_Hover 

ホバー状態

ES_Pushed 

押下状態

ES_Disable 

無効状態

TnbMfcAbstractButton.h199 行目に定義があります。

構築子と解体子

◆ CAbstractButton()

CAbstractButton ( void  )

コンストラクタ

TnbMfcAbstractButton.h86 行目に定義があります。

◆ ~CAbstractButton()

virtual ~CAbstractButton ( void  )
virtual

デストラクタ

TnbMfcAbstractButton.h107 行目に定義があります。

関数詳解

◆ GetButtonState()

EState GetButtonState ( void  ) const
protected

[取得] ボタン状態取得.

覚え書き
現在の状態を取得します
戻り値
状態。

TnbMfcAbstractButton.h212 行目に定義があります。

◆ GetExStyle()

DWORD GetExStyle ( void  ) const
inherited

[取得] ウィンドウ拡張スタイル取得.

本インスタンスが管理しているウィンドウの拡張スタイルを返します。

戻り値
ウィンドウスタイル。 WS_EX_LEFT や WS_EX_TOPMOST などのシンボルが論理和(or)されている。

◆ GetSafeHwnd()

HWND GetSafeHwnd ( void  ) const
inherited

[取得] ウィンドウハンドル取得.

本インスタンスが管理しているウィンドウのハンドルを返します。

戻り値
ウィンドウハンドル

◆ GetState()

UINT GetState ( void  ) const

[取得] 状態取得.

オプション ボタンまたはチェック ボックスの状態を取得します。

戻り値
状態。次のマスク値が使用できます。
マスク 説明
0x0003 オン、オフ状態を調べます (オプション ボタンとチェック ボックスの場合だけ)。 0 のときは、ボタンはオフです。1 のときは、ボタンはオンです。オプション ボタンはチェック マーク (?) が付いている状態がオンです。チェック ボックスは X マークが付いている状態がオンです。2 は、チェック状態が不確定であることを示します (3 ステート チェック ボックスのみ)。 3 ステート チェック ボックスは淡色表示状態のとき不確定状態を示します。
0x0004 強調表示状態を調べます。0 以外の値のときは、ボタンが強調表示状態です。 マウスの左ボタンをクリックしたままにすると、ボタンは強調表示状態になります。 マウス ボタンを離すと、強調表示状態は解除されます。
0x0008 フォーカス状態を調べます。0 以外の値のときは、ボタンにフォーカスがあることを示します。

TnbMfcAbstractButton.h158 行目に定義があります。

◆ GetStyle()

DWORD GetStyle ( void  ) const
inherited

[取得] ウィンドウスタイル取得.

本インスタンスが管理しているウィンドウのスタイルを返します。

戻り値
ウィンドウスタイル。 WS_CHILD や WS_MINIMIZE などのシンボルが論理和(or)されている。

◆ HasFocus()

virtual bool HasFocus ( void  ) const
protectedvirtual

[確認] フォーカスの有無

戻り値
trueフォーカスあり。
falseフォーカスなし。

CDrawingButtonTxで再実装されています。

TnbMfcAbstractButton.h298 行目に定義があります。

◆ IsOnButton()

virtual bool IsOnButton ( const POINT &  po) const
protectedvirtual

[確認] ポイントがボタン上にあるか.

引数
poスクリーン座標。
戻り値
true上にある。
falseない。

TnbMfcAbstractButton.h249 行目に定義があります。

◆ ModifyStyle()

BOOL ModifyStyle ( DWORD  dwRemove,
DWORD  dwAdd,
UINT  nFlags = 0 
)
inherited

[設定] ウィンドウスタイル変更.

引数
dwRemove除去するスタイルを指定する。
dwAdd追加するスタイルを指定する。
nFlagsSetWindowPos() に渡すフラグ。0なら SetWindowPos() を呼びません。
戻り値
TRUE成功.
FALSE失敗.

◆ ModifyStyleEx()

BOOL ModifyStyleEx ( DWORD  dwRemove,
DWORD  dwAdd,
UINT  nFlags = 0 
)
inherited

[設定] ウィンドウ拡張スタイル変更.

引数
dwRemove除去する拡張スタイルを指定する。
dwAdd追加する拡張スタイルを指定する。
nFlagsSetWindowPos() に渡すフラグ。0なら SetWindowPos() を呼びません。
戻り値
TRUE成功.
FALSE失敗.

◆ OnChangeState()

virtual void OnChangeState ( EState  state)
protectedvirtual

[通知] 状態変化通知.

覚え書き
現在の状態を通知します。フォーカスが変化した時も通知します(stateは同じ値です)。
引数
state状態。

CDrawingButton, CLinkText, CTransparentButtonで再実装されています。

TnbMfcAbstractButton.h316 行目に定義があります。

◆ OnCheckState()

virtual EState OnCheckState ( EState  st)
protectedvirtual

[通知] 現在の状態確認通知

引数
st現在の状態
戻り値
新しい状態

TnbMfcAbstractButton.h259 行目に定義があります。

◆ OnChildNotify()

virtual BOOL OnChildNotify ( UINT  message,
WPARAM  wParam,
LPARAM  lParam,
LRESULT *  _pResult 
)
protectedvirtual

[通知] for notifications from parent

覚え書き
CWndのメソッドをオーバーライドしています。 メッセージ受信したらコールされます。
引数
[in]messageメッセージ
[in]wParamWPARAM
[in]lParamLPARAM
[out]_pResultリザルト
戻り値
TRUE処理済。
FALSE未処理。

TnbMfcAbstractButton.h332 行目に定義があります。

◆ OnClickButton()

virtual void OnClickButton ( void  )
protectedvirtual

[通知] クリック.

BN_CLICKED を親に通知する前にコールされます。

CColorSelectButton, CDrawingButton, CHyperLinkTextで再実装されています。

TnbMfcAbstractButton.h307 行目に定義があります。

◆ OnDrawButton()

virtual void OnDrawButton ( CDC *  pDC)
protectedpure virtual

[処理] 描画.

引数
pDCデバイスコンテキスト。

CDrawingButton, CLinkText, CRgnButton, CTransparentButtonで実装されています。

◆ operator=()

CAbstractButton & operator= ( const CAbstractButton other)

コピーオペレータ.

覚え書き
フォントハンドル、ショートカットキー情報のみ複製します。
引数
otherコピー元。
戻り値
自分の参照

TnbMfcAbstractButton.h99 行目に定義があります。

◆ PreSubclassWindow()

virtual void PreSubclassWindow ( void  )
protectedvirtual

[通知] subclassing/unsubclassing functions.

サブクラス化する時コールされます。

覚え書き
CWndのメソッドをオーバーライドしています。

CColorSelectButton, CDrawingButton, CDrawingButtonTx, CRgnButton, CRgnButtonTx, CTransparentButtonで再実装されています。

TnbMfcAbstractButton.h579 行目に定義があります。

◆ SetButtonState()

void SetButtonState ( EState  s)
protected

[設定] ボタン状態設定.

覚え書き
内部情報を書き換えるだけです。再表示はしません。
引数
s状態。

TnbMfcAbstractButton.h222 行目に定義があります。

◆ SetDefaultButtonStyle()

void SetDefaultButtonStyle ( void  )

[設定] デフォルトボタンスタイル設定.

本ボタンにデフォルトボタンスタイルをつけます。

覚え書き
他のボタンにフォーカスがない時に、リターンを押下すると動作するのが、デフォルトボタンです。

TnbMfcAbstractButton.h127 行目に定義があります。

◆ SetPressedMode() [1/2]

void SetPressedMode ( bool  isEnable)

[設定] プレスモード設定.

プレスロックモード付きのボタンにすることが出来ます。 プレスモードにすると、プレスすると親ウィンドウに BN_PUSHED_T が、 リリースすると BN_UNPUSHED_T が通知されます。

引数
isEnabletrue ならプレスモード。 false なら通常ボタンにします。

TnbMfcAbstractButton.h179 行目に定義があります。

◆ SetPressedMode() [2/2]

void SetPressedMode ( EPressMode  pm)

[設定] プレスモード設定.

プレスメッセージ、プレスロックモード付きのボタンにすることが出来ます。 プレスモードにすると、プレスすると親ウィンドウに BN_PUSHED_T が、 リリースすると BN_UNPUSHED_T が通知されます。

引数
pmプレスモード

TnbMfcAbstractButton.h191 行目に定義があります。

◆ SetSendDblClkMode()

void SetSendDblClkMode ( bool  canSendDblClk)
protected

[設定] ダブルクリックイベントサポート

覚え書き
デフォルトでは false です。
引数
canSendDblClktrue なら、 BN_DOUBLECLICKED を親に通知するようになります。

TnbMfcAbstractButton.h232 行目に定義があります。

◆ SetShortcutKey()

void SetShortcutKey ( TCHAR  key)

[設定] ショートカットキー設定.

フォーカスが無いときでもキーボードの ALT + で押せるショートカットキーに対応するキーを指定します。 指定しない場合、ショートカットは出来ません。

引数
keyキー。 'A' 〜 'Z' を指定します。

TnbMfcAbstractButton.h117 行目に定義があります。

◆ SetWindowPos()

BOOL SetWindowPos ( const CWnd pWndInsertAfter,
int  x,
int  y,
int  cx,
int  cy,
UINT  nFlags 
)
inherited

[設定] ウィンドウサイズポジション設定.

子ウィンドウ、ポップアップ ウィンドウ、およびトップレベル ウィンドウのサイズ、位置、および Z オーダーを変更します。

引数
pWndInsertAfterZ オーダーでこの CWnd オブジェクトより前に配置される CWnd オブジェクトを識別します。このパラメータへは、 CWnd へのポインタか 次の値のいずれか 1 つを指定できます。
  • wndBottom ウィンドウを Z オーダーの一番下に置きます。この CWnd が最上位のウィンドウの場合、ウィンドウの最上位ステータスは失われます。 システムでは、このウィンドウをほかのすべてのウィンドウよりも下に置きます。
  • wndTop ウィンドウを Z オーダーの先頭に置きます。
  • wndTopMost ウィンドウを最上位でないすべてのウィンドウの上に置きます。 ウィンドウは、非アクティブになったときも、最上位の位置を保持します。
  • wndNoTopMost ウィンドウを最上位でないすべてのウィンドウの先頭に再配置します (つまり、一番手前のすべてのウィンドウの後ろに置きます)。 ウィンドウが既に非最上位ウィンドウとなっているときは、このフラグは無効です。
xウィンドウの新しい左辺の位置を指定します。
yウィンドウの新しい上辺の位置を指定します。
cxウィンドウの新しい幅を指定します。
cyウィンドウの新しい高さを指定します。
nFlagsサイズ変更オプションおよび位置指定オプションを指定します。このパラメータには、次の値を組み合わせて指定できます。
  • SWP_DRAWFRAME ウィンドウの周りにフレーム (ウィンドウ作成時に定義されます) を描画します。
  • SWP_FRAMECHANGED ウィンドウのサイズが変化されていない場合でも、ウィンドウに WM_NCCALCSIZE メッセージを送信します。このフラグが指定されていない場合、WM_NCCALCSIZE メッセージはウィンドウのサイズが実際に変化しているときにだけ送られます。
  • SWP_HIDEWINDOW ウィンドウを非表示にします。
  • SWP_NOACTIVATE ウィンドウをアクティブにしません。このフラグが設定されていないと、ウィンドウはアクティブになり、最上位または非最上位のウィンドウ グループのいずれかの先頭に移動されます (パラメータ pWndInsertAfter の設定に依存します)。
  • SWP_NOCOPYBITS クライアント領域の内容全体を破棄します。このフラグが指定されていない場合、クライアント領域の有効な内容はすべて保存されます。保存された内容は、ウィンドウのサイズや位置が再び変更されたときにクライアント領域に復元されます。
  • SWP_NOMOVE 現在位置を保持します (x パラメータと y パラメータを無視します)。
  • SWP_NOOWNERZORDER オーナー ウィンドウの Z オーダーの位置を変更しません。
  • SWP_NOREDRAW 変更があっても再描画しません。このフラグが設定されていると、どのような種類の再描画も行われません。このことは、クライアント領域、非クライアント領域 (タイトルやスクロール バーを含みます)、ウィンドウが移動したことにより覆われない親ウィンドウのあらゆる部分に適用されます。このフラグが設定されているときは、アプリケーションは再描画が必要なウィンドウや親ウィンドウのあらゆる部分を明示的に無効領域または再描画する必要があります。
  • SWP_NOREPOSITION SWP_NOOWNERZORDER と同じです。
  • SWP_NOSENDCHANGING ウィンドウが WM_WINDOWPOSCHANGING メッセージを受信しないようにします。
  • SWP_NOSIZE 現在のサイズを保持します (cx パラメータと cy パラメータを無視します)。
  • SWP_NOZORDER 現在の順序を保持します (pWndInsertAfter を無視します)。
  • SWP_SHOWWINDOW ウィンドウを表示します。
戻り値
TRUE成功.
FALSE失敗.

◆ ShowWindow()

BOOL ShowWindow ( int  nCmdShow)
inherited

[設定] ウィンドウ表示状態.

引数
nCmdShowCWnd を表示する方法を指定します。次の値のいずれかになります。
  • SW_HIDE このウィンドウを非表示にし、他のウィンドウをアクティブにします。
  • SW_MINIMIZE ウィンドウを最小化し、システムのリストのトップレベル ウィンドウをアクティブにします。
  • SW_RESTORE ウィンドウをアクティブにし、表示します。ウィンドウが最小化または最大化されている場合は、Windows によって元のサイズと位置に戻されます。
  • SW_SHOW ウィンドウをアクティブにし、現在のサイズと位置で表示します。
  • SW_SHOWMAXIMIZED ウィンドウをアクティブにし、最大表示します。
  • SW_SHOWMINIMIZED ウィンドウをアクティブにし、最小化して表示します。
  • SW_SHOWMINNOACTIVE ウィンドウを最小化して表示します。現在アクティブなウィンドウはアクティブなまま表示します。
  • SW_SHOWNA 現在の状態でウィンドウを表示します。現在アクティブなウィンドウはアクティブなまま表示します。
  • SW_SHOWNOACTIVATE ウィンドウを直前のサイズと位置で表示します。現在アクティブなウィンドウはアクティブなまま表示します。
  • SW_SHOWNORMAL ウィンドウをアクティブにし、表示します。ウィンドウが最小化または最大化されている場合は、Windows によって元のサイズと位置に戻されます。
戻り値
TRUE成功.
FALSE失敗.

◆ WindowProc()

virtual LRESULT WindowProc ( UINT  message,
WPARAM  wParam,
LPARAM  lParam 
)
protectedvirtual

[通知] for processing Windows messages.

メッセージ受信したらコールされます。

覚え書き
CWndのメソッドをオーバーライドしています。
引数
messageメッセージ
wParamWPARAM
lParamLPARAM
戻り値
リザルト。

CColorSelectButton, CCursorControlAddinT< CAbstractButton >, CDrawingButton, CLinkText, CRgnButton, CRgnButtonTx, CRgnSemitransparentButtonT< MODE, PAR >, CTransparentButtonで再実装されています。

TnbMfcAbstractButton.h362 行目に定義があります。