CMFCCaptionBar クラス

[アーティクル]
08/04/2024

CMFCCaptionBar オブジェクトは、ボタン、テキストラベル、ビットマップの 3 つの要素を表示できるコントロールバーです。表示できる各要素の数は 1 つずつです。各要素は、コントロールの左端、右端、または中央に揃えて配置できます。また、キャプションバーの上部または下部の境界線にフラットスタイルまたは 3D スタイルを適用することもできます。

構文

class CMFCCaptionBar : public CPane

メンバー

パブリックメソッド

名前	説明
CMFCCaptionBar::Create	キャプションバーコントロールを作成し、 `CMFCCaptionBar` オブジェクトにアタッチします。
CMFCCaptionBar::D oesAllowDynInsertBefore	キャプションバーとその親フレームの間に別のウィンドウを動的に挿入できるかどうかを示します。 ( をオーバーライドしますCBasePane::D oesAllowDynInsertBefore.)
CMFCCaptionBar::EnableButton	キャプションバーのボタンを有効または無効にします。
CMFCCaptionBar::GetAlignment	指定した要素の配置を返します。
CMFCCaptionBar::GetBorderSize	キャプションバーの境界線のサイズを返します。
CMFCCaptionBar::GetButtonRect	キャプションバーのボタンの外接する四角形を取得します。
CMFCCaptionBar::GetMargin	キャプションバー要素の端とキャプションバーコントロールの端との間の距離を返します。
CMFCCaptionBar::IsMessageBarMode	キャプションバーがメッセージバーモードかどうかを指定します。
CMFCCaptionBar::RemoveBitmap	キャプションバーからビットマップイメージを削除します。
CMFCCaptionBar::RemoveButton	キャプションバーからボタンを削除します。
CMFCCaptionBar::RemoveIcon	キャプションバーからアイコンを削除します。
CMFCCaptionBar::RemoveText	キャプションバーからテキストラベルを削除します。
CMFCCaptionBar::SetBitmap	キャプションバーのビットマップイメージを設定します。
CMFCCaptionBar::SetBorderSize	キャプションバーの境界線のサイズを設定します。
CMFCCaptionBar::SetButton	キャプションバーのボタンを設定します。
CMFCCaptionBar::SetButtonPressed	ボタンを押したままにするかどうかを指定します。
CMFCCaptionBar::SetButtonToolTip	ボタンのヒントを設定します。
CMFCCaptionBar::SetFlatBorder	キャプションバーの罫線のスタイルを設定します。
CMFCCaptionBar::SetIcon	キャプションバーのアイコンを設定します。
CMFCCaptionBar::SetImageToolTip	キャプションバーの画像のヒントを設定します。
CMFCCaptionBar::SetMargin	キャプションバー要素の端とキャプションバーコントロールの端との間の距離を設定します。
CMFCCaptionBar::SetText	キャプションバーのテキストラベルを設定します。

保護メソッド

名前	説明
CMFCCaptionBar::OnDrawBackground	キャプションバーの背景を埋めるためにフレームワークによって呼び出されます。
CMFCCaptionBar::OnDrawBorder	キャプションバーの境界線を描画するためにフレームワークによって呼び出されます。
CMFCCaptionBar::OnDrawButton	キャプションバーボタンを描画するためにフレームワークによって呼び出されます。
CMFCCaptionBar::OnDrawImage	キャプションバーイメージを描画するためにフレームワークによって呼び出されます。
CMFCCaptionBar::OnDrawText	キャプションバーのテキストを描画するためにフレームワークによって呼び出されます。

データメンバー

名前	説明
CMFCCaptionBar::m_clrBarBackground	キャプションバーの背景色。
CMFCCaptionBar::m_clrBarBorder	キャプションバーの境界線の色。
CMFCCaptionBar::m_clrBarText	キャプションバーのテキストの色。

解説

キャプションバーを作成するには、次の手順に従います。

CMFCCaptionBar オブジェクトを構築します。通常は、フレームウィンドウクラスにキャプションバーを追加します。
CMFCCaptionBar::Create メソッドを呼び出してキャプションバーコントロールを作成し、CMFCCaptionBar オブジェクトにアタッチします。
CMFCCaptionBar::SetButton、CMFCCaptionBar::SetText、CMFCCaptionBar::SetIcon、および CMFCCaptionBar::SetBitmap を呼び出してキャプションバー要素を設定します。

