CControlBar Class

[アーティクル]
06/16/2023

コントロールバークラスの基底クラス CStatusBar、 CToolBar、 CDialogBar、 CReBar、および COleResizeBar。

構文

class CControlBar : public CWnd

メンバー

保護されたコンストラクター

名前	説明
CControlBar::CControlBar	`CControlBar` オブジェクトを構築します。

パブリックメソッド

名前	説明
CControlBar::CalcDynamicLayout	動的コントロールバーのサイズを CSize オブジェクトとして返します。
CControlBar::CalcFixedLayout	コントロールバーのサイズを CSize オブジェクトとして返します。
CControlBar::CalcInsideRect	境界線を含むコントロールバー領域の現在のディメンションを返します。
CControlBar::D oPaint	コントロールバーの境界線およびグリップをレンダリングします。
CControlBar::D rawBorders	コントロールバーの境界線をレンダリングします。
CControlBar::D rawGripper	コントロールバーのグリップをレンダリングします。
CControlBar::EnableDocking	コントロールバーをドッキングまたはフローティングできるようにします。
CControlBar::GetBarStyle	コントロールバーのスタイル設定を取得します。
CControlBar::GetBorders	コントロールバーの境界線の値を取得します。
CControlBar::GetCount	コントロールバー内の HWND 以外の要素の数を返します。
CControlBar::GetDockingFrame	コントロールバーがドッキングされるフレームへのポインターを返します。
CControlBar::IsFloating	対象のコントロールバーがフローティングコントロールバーである場合に、ゼロ以外の値を返します。
CControlBar::OnUpdateCmdUI	コマンド UI ハンドラーを呼び出します。
CControlBar::SetBarStyle	コントロールバーのスタイル設定を変更します。
CControlBar::SetBorders	コントロールバーの境界線の値を設定します。
CControlBar::SetInPlaceOwner	コントロールバーのインプレース所有者を変更します。

パブリックデータメンバー

名前	説明
CControlBar::m_bAutoDelete	ゼロ以外の場合は、Windows のコントロールバーが破棄されると、`CControlBar` オブジェクトが削除されます。
CControlBar::m_pInPlaceOwner	コントロールバーのインプレース所有者です。

解説

通常、コントロールバーは、フレームウィンドウの左側または右側にアラインされるウィンドウです。これには、HWND ベースのコントロール (Windows メッセージを生成して応答するウィンドウ) または HWND ベース以外の項目 (ウィンドウではなく、アプリケーションコードまたはフレームワークコードによって管理される) が含まれる場合があります。リストボックスと編集コントロールは、HWND ベースのコントロールの例です。ステータスバーペインとビットマップボタンは、HWND ベース以外のコントロールの例です。

通常、コントロールバーのウィンドウは親フレームウィンドウの子ウィンドウであり、通常はクライアントビューまたはフレームウィンドウの MDI クライアントの兄弟です。 CControlBar オブジェクトは、親ウィンドウのクライアント領域の四角形に関する情報を使用して、それ自体を配置します。次に、親ウィンドウのクライアント領域においてどの程度の未割り当て領域が残っているかについて、親ウィンドウに通知します。

CControlBar の詳細については、次を参照してください。

継承階層

CObject

CCmdTarget

CWnd

CControlBar

要件

Header: afxext.h

CControlBar::CalcDynamicLayout

フレームワークは、このメンバー関数を呼び出して、動的ツールバーのディメンションを計算します。

virtual CSize CalcDynamicLayout(
    int nLength,
    DWORD nMode);

パラメーター

nLength
dwModeに応じて、水平または垂直のコントロールバーの要求されたディメンション。

nMode
次の定義済みのフラグを使用して、動的コントロールバーの高さと幅を決定します。フラグを結合するには、ビットごとの OR (|) 演算子を使用します。

