CMFCCaptionBar Class

[アーティクル]
02/21/2013

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

class CMFCCaptionBar : public CPane

メンバー

パブリックメソッド

名前	説明
CMFCCaptionBar::Create	キャプションバーコントロールを作成し、CMFCCaptionBarのオブジェクトにアタッチします。
CMFCCaptionBar::DoesAllowDynInsertBefore	別のペインをキャプションバーと親フレームの間に動的に挿入できるかどうかを示します。(CBasePane::DoesAllowDynInsertBefore をオーバーライドします。)
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 アプリケーションに表示されるメッセージバーをエミュレートします。メッセージバーモードのキャプションバーは、ビットマップ、メッセージ、およびボタン (一般的にはダイアログボックスを開く) を 1 つずつ表示します。ビットマップにはツールヒントを割り当てることもできます。

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

使用例

次の例は、CMFCCaptionBar クラスのさまざまなメソッドの使用方法を説明しています。この例では、キャプションバーコントロールの作成、キャプションバーへの 3D 境界線の設定、キャプションバー要素の端とキャプションバーコントロールの端との距離 (ピクセル単位) の設定、キャプションバーのボタンの設定、ボタンのツールヒントの設定、キャプションバーのテキストラベルの設定、キャプションバーのテキストラベルの設定、およびキャプションバーに含まれるイメージのツールヒントの設定の各手順を示しています。このコードスニペットは MS Office 2007 のデモのサンプルの一部です。

    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;
}