ボタン要素を設定するときは、ボタンにコマンド ID を割り当てる必要があります。ユーザーがボタンをクリックすると、キャプションバーは、この ID を持つWM_COMMANDメッセージを親フレームウィンドウにルーティングします。

キャプションバーは、Microsoft Office 2007 アプリケーションに表示されるメッセージバーをエミュレートするメッセージバーモードでも機能します。メッセージバーモードでは、キャプションバーにビットマップ、メッセージ、ボタン (通常はダイアログボックスが開きます) が表示されます。ビットマップにツールヒントを割り当てることができます。

メッセージバーモードを有効にするには、 CMFCCaptionBar::Create を呼び出し、4 番目のパラメーター (bIsMessageBarMode) を TRUE に設定します。

例

CMFCCaptionBar クラスのさまざまなメソッドの使用方法を次の例に示します。この例では、キャプションバーコントロールを作成する方法、キャプションバーの 3D 境界線を設定する方法、キャプションバー要素の端とキャプションバーコントロールの端との間の距離をピクセル単位で設定する方法、キャプションバーのボタンを設定する方法、ボタンのヒントを設定する方法、キャプションバーのテキストラベルを設定する方法を示します。キャプションバーのビットマップイメージを設定し、キャプションバーに画像のヒントを設定します。このコードスニペットは、 MS Office 2007 Demo サンプルの一部です。

CMFCCaptionBar m_wndMessageBar;

BOOL CMainFrame::CreateMessageBar()
{
   // The this pointer points to a CMainFrame class which extends the CFrameWndEx class.
   if (!m_wndMessageBar.Create(WS_CHILD | WS_VISIBLE | WS_CLIPSIBLINGS, this, ID_VIEW_MESSAGEBAR, -1, TRUE))
   {
      TRACE0("Failed to create caption bar\n");
      return FALSE;
   }

   m_wndMessageBar.SetFlatBorder(FALSE);
   m_wndMessageBar.SetMargin(10);
   m_wndMessageBar.SetButton(_T("Options..."), ID_TOOLS_OPTIONS, CMFCCaptionBar::ALIGN_LEFT, FALSE);
   m_wndMessageBar.SetButtonToolTip(_T("Click here to see more options"));

   m_wndMessageBar.SetText(_T("Welcome to the MFC MSOffice2007 demonstration!"), CMFCCaptionBar::ALIGN_LEFT);

   m_wndMessageBar.SetBitmap(IDB_INFO, RGB(255, 255, 255), FALSE, CMFCCaptionBar::ALIGN_LEFT);
   m_wndMessageBar.SetImageToolTip(_T("Important"), _T("Please take a look at MSOffice2007Demo source code to learn how to create advanced user interface in minutes."));

   return TRUE;
}

継承階層

要件

Header: afxcaptionbar.h

CMFCCaptionBar::Create

キャプションバーコントロールを作成し、 CMFCCaptionBar オブジェクトにアタッチします。

BOOL Create(
    DWORD dwStyle,
    CWnd* pParentWnd,
    UINT uID,
    int nHeight=-1,
    BOOL bIsMessageBarMode=FALSE);

パラメーター

dwStyle
キャプションバースタイルの論理 OR の組み合わせ。

pParentWnd
キャプションバーコントロールの親ウィンドウ。

uID
キャプションバーコントロールの ID。

nHeight
キャプションバーコントロールの高さ (ピクセル単位)。 -1 の場合、高さはアイコンの高さ、テキスト、キャプションバーコントロールに表示されるボタンに従って計算されます。

bIsMessageBarMode
キャプションバーがメッセージバーモードの場合は TRUE。それ以外の場合は FALSE。

戻り値

キャプションバーコントロールが正常に作成された場合は TRUE。それ以外の場合は FALSE。

解説

CMFCCaptionBar オブジェクトは、2 つの手順で作成します。最初にコンストラクターを呼び出し、次に Create メソッドを呼び出します。これにより、Windows コントロールが作成され、 CMFCCaptionBar オブジェクトにアタッチされます。

CMFCCaptionBar::D oesAllowDynInsertBefore

キャプションバーとその親フレームの間に別のウィンドウを動的に挿入できるかどうかを示します。

virtual BOOL DoesAllowDynInsertBefore() const;

戻り値

オーバーライドされない限り、FALSE を返します。

解説

CMFCCaptionBar::EnableButton

キャプションバーのボタンを有効または無効にします。

void EnableButton(BOOL bEnable=TRUE);