レイアウトモードフラグ	意味
LM_STRETCH	コントロールバーをフレームのサイズまで拡大するかどうかを示します。バーがドッキングバーでない場合に設定します (ドッキングには使用できません)。バーがドッキングまたはフローティング (ドッキング可能) の場合は設定されません。設定した場合、LM_STRETCHは nLength を無視し、LM_HORZ状態に基づいてディメンションを返します。 LM_STRETCHは、CalcFixedLayout で使用される bStretch パラメーターと同様に動作します。ストレッチと方向の関係の詳細については、そのメンバー関数を参照してください。
LM_HORZ	バーが水平方向または垂直方向であることを示します。横棒が水平方向の場合は設定され、垂直方向の場合は設定されません。 LM_HORZは、CalcFixedLayout で使用される bHorz パラメーターと同様に機能します。ストレッチと方向の関係の詳細については、そのメンバー関数を参照してください。
LM_MRUWIDTH	最近使用した動的幅。 nLength パラメーターを無視し、最近使用した幅を使用します。
LM_HORZDOCK	水平ドッキングされた寸法。 nLength パラメーターを無視し、幅が最も大きい動的サイズを返します。
LM_VERTDOCK	垂直固定寸法。 nLength パラメーターを無視し、最大の高さの動的サイズを返します。
LM_LENGTHY	nLength が幅ではなく高さ (Y 方向) を示す場合に設定します。
LM_COMMIT	LM_MRUWIDTHをフローティングコントロールバーの現在の幅にリセットします。

戻り値

CSize オブジェクトのコントロールバーのサイズ (ピクセル単位)。

解説

このメンバー関数をオーバーライドして、 CControlBarから派生するクラスで独自の動的レイアウトを提供します。 CControlBarから派生した MFC クラス (CToolbar など) は、このメンバー関数をオーバーライドし、独自の実装を提供します。

CControlBar::CalcFixedLayout

コントロールバーの水平サイズを計算するには、このメンバー関数を呼び出します。

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

パラメーター

bStretch
バーをフレームのサイズまで引き伸ばす必要があるかどうかを示します。 bStretch パラメーターは、バーがドッキングバーでない場合は 0 以外で (ドッキングには使用できません)、ドッキングまたはフローティング (ドッキングに使用できる) 場合は 0 です。

bHorz
バーが水平方向または垂直方向であることを示します。 bHorz パラメーターは、バーが水平方向の場合は 0 以外で、垂直方向の場合は 0 です。

戻り値

CSize オブジェクトのコントロールバーのサイズ (ピクセル単位)。

解説

ツールバーなどのコントロールバーは、コントロールバーに含まれるボタンに合わせて水平方向または垂直方向に引き伸ばすことができます。

bStretch が TRUE の場合は、bHorz によって提供される方向に沿って寸法を引き伸ばします。つまり、 bHorz が FALSE の場合、コントロールバーは垂直方向に引き伸ばされます。 bStretch が FALSE の場合、ストレッチは行われません。次の表は、 bStretch および bHorzの可能な順列と結果のコントロールバースタイルを示しています。

bStretch	bHorz	拡張	オリエンテーション	ドッキング/ドッキングしない
TRUE	TRUE	水平方向のストレッチ	水平方向	ドッキングしない
TRUE	FALSE	垂直方向のストレッチ	垂直方向	ドッキングしない
FALSE	TRUE	使用できるストレッチなし	水平方向	ドッキング
FALSE	FALSE	使用できるストレッチなし	垂直方向	ドッキング

CControlBar::CalcInsideRect

フレームワークはこの関数を呼び出して、コントロールバーのクライアント領域を計算します。

virtual void CalcInsideRect(
    CRect& rect,
    BOOL bHorz) const;

パラメーター

rect
コントロールバーの現在の寸法を格納します。罫線を含みます。

解説

この関数は、コントロールバーが描画される前に呼び出されます。

コントロールバーの境界線とグリッパーバーのレンダリングをカスタマイズするには、この関数をオーバーライドします。

