CMFCCaptionButton クラス
CMFCCaptionButton クラスは、ドッキング ウィンドウまたはミニ フレーム ウィンドウのキャプション バーに表示されるボタンを実装します。 通常は、フレームワークがキャプション ボタンを自動的に作成します。
構文
class CMFCCaptionButton : public CObject
メンバー
コンストラクター
| 名前 | 説明 |
|---|---|
| CMFCCaptionButton::CMFCCaptionButton | CMFCCaptionButton オブジェクトを構築します。 |
パブリック メソッド
| 名前 | 説明 |
|---|---|
| CMFCCaptionButton::GetHit | ボタンで表されるコマンドを返します。 |
| CMFCCaptionButton::GetIconID | ボタンに関連付けられているイメージ ID を返します。 |
| CMFCCaptionButton::GetRect | ボタンが占める四角形を返します。 |
| CMFCCaptionButton::GetSize | ボタンの幅と高さを返します。 |
| CMFCCaptionButton::IsMiniFrameButton | タイトル バーの高さがミニ サイズに設定されているかどうかを示します。 |
| CMFCCaptionButton::Move | ボタンの描画位置とウィンドウの表示状態を設定します。 |
| CMFCCaptionButton::OnDraw | キャプション ボタンを描画します。 |
| CMFCCaptionButton::SetMiniFrameButton | タイトル バーのミニ サイズを設定します。 |
解説
CPaneFrameWnd クラスからクラスを派生させ保護されたメソッド (AddButton) を使用して、キャプション ボタンをミニ フレーム ウィンドウに追加できます。
CPaneFrameWnd.h は、次の 2 種類のキャプション ボタンのコマンド ID を定義します。
AFX_CAPTION_BTN_PIN:ドッキング ウィンドウで自動非表示モードがサポートされている場合にピン ボタンが表示されます。
AFX_CAPTION_BTN_CLOSE:ウィンドウを閉じたり非表示にしたりできる場合に Close ボタンを表示します。
例
次の例では、 CMFCCaptionButton オブジェクトを構築し、タイトル バーのミニ サイズを設定する方法を示します。
CMFCCaptionButton *captionButton = new CMFCCaptionButton(AFX_HTCLOSE);
captionButton->SetMiniFrameButton(true);
継承階層
要件
Header: afxcaptionbutton.h
CMFCCaptionButton::CMFCCaptionButton
CMFCCaptionButton オブジェクトを構築します。
CMFCCaptionButton();
CMFCCaptionButton(
UINT nHit,
BOOL bLeftAlign = FALSE);
パラメーター
nHit
[in]ボタンに関連付けられているコマンド。
bLeftAlign
[in]ボタンを左揃えにするかどうかを指定します。
次の表に、 nHit パラメーターに使用できる値を示します。
| Value | command |
|---|---|
| AFX_HTCLOSE | 閉じるボタン。 |
| HTMINBUTTON | [最小化] ボタン。 |
| HTMAXBUTTON | 最大化ボタン。 |
| AFX_HTLEFTBUTTON | 左矢印ボタン。 |
| AFX_HTRIGHTBUTTON | 右矢印ボタン。 |
| AFX_HTMENU | 下矢印メニュー ボタン。 |
| HTNOWHERE | 既定値。はコマンドを表しません。 |
解説
既定では、キャプション ボタンはコマンドに関連付けされません。
キャプション ボタンは、右または左に配置されます。
CMFCCaptionButton::GetHit
ボタンで表されるコマンドを返します。
UINT GetHit() const;
戻り値
ボタンで表されるコマンド。
次の表に、可能な戻り値を示します。
| Value | command |
|---|---|
| AFX_HTCLOSE | 閉じるボタン。 |
| HTMINBUTTON | [最小化] ボタン。 |
| HTMAXBUTTON | 最大化ボタン。 |
| AFX_HTLEFTBUTTON | 左矢印ボタン。 |
| AFX_HTRIGHTBUTTON | 右矢印ボタン。 |
| AFX_HTMENU | 下矢印メニュー ボタン。 |
| HTNOWHERE | 既定値。はコマンドを表しません。 |
CMFCCaptionButton::GetIconID
ボタンに関連付けられているイメージ ID を返します。
virtual CMenuImages::IMAGES_IDS GetIconID(
BOOL bHorz,
BOOL bMaximized = FALSE) const;
パラメーター
bHorz
[in]左方向または右方向の画像 ID の場合は TRUE。上矢印イメージ ID または下矢印イメージ ID の場合は FALSE。
bMaximized
[in]最大化イメージ ID の場合は TRUE。最小化イメージ ID の場合は FALSE。
戻り値
イメージ ID。
解説
パラメーターでは、キャプション ボタンを最小化または最大化するためのイメージ ID を指定します。
CMFCCaptionButton::GetRect
ボタンが占める四角形を返します。
virtual CRect GetRect() const;
戻り値
ボタンの位置を表す四角形。
解説
ボタンが表示されない場合、返されるサイズは 0 です。
CMFCCaptionButton::GetSize
ボタンの幅と高さを返します。
static CSize GetSize();
戻り値
ボタンの外側の寸法。
解説
返されるサイズには、ボタンの余白と境界線が含まれます。
CMFCCaptionButton::IsMiniFrameButton
タイトル バーの高さがミニ サイズに設定されているかどうかを示します。
BOOL IsMiniFrameButton() const;
戻り値
キャプションがミニ サイズに設定されている場合は TRUE。それ以外の場合は FALSE。
解説
CMFCCaptionButton::Move
ボタンの描画位置とウィンドウの表示状態を設定します。
void Move(
const CPoint& ptTo,
BOOL bHide = FALSE);
パラメーター
ptTo
[in]新しい場所。
bHide
[in]ボタンを表示するかどうかを指定します。
CMFCCaptionButton::OnDraw
キャプション ボタンを描画します。
virtual void OnDraw(
CDC* pDC,
BOOL bActive,
BOOL bHorz = TRUE,
BOOL bMaximized = TRUE,
BOOL bDisabled = FALSE);
パラメーター
pDC
[in]ボタンのデバイス コンテキストへのポインター。
bActive
[in]アクティブなボタンイメージを描画するかどうかを指定します。
bHorz
[in]派生クラスで使用するために予約されています。
bMaximized
[in]最大化されたボタン画像を描画するかどうかを指定します。
bDisabled
[in]有効なボタンイメージを描画するかどうかを指定します。
解説
bMaximized パラメーターは、ボタンが最大化または最小化ボタンの場合に使用されます。
CMFCCaptionButton::SetMiniFrameButton
タイトル バーのミニ サイズを設定します。
void SetMiniFramebutton(BOOL bSet = TRUE);
パラメーター
bSet
[in]ミニ タイトル バーの高さの場合は TRUE。既定のタイトル バーの高さの場合は FALSE。