パラメーター

bEnable
[in]ボタンを有効にする場合は TRUE、ボタンを無効にする場合は FALSE。

CMFCCaptionBar::GetAlignment

指定した要素の配置を返します。

BarElementAlignment GetAlignment(BarElement elem);

パラメーター

elem
[in]配置を取得するキャプションバー要素。

戻り値

ボタン、ビットマップ、テキスト、アイコンなどの要素の配置。

解説

要素の配置には、次のいずれかの値を指定できます。

ALIGN_INVALID
ALIGN_LEFT
ALIGN_RIGHT
ALIGN_CENTER

CMFCCaptionBar::GetBorderSize

キャプションバーの境界線のサイズを返します。

int GetBorderSize() const;

戻り値

境界線のサイズ (ピクセル単位)。

CMFCCaptionBar::GetButtonRect

キャプションバーのボタンの外接する四角形を取得します。

CRect GetButtonRect() const;

戻り値

キャプションバーのボタンの外接する四角形の座標を格納する CRect オブジェクト。

CMFCCaptionBar::GetMargin

キャプションバー要素の端とキャプションバーコントロールの端との間の距離を返します。

int GetMargin() const;

戻り値

キャプションバー要素の端とキャプションバーコントロールの端との間の距離 (ピクセル単位)。

CMFCCaptionBar::IsMessageBarMode

キャプションバーがメッセージバーモードかどうかを指定します。

BOOL IsMessageBarMode() const;

戻り値

キャプションバーがメッセージバーモードの場合は TRUE。それ以外の場合は FALSE。

解説

メッセージバーモードでは、キャプションバーにヒント、メッセージテキスト、ボタンを含む画像が表示されます。

CMFCCaptionBar::m_clrBarBackground

キャプションバーの背景色。

COLORREF m_clrBarBackground

CMFCCaptionBar::m_clrBarBorder

キャプションバーの境界線の色。

COLORREF m_clrBarBorder

CMFCCaptionBar::m_clrBarText

キャプションバーのテキストの色。

COLORREF m_clrBarText

CMFCCaptionBar::OnDrawBackground

キャプションバーの背景を埋めるためにフレームワークによって呼び出されます。

virtual void OnDrawBackground(
    CDC* pDC,
    CRect rect);

パラメーター

pDC
[in]キャプションバーのデバイスコンテキストへのポインター。

rect
[in]塗りつぶす外接する四角形。

解説

OnDrawBackground メソッドは、キャプションバーの背景が塗りつぶされようとしているときに呼び出されます。既定の実装では、 CMFCCaptionBar::m_clrBarBackground 色を使用して背景を塗りつぶします。

キャプションバーの外観をカスタマイズするには、 CMFCCaptionBar 派生クラスでこのメソッドをオーバーライドします。

CMFCCaptionBar::OnDrawBorder

キャプションバーの境界線を描画するためにフレームワークによって呼び出されます。

virtual void OnDrawBorder(
    CDC* pDC,
    CRect rect);

パラメーター

pDC
[in]罫線を表示するために使用されるデバイスコンテキスト。

rect
[in]外接する四角形。

解説

既定では、罫線にはフラットスタイルが適用されます。

キャプションバーの境界線の外観をカスタマイズするには、 CMFCCaptionBar 派生クラスでこのメソッドをオーバーライドします。

CMFCCaptionBar::OnDrawButton

キャプションバーボタンを描画するためにフレームワークによって呼び出されます。

virtual void OnDrawButton(
    CDC* pDC,
    CRect rect,
    const CString& strButton,
    BOOL bEnabled);

パラメーター

pDC
[in]ボタンの表示に使用されるデバイスコンテキストへのポインター。

rect
[in]ボタンの外接する四角形。

strButton
[in]ボタンのテキストラベル。

bEnabled
[in]ボタンが有効な場合は TRUE。それ以外の場合は FALSE。

解説

キャプションバーのボタンの外観をカスタマイズするには、 CMFCCaptionBar 派生クラスでこのメソッドをオーバーライドします。

CMFCCaptionBar::OnDrawImage

キャプションバーイメージを描画するためにフレームワークによって呼び出されます。

virtual void OnDrawImage(
    CDC* pDC,
    CRect rect);

パラメーター

pDC
[in]イメージの表示に使用されるデバイスコンテキストへのポインター。

rect
[in]イメージの外接する四角形を指定します。

解説