CControlBar::CControlBar

CControlBar オブジェクトを構築します。

CControlBar();

CControlBar::D oPaint

コントロールバーの境界線とグリッパーバーをレンダリングするためにフレームワークによって呼び出されます。

virtual void DoPaint(CDC* pDC);

パラメーター

pDC
コントロールバーの境界線とグリッパーのレンダリングに使用するデバイスコンテキストをポイントします。

解説

コントロールバーの描画動作をカスタマイズするには、この関数をオーバーライドします。

もう 1 つのカスタマイズ方法は、 DrawBorders 関数と DrawGripper 関数をオーバーライドし、罫線とグリッパーのカスタム描画コードを追加することです。これらのメソッドは既定の DoPaint メソッドによって呼び出されるため、 DoPaint のオーバーライドは必要ありません。

CControlBar::D rawBorders

コントロールバーの境界線をレンダリングするためにフレームワークによって呼び出されます。

virtual void DrawBorders(
    CDC* pDC,
    CRect& rect);

パラメーター

pDC
コントロールバーの境界線のレンダリングに使用するデバイスコンテキストをポイントします。

rect
コントロールバーの寸法を含む CRect オブジェクト。

解説

コントロールバーの境界線の外観をカスタマイズするには、この関数をオーバーライドします。

CControlBar::D rawGripper

コントロールバーのグリッパーをレンダリングするためにフレームワークによって呼び出されます。

virtual void DrawGripper(
    CDC* pDC,
    const CRect& rect);

パラメーター

pDC
コントロールバーグリッパーのレンダリングに使用するデバイスコンテキストを指します。

rect
コントロールバーグリッパーの寸法を含む CRect オブジェクト。

解説

コントロールバーグリッパーの外観をカスタマイズするには、この関数をオーバーライドします。

CControlBar::EnableDocking

コントロールバーをドッキングできるようにするには、この関数を呼び出します。

void EnableDocking(DWORD dwDockStyle);

パラメーター

dwDockStyle
コントロールバーがドッキングをサポートしているかどうか、およびコントロールバーをドッキングできる親ウィンドウの側面 (サポートされている場合) を指定します。次のいずれかになります。

CBRS_ALIGN_TOP クライアント領域の上部にドッキングできます。
CBRS_ALIGN_BOTTOM クライアント領域の下部にドッキングできます。
CBRS_ALIGN_LEFT クライアント領域の左側にドッキングできます。
CBRS_ALIGN_RIGHT クライアント領域の右側にドッキングできます。
CBRS_ALIGN_ANY クライアント領域の任意の側にドッキングできるようにします。
CBRS_FLOAT_MULTI 複数のコントロールバーを 1 つのミニフレームウィンドウに浮動させます。

0 の場合 (つまり、フラグがないことを示します)、コントロールバーはドッキングされません。

解説

指定された辺は、移動先フレームウィンドウでドッキングが有効になっている辺のいずれかと一致している必要があります。または、コントロールバーをそのフレームウィンドウにドッキングできません。

CControlBar::GetBarStyle

この関数を呼び出して、コントロールバーに対して現在設定されている CBRS_ (コントロールバースタイル) の設定を決定します。

DWORD GetBarStyle();

戻り値

コントロールバーの現在の CBRS_ (コントロールバースタイル) の設定。使用可能なスタイルの完全な一覧については、 CControlBar::SetBarStyle を参照してください。

解説

WS_ (ウィンドウスタイル) スタイルを処理しません。

CControlBar::GetBorders

コントロールバーの現在の境界線の値を返します。

CRect GetBorders() const;

戻り値

コントロールバーオブジェクトの両側の現在の幅 (ピクセル単位) を含む CRect オブジェクト。たとえば、CRect オブジェクトの left メンバーの値は、左罫線の幅です。

CControlBar::GetCount

CControlBar オブジェクトの HWND 以外の項目の数を返します。

int GetCount() const;

戻り値

CControlBar オブジェクトの HWND 以外の項目の数。この関数は、 CDialogBar オブジェクトに対して 0 を返します。

解説

項目の種類は、派生オブジェクト ( CStatusBar のペインオブジェクト、および CToolBar オブジェクトのボタンと区切り記号によって異なります。

CControlBar::GetDockingFrame

このメンバー関数を呼び出して、コントロールバーがドッキングされている現在のフレームウィンドウへのポインターを取得します。

CFrameWnd* GetDockingFrame() const;

戻り値

成功した場合のフレームウィンドウへのポインター。それ以外の場合は NULL。

コントロールバーがフレームウィンドウにドッキングされていない場合 (つまり、コントロールバーがフローティングの場合)、この関数は親 CMiniFrameWnd へのポインターを返します。

解説

ドッキング可能なコントロールバーの詳細については、「 CControlBar::EnableDocking および CFrameWnd::D ockControlBarを参照してください。

CControlBar::IsFloating

このメンバー関数を呼び出して、コントロールバーが浮動かドッキングされているかを判断します。

BOOL IsFloating() const;

戻り値

コントロールバーが浮動の場合は 0 以外。それ以外の場合は 0。

解説

コントロールバーの状態をドッキングからフローティングに変更するには、 CFrameWnd::FloatControlBar を呼び出します。

CControlBar::m_bAutoDelete

ゼロ以外の場合は、Windows のコントロールバーが破棄されると、CControlBar オブジェクトが削除されます。

BOOL m_bAutoDelete;

解説

m_bAutoDelete は、BOOL 型のパブリック変数です。

コントロールバーオブジェクトは通常、フレームウィンドウオブジェクトに埋め込まれます。この場合、フレームウィンドウが破棄されると埋め込みコントロールバーオブジェクトが破棄されるため、 m_bAutoDelete は 0 になります。

ヒープに CControlBar オブジェクトを割り当て、 deleteを呼び出す予定がない場合は、この変数を 0 以外の値に設定します。

CControlBar::m_pInPlaceOwner

コントロールバーのインプレース所有者です。

CWnd* m_pInPlaceOwner;

CControlBar::OnUpdateCmdUI

このメンバー関数は、ツールバーまたはステータスバーの状態を更新するためにフレームワークによって呼び出されます。

virtual void OnUpdateCmdUI(
    CFrameWnd* pTarget,
    BOOL bDisableIfNoHndler) = 0;

パラメーター

pTarget
アプリケーションのメインフレームウィンドウをポイントします。このポインターは、更新メッセージのルーティングに使用されます。

bDisableIfNoHndler
更新ハンドラーを持たないコントロールを自動的に無効として表示するかどうかを示すフラグ。

解説

個々のボタンまたはウィンドウを更新するには、メッセージマップの ON_UPDATE_COMMAND_UI マクロを使用して、更新ハンドラーを適切に設定します。このマクロの使用方法の詳細については、 ON_UPDATE_COMMAND_UI を参照してください。

OnUpdateCmdUI は、アプリケーションがアイドル状態のときにフレームワークによって呼び出されます。更新するフレームウィンドウは、少なくとも間接的に表示されるフレームウィンドウの子ウィンドウである必要があります。 OnUpdateCmdUI は高度なオーバーライド可能です。

CControlBar::SetBarStyle

コントロールバーの目的の CBRS_ スタイルを設定するには、この関数を呼び出します。

void SetBarStyle(DWORD dwStyle);

パラメーター

dwStyle
コントロールバーに必要なスタイル。次のいずれかになります。

CBRS_ALIGN_TOP コントロールバーをフレームウィンドウのクライアント領域の上部にドッキングできるようにします。
CBRS_ALIGN_BOTTOM コントロールバーをフレームウィンドウのクライアント領域の下部にドッキングできるようにします。
CBRS_ALIGN_LEFT コントロールバーをフレームウィンドウのクライアント領域の左側にドッキングできるようにします。
CBRS_ALIGN_RIGHT コントロールバーをフレームウィンドウのクライアント領域の右側にドッキングできるようにします。
CBRS_ALIGN_ANY コントロールバーをフレームウィンドウのクライアント領域の任意の側にドッキングできるようにします。
CBRS_BORDER_TOP コントロールバーが表示されるときに、コントロールバーの上端に罫線が描画されます。
CBRS_BORDER_BOTTOM コントロールバーが表示されるときに、コントロールバーの下端に罫線が描画されます。
CBRS_BORDER_LEFT コントロールバーが表示されるときに、コントロールバーの左端に罫線が描画されます。
CBRS_BORDER_RIGHT コントロールバーが表示されるときに、コントロールバーの右端に罫線が描画されます。
CBRS_FLOAT_MULTI 複数のコントロールバーを 1 つのミニフレームウィンドウに浮動させます。
CBRS_TOOLTIPS コントロールバーのツールヒントが表示されます。
CBRS_FLYBY ツールヒントと同時にメッセージテキストが更新されます。
CBRS_GRIPPER CReBar オブジェクト内のバンドで使用されるグリッパーと同様に、 CControlBar派生クラスに対して描画されます。

解説

WS_ (ウィンドウスタイル) の設定には影響しません。

CControlBar::SetBorders

コントロールバーの境界線のサイズを設定するには、この関数を呼び出します。

void SetBorders(
    int cxLeft = 0,
    int cyTop = 0,
    int cxRight = 0,
    int cyBottom = 0);

void SetBorders(LPCRECT lpRect);

パラメーター

cxLeft
コントロールバーの左罫線の幅 (ピクセル単位)。

cyTop
コントロールバーの上罫線の高さ (ピクセル単位)。

cxRight
コントロールバーの右境界線の幅 (ピクセル単位)。

cyBottom
コントロールバーの下罫線の高さ (ピクセル単位)。

lpRect
コントロールバーオブジェクトの各境界線の現在の幅 (ピクセル単位) を含む CRect オブジェクトへのポインター。

例

次のコード例では、コントロールバーの上下の境界線を 5 ピクセルに、左右の境界線を 2 ピクセルに設定します。

CControlBar &m_myControlBar = m_Rebar;
m_myControlBar.SetBorders(2, 5, 2, 5);

CControlBar::SetInPlaceOwner

コントロールバーのインプレース所有者を変更します。

void SetInPlaceOwner(CWnd* pWnd);

パラメーター

pWnd
CWnd オブジェクトを指すポインターです。

次の方法で共有

CControlBar Class

構文

メンバー

保護されたコンストラクター

パブリック メソッド

パブリック データ メンバー

解説

継承階層

要件

CControlBar::CalcDynamicLayout

パラメーター

戻り値

解説

CControlBar::CalcFixedLayout

パラメーター

戻り値

解説

CControlBar::CalcInsideRect

パラメーター

解説

CControlBar::CControlBar

CControlBar::D oPaint

パラメーター

解説

CControlBar::D rawBorders

パラメーター

解説

CControlBar::D rawGripper

パラメーター

解説

CControlBar::EnableDocking

パラメーター

解説

CControlBar::GetBarStyle

戻り値

解説

CControlBar::GetBorders

戻り値

CControlBar::GetCount

戻り値

解説

CControlBar::GetDockingFrame

戻り値

解説

CControlBar::IsFloating

戻り値

解説

CControlBar::m_bAutoDelete

解説

CControlBar::m_pInPlaceOwner

CControlBar::OnUpdateCmdUI

パラメーター

解説

CControlBar::SetBarStyle

パラメーター

解説

CControlBar::SetBorders

パラメーター

例

CControlBar::SetInPlaceOwner

パラメーター

解説

関連項目

フィードバック

その他のリソース

パブリックメソッド

パブリックデータメンバー