イメージの外観をカスタマイズするには、 CMFCCaptionBar 派生クラスでこのメソッドをオーバーライドします。

CMFCCaptionBar::OnDrawText

キャプションバーのテキストを描画するためにフレームワークによって呼び出されます。

virtual void OnDrawText(
    CDC* pDC,
    CRect rect,
    const CString& strText);

パラメーター

pDC
[in]ボタンの表示に使用されるデバイスコンテキストへのポインター。

rect
[in]テキストの外接する四角形。

strText
[in]表示するテキスト文字列。

解説

既定の実装では、 CDC::DrawText と CMFCCaptionBar::m_clrBarText 色を使用してテキストが表示されます。

キャプションバーのテキストの外観をカスタマイズするには、 CMFCCaptionBar 派生クラスでこのメソッドをオーバーライドします。

CMFCCaptionBar::RemoveBitmap

キャプションバーからビットマップイメージを削除します。

void RemoveBitmap();

CMFCCaptionBar::RemoveButton

キャプションバーからボタンを削除します。

void RemoveButton();

解説

キャプションバー要素のレイアウトは自動的に調整されます。

CMFCCaptionBar::RemoveIcon

キャプションバーからアイコンを削除します。

void RemoveIcon();

CMFCCaptionBar::RemoveText

キャプションバーからテキストラベルを削除します。

void RemoveText();

CMFCCaptionBar::SetBitmap

キャプションバーのビットマップイメージを設定します。

void SetBitmap(
    HBITMAP hBitmap,
    COLORREF clrTransparent,
    BOOL bStretch=FALSE,
    BarElementAlignment bmpAlignment=ALIGN_RIGHT);

void SetBitmap(
    UINT uiBmpResID,
    COLORREF clrTransparent,
    BOOL bStretch=FALSE,
    BarElementAlignment bmpAlignment=ALIGN_RIGHT);

パラメーター

hBitmap
[in]設定するビットマップのハンドル。

clrTransparent
[in]ビットマップの透明な色を指定する RGB 値。

bStretch
[in]TRUE の場合、ビットマップはイメージの外接する四角形に収まらない場合に引き伸ばされます。それ以外の場合、ビットマップは引き伸ばされません。

bmpAlignment
[in]ビットマップの配置。

解説

キャプションバーにビットマップを設定するには、このメソッドを使用します。

前のビットマップは自動的に破棄されます。 CMFCCaptionBar::SetIcon メソッドを呼び出したためにキャプションバーにアイコンが表示された場合、CMFCCaptionBar::RemoveIcon を呼び出してアイコンを削除しない限り、ビットマップは表示されません。

ビットマップは、 bmpAlignment パラメーターで指定されたとおりに配置されます。このパラメーターには、次の BarElementAlignment 値のいずれかを指定できます。

ALIGN_INVALID
ALIGN_LEFT
ALIGN_RIGHT
ALIGN_CENTER

CMFCCaptionBar::SetBorderSize

キャプションバーの境界線のサイズを設定します。

void SetBorderSize(int nSize);

パラメーター

nSize
[in]キャプションバーの境界線の新しいサイズ (ピクセル単位)。

CMFCCaptionBar::SetButton

キャプションバーのボタンを設定します。

void SetButton(
    LPCTSTR lpszLabel,
    UINT uiCmdUI,
    BarElementAlignment btnAlignmnet=ALIGN_LEFT,
    BOOL bHasDropDownArrow=TRUE);

パラメーター

lpszLabel
ボタンのコマンドラベル。

uiCmdUI
ボタンのコマンド ID。

btnAlignmnet
ボタンの配置。

bHasDropDownArrow
ボタンにドロップダウン矢印が表示される場合は TRUE、それ以外の場合は FALSE。

CMFCCaptionBar::SetButtonPressed

ボタンを押したままにするかどうかを指定します。

void SetButtonPressed(BOOL bPresed=TRUE);

パラメーター

bPresed
ボタンが押された状態を維持する場合は TRUE、それ以外の場合は FALSE。

CMFCCaptionBar::SetButtonToolTip

ボタンのヒントを設定します。

void SetButtonToolTip(
    LPCTSTR lpszToolTip,
    LPCTSTR lpszDescription=NULL);

パラメーター

lpszToolTip
[in]ヒントのキャプション。

lpszDescription
[in]ツールヒントの説明。

CMFCCaptionBar::SetFlatBorder

キャプションバーの罫線のスタイルを設定します。

void SetFlatBorder(BOOL bFlat=TRUE);

パラメーター

bFlat
[in]キャプションバーの境界線がフラットの場合は TRUE。罫線が 3D の場合は FALSE。

CMFCCaptionBar::SetIcon

キャプションバーのアイコンを設定します。

void SetIcon(
    HICON hIcon,
    BarElementAlignment iconAlignment=ALIGN_RIGHT);

パラメーター

hIcon
[in]設定するアイコンのハンドル。

iconAlignment
[in]アイコンの配置。

解説

キャプションバーには、アイコンまたはビットマップを表示できます。ビットマップの表示方法については、 CMFCCaptionBar::SetBitmap を参照してください。アイコンとビットマップの両方を設定すると、アイコンは常に表示されます。 CMFCCaptionBar::RemoveIcon を呼び出して、キャプションバーからアイコンを削除します。

アイコンは、 iconAlignment パラメーターに従って配置されます。次のいずれかの BarElementAlignment 値を指定できます。

ALIGN_INVALID
ALIGN_LEFT
ALIGN_RIGHT
ALIGN_CENTER

CMFCCaptionBar::SetImageToolTip

キャプションバーの画像のヒントを設定します。

void SetImageToolTip(
    LPCTSTR lpszToolTip,
    LPCTSTR lpszDescription=NULL);

パラメーター

lpszToolTip
[in]ヒントのテキスト。

lpszDescription
[in]ツールヒントの説明。

CMFCCaptionBar::SetMargin

キャプションバー要素の端とキャプションバーコントロールの端との間の距離を設定します。

void SetMargin(int nMargin);

パラメーター

nMargin
[in]キャプションバー要素の端とキャプションバーコントロールの端との間の距離 (ピクセル単位)。

CMFCCaptionBar::SetText

キャプションバーのテキストラベルを設定します。

void SetText(
    const CString& strText,
    BarElementAlignment textAlignment=ALIGN_RIGHT);

パラメーター

strText
[in]設定するテキスト文字列。

textAlignment
[in]テキストの配置。

解説

テキストラベルは、 textAlignment パラメーターで指定されているように配置されます。次のいずれかの BarElementAlignment 値を指定できます。

ALIGN_INVALID
ALIGN_LEFT
ALIGN_RIGHT
ALIGN_CENTER

次の方法で共有

CMFCCaptionBar クラス

構文

メンバー

パブリック メソッド

保護メソッド

データ メンバー

解説

例

継承階層

要件

CMFCCaptionBar::Create

パラメーター

戻り値

解説

CMFCCaptionBar::D oesAllowDynInsertBefore

戻り値

解説

CMFCCaptionBar::EnableButton

パラメーター

CMFCCaptionBar::GetAlignment

パラメーター

戻り値

解説

CMFCCaptionBar::GetBorderSize

戻り値

CMFCCaptionBar::GetButtonRect

戻り値

CMFCCaptionBar::GetMargin

戻り値

CMFCCaptionBar::IsMessageBarMode

戻り値

解説

CMFCCaptionBar::m_clrBarBackground

CMFCCaptionBar::m_clrBarBorder

CMFCCaptionBar::m_clrBarText

CMFCCaptionBar::OnDrawBackground

パラメーター

解説

CMFCCaptionBar::OnDrawBorder

パラメーター

解説

CMFCCaptionBar::OnDrawButton

パラメーター

解説

CMFCCaptionBar::OnDrawImage

パラメーター

解説

CMFCCaptionBar::OnDrawText

パラメーター

解説

CMFCCaptionBar::RemoveBitmap

CMFCCaptionBar::RemoveButton

解説

CMFCCaptionBar::RemoveIcon

CMFCCaptionBar::RemoveText

CMFCCaptionBar::SetBitmap

パラメーター

解説

CMFCCaptionBar::SetBorderSize

パラメーター

CMFCCaptionBar::SetButton

パラメーター

CMFCCaptionBar::SetButtonPressed

パラメーター

CMFCCaptionBar::SetButtonToolTip

パラメーター

CMFCCaptionBar::SetFlatBorder

パラメーター

CMFCCaptionBar::SetIcon

パラメーター

解説

CMFCCaptionBar::SetImageToolTip

パラメーター

CMFCCaptionBar::SetMargin

パラメーター

CMFCCaptionBar::SetText

パラメーター

解説

関連項目

パブリックメソッド

データメンバー