次の方法で共有

CMFCToolBar クラス

  • [アーティクル]

CMFCToolBar クラスは CToolBar Class に似ていますが、ユーザー インターフェイス機能の追加サポートを提供します。 フラット ツール バー、ホット イメージのツール バー、大きいアイコン、ページャー ボタン、ロックされたツール バー、rebar コントロール、イメージの下のテキスト、背景イメージ、およびタブ付きのツール バーなどがサポートされます。 CMFCToolBar クラスには、ツール バーおよびメニューに対するユーザーのカスタマイズ、ツール バーとメニューの間のドラッグ アンド ドロップ、コンボ ボックス ボタン、エディット ボックス ボタン、カラー ピッカー、およびロールアップ ボタンのサポートも組み込まれています。

詳細については、Visual Studio のインストールにあるソース コード ( %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfcなど) を参照してください。

構文

class CMFCToolBar : public CMFCBaseToolBar

メンバー

パブリック コンストラクター

名前 説明
CMFCToolBar::CMFCToolBar 既定のコンストラクターです。
CMFCToolBar::~CMFCToolBar デストラクターです。

パブリック メソッド

名前 説明
CMFCToolBar::AddBasicCommand ユーザーがメニューを開いたときに常に表示されるコマンドの一覧にメニュー コマンドを追加します。
CMFCToolBar::AddCommandUsage 指定されたコマンドに関連付けられているカウンターを 1 ずつインクリメントします。
CMFCToolBar::AddToolBarForImageCollection ユーザー インターフェイス リソースからアプリケーション内のイメージのコレクションにイメージを追加します。
CMFCToolBar::AdjustLayout ツール バーのサイズと位置を再計算します。 (CBasePane::AdjustLayout をオーバーライドします)。
CMFCToolBar::AdjustSize ツール バーのサイズを再計算します。
CMFCToolBar::AllowChangeTextLabels ツール バー ボタンの画像の下にテキスト ラベルを表示できるかどうかを指定します。
CMFCToolBar::AreTextLabels イメージの下のテキスト ラベルをツール バー ボタンに現在表示するかどうかを指定します。
CMFCToolBar::AutoGrayInactiveImages 非アクティブなボタン イメージの自動生成を有効または無効にします。
CMFCToolBar::ButtonToIndex このツール バーの指定した CMFCToolBarButton Class オブジェクトのインデックスを返します。
CMFCToolBar::CalcFixedLayout ツール バーの水平方向のサイズを計算します。 ( CBasePane::CalcFixedLayoutをオーバーライドします)。
CMFCToolBar::CalcSize レイアウト計算プロセスの一部としてフレームワークによって呼び出されます。 ( CPane::CalcSizeをオーバーライドします)。
CMFCToolBar::CanHandleSiblings ツール バーとその兄弟が同じウィンドウに配置されているかどうかを判定します。
CMFCToolBar::CleanUpImages ツール バー イメージに割り当てられたシステム リソースを解放します。
CMFCToolBar::CleanUpLockedImages ロックされたツール バー イメージに割り当てられたシステム リソースを解放します。
CMFCToolBar::CanBeClosed ユーザーがツール バーを閉じることができるかどうかを指定します。 ( CBasePane::CanBeClosedをオーバーライドします)。
CMFCToolBar::CanBeRestored カスタマイズ後にツール バーを元の状態に戻すことができるかどうかを判断します。
CMFCToolBar::CanFocus ウィンドウがフォーカスを受け取ることができるかどうかを指定します。 ( CBasePane::CanFocusをオーバーライドします)。
CMFCToolBar::CanHandleSiblings ツール バーとその兄弟が同じウィンドウに配置されているかどうかを判定します。
CMFCToolBar::CommandToIndex 指定したコマンド ID を持つツール バーのボタンのインデックスを返します。
CMFCToolBar::Create CMFCToolBar オブジェクトを作成します。
CMFCToolBar::CreateEx 大きなアイコンなどの追加のスタイル オプションを使用する CMFCToolBar オブジェクトを作成します。
CMFCToolBar::Deactivate ツール バーを非アクティブ化します。
CMFCToolBar::EnableCustomizeButton ツール バーの末尾に表示 ボタンの追加または削除 ボタンを有効または無効にします。
CMFCToolBar::EnableDocking メイン フレームへのペインのドッキングを有効にします。 ( CBasePane::EnableDockingをオーバーライドします)。
CMFCToolBar::EnableLargeIcons ツール バー ボタンの大きなアイコンを有効または無効にします。
CMFCToolBar::EnableQuickCustomization ユーザーが Alt キーを押して新しい場所にボタンをドラッグできるように、ツール バーのクイック カスタマイズを有効または無効にします。
CMFCToolBar::EnableReflections コマンド リフレクションを有効または無効にします。
CMFCToolBar::EnableTextLabels ツール バー ボタンの画像の下にあるテキスト ラベルを有効または無効にします。
CMFCToolBar::FromHandlePermanent 指定されたウィンドウ ハンドルを含む CMFCToolBar オブジェクトへのポインターを取得します。
CMFCToolBar::GetAllButtons ツール バーのボタンの読み取り専用リストを返します。
CMFCToolBar::GetAllToolbars アプリケーション内のすべてのツール バーの読み取り専用リストを返します。
CMFCToolBar::GetBasicCommands アプリケーションで定義されている基本コマンドの読み取り専用リストを返します。
CMFCToolBar::GetButton 指定したツール バー ボタンインデックスを持つ CMFCToolBarButton オブジェクトへのポインターを返します。
CMFCToolBar::GetButtonInfo 指定したインデックス位置にあるボタンのコマンド ID、スタイル、およびイメージ インデックスを返します。
CMFCToolBar::GetButtonSize ツール バーの各ボタンの寸法を返します。
CMFCToolBar::GetButtonStyle 指定したインデックス位置にあるツール バー ボタンの現在のスタイルを返します。
CMFCToolBar::GetButtonText 指定したインデックスを持つボタンのテキスト ラベルを返します。
CMFCToolBar::GetColdImages アプリケーションのコールド ツール バー ボタン イメージのコレクションへのポインターを返します。
CMFCToolBar::GetColumnWidth ツール バー ボタンの幅を返します。
CMFCToolBar::GetCommandButtons 指定したコマンド ID を持つボタンの一覧を、アプリケーション内のすべてのツール バーから返します。
CMFCToolBar::GetCount ツール バーのボタンと区切り記号の数を返します。
CMFCToolBar::GetCustomizeButton ツール バーに関連付けられている CMFCCustomizeButton オブジェクトへのポインターを取得します。
CMFCToolBar::GetDefaultImage 指定したコマンド ID を持つツール バー ボタンの既定のイメージのインデックスを返します。
CMFCToolBar::GetDisabledImages アプリケーションで無効になっているツール バー ボタンに使用されるイメージのコレクションへのポインターを返します。
CMFCToolBar::GetDisabledMenuImages アプリケーションで無効になっているメニュー ボタンに使用されるイメージのコレクションへのポインターを返します。
CMFCToolBar::GetDroppedDownMenu 現在サブメニューを表示しているメニュー ボタン オブジェクトへのポインターを取得します。
CMFCToolBar::GetGrayDisabledButtons 無効なボタンのイメージを通常のボタン イメージの淡色表示バージョンにするか、無効なボタンイメージのコレクションから取得するかを指定します。
CMFCToolBar::GetHighlightedButton 現在強調表示されているツール バー ボタンへのポインターを返します。
CMFCToolBar::GetHotBorder ツール バー ボタンをホット トラックするかどうかを指定します。
CMFCToolBar::GetHotTextColor 強調表示されているツール バー ボタンのテキストの色を返します。
CMFCToolBar::GetHwndLastFocus ツール バーの直前に入力フォーカスがあるウィンドウへのハンドルを返します。
CMFCToolBar::GetIgnoreSetText ボタン ラベルを設定する呼び出しを無視するかどうかを指定します。
CMFCToolBar::GetImageSize ツール バー ボタンイメージの現在のサイズを返します。
CMFCToolBar::GetImages アプリケーション内の既定のボタン イメージのコレクションへのポインターを返します。
CMFCToolBar::GetImagesOffset ツール バー ボタン イメージのグローバル リストで、このツール バーのツール バー ボタンイメージを検索するために使用されるインデックス オフセットを返します。
CMFCToolBar::GetInvalidateItemRect 指定したインデックス位置にあるボタンに対して再描画する必要があるクライアント領域の領域を取得します。
CMFCToolBar::GetItemID 指定したインデックス位置にあるツール バー ボタンのコマンド ID を返します。
CMFCToolBar::GetItemRect 指定したインデックス位置にあるボタンの外接する四角形を返します。
CMFCToolBar::GetLargeColdImages アプリケーション内の大きなコールド ツール バー ボタン イメージのコレクションへのポインターを返します。
CMFCToolBar::GetLargeDisabledImages アプリケーションで無効になっている大きなツール バー ボタンイメージのコレクションへのポインターを返します。
CMFCToolBar::GetLargeImages アプリケーション内の大きなツール バー ボタンイメージのコレクションへのポインターを返します。
CMFCToolBar::GetLockedColdImages ツール バーのロックされたコールド イメージのコレクションへのポインターを返します。
CMFCToolBar::GetLockedDisabledImages ツール バーのロックされた無効なイメージのコレクションへのポインターを返します。
CMFCToolBar::GetLockedImages ツール バーのロックされたボタン イメージのコレクションへのポインターを返します。
CMFCToolBar::GetLockedImageSize ロックされているツール バー イメージの既定のサイズを返します。
CMFCToolBar::GetLockedMenuImages ツール バーのロックされたツール バー メニュー イメージのコレクションへのポインターを返します。
CMFCToolBar::GetMenuButtonSize アプリケーションのメニュー ボタンのサイズを返します。
CMFCToolBar::GetMenuImageSize アプリケーション内のメニュー ボタンイメージのサイズを返します。
CMFCToolBar::GetMenuImages アプリケーション内のメニュー ボタン イメージのコレクションへのポインターを返します。
CMFCToolBar::GetOrigButtons ツール バーのカスタマイズされていないボタンのコレクションを取得します。
CMFCToolBar::GetOrigResetButtons ツール バーのカスタマイズされていないリセット ボタンのコレクションを取得します。
CMFCToolBar::GetResourceID ツール バーのリソース ID を取得します。
CMFCToolBar::GetRouteCommandsViaFrame どのオブジェクト (親フレームまたは所有者) がツール バーにコマンドを送信するかを決定します。
CMFCToolBar::GetRowHeight ツール バー ボタンの高さを返します。
CMFCToolBar::GetShowTooltips ツール バー ボタンのツール ヒントを表示するかどうかを指定します。
CMFCToolBar::GetSiblingToolBar ツール バーの兄弟を取得します。
CMFCToolBar::GetUserImages アプリケーション内のユーザー定義ツール バー ボタン イメージのコレクションへのポインターを返します。
CMFCToolBar::HitTest 指定した位置にあるツール バー ボタンのインデックスを返します。
CMFCToolBar::InsertButton ツール バーにボタンを挿入します。
CMFCToolBar::InsertSeparator ツールバーに区切り記号を挿入します。
CMFCToolBar::InvalidateButton 指定されたインデックスに存在するツール バー ボタンのクライアント領域を無効にします。
CMFCToolBar::IsAddRemoveQuickCustomize Customize メニュー オプションを使用して、ユーザーがツール バー ボタンを追加または削除できるかどうかを指定します。
CMFCToolBar::IsAltCustomizeMode カスタマイズを使用してボタンをドラッグするかどうかを指定します。
CMFCToolBar::IsAutoGrayInactiveImages 非アクティブ (強調表示されていない) ボタン イメージの自動生成を有効にするかどうかを指定します。
CMFCToolBar::IsBasicCommand コマンドが基本コマンドの一覧にあるかどうかを判断します。
CMFCToolBar::IsButtonExtraSizeAvailable 罫線が拡張されたボタンをツール バーに表示できるかどうかを指定します。
CMFCToolBar::IsButtonHighlighted ツール バーのボタンが強調表示されているかどうかを示します。
CMFCToolBar::IsCommandPermitted コマンドが許可されているかどうかを判断します。
CMFCToolBar::IsCommandRarelyUsed コマンドがほとんど使用されないかどうかを判断します ( CMFCToolBar::SetCommandUsageOptionsを参照)。
CMFCToolBar::IsCustomizeMode ツール バー フレームワークがカスタマイズ モードかどうかを指定します。
CMFCToolBar::IsDragButton ツール バー ボタンをドラッグするかどうかを指定します。
CMFCToolBar::IsExistCustomizeButton ツール バーに Customize ボタンが含まれているかどうかを指定します。
CMFCToolBar::IsFloating ツール バーが浮動かどうかを判断します。
CMFCToolBar::IsLargeIcons アプリケーションのツール バーに現在大きなアイコンを表示するかどうかを指定します。
CMFCToolBar::IsLastCommandFromButton 指定したツール バー ボタンから、最後に実行されたコマンドが送信されたかどうかを判断します。
CMFCToolBar::IsLocked ツール バーがロックされているかどうかを判断します。
CMFCToolBar::IsOneRowWithSibling ツール バーとその兄弟ツール バーが同じ行に配置されているかどうかを判断します。
CMFCToolBar::IsUserDefined ツール バーがユーザー定義かどうかを指定します。
CMFCToolBar::LoadBitmap アプリケーション リソースからツール バー イメージを読み込みます。
CMFCToolBar::LoadBitmapEx アプリケーション リソースからツール バー イメージを読み込みます。 大きな画像が含まれます。
CMFCToolBar::LoadParameters Windows レジストリからグローバル ツール バー オプションを読み込みます。
CMFCToolBar::LoadState Windows レジストリからツール バーの状態情報を読み込みます。 ( CPane::LoadStateをオーバーライドします)。
CMFCToolBar::LoadToolBar アプリケーション リソースからツール バーを読み込みます。
CMFCToolBar::LoadToolBarEx CMFCToolBarInfo ヘルパー クラスを使用して、アプリケーション リソースからツール バーを読み込み、アプリケーションで大きなイメージを使用できるようにします。
CMFCToolBar::OnChangeHot ユーザーがツール バーのボタンを選択すると、フレームワークによって呼び出されます。
CMFCToolBar::OnFillBackground ツール バーの背景を埋めるために、 CBasePane::DoPaint からフレームワークによって呼び出されます。
CMFCToolBar::OnReset ツールバーを元の状態に戻します。
CMFCToolBar::OnSetAccData ( CBasePane::OnSetAccDataをオーバーライドします)。
CMFCToolBar::OnSetDefaultButtonText ツール バー ボタンのテキストを既定の状態に戻します。
CMFCToolBar::OnUpdateCmdUI 内部使用。
CMFCToolBar::RemoveAllButtons ツールバーからすべてのボタンを削除します。
CMFCToolBar::RemoveButton 指定したインデックスを持つボタンをツール バーから削除します。
CMFCToolBar::RemoveStateFromRegistry ツール バーの状態情報を Windows レジストリから削除します。
CMFCToolBar::ReplaceButton ツール バー ボタンを別のツール バー ボタンに置き換えます。
CMFCToolBar::ResetAll すべてのツールバーを元の状態に戻します。
CMFCToolBar::ResetAllImages アプリケーション内のすべてのツール バー イメージ コレクションをクリアします。
CMFCToolBar::RestoreOriginalState ツール バーを元の状態に戻します。
CMFCToolBar::SaveState Windows レジストリのツール バーの状態情報を保存します。 ( CPane::SaveStateをオーバーライドします)。
CMFCToolBar::Serialize ( CBasePane::Serializeをオーバーライドします)。
CMFCToolBar::SetBasicCommands ユーザーがメニューを開いたときに常に表示されるコマンドの一覧を設定します。
CMFCToolBar::SetButtonInfo ツール バー ボタンのコマンド ID、スタイル、イメージ ID を設定します。
CMFCToolBar::SetButtonStyle 指定したインデックス位置にあるツール バー ボタンのスタイルを設定します。
CMFCToolBar::SetButtonText ツール バー ボタンのテキスト ラベルを設定します。
CMFCToolBar::SetButtons ツール バーのボタンを設定します。
CMFCToolBar::SetCommandUsageOptions 使用頻度の低いコマンドがアプリケーションのメニューに表示されない場合に指定します。
CMFCToolBar::SetCustomizeMode アプリケーション内のすべてのツール バーのカスタマイズ モードを有効または無効にします。
CMFCToolBar::SetGrayDisabledButtons ツール バーの無効なボタンを淡色表示にするか、無効にしたボタンに無効なイメージを使用するかを指定します。
CMFCToolBar::SetHeight ツールバーの高さを設定します。
CMFCToolBar::SetHotBorder ツール バー ボタンをホット トラックするかどうかを指定します。
CMFCToolBar::SetHotTextColor ホット ツールバー ボタンのテキストの色を設定します。
CMFCToolBar::SetLargeIcons ツール バー ボタンに大きなアイコンを表示するかどうかを指定します。
CMFCToolBar::SetLockedSizes ツール バーのロックされたボタンとロックされたイメージのサイズを設定します。
CMFCToolBar::SetMenuSizes ツール バー メニュー ボタンとそのイメージのサイズを設定します。
CMFCToolBar::SetNonPermittedCommands ユーザーが実行できないコマンドの一覧を設定します。
CMFCToolBar::SetOneRowWithSibling ツール バーとその兄弟を同じ行に配置します。
CMFCToolBar::SetPermament ユーザーがツール バーを閉じることができるかどうかを指定します。
CMFCToolBar::SetRouteCommandsViaFrame 親フレームまたは所有者がツール バーにコマンドを送信するかどうかを指定します。
CMFCToolBar::SetShowTooltips フレームワークにツール ヒントを表示するかどうかを指定します。
CMFCToolBar::SetSiblingToolBar ツール バーの兄弟を指定します。
CMFCToolBar::SetSizes すべてのツール バーのボタンと画像のサイズを指定します。
CMFCToolBar::SetToolBarBtnText ツール バーのボタンのプロパティを指定します。
CMFCToolBar::SetTwoRowsWithSibling ツールバーとその兄弟を別々の行に配置します。
CMFCToolBar::SetUserImages アプリケーション内のユーザー定義イメージのコレクションを設定します。
CMFCToolBar::StretchPane ツールバーを垂直方向または水平方向に引き伸ばします。 ( CBasePane::StretchPaneをオーバーライドします)。
CMFCToolBar::TranslateChar 指定したキー コードが有効なキーボード ショートカットに対応する場合は、ボタン コマンドを実行します。
CMFCToolBar::UpdateButton 指定したボタンの状態を更新します。
CMFCToolBar::WrapToolBar 指定した寸法内のツールバー ボタンの位置を変更します。

保護メソッド

名前 説明
CMFCToolBar::AllowShowOnList Customize ダイアログ ボックスの Toolbars ペインの一覧にツール バーを表示するかどうかを指定します。
CMFCToolBar::CalcMaxButtonHeight ツール バーのボタンの最大高さを計算します。
CMFCToolBar::DoPaint ツール バーを再描画します。
CMFCToolBar::DrawButton ツール バー ボタンを再描画します。
CMFCToolBar::DrawSeparator ツールバーの区切り記号を再描画します。
CMFCToolBar::OnUserToolTip ボタンのツールヒントが表示されようとしているときにフレームワークによって呼び出されます。

データ メンバー

名前 説明
CMFCToolBar::m_bDontScaleImages ツール バー イメージを高 DPI モードで拡大縮小するかどうかを指定します。
CMFCToolBar::m_dblLargeImageRatio 大きな画像の寸法(高さまたは幅)と通常の画像の寸法との比率を指定します。

解説

CMFCToolBar オブジェクトをアプリケーションに組み込むには、次の手順に従います。

  1. メイン フレーム ウィンドウに CMFCToolBar オブジェクトを追加します。

  2. メイン フレーム ウィンドウのWM_CREATE メッセージを処理するときは、 CMFCToolBar::Create または CMFCToolBar::CreateEx を呼び出してツール バーを作成し、そのスタイルを指定します。

  3. ドッキング スタイルを指定するには、 CBasePane::EnableDocking を呼び出します。

コンボ ボックスやドロップダウン ツール バーなどの特別なボタンを挿入するには、親リソースにダミー ボタンを予約し、実行時に CMFCToolBar::ReplaceButtonを使用してダミー ボタンを置き換えます。 詳細については、「 Walkthrough: Putting Controls on Toolbars」を参照してください。

CMFCToolBarは、クラス、CMFCPopupMenuBar クラス、および CMFCDropDownToolBar クラスCMFCMenuBar MFC ライブラリ クラスの基本クラスです。

例

CMFCToolBar クラスのさまざまなメソッドの使用方法を次の例に示します。 この例では、ツール バーのウィンドウ ラベルのテキストの設定、罫線の設定、ウィンドウのスタイルの設定、ツール バーの末尾に表示される ボタンの追加または削除 ボタンの有効化を行う方法を示します。 このコード スニペットは、 IE Demo サンプルの一部です。

CMFCToolBar m_wndToolBar;

m_wndToolBar.SetWindowText(_T("Standard"));
m_wndToolBar.SetBorders();

//------------------------------------
// Remove toolbar gripper and borders:
//------------------------------------
m_wndToolBar.SetPaneStyle(m_wndToolBar.GetPaneStyle() &
                          ~(CBRS_GRIPPER | CBRS_BORDER_TOP | CBRS_BORDER_BOTTOM | CBRS_BORDER_LEFT | CBRS_BORDER_RIGHT));

m_wndToolBar.EnableCustomizeButton(TRUE, ID_VIEW_CUSTOMIZE, _T("Customize..."));

要件

ヘッダー: afxtoolbar.h

継承階層

CObject

CCmdTarget

CWnd

CBasePane

CPane

CMFCBaseToolBar

CMFCToolBar

CMFCToolBar::AddBasicCommand

ユーザーがメニューを開いたときに常に表示されるコマンドの一覧にメニュー コマンドを追加します。

static void __stdcall AddBasicCommand(UINT uiCmd);

パラメーター

uiCmd
[in]追加するコマンドを指定します。

解説

メニューを開くと、基本コマンドが常に表示されます。 このメソッドは、ユーザーが最近使用したコマンドを表示することを選択した場合に意味があります。

CMFCToolBar::SetBasicCommandsメソッドを使用して、ユーザーがメニューを開いたときに常に表示されるコマンドの一覧を設定します。 CMFCToolBar::GetBasicCommands メソッドを使用して、アプリケーションで使用される基本的なコマンドの一覧を取得します。

CMFCToolBar::AddCommandUsage

指定されたコマンドに関連付けられているカウンターを 1 ずつインクリメントします。

static void __stdcall AddCommandUsage(UINT uiCommand);

パラメーター

uiCommand
[in]インクリメントするコマンド カウンターを指定します。

解説

フレームワークは、ユーザーがメニュー項目を選択したときにこのメソッドを呼び出します。

フレームワークは、コマンド カウンターを使用して最近使用したメニュー項目を表示します。

このメソッドは、 CMFCCmdUsageCount::AddCmd メソッドを使用してコマンド カウンターをインクリメントします。

CMFCToolBar::AddToolBarForImageCollection

ユーザー インターフェイス リソースからアプリケーション内のイメージのコレクションにイメージを追加します。

static BOOL __stdcall AddToolBarForImageCollection(
    UINT uiResID,
    UINT uiBmpResID=0,
    UINT uiColdResID=0,
    UINT uiMenuResID=0,
    UINT uiDisabledResID=0,
    UINT uiMenuDisabledResID=0);

パラメーター

uiResID
[in]読み込むイメージを含むツール バーのリソース ID。

uiBmpResID
[in]ツール バー イメージを含むビットマップのリソース ID。

uiColdResID
[in]"コールド" ツール バー イメージを含むビットマップのリソース ID。

uiMenuResID
[in]メニュー イメージを含むビットマップのリソース ID。

uiDisabledResID
[in]ツール バー イメージが無効になっているビットマップのリソース ID。

uiMenuDisabledResID
[in]無効なメニュー イメージを含むビットマップのリソース ID。

戻り値

TRUEメソッドが成功した場合。uiResIDまたはuiBmpResIDが有効なリソースを指定していない場合、または別のエラーが発生した場合にFALSEします。

解説

ツール バー イメージを含むビットマップを読み込み、ツール バー イメージのコレクションに追加するには、このメソッドを呼び出します。 このメソッドは、一時的なツール バー オブジェクトを作成し、 CMFCToolBar::LoadToolBarを呼び出します。

CMFCToolBar::AdjustLayout

ツール バーのサイズと位置を再計算します。

virtual void AdjustLayout();

解説

ツール バーが作成されたときにこのメソッドを呼び出して、サイズと位置を再計算します。

フレームワークは、ツール バーのレイアウトを変更する必要があるたびに、このメソッドを呼び出します。 たとえば、ユーザーが別のコントロール バーを移動したり、アプリケーション ウィンドウのサイズを変更したり、ツール バーをカスタマイズしたりするときに、レイアウトを変更する必要があります。

このメソッドをオーバーライドして、 CMFCToolbarから派生するクラスで独自の動的レイアウトを提供します。

CMFCToolBar::AdjustSize

ツール バーのサイズを再計算します。

void AdjustSize();

解説

このメソッドは、ツールバーが親フレームの境界に収まるようにします。 ツール バーに親フレームがない場合、このメソッドは何も行いません。

ツール バーの親がCMFCReBar オブジェクトでない場合、CMFCToolBar::AdjustLayout メソッドはこのメソッドを呼び出してサイズを再計算します。

CMFCToolBar::AllowChangeTextLabels

ツール バー ボタンの画像の下にテキスト ラベルを表示できるかどうかを指定します。

virtual BOOL AllowChangeTextLabels() const;

戻り値

TRUE 画像の下にテキストラベルを表示することが許可されている場合。それ以外の場合は FALSE。

解説

このメソッドは、選択したツール バーの Toolbars ページで Show テキスト ラベルチェック ボックスを有効にするかどうかを決定するために、カスタマイズ ダイアログ ボックスによって呼び出されます。

既定の実装では、TRUE が返されます。

CMFCToolBarから派生したオブジェクトでこのメソッドをオーバーライドし、ユーザーが画像の下にあるツール バー ボタンにテキスト ラベルを表示するかどうかを決定しない場合は、FALSEを返します。

CMFCToolBar::AllowShowOnList

Customize ダイアログ ボックスの Toolbars ペインのツール バーの一覧にツール バーを表示するかどうかを指定します。

virtual BOOL AllowShowOnList() const;

戻り値

TRUE ツールバーのカスタマイズ ページのリスト ボックスにツール バー オブジェクトを表示できる場合。それ以外の場合は FALSE。

解説

このメソッドは、ツール バーのカスタマイズ ページのリストに、 CMFCToolBarから派生した特定のオブジェクトを含める必要があるかどうかを判断するために、フレームワークによって呼び出されます。

既定の実装では、常に TRUE を返します。 カスタマイズ ダイアログ ボックスのツール バーの一覧にツール バーを表示しない場合は、このメソッドをオーバーライドします。

CMFCToolBar::AreTextLabels

イメージの下のテキスト ラベルをツール バー ボタンに現在表示するかどうかを指定します。

BOOL AreTextLabels() const;

戻り値

TRUE ツールバーボタンが画像の下にテキストラベルを表示する場合。それ以外の場合は FALSE。

解説

CMFCToolBar::EnableTextLabelsを使用して、テキストを表示するかどうかを指定します。 既定値は FALSE です。 CMFCToolBar::AllowChangeTextLabelsを呼び出して、ユーザーがカスタマイズ ダイアログ ボックスでこの設定を変更できるかどうかを指定します。

CMFCToolBar::AutoGrayInactiveImages

非アクティブなボタン イメージの自動生成を有効または無効にします。

static void AutoGrayInactiveImages(
    BOOL bEnable=TRUE,
    int nGrayImagePercentage=0,
    BOOL bRedrawAllToolbars=TRUE);

パラメーター

bEnable
[in]非アクティブなイメージを暗くするかどうかを指定するブール値。 このパラメーターが TRUEされている場合、非アクティブなイメージは淡色表示されます。 それ以外の場合、非アクティブなイメージは淡色表示されません。

nGrayImagePercentage
[in]非アクティブなイメージの輝度の割合を指定します。 bEnableがFALSEの場合、この値は無視されます。

bRedrawAllToolbars
[in]アプリケーション内のすべてのツール バーを再描画するかどうかを指定するブール値。 このパラメーターが TRUEされている場合、このメソッドはすべてのツール バーを再描画します。

解説

bEnableがTRUE場合、フレームワークはnGrayImagePercentageを使用して通常のイメージから非アクティブなイメージを生成します。 それ以外の場合は、 CMFCToolBar::GetColdImages メソッドを使用して非アクティブなイメージのセットを指定する必要があります。 既定では、このオプションは無効になっています。

nGrayImagePercentage パラメーターの詳細については、「CMFCToolBarImages::GrayImages」を参照してください。

CMFCToolBar::ButtonToIndex

このツール バーの指定した CMFCToolBarButton Class オブジェクトのインデックスを返します。

int ButtonToIndex(const CMFCToolBarButton* pButton) const;

パラメーター

pButton
[in]ツール バー ボタン オブジェクトへのポインター。

戻り値

ツール バー ボタンの内部リスト内の pButton のインデックス。指定したボタンがこのツール バーにない場合は -1。

CMFCToolBar::CalcFixedLayout

ツール バーの水平方向のサイズを計算します。

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

パラメーター

bStretch
[入力] TRUE をクリックして、ツールバーを親フレームのサイズに拡大します。

bHorz
[入力] TRUE ツールバーを水平方向に向ける場合。ツールバーを垂直方向に向ける FALSE します。

戻り値

ツール バーのサイズを指定する CSize オブジェクト。

解説

このメソッドは、 CMFCToolBar::CalcLayout メソッドを使用してツール バーのサイズを計算します。 bStretchがTRUEされている場合は、dwMode パラメーターのLM_STRETCH フラグを渡します。 bHorzがTRUE場合は、LM_HORZ フラグを渡します。

このメソッドを使用する例については、VisualStudioDemo サンプルを参照してください。

CMFCToolBar::CalcMaxButtonHeight

ツール バーのボタンの最大高さを計算します。

virtual int CalcMaxButtonHeight();

戻り値

ボタンの最大高さ。

解説

このメソッドは、ツールバー上のすべてのツールバー ボタンの最大高さを計算します。 高さは、現在のツール バーのドッキング状態などの要因によって異なる場合があります。

CMFCToolBarから派生したクラスでこのメソッドをオーバーライドして、独自の高さの計算を提供します。

CMFCToolBar::CalcSize

レイアウト計算プロセスの一部としてフレームワークによって呼び出されます。

virtual CSize CalcSize(BOOL bVertDock);

パラメーター

bVertDock
[入力] TRUE ツールバーを垂直方向にドッキングすることを指定する場合は >。ツールバーを水平方向にドッキングするように指定 FALSE 。

戻り値

ツール バーのボタンの全体的なサイズを指定する CSize オブジェクト。

解説

このメソッドは、テキスト ラベルの領域や境界線のサイズなど、各ボタンのサイズに影響する属性を考慮します。

ツール バーにボタンが含まれている場合、このメソッドは、 CMFCToolBar::GetButtonSize メソッドを使用して、1 つのボタンの予約済みサイズを返します。

CMFCToolBar::CanBeClosed

ユーザーがツール バーを閉じることができるかどうかを指定します。

virtual BOOL CanBeClosed() const;

戻り値

TRUE ツールバーをユーザーが閉じることができる場合。それ以外の場合は FALSE。

解説

フレームワークは、このメソッドを呼び出して、ユーザーがツール バーを閉じることができるかどうかを判断します。 メソッドが TRUE返された場合、フレームワークはツール バーのシステム メニューで SC_CLOSE コマンドを有効にし、ユーザーはカスタマイズ ダイアログ ボックスのツール バーの一覧にあるチェック ボックスを使用してツール バーを閉じます。

既定の実装では、TRUE が返されます。 ユーザーが閉じることができないツール バー オブジェクトを作成するには、 CMFCToolBar から派生したクラスでこのメソッドをオーバーライドします。

CMFCToolBar::CanBeRestored

カスタマイズ後にツール バーを元の状態に戻すことができるかどうかを判断します。

virtual BOOL CanBeRestored() const;

戻り値

TRUE ツール バーをアプリケーション リソースから復元できる場合。それ以外の場合は FALSE。

解説

フレームワークは、このメソッドを呼び出して、カスタマイズ後にツール バーを元の状態に戻すことができるかどうかを判断します。 元の状態は、アプリケーション リソースから読み込まれます。

TRUECanBeRestored返された場合、カスタマイズ ダイアログ ボックスの Toolbars ページで、選択したツール バーの [Reset] ボタンが有効になります。

既定の実装では、読み込まれたツール バーの元のリソース ID が 0 以外の場合、 TRUE が返されます。 通常、復元できるのはユーザー定義ツール バーのみです。

CanBeRestored メソッドをオーバーライドして、派生クラスでこの動作をカスタマイズできます。

CMFCToolBar::CanFocus

ウィンドウがフォーカスを受け取ることができるかどうかを指定します。

virtual BOOL CanFocus() const;

戻り値

このメソッドは FALSEを返します。

解説

ツール バー オブジェクトはフォーカスを受け取ることができないため、このメソッドは基底クラスの実装 ( CBasePane::CanFocus) をオーバーライドします。

CMFCToolBar::CanHandleSiblings

ツール バーとその兄弟が同じウィンドウに配置されているかどうかを判定します。

BOOL CanHandleSiblings();

戻り値

TRUE ツールバーに兄弟があり、そのツールバーとその兄弟が同じペインに配置されている場合。それ以外の場合は FALSE。

解説

内部 CMFCCustomizeButton::CreatePopupMenu メソッドは、このメソッドを呼び出して、 Customize ポップアップ メニューを表示する方法を決定します。 このメソッドがTRUEを返す場合、フレームワークは、1 つの行にShow ボタンまたは 2 行ボタンのShow ボタンを表示します。

通常、このメソッドを使用する必要はありません。 ツール バーに表示される Customize ボタンを有効にするには、 CMFCToolBar::EnableCustomizeButton メソッドを呼び出します。 1 行の Show ボタンを有効にするには 2 行ボタンの [表示] ボタンを、CMFCToolBar::SetSiblingToolBarを呼び出します。

CMFCToolBar::CleanUpImages

ツール バー イメージに割り当てられたシステム リソースを解放します。

static void CMFCToolBar::CleanUpImages();

解説

フレームワークは、アプリケーションのシャットダウン時にこのメソッドを呼び出します。

CMFCToolBar::CleanUpLockedImages

ロックされたツール バー イメージに割り当てられたシステム リソースを解放します。

void CleanUpLockedImages();

解説

アプリケーションのビジュアル スタイルが変更されたときに、このメソッドを呼び出します。 このメソッドを使用する例については、VisualStudioDemo サンプルを参照してください。

CMFCToolBar::CommandToIndex

指定したコマンド ID を持つツール バーのボタンのインデックスを返します。

int CommandToIndex(
    UINT nIDFind,
    int iIndexFirst=0) const;

パラメーター

nIDFind
[in]コマンド ID を指定します。

iIndexFirst
[in]開始する最初のインデックスを指定します。

戻り値

メソッドが成功した場合のツール バー ボタンの 0 から始まるインデックス。指定した ID のボタンがない場合は -1。

解説

CMFCToolBar オブジェクトは、ツールバーのボタンの内部リストを保持します。 この関数を呼び出して、ボタンのコマンド ID を指定してリスト内のボタンのインデックスを取得します。

iIndexが 0 より大きい場合、このメソッドは、iIndex未満のインデックスを持つツール バー上のボタンを無視します。

CMFCToolBar::Create

CMFCToolBar オブジェクトを作成します。

virtual BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle=AFX_DEFAULT_TOOLBAR_STYLE,
    UINT nID=AFX_IDW_TOOLBAR);

パラメーター

pParentWnd
[in]ツール バーの親ウィンドウへのポインター。

dwStyle
[in]ツール バーのスタイル。 スタイルの一覧については、Windows SDK の「 Toolbar コントロールとボタンのスタイル 」を参照してください。

nID
[in]ツール バーの子ウィンドウの ID。

戻り値

TRUE このメソッドが成功した場合。それ以外の場合は FALSE。

解説

このメソッドは、コントロール バーを作成し、ツール バーにアタッチします。 TBSTYLE_FLAT スタイルのコントロール バーが作成されます。 別のコントロール バー スタイルが必要な場合は、 CMFCToolBar::CreateEx を呼び出します。

CMFCToolBar::CreateEx

大きなアイコンなどの追加のスタイル オプションを使用する CMFCToolBar オブジェクトを作成します。

virtual BOOL CreateEx(
    CWnd* pParentWnd,
    DWORD dwCtrlStyle=TBSTYLE_FLAT,
    DWORD dwStyle=AFX_DEFAULT_TOOLBAR_STYLE,
    CRect rcBorders=CRect(1,
    1,
    1,
    1),
    UINT nID=AFX_IDW_TOOLBAR);

パラメーター

pParentWnd
[in]ツール バーの親ウィンドウへのポインター。

dwCtrlStyle
[in]埋め込みコントロール バー オブジェクトを作成するための追加のスタイル。

dwStyle
[in]ツール バーのスタイル。 適切なスタイルの一覧については、「 ツール バーのコントロールとボタンのスタイル を参照してください。

rcBorders
[in]ツール バー ウィンドウの境界線の幅を指定する CRect オブジェクト。

nID
[in]ツール バーの子ウィンドウの ID。

戻り値

このメソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

このメソッドは、コントロール バーを作成し、ツール バーにアタッチします。

特定のスタイルを指定する場合は、 CMFCToolBar::Create の代わりにこのメソッドを呼び出します。 たとえば、 dwCtrlStyle を TBSTYLE_FLAT | TBSTYLE_TRANSPARENT に設定して、Internet Explorer 4 で使用されるツール バーに似たツール バーを作成します。

例

次の例では、CMFCToolBar クラスの CreateEx メソッドを使用する方法を示します。 このコード スニペットは、 IE Demo サンプルの一部です。

CMFCToolBar m_wndToolBar;

// The this pointer points to CMainFrame class which extends the CFrameWnd class.
if (!m_wndToolBar.CreateEx(this, TBSTYLE_TRANSPARENT) ||
    !m_wndToolBar.LoadToolBar(IDR_MAINFRAME, uiToolbarColdID, uiMenuID,
                              FALSE /* Not locked */, 0, 0, uiToolbarHotID))
{
   TRACE0("Failed to create toolbar\n");
   return -1; // fail to create
}

CMFCToolBar::Deactivate

ツール バーを非アクティブ化します。

virtual void Deactivate();

解説

このメソッドは、強調表示されているツール バー ボタンからフォーカスを削除することで、ツール バーを非アクティブ化します。 フレームワークは、ツール バーがフォーカスを失うか破棄されたときに、このメソッドを呼び出します。

CMFCToolBar::DoPaint

ツール バーを再描画します。

virtual void DoPaint(CDC* pDC);

パラメーター

pDC
[入力] デバイス コンテキストへのポインター。

解説

このメソッドは、ツール バーの一部を再描画する必要がある場合に、フレームワークによって呼び出されます。

CMFCToolBarから派生したオブジェクトの外観をカスタマイズするには、このメソッドをオーバーライドします。

CMFCToolBar::DrawButton

ツール バー ボタンを再描画します。

virtual BOOL DrawButton(
    CDC* pDC,
    CMFCToolBarButton* pButton,
    CMFCToolBarImages* pImages,
    BOOL bHighlighted,
    BOOL bDrawDisabledImages);

パラメーター

pDC
[入力] デバイス コンテキストへのポインター。

pButton
[in]描画するボタンへのポインター。

pImages
[in]ツール バーイメージへのポインター。

bHighlighted
[入力] TRUE ボタンが強調表示されている場合。それ以外の場合は FALSE。

bDrawDisabledImages
[入力] TRUE 無効なボタンが淡色表示の場合。それ以外の場合は FALSE。

戻り値

TRUE ボタンが再描画された場合。ボタンが非表示になっている場合に FALSE します。

解説

CMFCToolBar::DrawButton メソッドは、ツール バー ボタンを再描画する必要がある場合に、このメソッドを呼び出します。

ツール バーのボタンの外観をカスタマイズする場合は、このメソッドをオーバーライドします。

CMFCToolBar::DrawSeparator

ツールバーの区切り記号を再描画します。

virtual void DrawSeparator(
    CDC* pDC,
    const CRect& rect,
    BOOL bHorz);

パラメーター

pDC
[入力] デバイス コンテキストへのポインター。

rect
[in]区切り記号が描画される位置の外接する四角形 (ピクセル単位)。

bHorz
[入力] TRUE 区切り記号が水平の場合は FALSE 。区切り記号が垂直の場合は。

解説

CMFCToolBar::DoPaintは、これらのボタンのCMFCToolBar::DrawButtonを呼び出す代わりに、TBBS_SEPARATOR スタイルを持つ各CMFCToolBar::DrawSeparator オブジェクトに対してこのメソッドを呼び出します。

ツール バーの区切り記号の外観をカスタマイズするには、 CMFCToolBar から派生したクラスでこのメソッドをオーバーライドします。 既定の実装では、 CMFCVisualManager::OnDrawSeparator を呼び出して、現在のビジュアル マネージャーによって外観が決定される区切り記号を描画します。

CMFCToolBar::EnableCustomizeButton

ツール バーに表示される [カスタマイズ] ボタンを有効または無効にします。

void EnableCustomizeButton(
    BOOL bEnable,
    int iCustomizeCmd,
    const CString& strCustomizeText,
    BOOL bQuickCustomize=TRUE);

void EnableCustomizeButton(
    BOOL bEnable,
    int iCustomizeCmd,
    UINT uiCustomizeTextResId,
    BOOL bQuickCustomize=TRUE);

パラメーター

bEnable
[in][カスタマイズ] ボタンを有効または無効にします。

iCustomizeCmd
[in][カスタマイズ] ボタンのコマンド ID。

strCustomizeText
[in][カスタマイズ] ボタンのテキスト ラベル。

uiCustomizeTextResId
[in][カスタマイズ] ボタン ラベルのリソース文字列 ID。

bQuickCustomize
[in]ボタンからドロップダウンメニューの ボタンの追加または削除 オプションを有効または無効にします。

解説

iCustomizeCmdが -1 の場合、複数のツール バー ボタンがツール バー領域に収まらない場合、フレームワークは [カスタマイズ] ボタンを表示します。 ボタンには、ボタンが他にもあることを示す二重左向きの矢印 (シェブロン) が表示されます。

iCustomizeCmdが有効なコマンド ID を指定し、bEnableがTRUE場合は、[カスタマイズ] ボタンが常に表示されます。 ボタンには小さな下向き矢印があり、コマンドを含むメニューが開きます。 このコマンドは、 strCustomizeTextで指定されたテキスト ラベルを使用します。 bQuickCustomizeもTRUEされている場合は、メニューにボタンの追加または削除オプションが表示されます。

フレームワークは、 iCustomizeCmdで指定された項目の前に、ツール バー領域に収まらないボタンをメニューに動的に追加します。 下矢印の横にシェブロンが表示されます。

CMFCToolBar::EnableDocking

メイン フレームへのペインのドッキングを有効にします。

virtual void EnableDocking(DWORD dwAlignment);

パラメーター

dwAlignment
[入力] 有効にするドッキング配置が指定されます。

解説

このメソッドは、CBasePane::m_dwControlBarStyle データ メンバーを AFX_CBRS_FLOAT に設定することで、基底クラスの実装CBasePane::EnableDocking拡張します。 このメソッドは、基底クラスの実装に dwAlignment を渡します。

CMFCToolBar::EnableLargeIcons

ツール バー ボタンの大きなアイコンを有効または無効にします。

void EnableLargeIcons(BOOL bEnable);

パラメーター

bEnable
[入力] TRUE 大きなアイコンを有効にするには、大きなアイコンを無効にする FALSE 。

解説

既定では、大きなアイコンが有効になっています。

CMFCToolBar::EnableQuickCustomization

ユーザーが Alt キーを押して新しい場所にボタンをドラッグできるように、ツール バーのクイック カスタマイズを有効または無効にします。

static void EnableQuickCustomization(BOOL bEnable=TRUE);

パラメーター

bEnable
[入力] TRUE クイック カスタマイズを有効にするには、クイック カスタマイズを無効にする FALSE 。

CMFCToolBar::EnableReflections

コマンド リフレクションを有効または無効にします。

void EnableReflections(BOOL bEnable = TRUE);

パラメーター

bEnable
[入力] TRUE コマンドリフレクションを有効にするには、コマンド リフレクションを無効にする FALSE 。

解説

コンボ ボックスなどの埋め込みコントロールを含むツール バー ボタンのコマンド リフレクションを有効にするには、このメソッドを呼び出します。

コマンド リフレクションの詳細については、「 TN062: Windows コントロールのメッセージ リフレクション」を参照してください。

CMFCToolBar::EnableTextLabels

ツール バー ボタンの画像の下にあるテキスト ラベルを有効または無効にします。

void EnableTextLabels(BOOL bEnable=TRUE);

パラメーター

bEnable
TRUE テキストラベルがツールバーボタンの画像の下に表示される場合。それ以外の場合は FALSE。

解説

テキスト ラベルが有効になっている場合は、ツール バーのすべてのボタンが拡大され、画像の下にラベルを表示するためのスペースが提供されます。 カスタマイズ ダイアログ ボックスには、Toolbars ページに Show テキスト ラベル チェック ボックスがあります。 ユーザーがツール バーを選択し、このオプションをオンにすると、フレームワークは選択したツール バーの EnableTextLabels を呼び出します。 CMFCToolBarから派生したオブジェクトのチェック ボックスを無効にするには、CMFCToolBar::AllowChangeTextLabelsからFALSEを返します。

CMFCToolBar::FromHandlePermanent

指定されたウィンドウ ハンドルを含む CMFCToolBar オブジェクトへのポインターを取得します。

static CMFCToolBar* __stdcall FromHandlePermanent(HWND hwnd);

パラメーター

hwnd
[in]検索するウィンドウ ハンドル。

戻り値

指定されたウィンドウ ハンドルを含むCMFCToolBar オブジェクトへのポインター。対応するCMFCToolBar オブジェクトが存在しない場合はNULL。

解説

この共有メソッドは、アプリケーションの各ツール バーで、指定されたウィンドウ ハンドルを含む CMFCToolBar オブジェクトを調べます。

CMFCToolBar::GetAllButtons

ツール バーのボタンの読み取り専用リストを返します。

const CObList& GetAllButtons() const;

戻り値

CMFCToolBarButton Class オブジェクトのコレクションを含むCObList クラス オブジェクトへの定数参照。

CMFCToolBar::GetAllToolbars

アプリケーション内のすべてのツール バーの読み取り専用リストを返します。

static const CObList& GetAllToolbars();

戻り値

CMFCToolBar オブジェクトのコレクションを含むCObList Class オブジェクトへの const 参照。

CMFCToolBar::GetBasicCommands

アプリケーションで定義されている基本コマンドの読み取り専用リストを返します。

static const CList<UINT,UINT>& GetBasicCommands();

戻り値

基本コマンドのコレクションを含む CList Class オブジェクトへの const 参照。

解説

CMFCToolBar::AddBasicCommandまたはCMFCToolBar::SetBasicCommandsを呼び出して、基本的なコマンドを追加します。

CMFCToolBar::GetButton

指定したインデックス位置にある CMFCToolBarButton Class オブジェクトへのポインターを返します。

CMFCToolBarButton* GetButton(int iIndex) const;

パラメーター

iIndex
[in]返すボタンのインデックスを指定します。

戻り値

ツール バー ボタン (存在する場合) へのポインター。または、そのようなボタンがない場合は NULL します。

CMFCToolBar::GetButtonInfo

指定したインデックス位置にあるボタンのコマンド ID、スタイル、およびイメージ インデックスを返します。

void GetButtonInfo(
    int nIndex,
    UINT& nID,
    UINT& nStyle,
    int& iImage) const;

パラメーター

nIndex
[in]ツール バーのボタンの一覧にあるボタンのインデックスを指定します。

nID
[out]ボタンのコマンド ID。

nStyle
[out]ボタンのスタイル。

iImage
[out]ボタンのイメージのインデックス。

解説

GetButtonInfo メソッドは、指定したインデックスにあるツール バー ボタンを検索し、ボタンのコマンド ID、スタイル、およびイメージ インデックスを取得します。

指定したインデックスにあるボタンが存在しない場合、フレームワークは nID と nStyle を 0 に設定し、メソッドが戻ったときに -1 に iImage します。

CMFCToolBar::GetButtonSize

ツール バーの各ボタンの寸法を返します。

CSize GetButtonSize() const;

戻り値

ツール バーの各ボタンの寸法を指定する CSize Class オブジェクト。

解説

CMFCToolBar::SetSizesまたはCMFCToolBar::SetLockedSizesを呼び出して、ツール バーの各ボタンの寸法を設定します。

CMFCToolBar::GetButtonStyle

指定したインデックス位置にあるツール バー ボタンの現在のスタイルを返します。

UINT GetButtonStyle(int nIndex) const;

パラメーター

nIndex
[in]ツール バー ボタンのインデックスを指定します。

戻り値

ツール バー ボタンのスタイルを指定する値。 . 使用可能なスタイルの一覧については、「 ToolBar コントロール のスタイル 」を参照してください。

解説

CMFCToolBar::SetButtonStyleを呼び出してツール バー ボタンのスタイルを設定する

CMFCToolBar::GetButtonText

指定したインデックスを持つボタンのテキスト ラベルを返します。

CString GetButtonText(int nIndex) const;

void GetButtonText(
    int nIndex,
    CString& rString) const;

パラメーター

nIndex
[in]ツール バー ボタンのインデックス。

rString
[out]ツール バー ボタンのラベル テキスト。

戻り値

ツール バー ボタンのラベル テキスト。

解説

CMFCToolBar::SetButtonTextまたはCMFCToolBar::SetToolBarBtnTextを呼び出して、テキスト ラベルを設定します。

CMFCToolBar::GetColdImages

アプリケーションのコールド ツール バー ボタン イメージのコレクションへのポインターを返します。

static CMFCToolBarImages* GetColdImages();

戻り値

コールド ツール バー ボタンイメージのコレクションへのポインター。

解説

コールド イメージは、ユーザーがツール バー ボタンを操作していない場合に使用されるイメージです。 CMFCToolBar::LoadBitmapExまたはCMFCToolBar::LoadBitmapを呼び出して、コールド イメージを読み込みます。

CMFCToolBar::GetColumnWidth

ツール バー ボタンの幅を返します。

virtual int GetColumnWidth() const;

戻り値

ツール バー ボタンの幅を指定する値。

解説

フレームワークはこのメソッドを呼び出して、ツール バーのレイアウトを計算します。 派生クラスでこのメソッドをオーバーライドして、ツール バーに別の列幅を指定します。

CMFCToolBar::GetCommandButtons

指定したコマンド ID を持つボタンの一覧を、アプリケーション内のすべてのツール バーから返します。

static int GetCommandButtons(
    UINT uiCmd,
    CObList& listButtons);

パラメーター

uiCmd
[in]ボタンのコマンド ID。

listButtons
[out]ツール バー ボタンの一覧を受け取る CObList Class オブジェクトへの参照。

戻り値

指定したコマンド ID を持つボタンの数。

CMFCToolBar::GetCount

ツール バーのボタンと区切り記号の数を返します。

int GetCount() const;

戻り値

ツール バーのボタンと区切り記号の数。

CMFCToolBar::GetCustomizeButton

ツール バーに関連付けられている CMFCCustomizeButton オブジェクトへのポインターを取得します。

CMFCCustomizeButton* GetCustomizeButton();

戻り値

ツール バーに関連付けられている CMFCCustomizeButton オブジェクトへのポインター。

解説

このメソッドは、ツール バーの末尾に表示される Customize ボタンを取得します。 CMFCToolBar::EnableCustomizeButton メソッドを使用して、ツール バーに Customize ボタンを追加します。

CMFCToolBar::IsExistCustomizeButton メソッドを呼び出して、ツール バーに有効なCMFCCustomizeButton オブジェクトが含まれているかどうかを判断できます。

CMFCToolBar::GetDefaultImage

指定したコマンド ID を持つツール バー ボタンの既定のイメージのインデックスを返します。

static int GetDefaultImage(UINT uiID);

パラメーター

uiID
[in]ボタンのコマンド ID を指定します。

戻り値

イメージの共有リスト内のツール バー イメージのインデックス。

解説

この共有メソッドを使用して、指定したコマンド ID を持つツール バー ボタンの既定のイメージのインデックスを取得します。 戻り値は、アプリケーション内のすべてのツール バーのツール バー ボタン イメージの共有コレクションへのインデックスです。 CMFCToolBar::GetImages メソッドを呼び出して、このコレクションへのポインターを取得します。

CMFCToolBar::GetDisabledImages

アプリケーションで無効になっているツール バー ボタンに使用されるイメージのコレクションへのポインターを返します。

static CMFCToolBarImages* __stdcall GetDisabledImages();

戻り値

無効なツール バー ボタンイメージのコレクションへのポインター。

解説

CMFCToolBarEditBoxButton Class および CMFCToolBar::LoadBitmap メソッドを使用して、無効になっているツール バー ボタンの画像を読み込みます。

CMFCToolBar::GetDisabledMenuImages

アプリケーションで無効になっているメニュー ボタンに使用されるイメージのコレクションへのポインターを返します。

static CMFCToolBarImages* __stdcall GetDisabledMenuImages();

戻り値

無効なメニュー イメージのコレクションへのポインター。

解説

CMFCToolBarEditBoxButton Class メソッドを使用して、無効なイメージを読み込みます。

CMFCToolBar::GetDroppedDownMenu

現在サブメニューを表示しているメニュー ボタン オブジェクトへのポインターを取得します。

CMFCToolBarMenuButton* GetDroppedDownMenu(int* pIndex = NULL) const;

パラメーター

pIndex
[out]ツール バー ボタンのコレクション内のボタンのインデックスを受け取ります。

戻り値

サブメニューを表示しているメニュー ボタン オブジェクトへのポインター。メニューにサブメニューが表示されていない場合は NULL 。

解説

このメソッドが null 以外の値を返し、 pIndex が NULLされていない場合、 pIndex が指す値は、ツール バー ボタンのコレクション内のメニュー ボタンのインデックスに設定されます。

CMFCToolBar::GetGrayDisabledButtons

無効なボタンのイメージを通常のボタン イメージの淡色表示バージョンにするか、無効なボタンイメージのコレクションから取得するかを指定します。

BOOL GetGrayDisabledButtons() const;

戻り値

TRUE 無効なボタンの画像を暗くする場合。無効なイメージのコレクションからイメージを取得する FALSE 。

解説

CMFCToolBar::SetGrayDisabledButtonsを使用して、淡色表示されたイメージと無効なイメージのコレクションからイメージを切り替えます。

CMFCToolBar::GetHighlightedButton

現在強調表示されているツール バー ボタンへのポインターを返します。

CMFCToolBarButton* GetHighlightedButton() const;

戻り値

ツール バー ボタン オブジェクトへのポインター。ボタンが強調表示されていない場合は NULL します。

解説

キーボード フォーカスがある場合、ツール バー ボタンが強調表示されます。 このアプリケーションでツール バー ボタンがホット トラックされていて (詳細については、 CMFCToolBar::GetHotBorder と CMFCToolBar::SetHotBorderを参照)、ツール バー ボタンまたはメニュー項目にキーボード フォーカスがないときにマウスがポイントされている場合も、ツール バー ボタンが強調表示されます。

CMFCToolBar::GetHotBorder

ツール バー ボタンを hot 追跡するかどうかを指定します。 ボタンがホット トラックされている場合は、マウスが移動したときに強調表示されます。

BOOL GetHotBorder() const;

戻り値

TRUE ツール バー ボタンがホット トラックされている場合。それ以外の場合は FALSE。

解説

既定では、ツール バー ボタンはホット トラックされます。

CMFCToolBar::GetHotTextColor

強調表示されているツール バー ボタンのテキストの色を返します。

static COLORREF GetHotTextColor();

戻り値

現在強調表示されているテキストの色を表す COLORREF 値。

解説

強調表示されたツール バー ボタンの新しいテキストの色を設定するには、 CMFCToolBar::SetHotTextColor を呼び出します。

CMFCToolBar::GetHwndLastFocus

ツール バーの直前に入力フォーカスがあるウィンドウへのハンドルを返します。

HWND GetHwndLastFocus() const;

戻り値

以前に入力フォーカスを持っていた CMFCBaseToolBar クラスから派生していないウィンドウへのハンドル。または、そのようなウィンドウがない場合は NULL 。

解説

CMFCToolBar コントロールは、入力フォーカスを受け取ると、フォーカスを失ったウィンドウへのハンドルを格納して、後で復元できるようにします。

CMFCToolBar::GetIgnoreSetText

ボタン ラベルを設定する呼び出しを無視するかどうかを指定します。

BOOL GetIgnoreSetText() const;

戻り値

TRUE ボタン ラベルを設定する呼び出しが無視される場合。それ以外の場合は FALSE。

解説

CMFCToolBar::GetImages

アプリケーション内の既定のボタン イメージのコレクションへのポインターを返します。

static CMFCToolBarImages* GetImages();

戻り値

アプリケーション内のすべてのツール バーの既定のイメージのコレクションを含む CMFCToolBarImages クラス オブジェクトへのポインター。

解説

この共有メソッドは、アプリケーションのすべての既定のツール バー イメージのコレクションへのアクセスを提供します。 CMFCToolBar::LoadBitmap メソッドを呼び出して、コレクションにイメージを追加します。

CMFCToolBar::GetImageSize

ツール バー ボタンイメージの現在のサイズを返します。

CSize GetImageSize() const;

戻り値

ツール バー ボタンイメージの現在のサイズを表す CSize クラス オブジェクト。

CMFCToolBar::GetImagesOffset

ツール バー ボタン イメージのグローバル リストで、このツール バーのツール バー ボタンイメージを検索するために使用されるインデックス オフセットを返します。

int GetImagesOffset() const;

戻り値

ツール バー イメージのインデックス オフセット。

解説

すべてのツール バーの既定のイメージは、グローバル CMFCToolBarImages クラス 一覧に格納されます。 ツール バーの各ボタンの画像は、その一覧に連続して格納されます。 イメージのインデックスを計算するには、ツール バーのボタンのインデックスを、そのツール バー ボタンの画像リストの先頭のオフセットに追加します。

CMFCToolBar::ButtonToIndexを呼び出して、ボタンへのポインターを指定してツール バー ボタンのインデックスを取得します。

CMFCToolBar::GetImagesを呼び出して、ツール バー イメージのコレクションへのポインターを取得します。

CMFCToolBar::GetInvalidateItemRect

指定したインデックス位置にあるボタンに対して再描画する必要があるクライアント領域の領域を取得します。

virtual void GetInvalidateItemRect(
    int nIndex,
    LPRECT lpRect) const;

パラメーター

nIndex
[in]クライアント領域を取得するボタンのインデックス。

lpRect
[out]クライアント領域の領域を受け取る RECT オブジェクトへのポインター。

解説

lpRect パラメーターをNULLすることはできません。 指定したインデックスにボタンが存在しない場合、 lpRect は 0 に初期化された RECT オブジェクトを受け取ります。

CMFCToolBar::GetItemID

指定したインデックス位置にあるツール バー ボタンのコマンド ID を返します。

UINT GetItemID(int nIndex) const;

パラメーター

nIndex
[in]ツール バー ボタンのインデックスを指定します。

戻り値

ツール バー ボタンのコマンド ID。指定したインデックスを持つボタンが存在しない場合は 0。

CMFCToolBar::GetItemRect

指定したインデックス位置にあるボタンの外接する四角形を返します。

virtual void GetItemRect(
    int nIndex,
    LPRECT lpRect) const;

パラメーター

nIndex
[in]ツール バー ボタンのインデックスを指定します。

lpRect
[out]画像の外接する四角形 CRect 座標を受け取るオブジェクトへのポインター。

解説

指定したインデックス位置にあるボタンが存在しない場合、lpRectポイントするCRect オブジェクトは 0 に設定されます。

例

次の例では、CMFCToolBar クラスの GetItemRect メソッドを使用する方法を示します。 このコード スニペットは、 IE Demo サンプルの一部です。

CMFCToolBar m_wndToolBar;

CRect rectToolBar;
m_wndToolBar.GetItemRect(0, &rectToolBar);

CMFCToolBar::GetLargeColdImages

アプリケーション内の大きなコールド ツール バー ボタン イメージのコレクションへのポインターを返します。

static CMFCToolBarImages* GetLargeColdImages();

戻り値

大きなコールド イメージのコレクションへのポインター。

解説

コールド イメージは、ユーザーがツール バー ボタンを操作していない場合に使用されるイメージです。 CMFCToolBar::LoadBitmapExを呼び出して、大きなコールド イメージを読み込みます。

CMFCToolBar::GetLargeDisabledImages

アプリケーションで無効になっている大きなツール バー ボタンイメージのコレクションへのポインターを返します。

static CMFCToolBarImages* GetLargeDisabledImages();

戻り値

無効になっている大きなツール バー ボタンイメージのコレクションへのポインター。

解説

大きなイメージは、通常のツール バー ボタンイメージの大きなバージョンです。 CMFCToolBar::LoadBitmapExまたはCMFCToolBar::LoadBitmapを呼び出して、大きなイメージを読み込みます。

CMFCToolBar::GetLargeImages

アプリケーション内の大きなツール バー ボタンイメージのコレクションへのポインターを返します。

static CMFCToolBarImages* GetLargeImages();

戻り値

大きなツール バー ボタンイメージのコレクションへのポインター。

解説

大きなイメージは、通常のツール バー ボタンイメージの大きなバージョンです。 CMFCToolBar::LoadBitmapExを呼び出して、大きなイメージを読み込みます。

CMFCToolBar::GetLockedColdImages

ツール バーのロックされたコールド イメージのコレクションへのポインターを返します。

CMFCToolBarImages* GetLockedColdImages();

戻り値

ロックされたコールド イメージのコレクションへのポインター。ツール バーがロックされていない場合は NULL 。

解説

ロックされたイメージは、ユーザーがツール バーをカスタマイズできない場合にフレームワークが使用する通常のツール バー ボタン イメージのバージョンです。 コールド イメージは、ユーザーがツール バー ボタンを操作していない場合に使用されるイメージです。

ツール バーがロックされていない場合、このメソッドは NULL を返します。 このメソッドは、ツール バーがロックされていない場合、デバッグ ビルドでアサーション エラーも生成します。 ロックされたツールバーの詳細については、「 CMFCToolBar::IsLocked」を参照してください。

CMFCToolBar::LoadBitmapEx メソッドを呼び出して、ロックされたコールド イメージを読み込みます。

CMFCToolBar::GetLockedDisabledImages

ツール バーのロックされた無効なイメージのコレクションへのポインターを返します。

CMFCToolBarImages* GetLockedDisabledImages();

戻り値

ロックされた無効なイメージのコレクションへのポインター。ツール バーがロックされていない場合は NULL 。

解説

ロックされたイメージは、ユーザーがツール バーをカスタマイズできない場合にフレームワークが使用する通常のツール バー ボタン イメージのバージョンです。 無効なイメージは、ボタンに TBBS_DISABLED スタイルがある場合にフレームワークが使用するイメージです。

ツール バーがロックされていない場合、このメソッドは NULL を返します。 このメソッドは、ツール バーがロックされていない場合、デバッグ ビルドでアサーション エラーも生成します。 ロックされたツールバーの詳細については、「 CMFCToolBar::IsLocked」を参照してください。

CMFCToolBar::LoadBitmapEx メソッドを呼び出して、ロックされた無効なイメージを読み込みます。

CMFCToolBar::GetLockedImages

ツール バーのロックされたボタン イメージのコレクションへのポインターを返します。

CMFCToolBarImages* GetLockedImages();

戻り値

ロックされたツール バー ボタンイメージのコレクションへのポインター。ツール バーがロックされていない場合は NULL 。

解説

ロックされたイメージは、ユーザーがツール バーをカスタマイズできない場合にフレームワークが使用する通常のツール バー ボタン イメージのバージョンです。

ツール バーがロックされていない場合、このメソッドは NULL を返します。 このメソッドは、ツール バーがロックされていない場合、デバッグ ビルドでアサーション エラーも生成します。 ロックされたツールバーの詳細については、「 CMFCToolBar::IsLocked」を参照してください。

CMFCToolBar::GetLockedImageSize

ロックされているツール バー イメージの既定のサイズを返します。

CSize GetLockedImageSize() const;

戻り値

ロックされたツール バー イメージのサイズを指定する CSize 構造体。ツール バーがロックされていない場合は空の CSize 構造体。

解説

ロックされたイメージは、ユーザーがツール バーをカスタマイズできない場合にフレームワークが使用する通常のツール バー ボタン イメージのバージョンです。

このメソッドは、ツールバーがロックされていない場合、幅が 0 で高さが 0 の CSize 構造体を返します。 このメソッドは、ツール バーがロックされていない場合、デバッグ ビルドでアサーション エラーも生成します。 ロックされたツールバーの詳細については、「 CMFCToolBar::IsLocked」を参照してください。

CMFCToolBar::SetLockedSizes メソッドを呼び出して、ロックされたイメージ サイズを指定します。

CMFCToolBar::GetLockedMenuImages

ツール バーのロックされたツール バー メニュー イメージのコレクションへのポインターを返します。

CMFCToolBarImages* GetLockedMenuImages();

戻り値

ロックされたツールバー メニュー イメージのコレクションへのポインター。または、ツール バーがロックされていない場合は NULL 。

解説

ロックされたイメージは、ユーザーがツール バーをカスタマイズできない場合にフレームワークが使用する通常のツール バー メニュー イメージのバージョンです。

ツール バーがロックされていない場合、このメソッドは NULL を返します。 このメソッドは、ツール バーがロックされていない場合、デバッグ ビルドでアサーション エラーも生成します。 ロックされたツールバーの詳細については、「 CMFCToolBar::IsLocked」を参照してください。

CMFCToolBar::LoadBitmapEx メソッドを呼び出して、ロックされたメニュー イメージを読み込みます。

CMFCToolBar::GetMenuButtonSize

アプリケーションのメニュー ボタンのサイズを返します。

static CSize GetMenuButtonSize();

戻り値

メニュー ボタンのサイズをピクセル単位で表す CSize オブジェクト。

解説

ツール バーのメニュー ボタンのサイズはグローバル変数として保持され、この静的メソッドで取得できます。

CMFCToolBar::SetMenuSizesを呼び出して、このグローバル変数を設定します。

CMFCToolBar::GetMenuImages

アプリケーション内のメニュー ボタン イメージのコレクションへのポインターを返します。

static CMFCToolBarImages* GetMenuImages();

戻り値

メニュー イメージのコレクションへのポインター。

解説

CMFCToolBar::LoadBitmapEx メソッドを呼び出してメニュー イメージを読み込みます。

CMFCToolBar::SetMenuSizes メソッドを呼び出して、ボタンとその画像のサイズを設定します。

CMFCToolBar::GetMenuImageSize

アプリケーション内のメニュー ボタンイメージのサイズを返します。

static CSize GetMenuImageSize();

戻り値

メニュー イメージのサイズを表す CSize オブジェクト。

解説

このメソッドは、グローバル変数として保持されているツール バー メニュー ボタンのイメージのサイズを返します。 CMFCToolBar::SetMenuSizesを呼び出して、このグローバル変数を設定します。

CMFCToolBar::GetOrigButtons

ツール バーのカスタマイズされていないボタンのコレクションを取得します。

const CObList& GetOrigButtons() const;

戻り値

ツール バーのカスタマイズされていないボタンの一覧への参照。

解説

フレームワークは、ユーザーがカスタマイズする前に、ツール バー ボタンのコピーを作成します。 CMFCToolBar::SetButtons メソッドは、指定された配列内の各ボタンのコピーを元のボタンの一覧に追加します。 CMFCToolBar::RestoreOriginalState メソッドは、リソース ファイルからツール バーを読み込むことで、ツール バーの元の状態を復元します。

ツール バーの元のボタンの一覧を設定するには、 CMFCToolBar::SetOrigButtons メソッドを呼び出します。

CMFCToolBar::GetOrigResetButtons

ツール バーのカスタマイズされていないリセット ボタンのコレクションを取得します。

const CObList& GetOrigResetButtons() const;

戻り値

ツール バーのカスタマイズされていないリセット ボタンの一覧への参照。

解説

ユーザーがカスタマイズ モード中に Reset ボタンを選択すると、フレームワークはこのメソッドを使用して、ツール バーから削除されたボタンを復元します。

CMFCToolBar::SetButtons メソッドは、CMFCToolBar::OnReset メソッドを呼び出した後、元のリセット ボタンの一覧に各ツール バー ボタンのコピーを追加します。 ユーザーが Reset ボタンを押した後で、CMFCToolBar::OnReset メソッドをオーバーライドしてボタンの外観をカスタマイズできます。

CMFCToolBar::GetResourceID

ツール バーのリソース ID を取得します。

UINT GetResourceID() const;

戻り値

ツール バーのリソース ID。

解説

CMFCToolBar::LoadToolBarEx メソッドを呼び出して、ツール バーのリソース ID を設定します。

CMFCToolBar::GetRouteCommandsViaFrame

どのオブジェクト (親フレームまたは所有者) がツール バーにコマンドを送信するかを決定します。

BOOL GetRouteCommandsViaFrame();

戻り値

親フレームがツール バーにコマンドを送信する場合は 0 以外。所有者がツール バーにコマンドを送信する場合は 0。

解説

既定では、親フレームはツール バーにコマンドを送信します。 この動作を変更するには、 CMFCToolBar::SetRouteCommandsViaFrame を呼び出します。

このメソッドが 0 以外の値を返す場合は、 CMFCToolBar::GetCommandTarget メソッドを使用して親フレーム オブジェクトへのポインターを取得できます。 このメソッドを使用する例については、VisualStudioDemo サンプルを参照してください。

CMFCToolBar::GetRowHeight

ツール バー ボタンの高さを返します。

virtual int GetRowHeight() const;

戻り値

ツールバー ボタンの高さ (ピクセル単位)。

解説

フレームワークはこのメソッドを呼び出して、ツール バーのレイアウトを計算します。 派生クラスでこのメソッドをオーバーライドして、ツール バーに別の高さを指定します。

CMFCToolBar::GetShowTooltips

ツール バー ボタンのツール ヒントを表示するかどうかを指定します。

static BOOL GetShowTooltips();

戻り値

TRUE ツール バー ボタンのツール ヒントが表示される場合。それ以外の場合は FALSE。

解説

既定では、ツール ヒントが表示されます。 この静的フラグは、 CMFCToolBar::SetShowTooltipsを呼び出すことによって変更できます。

CMFCToolBar::GetSiblingToolBar

ツール バーの兄弟を取得します。

CMFCToolBar* GetSiblingToolBar();

戻り値

兄弟ツール バーへのポインター。

解説

1 行の Show ボタンを有効にする方法の詳細については 2 つの行ボタンの表示ボタンを参照してくださいCMFCToolBar::SetSiblingToolBar。

CMFCToolBar::GetUserImages

アプリケーション内のユーザー定義ツール バー ボタン イメージのコレクションへのポインターを返します。

static CMFCToolBarImages* GetUserImages();

戻り値

アプリケーション内のすべてのツール バーのユーザー定義ツール バー ボタン イメージのコレクションへのポインター。

解説

CMFCToolBar::SetUserImages メソッドを呼び出して、アプリケーション内のユーザー定義イメージのコレクションを設定します。

CMFCToolBar::HitTest

指定した位置にあるツール バー ボタンのインデックスを返します。

virtual int HitTest(CPoint point);

パラメーター

point
[in]クライアント座標でテストするポイント。

戻り値

指定した位置にあるボタンのインデックス。そのようなボタンがない場合、またはボタンが区切り記号である場合は -1。

CMFCToolBar::InsertButton

ツール バーにボタンを挿入します。

virtual int InsertButton(
    const CMFCToolBarButton& button,
    INT_PTR iInsertAt=-1);

virtual int InsertButton(
    CMFCToolBarButton* pButton,
    int iInsertAt=-1);

パラメーター

button
[in]挿入するボタンを指定します。

iInsertAt
[in]ボタンを挿入する位置を 0 から始める位置を指定します。

戻り値

ボタンが挿入された位置。エラーが発生した場合は -1。

解説

iInsertAtが -1 の場合、このメソッドはツール バー ボタンの一覧の末尾にボタンを追加します。

CMFCToolBar::InsertSeparator メソッドを呼び出して、ツールバーに区切り記号を挿入します。

CMFCToolBar::InsertSeparator

ツールバーに区切り記号を挿入します。

virtual int InsertSeparator(INT_PTR iInsertAt=-1);

パラメーター

iInsertAt
[in]区切り記号を挿入する位置を 0 から始める位置を指定します。 このパラメーターは 0 より大きくする必要があります。

戻り値

区切り記号が挿入された位置。エラーが発生した場合は -1。

解説

このメソッドを呼び出して、既存の 2 つのボタンの間に区切り記号を挿入します。 iInsertAtが -1 の場合、このメソッドはツールバー ボタンの一覧の末尾に区切り記号を追加します。

このメソッドを使用して、空白のツール バーに区切り記号を追加することはできません。

CMFCToolBar::InsertButton メソッドを呼び出して、ツール バーにボタンを挿入します。

CMFCToolBar::InvalidateButton

指定されたインデックスに存在するツール バー ボタンのクライアント領域を無効にします。

CMFCToolBarButton* InvalidateButton(int nIndex);

パラメーター

nIndex
[in]ツール バーのボタンの 0 から始まるインデックス。

戻り値

指定されたインデックスに存在する CMFCToolBarButton オブジェクトへのポインター。または、そのようなオブジェクトが存在しない場合は NULL 。

解説

フレームワークは、ツール バー ボタンに関連付けられているクライアント領域を更新するときに、このメソッドを呼び出します。 指定されたインデックスに存在するCMFCToolBarButton オブジェクトのクライアント四角形を使用して、CWnd::InvalidateRect メソッドを呼び出します。

CMFCToolBar::IsAddRemoveQuickCustomize

Customize メニュー オプションを使用して、ユーザーがツール バー ボタンを追加または削除できるかどうかを指定します。

BOOL IsAddRemoveQuickCustomize();

戻り値

TRUE ユーザーが Customize メニュー オプションを使用してツール バーを変更できる場合は FALSE。

解説

CMFCToolBar::IsAltCustomizeMode

カスタマイズを使用してボタンをドラッグするかどうかを指定します。 クイック カスタマイズを有効にすると、ユーザーは Alt キーを長押しし、ボタンを新しい場所にドラッグできます。

static BOOL __stdcall IsAltCustomizeMode();

戻り値

TRUE クイックカスタマイズを使用してボタンをドラッグする場合。それ以外の場合は FALSE。

解説

CMFCToolBar::IsAutoGrayInactiveImages

非アクティブ (強調表示されていない) ボタン イメージの自動生成を有効にするかどうかを指定します。

static BOOL IsAutoGrayInactiveImages();

戻り値

TRUE 非アクティブな画像を自動的に暗くするオプションが有効になっている場合。それ以外の場合は FALSE。

解説

CMFCToolBar::AutoGrayInactiveImagesを呼び出すことによって、非アクティブなイメージの自動淡色表示を有効または無効にすることができます。

CMFCToolBar::IsBasicCommand

コマンドが基本コマンドの一覧にあるかどうかを判断します。

static BOOL IsBasicCommand(UINT uiCmd);

パラメーター

uiCmd
[in]チェックするコマンドを指定します。

戻り値

TRUE 指定されたコマンドが基本コマンドのリストに属している場合。それ以外の場合は FALSE。

解説

この静的メソッドは、 uiCmd によって指定されたコマンドが基本コマンドのグローバル リストに属しているかどうかを判断します。 基本的なコマンドの一覧を変更するには、 CMFCToolBar::AddBasicCommand または CMFCToolBar::SetBasicCommandsを呼び出します。

CMFCToolBar::IsButtonExtraSizeAvailable

罫線が拡張されたボタンをツール バーに表示できるかどうかを指定します。

virtual BOOL IsButtonExtraSizeAvailable() const;

戻り値

TRUE バーが余分な境界線サイズのボタンを表示できる場合。それ以外の場合は FALSE。

解説

ツール バー オブジェクトは、罫線が拡張されたボタンを表示できる場合は、 TRUE を返します。 ツール バー ボタンは、 CMFCToolBarButton::OnChangeParentWnd 通知を処理するときにこのメソッドを呼び出し、それに応じて内部の余分な境界線サイズ フラグを設定します。 この内部フラグは、後で CMFCToolBarButton::IsExtraSize を呼び出すことによって取得できます。

CMFCToolBarから派生したクラスでこのメソッドをオーバーライドし、バーに余分な罫線サイズのツール バー ボタンを表示できる場合はTRUEを返し、それ以外の場合はFALSE返します。 既定の実装では、TRUE が返されます。

CMFCToolBar::IsButtonHighlighted

指定したボタンが強調表示されているかどうかを判断します。

BOOL IsButtonHighlighted(int iButton) const;

パラメーター

iButton
[in]ツール バー ボタンのインデックスを指定します。

戻り値

TRUE 指定したボタンが強調表示されている場合。それ以外の場合は FALSE。

解説

CMFCToolBar::IsCommandPermitted

コマンドが許可されているかどうかを判断します。

static BOOL IsCommandPermitted(UINT uiCmd);

パラメーター

uiCmd
[in]チェックするコマンドを指定します。

戻り値

TRUE 指定したコマンドが許可されている場合は〘。それ以外の場合は FALSE。

解説

この静的メソッドは、 uiCmd によって指定されたコマンドが、許可されていないコマンドのグローバル リストに属しているかどうかを判断します。

許可されていないコマンドの一覧を変更するには、 CMFCToolBar::SetNonPermittedCommandsを呼び出します。

CMFCToolBar::IsCommandRarelyUsed

コマンドがほとんど使用されないかどうかを判断します。

static BOOL IsCommandRarelyUsed(UINT uiCmd);

パラメーター

uiCmd
[in]チェックするコマンドを指定します。

戻り値

TRUE 指定されたコマンドがほとんど使用されない場合。それ以外の場合は FALSE。

解説

IsCommandRarelyUsed メソッドは、次の 1 つ以上の条件が発生した場合にFALSEを返します。

  • 指定されたコマンドは、基本コマンドのリストに属しています

  • 指定されたコマンドは、標準コマンドの 1 つです

  • フレームワークはカスタマイズ モードです

  • 基本的なコマンドの一覧が空です

  • コマンド呼び出しの 20% を超えるコマンド呼び出しは、指定されたコマンドの呼び出しです。

CMFCToolBar::IsCustomizeMode

ツール バー フレームワークがカスタマイズ モードかどうかを指定します。

static BOOL IsCustomizeMode();

戻り値

TRUE フレームワークがカスタマイズ モードの場合。それ以外の場合は FALSE。

解説

CMFCToolBar::SetCustomizeModeを呼び出すことで、カスタマイズ モードを切り替えることができます。

フレームワークは、ユーザーがカスタマイズ ダイアログ ボックス ( CMFCToolBarsCustomizeDialog クラス) を呼び出すときにモードを変更します。

CMFCToolBar::IsDragButton

ツール バー ボタンをドラッグするかどうかを指定します。

BOOL IsDragButton(const CMFCToolBarButton* pButton) const;

パラメーター

pButton
[in]ツール バー ボタンへのポインター。

戻り値

TRUE 指定したボタンがドラッグされている場合。それ以外の場合は FALSE。

解説

CMFCToolBar::IsExistCustomizeButton

ツール バーに Customize ボタンが含まれているかどうかを指定します。

BOOL IsExistCustomizeButton();

戻り値

TRUE ツール バーに Customize ボタンが含まれている場合は。それ以外の場合は FALSE。

解説

このメソッドが TRUEを返す場合、 CMFCToolBar::GetCustomizeButton メソッドはツール バーの末尾に表示される Customize ボタンへのポインターを返します。

CMFCToolBar::EnableCustomizeButton メソッドを使用して、ツール バーに Customize ボタンを追加します。

CMFCToolBar::IsFloating

ツール バーが浮動かどうかを判断します。

virtual BOOL IsFloating() const;

戻り値

TRUE ツール バーが浮動の場合は 〗。それ以外の場合は FALSE。

CMFCToolBar::IsLargeIcons

アプリケーションのツール バーに現在大きなアイコンを表示するかどうかを指定します。

static BOOL IsLargeIcons();

戻り値

TRUE アプリケーションが大きなアイコンを使用している場合。それ以外の場合は FALSE。

解説

CMFCToolBar::SetLargeIconsを呼び出して、大きなアイコンと通常のアイコンを切り替えます。

フレームワークは、ユーザーが Customization ダイアログ ボックスの Options ページで Large アイコン チェック ボックスを切り替えると、モードを自動的に変更します。

CMFCToolBar::IsLastCommandFromButton

指定したツール バー ボタンから、最後に実行されたコマンドが送信されたかどうかを判断します。

static BOOL IsLastCommandFromButton(CMFCToolBarButton* pButton);

パラメーター

pButton
[in]ボタンへのポインター。

戻り値

TRUE 指定したボタンから最後のコマンドが送信された場合 pButton 。それ以外の場合は FALSE。

解説

このメソッドは、CWnd::GetCurrentMessageを呼び出すことによってMSG構造体へのポインターを取得します。 次に、ボタンの HWND を MSG::lParam と MSG::hwnd メンバーと比較して、ボタンがコマンドのソースであるかどうかを判断します。

CMFCToolBar::IsLocked

ツール バーがロックされているかどうかを判断します。

BOOL IsLocked() const;

戻り値

TRUE ツールバーがロックされている場合。それ以外の場合は FALSE。

解説

このメソッドは、ユーザーがツール バー ボタンの位置を変更するなど、カスタマイズ タスクを実行できない場合に TRUE を返します。

ロックされたツールバーでは、個別のイメージ リストが使用されます。 これらの画像リストの詳細については、 CMFCToolBar::LoadBitmapExを参照してください。

CMFCToolBar::IsOneRowWithSibling

ツール バーとその兄弟ツール バーが同じ行に配置されているかどうかを判断します。

BOOL IsOneRowWithSibling();

戻り値

TRUE ツールバーとその兄弟が同じ行に配置されている場合。それ以外の場合は FALSE。

解説

CMFCCustomizeButton::CreatePopupMenu メソッドは、このメソッドを呼び出して、Customize ポップアップ メニューを表示する方法を決定します。 このメソッドがTRUEを返す場合、フレームワークは 1 行ボタンにShow ボタンを表示します。 それ以外の場合、フレームワークは 2 行の Show ボタン 表示します。

通常、このメソッドを使用する必要はありません。 1 行の Show ボタンを有効にするには 2 行ボタンの [表示] ボタンを、CMFCToolBar::SetSiblingToolBarを呼び出します。

CMFCToolBar::IsResourceChanged

virtual BOOL IsResourceChanged() const;

戻り値

解説

CMFCToolBar::IsSibling

BOOL IsSibling();

戻り値

解説

CMFCToolBar::IsUserDefined

ツール バーがユーザー定義かどうかを指定します。

BOOL IsUserDefined() const;

戻り値

TRUE ツールバーがユーザーによって作成された場合。それ以外の場合は FALSE。

CMFCToolBar::LoadBitmap

アプリケーション リソースからツール バー イメージを読み込みます。

virtual BOOL LoadBitmap(
    UINT uiResID,
    UINT uiColdResID=0,
    UINT uiMenuResID=0,
    BOOL bLocked=FALSE,
    UINT uiDisabledResID=0,
    UINT uiMenuDisabledResID=0);

パラメーター

uiResID
[in]ホット ツール バーイメージを参照するビットマップのリソース ID。

uiColdResID
[in]コールド ツール バー イメージを参照するビットマップのリソース ID。

uiMenuResID
[in]通常のメニュー イメージを参照するビットマップのリソース ID。

bLocked
[入力] TRUE ツールバーをロックするには、それ以外の場合は FALSE。

uiDisabledResID
[in]無効になっているツール バー イメージを参照するビットマップのリソース ID。

uiMenuDisabledResID
[in]無効なメニュー イメージを参照するビットマップのリソース ID。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

CMFCToolBar::LoadToolBarEx メソッドはこのメソッドを呼び出して、ツール バーに関連付けられているイメージを読み込みます。 このメソッドをオーバーライドして、イメージ リソースのカスタムの読み込みを実行します。

ツール バーの作成後に、 LoadBitmapEx メソッドを呼び出して追加のイメージを読み込みます。

CMFCToolBar::LoadBitmapEx

virtual BOOL LoadBitmapEx(
    CMFCToolBarInfo& params,
    BOOL bLocked = FALSE);

パラメーター

[入力] params
[入力] bLocked\

戻り値

解説

CMFCToolBar::LoadLargeIconsState

static BOOL __stdcall LoadLargeIconsState(LPCTSTR lpszProfileName = NULL);

パラメーター

[入力] lpszProfileName\

戻り値

解説

CMFCToolBar::LoadParameters

Windows レジストリからグローバル ツール バー オプションを読み込みます。

static BOOL LoadParameters(LPCTSTR lpszProfileName=NULL);

パラメーター

lpszProfileName
[in]Windows レジストリ キーの相対パスを指定します。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

このメソッドは、メニュー アニメーションの種類、メニュー シャドウ スタイル、Windows レジストリから大きなアイコンを表示するかどうかなどのグローバル パラメーターを読み込みます。

CWinAppEx::LoadState メソッドは、アプリケーションの初期化プロセスの一部としてこのメソッドを呼び出します。

CMFCToolBar::LoadState

Windows レジストリからツール バーの状態情報を読み込みます。

virtual BOOL LoadState(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

パラメーター

lpszProfileName
[in]Windows レジストリ キーの相対パスを指定します。

nIndex
[in]ツール バーのコントロール ID を指定します。

uiID
[in]ツール バーのリソース ID を指定します。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

フレームワークは、アプリケーションの初期化プロセスの一部としてこのメソッドを呼び出します。 詳細については、CWinAppEx::LoadStateを参照してください。

CMFCToolBar::LoadToolBar

アプリケーション リソースからツール バーを読み込みます。

virtual BOOL LoadToolBar(
    UINT uiResID,
    UINT uiColdResID=0,
    UINT uiMenuResID=0,
    BOOL bLocked=FALSE,
    UINT uiDisabledResID=0,
    UINT uiMenuDisabledResID=0,
    UINT uiHotResID=0);

パラメーター

uiResID
[in]ツール バーのリソース ID。

uiColdResID
[in]コールド ツール バー イメージを参照するビットマップのリソース ID。

uiMenuResID
[in]通常のメニュー イメージを参照するビットマップのリソース ID。

bLocked
[in]ツール バーがロックされているかどうかを示すブール値。 このパラメーターが TRUE場合、ツール バーはロックされます。 それ以外の場合、ツール バーはロックされません。

uiDisabledResID
[in]無効になっているツール バー イメージを参照するビットマップのリソース ID。

uiMenuDisabledResID
[in]無効なメニュー イメージを参照するビットマップのリソース ID。

uiHotResID
[in]ホット ツール バーイメージを参照するビットマップのリソース ID。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

フレームワークは、初期化中にこのメソッドを呼び出して、ツール バーに関連付けられているイメージを読み込みます。

例

次の例では、CMFCToolBar クラスで LoadToolBar メソッドを使用する方法を示します。 このコード スニペットは、 IE Demo サンプルの一部です。

CMFCToolBar m_wndToolBar;

// The this pointer points to CMainFrame class which extends the CFrameWnd class.
if (!m_wndToolBar.CreateEx(this, TBSTYLE_TRANSPARENT) ||
    !m_wndToolBar.LoadToolBar(IDR_MAINFRAME, uiToolbarColdID, uiMenuID,
                              FALSE /* Not locked */, 0, 0, uiToolbarHotID))
{
   TRACE0("Failed to create toolbar\n");
   return -1; // fail to create
}

CMFCToolBar::LoadToolBarEx

CMFCToolBarInfo ヘルパー クラスを使用して、アプリケーション リソースからツール バーを読み込み、アプリケーションで大きなイメージを使用できるようにします。

virtual BOOL LoadToolBarEx(
    UINT uiToolbarResID,
    CMFCToolBarInfo& params,
    BOOL bLocked=FALSE);

パラメーター

uiToolbarResID
[in]ツール バーのリソース ID。

params
[in]ツール バー イメージのリソース ID を含む CMFCToolBarInfo オブジェクトへの参照。

bLocked
[in]ツール バーがロックされているかどうかを示すブール値。 このパラメーターが TRUE場合、ツール バーはロックされます。 それ以外の場合、ツール バーはロックされません。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

このメソッドを呼び出して、アプリケーション リソースからツール バー イメージを読み込みます。

CMFCToolBar::m_dblLargeImageRatio

大きな画像の寸法(高さまたは幅)と通常の画像の寸法との比率を指定します。

AFX_IMPORT_DATA static double m_dblLargeImageRatio;

解説

既定の比率は 2 です。 この値を変更して、大きなツール バーイメージを大きくしたり小さくしたりできます。

大きなイメージのセットを指定しない場合、フレームワークはこのデータ メンバーを使用します。 たとえば、サイズが 16 x 16 の小さなイメージのセットのみを指定し、大きなイメージのサイズを 24 x 24 にする場合は、このデータ メンバーを 1.5 に設定します。

CMFCToolBar::NextMenu

virtual BOOL NextMenu();

戻り値

解説

CMFCToolBar::OnBeforeRemoveButton

virtual BOOL OnBeforeRemoveButton(
    CMFCToolBarButton* pButton,
    DROPEFFECT dropEffect);

パラメーター

pButton
[in] 使用されていません。

dropEffect
[入力] 使用されていません。

戻り値

解説

CMFCToolBar::OnChangeHot

ユーザーがツール バーのボタンを選択すると、フレームワークによって呼び出されます。

virtual void OnChangeHot(int iHot);

パラメーター

iHot
[in]選択されているツール バー ボタンのインデックスを指定します。ツール バー ボタンが選択されていない場合は -1。

解説

ユーザーがツール バーのボタンを選択したことを示す通知を処理するには、このメソッドをオーバーライドします。

CMFCToolBar::OnChangeVisualManager

virtual void OnChangeVisualManager();

解説

CMFCToolBar::OnFillBackground

ツール バーの背景を埋めるために、 CBasePane::DoPaint からフレームワークによって呼び出されます。

virtual void OnFillBackground(CDC* pDC);

パラメーター

pDC
[入力] デバイス コンテキストへのポインター。

解説

CMFCToolBar::DoPaint は、ツールバーの背景が塗りつぶされたときにこのメソッドを呼び出します。 既定の実装では、何も行われません。

派生クラスでカスタム背景を描画するには、このメソッドをオーバーライドします。

CMFCToolBar::OnGlobalFontsChanged

virtual void OnGlobalFontsChanged();

解説

CMFCToolBar::OnReset

ツールバーを元の状態に戻します。

virtual void OnReset();

解説

ツール バーのリセットに関する通知を処理するには、このメソッドをオーバーライドします。

既定の実装では、何も行われません。 ツール バーが元の状態に戻ったときに置き換える必要があるダミー ボタンがある場合は、CMFCToolBarから派生したクラスのOnResetをオーバーライドします。

CMFCToolBar::OnSetAccData

virtual BOOL OnSetAccData(long lVal);

パラメーター

[入力] lVal\

戻り値

解説

CMFCToolBar::OnSetDefaultButtonText

ツール バー ボタンのテキストを既定の状態に戻します。

virtual BOOL OnSetDefaultButtonText(CMFCToolBarButton* pButton);

パラメーター

pButton
[in]テキストが設定されているボタンをポイントします。

戻り値

TRUE テキストが正常に復元された場合。それ以外の場合は FALSE。

解説

ツール バー ボタンのテキストが既定に変更されていることを示す通知を処理するには、このメソッドをオーバーライドします。

既定の実装では、アプリケーション リソースからボタンのテキストが読み込まれます。

CMFCToolBar::OnUserToolTip

ボタンのツールヒントが表示されようとしているときにフレームワークによって呼び出されます。

virtual BOOL OnUserToolTip(
    CMFCToolBarButton* pButton,
    CString& strTTText) const;

パラメーター

pButton
[in]ツール ヒントを表示するツール バー ボタンをポイントします。

strTTText
[out]ツールヒントのテキストを受け取る CString オブジェクトへの参照。

戻り値

TRUEstrTTTextにヒント テキストが設定されている場合は FALSE。それ以外の場合は。

解説

フレームワークは、ツール バー ボタンのツール ヒントが表示されるときに、このメソッドを呼び出します。 OnUserToolTipがTRUEを返す場合、フレームワークは、strTTTextでOnUserToolTipによって返されたテキストを含むツールヒントを表示します。 それ以外の場合は、ツールヒントにボタンテキストが含まれます。

ツール バー ボタンのツール ヒントをカスタマイズするには、 OnUserToolTip をオーバーライドします。 既定の実装では、ツールヒントテキストを取得するために CMFCToolBar::OnUserToolTip が呼び出されます。

CMFCToolBar::PrevMenu

virtual BOOL PrevMenu();

戻り値

解説

CMFCToolBar::ProcessCommand

ツール バーを所有するウィンドウに WM_COMMAND メッセージを投稿します。

BOOL ProcessCommand(CMFCToolBarButton* pButton);

パラメーター

pButton
[in]ツール バーのボタンへのポインター。

戻り値

このメソッドは常に TRUE を返す必要があります。 MFC は FALSE 値を内部的に使用します。

解説

このメソッドは、CWnd::PostMessageを呼び出し、指定したボタンのコマンド ID を wParam パラメーターとして渡すことによって、ツール バーを所有するウィンドウにWM_COMMAND メッセージをポストします。

ON_COMMAND マクロを使用して、WM_COMMAND メッセージをメンバー関数にマップします。

CMFCToolBar::RemoveAllButtons

ツールバーからすべてのボタンと区切り記号を削除します。

virtual void RemoveAllButtons();

解説

フレームワークは、ツール バーを再作成または破棄するときに、このメソッドを呼び出します。

CMFCToolBar::RemoveButton

指定したインデックスを持つボタンをツール バーから削除します。

virtual BOOL RemoveButton(int iIndex);

パラメーター

iIndex
[in]削除するボタンの 0 から始まるインデックスを指定します。

戻り値

TRUEメソッドが成功した場合、または指定したインデックスが無効であるか、インデックスが Customize ボタンを参照している場合はFALSE。

解説

このメソッドは、ボタンの削除の影響を受ける追加のツール バー属性を更新します。 たとえば、このメソッドはツールバーから不要な区切り記号を削除し、ショートカット キーのテーブルを再構築します。

Customize ボタンの詳細については、「CMFCToolBar::EnableCustomizeButton」を参照してください。

CMFCToolBar::RemoveStateFromRegistry

ツール バーの状態情報を Windows レジストリから削除します。

virtual BOOL RemoveStateFromRegistry(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

パラメーター

lpszProfileName
[in]状態情報が格納されているレジストリ キーを指定します。

nIndex
[in]ツール バーのコントロール ID。

uiID
[in]ツール バーのリソース ID。 このパラメーターが -1 の場合、このメソッドは CWnd::GetDlgCtrlID メソッドを使用してリソース ID を取得します。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

フレームワークは、ユーザー定義ツール バーを削除するときにこのメソッドを呼び出します。

Windows レジストリに追加の状態情報を格納する場合は、このメソッドをオーバーライドします。

CMFCToolBar::ReplaceButton

ツール バー ボタンを別のツール バー ボタンに置き換えます。

int ReplaceButton(
    UINT uiCmd,
    const CMFCToolBarButton& button,
    BOOL bAll=FALSE);

パラメーター

uiCmd
[in]置き換えるボタンのコマンド ID。

button
[in]挿入する CMFCToolBarButton への参照。

bAll
[in] uiCmdで指定されたコマンド ID を持つすべてのボタンを置き換えるかどうかを指定するブール値。 このパラメーターが TRUEの場合、指定したコマンド ID を持つすべてのボタンが置き換えられます。 それ以外の場合は、最初のボタンが置き換えられます。

戻り値

置き換えられるボタンの数。 指定したコマンド ID のボタンがツール バーに存在しない場合、このメソッドは 0 を返します。

解説

リソースから読み込むことができないツール バー ボタンを追加する場合は、このメソッドを呼び出します。 デザイン時にプレースホルダー ボタンを作成し、ツール バーを初期化するときにそのボタンをカスタム ボタンに置き換えることができます。 このメソッドを使用する例については、VisualStudioDemo サンプルを参照してください。

例

次の例では、CMFCToolBar クラスで ReplaceButton メソッドを使用する方法を示します。 このコード スニペットは、 IE Demo サンプルの一部です。

CMFCToolBar m_wndToolBar;

// CMenu menuHistory
// CString str
m_wndToolBar.ReplaceButton(ID_GO_BACK,
                           CMFCToolBarMenuButton(ID_GO_BACK, menuHistory,
                                                 GetCmdMgr()->GetCmdImage(ID_GO_BACK), str));

CMFCToolBar::ResetAll

すべてのツールバーを元の状態に戻します。

static void __stdcall ResetAll();

解説

このメソッドは、復元可能なアプリケーションの各ツール バーで CMFCToolBar::RestoreOriginalState メソッドを呼び出します。 CMFCToolBar::CanBeRestored メソッドを使用して、ツール バーを復元できるかどうかを判断します。

CMFCToolBar::ResetAllImages

アプリケーション内のすべてのツール バー イメージ コレクションをクリアします。

static void __stdcall ResetAllImages();

解説

このメソッドは、 CMFCToolBar::LoadToolBar および CMFCToolBar::LoadBitmap メソッドによって初期化されたイメージ コレクションをクリアします。

CMFCToolBar::ResetImages

virtual void ResetImages();

解説

CMFCToolBar::RestoreFocus

virtual void RestoreFocus();

解説

CMFCToolBar::RestoreOriginalState

ツール バーを元の状態に戻します。

virtual BOOL RestoreOriginalState();

戻り値

TRUE メソッドが成功した場合は a0/>。メソッドが失敗した場合、またはツール バーがユーザー定義の場合は FALSE 。

解説

このメソッドは、 CMFCToolBar::LoadToolBar メソッドを使用して、リソース ファイルからツール バーを読み込みます。

フレームワークは、ユーザーがカスタマイズ ダイアログ ボックスの Toolbars ページで Reset All ボタンを選択すると、このメソッドを呼び出します。

CMFCToolBar::SaveParameters

static BOOL __stdcall SaveParameters(LPCTSTR lpszProfileName = NULL);

パラメーター

[入力] lpszProfileName\

戻り値

解説

CMFCToolBar::SaveState

Windows レジストリのツール バーの状態情報を保存します。

virtual BOOL SaveState(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

パラメーター

lpszProfileName
[in]Windows レジストリ キーの相対パスを指定します。

nIndex
[in]ツール バーのコントロール ID。

uiID
[in]ツール バーのリソース ID。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

フレームワークは、アプリケーションの状態をレジストリに保存するときに、このメソッドを呼び出します。 詳細については、CWinAppEx::SaveStateを参照してください。

CMFCToolBar::SetBasicCommands

ユーザーがメニューを開いたときに常に表示されるコマンドの一覧を設定します。

static void __stdcall SetBasicCommands(CList<UINT,UINT>& lstCommands);

パラメーター

lstCommands
[in]コマンドのコレクションを含む CList オブジェクトへの参照。

解説

メニューを開くと、基本コマンドが常に表示されます。 このメソッドは、ユーザーが最近使用したコマンドを表示することを選択した場合に意味があります。

CMFCToolBar::AddBasicCommand メソッドを使用して、基本的なコマンドの一覧にコマンドを追加します。 CMFCToolBar::GetBasicCommands メソッドを使用して、アプリケーションで使用される基本的なコマンドの一覧を取得します。

このメソッドを使用する例については、エクスプローラーのサンプルを参照してください。

CMFCToolBar::SetButtonInfo

ツール バー ボタンのコマンド ID、スタイル、イメージ ID を設定します。

void SetButtonInfo(
    int nIndex,
    UINT nID,
    UINT nStyle,
    int iImage);

パラメーター

nIndex
[in]プロパティが設定されているボタンの 0 から始まるインデックス。

nID
[in]ボタンのコマンド ID。

nStyle
[in]ボタンのスタイル。 使用可能なツール バー ボタン のスタイルの一覧については、「 ToolBar コントロール のスタイル 」を参照してください。

iImage
[in]ボタンの 0 から始まるイメージ インデックス (つまり、ツール バー イメージのコレクション内のインデックス)。

解説

ツール バー ボタンのプロパティを設定するには、このメソッドを呼び出します。

デバッグ ビルドでは、 nIndex で指定されたインデックスが無効な場合、このメソッドはアサーション エラーを生成します。

CMFCToolBar::SetButtonStyle メソッドを呼び出して、ボタンのスタイルのみを設定します。

CMFCToolBar::SetButtons

ツール バーのボタンを設定します。

virtual BOOL SetButtons(
    const UINT* lpIDArray,
    int nIDCount,
    BOOL bRemapImages=TRUE);

パラメーター

lpIDArray
[in]挿入するボタンのコマンド ID の配列へのポインター。

nIDCount
[in] lpIDArray 内の項目の数。

bRemapImages
[in]既存のボタン イメージを挿入されたボタンに関連付けるかどうかを指定するブール値。 このパラメーターが TRUEされている場合、イメージは再マップされます。

戻り値

メソッドが成功した場合は 0 以外。それ以外の場合は 0。

解説

ツール バーから既存のボタンを削除し、新しいボタンのコレクションを挿入するには、このメソッドを呼び出します。

このメソッドは、ツール バーに Customize ボタンを追加し、 AFX_WM_RESETTOOLBAR メッセージをツールバーの親ウィンドウに送信します。 Customize ボタンの詳細については、「CMFCToolBar::EnableCustomizeButton」を参照してください。

CMFCToolBar::SetButtonStyle

指定したインデックス位置にあるツール バー ボタンのスタイルを設定します。

virtual void SetButtonStyle(
    int nIndex,
    UINT nStyle);

パラメーター

nIndex
[in]スタイルを設定するツール バー ボタンの 0 から始まるインデックス。

nStyle
[in]ボタンのスタイル。 使用可能なツール バー ボタン のスタイルの一覧については、「 ToolBar コントロール のスタイル 」を参照してください。

解説

ユーザーが無効なボタンを選択できないため、nStyleがTBBS_DISABLEDされている場合、このメソッドはTBBS_PRESSEDスタイルを削除します。

CMFCToolBar::SetButtonText

ツール バー ボタンのテキスト ラベルを設定します。

BOOL SetButtonText(
    int nIndex,
    LPCTSTR lpszText);

パラメーター

nIndex
[in]ツール バー ボタンのインデックス。

lpszText
[in]ツール バー ボタンのテキスト ラベル。 null 以外である必要があります。

戻り値

TRUE メソッドが成功した場合。それ以外の場合は FALSE。

解説

指定したインデックスが有効なツール バー ボタンを参照していない場合、このメソッドは FALSE を返します。

CMFCToolBar::SetCommandUsageOptions

使用頻度の低いコマンドがアプリケーションのメニューに表示されない場合に指定します。

static BOOL SetCommandUsageOptions(
    UINT nStartCount,
    UINT nMinUsagePercentage=5);

パラメーター

nStartCount
[in]フレームワークが基本コマンドと最近使用したコマンドのみを表示するまでにコマンドを実行する必要がある回数を指定します。

nMinUsagePercentage
[in]最近使用したコマンドと見なされるためにコマンドを実行する必要がある時間の割合。

戻り値

FALSEnMinUsagePercentageが 100 以上の場合は a0/>。それ以外の場合はTRUE。

解説

このメソッドを呼び出して、基本的なメニュー項目と最近使用したメニュー項目の表示方法を決定するためにフレームワークが使用するアルゴリズムをカスタマイズします。 基本的なコマンドの詳細については、 CMFCToolBar::AddBasicCommandを参照してください。

このクラスでは、 CMFCCmdUsageCount クラスを使用してコマンドの使用数を追跡します。 このクラスの詳細については、「 CMFCCmdUsageCount クラス」を参照してください。

CMFCToolBar::SetCustomizeMode

アプリケーション内のすべてのツール バーのカスタマイズ モードを有効または無効にします。

static BOOL __stdcall SetCustomizeMode(BOOL bSet=TRUE);

パラメーター

bSet
[in]カスタマイズ モードを有効または無効にするかどうかを指定するブール値。 このパラメーターを TRUE に設定してカスタマイズ モードを有効にするか、無効にする FALSE します。

戻り値

TRUE このメソッドを呼び出すと、カスタマイズ モードが変更されます。それ以外の場合は FALSE。

解説

このメソッドは、アプリケーションの各ツール バーのレイアウトを調整し、再描画します。 CMFCToolBar::IsCustomizeModeメソッドを呼び出して、アプリケーションがカスタマイズ モードであるかどうかを判断します。

CMFCToolBar::SetGrayDisabledButtons

ツール バーの使用できないボタンを淡色表示にするか、ボタンを使用できないイメージを使用するかを指定します。

void SetGrayDisabledButtons(BOOL bGrayDisabledButtons);

パラメーター

bGrayDisabledButtons
[in]使用できないボタンを表示する方法を指定するブール値。 このパラメーターが TRUE場合、フレームワークはボタンを暗くします。 それ以外の場合、フレームワークはボタンを使用できないイメージのコレクションを使用します。

解説

既定では、使用できないボタンは淡色表示になっています。

CMFCToolBar::SetHeight

ツールバーの高さを設定します。

void SetHeight(int cyHeight);

パラメーター

cyHeight
[in]ツールバーの高さ (ピクセル単位)。

解説

このメソッドは、高さを設定した後、ツール バーを再描画します。

CMFCToolBar::SetHelpMode

static void __stdcall SetHelpMode(BOOL bOn = TRUE);

パラメーター

[入力] bOn\

解説

CMFCToolBar::SetHot

BOOL SetHot(CMFCToolBarButton* pMenuButton);

パラメーター

[入力] pMenuButton\

戻り値

解説

CMFCToolBar::SetHotBorder

ツール バー ボタンをホット トラックするかどうかを指定します。

void SetHotBorder(BOOL bShowHotBorder);

パラメーター

bShowHotBorder
[in]ツール バー ボタンをホット トラックするかどうかを指定するブール値。 このパラメーターが TRUE場合、ツール バーはそのボタンをホット トラックします。 それ以外の場合、ツール バーはボタンをホット トラックしません。

解説

ボタンがホット トラックされている場合、マウスがボタンの間を移動すると、フレームワークによってボタンが強調表示されます。 既定では、各ツール バーはボタンをホットトラックします。

CMFCToolBar::GetHotBorder メソッドを呼び出して、ツール バーがそのボタンをホット トラックするかどうかを判断します。

CMFCToolBar::SetHotTextColor

ホット ツールバー ボタンのテキストの色を設定します。

static void SetHotTextColor(COLORREF clrText);

パラメーター

clrText
[in]ホット トラックされるツール バー ボタンのテキストの色を指定します。

解説

ホット トラックツール バー ボタンの詳細については、「 CMFCToolBar::GetHotBorder と CMFCToolBar::SetHotBorder」を参照してください。

CMFCToolBar::SetIgnoreSetText

void SetIgnoreSetText(BOOL bValue);

パラメーター

[入力] bValue\

解説

CMFCToolBar::SetLargeIcons

ツール バー ボタンに大きなアイコンを表示するかどうかを指定します。

static void SetLargeIcons(BOOL bLargeIcons=TRUE);

パラメーター

bLargeIcons
[in]使用するアイコンを指定するブール値。 このパラメーターが TRUE場合、フレームワークには大きなアイコンが表示されます。 それ以外の場合、フレームワークには通常のアイコンが表示されます。

解説

フレームワークは、ユーザーが Customize ダイアログ ボックスの Options タブの Large Icons チェック ボックスの状態を変更するときに、このメソッドを呼び出します。 このメソッドは、アプリケーション内のすべてのツール バーのサイズを変更します。

既定では、フレームワークには通常のアイコンが表示されます。

Customize ダイアログ ボックスの詳細については、「CMFCToolBarsCustomizeDialog クラスを参照してください。

CMFCToolBar::SetLockedSizes

ツール バーのロックされたボタンとロックされたイメージのサイズを設定します。

void SetLockedSizes(
    SIZE sizeButton,
    SIZE sizeImage,
    BOOL bDontScale = FALSE);

パラメーター

sizeButton
[in]ロックされているツール バー ボタンのサイズを指定します。

sizeImage
[in]ロックされたツール バー イメージのサイズを指定します。

bDontScale
ツール バー イメージを高 DPI モードで拡大または縮小するかどうかを指定します。

解説

ロックされたボタンの既定のサイズは 23 x 22 ピクセルです。 ロックされたイメージの既定のサイズは 16 x 15 ピクセルです。

CMFCToolBar::GetLockedImageSize メソッドを呼び出して、ロックされたイメージのサイズを取得します。 CMFCToolBar::GetButtonSize メソッドを呼び出して、ロックされたツール バー ボタンのサイズを取得します。

CMFCToolBar::SetMaskMode

void SetMaskMode(BOOL bMasked);

パラメーター

[入力] bMasked\

解説

CMFCToolBar::SetMenuSizes

ツール バー メニュー ボタンとそのイメージのサイズを設定します。

static void __stdcall SetMenuSizes(
    SIZE sizeButton,
    SIZE sizeImage);

パラメーター

sizeButton
[in]ツールバー ボタンのサイズをピクセル単位で指定します。

sizeImage
[in]ツールバーイメージのサイズをピクセル単位で指定します。

解説

既定では、メニュー ボタンとそのイメージのサイズは未定義です。

CMFCToolBar::GetMenuButtonSize メソッドを呼び出して、メニュー ボタンのサイズを確認し、CMFCToolBar::GetMenuImageSize メソッドを呼び出して、メニュー ボタンイメージのサイズを決定します。

このメソッドを使用する例については、IEDemo と MSMoneyDemo のサンプルを参照してください。

CMFCToolBar::SetNonPermittedCommands

ユーザーが実行できないコマンドの一覧を設定します。

static void SetNonPermittedCommands(CList<UINT,UINT>& lstCommands);

パラメーター

lstCommands
[in]ユーザーが実行できないコマンドを含む CList オブジェクトへの参照。

解説

ユーザーが特定のコマンドを選択できないようにするには、このメソッドを呼び出します。 たとえば、セキュリティ上の理由からユーザーが特定のコマンドを選択できないようにすることができます。 このメソッドを使用する例については、MDITabsDemo と MenuSubSet のサンプルを参照してください。

このメソッドは、許可されていないコマンドの前の一覧をクリアします。 既定では、許可されていないコマンドの一覧は空です。

CMFCToolBar::SetOneRowWithSibling

ツール バーとその兄弟を同じ行に配置します。

void SetOneRowWithSibling();

解説

フレームワークは、ユーザーが [1 行の Show ボタン] ボタンを選択すると このメソッドを呼び出します。

CMFCToolBar::SetSiblingToolBar メソッドを呼び出して、1 行のShow ボタンまたは 2 行 ボタンのShow ボタンを有効にします。 このツール バーの CMFCToolBar::SetSiblingToolBar を呼び出すと、兄弟ツール バーがこのツール バーの行に移動します。 それ以外の場合、このツール バーは兄弟の行に移動されます。

フレームワークは、ユーザーが [2 つの行のShow ボタン] ボタンを選択したときにCMFCToolBar::SetTwoRowsWithSibling メソッド呼び出します。

CMFCToolBar::SetOrigButtons

void SetOrigButtons(const CObList& lstOrigButtons);

パラメーター

[入力] lstOrigButtons\

解説

CMFCToolBar::SetPermament

ユーザーがツール バーを閉じることができるかどうかを指定します。

void SetPermament(BOOL bPermament=TRUE);

パラメーター

bPermament
[in]ユーザーがツール バーを閉じることができるかどうかを指定するブール値。 このパラメーターが TRUEされている場合、ユーザーはツール バーを閉じることができません。 それ以外の場合、ユーザーはツール バーを閉じます。

解説

既定では、ユーザーは各ツール バーを閉じます。

CMFCToolBar::CanBeClosed メソッドを呼び出して、ユーザーがツール バーを閉じることができるかどうかを判断します。

CMFCToolBar::SetRouteCommandsViaFrame

親フレームまたは所有者がツール バーにコマンドを送信するかどうかを指定します。

void SetRouteCommandsViaFrame(BOOL bValue);

パラメーター

bValue
[in]このパラメーターが TRUEの場合、親フレームはコマンドをツール バーに送信します。 それ以外の場合、所有者はコマンドをツール バーに送信します。

解説

既定では、親フレームはツール バーにコマンドを送信します。 CMFCToolBar::GetRouteCommandsViaFrame メソッドを呼び出して、親フレームまたは所有者がツール バーにコマンドを送信するかどうかを判断します。

CMFCToolBar::SetShowTooltips

フレームワークにツール ヒントを表示するかどうかを指定します。

static void SetShowTooltips(BOOL bValue);

パラメーター

bValue
[in]このパラメーターが TRUEされている場合、フレームワークにはツール ヒントが表示されます。 それ以外の場合、フレームワークはツール ヒントを非表示にします。

解説

既定では、フレームワークにはツール ヒントが表示されます。

CMFCToolBar::GetShowTooltips メソッドを呼び出して、フレームワークにツール ヒントが表示されるかどうかを判断します。

CMFCToolBar::SetSiblingToolBar

ツール バーの兄弟を指定します。

void SetSiblingToolBar(CMFCToolBar* pBrotherToolbar);

パラメーター

pBrotherToolbar
[in]兄弟ツール バーへのポインター。

解説

このメソッドは、ユーザーが Customize ポップアップ メニューを表示するときに表示される 2 つの行の 1 行または Show ボタンの表示ボタンを有効にします。 関連するツール バーを同じ行に表示するか、別の行に表示するかをユーザーが指定できるようにする場合は、このメソッドを呼び出します。

ツール バーに表示される Customize ボタンを有効にした後、このメソッドを呼び出します。 Customize ボタンを有効にするには、CMFCToolBar::EnableCustomizeButton メソッドを呼び出します。

ツール バーの兄弟を取得するには、 CMFCToolBar::GetSiblingToolBarを呼び出します。

CMFCToolBar::SetSizes

すべてのツール バーのボタンと画像のサイズを指定します。

static void __stdcall SetSizes(
    SIZE sizeButton,
    SIZE sizeImage);

パラメーター

sizeButton
[in]ツールバー ボタンのサイズ (ピクセル単位)。

sizeImage
[in]ツールバー ボタンイメージのサイズ (ピクセル単位)。

解説

ツール バー ボタンの既定のサイズは 23 x 22 ピクセルです。 ツール バー ボタンの画像の既定のサイズは 16 x 15 ピクセルです。

CMFCToolBar::GetImageSize メソッドを呼び出して、ツール バー ボタンイメージのサイズを取得します。 CMFCToolBar::GetButtonSize メソッドを呼び出して、ツール バー ボタンのサイズを取得します。

CMFCToolBar::SetToolBarBtnText

ツール バーのボタンのプロパティを指定します。

void SetToolBarBtnText(
    UINT nBtnIndex,
    LPCTSTR szText=NULL,
    BOOL bShowText=TRUE,
    BOOL bShowImage=TRUE);

パラメーター

nBtnIndex
[in]ツール バー ボタンの一覧にあるツール バー ボタンの 0 から始まるインデックス。

szText
[in]ツール バー ボタンのテキスト ラベルを指定します。

bShowText
[in]このパラメーターが TRUE場合、フレームワークにはテキスト ラベルが表示されます。 それ以外の場合、フレームワークはテキスト ラベルを非表示にします。

bShowImage
[in]このパラメーターが TRUEされている場合、フレームワークにはツール バー ボタンの画像が表示されます。 それ以外の場合、フレームワークはツール バー ボタンのイメージを非表示にします。

解説

既定では、フレームワークにはツール バー ボタンの画像が表示されますが、ツール バー ボタンのテキスト ラベルは表示されません。

デバッグ ビルドでは、 nBtnIndex が有効なツール バー ボタンを参照していない場合、またはツール バー ボタンが区切り記号である場合、このメソッドはアサーション エラーを生成します。

CMFCToolBar::SetTwoRowsWithSibling

ツールバーとその兄弟を別々の行に配置します。

void SetTwoRowsWithSibling();

解説

フレームワークは、ユーザーが [2 つの行の Show ボタン ボタンを選択すると、このメソッドを呼び出します。

CMFCToolBar::SetSiblingToolBar メソッドを呼び出して、1 行のShow ボタンまたは 2 行 ボタンのShow ボタンを有効にします。 このツール バーの CMFCToolBar::SetSiblingToolBar を呼び出すと、兄弟ツール バーは別の行に移動されます。 それ以外の場合、このツール バーは別の行に移動されます。

フレームワークは、ユーザーが Show Buttons on One Row ボタンを選択すると、CMFCToolBar::SetOneRowWithSibling メソッドを呼び出します。

CMFCToolBar::SetUserImages

アプリケーション内のユーザー定義イメージのコレクションを設定します。

static BOOL SetUserImages(CMFCToolBarImages* pUserImages);

パラメーター

pUserImages
[in]ユーザー定義イメージのコレクションへのポインター。

戻り値

メソッドが成功した場合は 0 以外。指定した CMFCToolBarImages オブジェクトが有効でない場合、またはツール バーの既定のイメージ サイズと異なるイメージ サイズを持つ場合は 0。

解説

フレームワークでは、ユーザー定義のイメージを使用して、ユーザーがカスタマイズしたツール バー ボタンを描画します。 pUserImagesで指定されたイメージ リストは、アプリケーション内のすべてのツール バー間で共有されます。

このメソッドは、指定した CMFCToolBarImages オブジェクトが無効であるか、ツール バーの既定のイメージ サイズと異なるイメージ サイズを持つ場合、デバッグ ビルドでアサーション エラーを生成します。

OutlookDemo、ToolTipDemo、VisualStudioDemo のサンプルでは、このメソッドを使用して、ユーザー定義イメージのグローバル コレクションを設定します。 アプリケーションの作業ディレクトリにある UserImages.bmp という名前のファイルを読み込みます。

'CMFCToolBar::GetUserImages メソッドを呼び出して、アプリケーション内のユーザー定義イメージのコレクションを取得します。

CMFCToolBar::StretchPane

ツールバーを垂直方向または水平方向に引き伸ばし、必要に応じてボタンの位置を変更します。

virtual CSize StretchPane(
    int nLength,
    BOOL bVert);

パラメーター

nLength
[in]ウィンドウを拡大する量 (ピクセル単位)。

bVert
[in] TRUE場合は、ウィンドウを垂直方向に引き伸ばします。 FALSE場合は、ウィンドウを水平方向に引き伸ばします。

戻り値

ツール バー クライアント領域のサイズを指定する CSize オブジェクト。

解説

このメソッドは、 CMFCToolBar::WrapToolBar を呼び出して、ストレッチ ツールバー内のボタンの位置を変更します。

戻り値は、 CMFCToolBar::CalcSizeを呼び出すことによって決定されます。

CMFCToolBar::TranslateChar

指定したキー コードが有効なキーボード ショートカットに対応する場合は、ボタン コマンドを実行します。

virtual BOOL TranslateChar(UINT nChar);

パラメーター

nChar
[in]仮想キー コードを指定します。 標準の仮想キー コードの一覧については、 Winuser.h

戻り値

FALSE 指定されたキー コードが印刷できないか、有効なキーボード ショートカットに対応していない場合。指定したキー コードがドロップダウン メニュー オプションに対応する場合は TRUE 。それ以外の場合は、 CMFCToolBar::ProcessCommandからの戻り値です。

解説

フレームワークは、キーが Alt キーと共に押されたときに、このメソッドを呼び出します。

CMFCToolBar::UpdateButton

指定したボタンの状態を更新します。

void UpdateButton(int nIndex);

パラメーター

nIndex
[in]更新するボタンの 0 から始まるインデックスを指定します。

解説

CMFCToolBar::WrapToolBar

指定した寸法内のツールバー ボタンの位置を変更します。

int WrapToolBar(
    int nWidth,
    int nHeight = 32767,
    CDC* pDC = NULL,
    int nColumnWidth = -1,
    int nRowHeight = -1);

パラメーター

nWidth
[in]ツールバーの最大幅。

nHeight
[in]ツールバーの最大高さ。 ツールバーが浮動状態の場合は使用されません。

pDC
[in]デバイス コンテキストへのポインター。 NULL場合は、ツール バーのデバイス コンテキストが使用されます。

nColumnWidth
[in]ボタンの幅。 -1 の場合、現在の幅が使用されます。

[入力] mnRowHeightボタンの高さ。 -1 の場合、現在の高さが使用されます。

戻り値

ツール バーのボタンの行数。

解説

このメソッドは、ツール バー内のボタンの位置を変更し、必要に応じてボタンを追加の行に折り返します。

CMFCToolBar::m_bDontScaleImages

ツール バー イメージを高 DPI モードでスケーリングするかどうかを指定します。 TRUEに設定すると、イメージ サイズがボタン のサイズと一致しない場合にイメージのスケーリングを回避できます。

AFX_IMPORT_DATA static BOOL m_bDontScaleImages;

関連項目

階層図
クラス
CMFCMenuBar クラス
CMFCPopupMenuBar クラス
CMFCDropDownToolBar クラス
チュートリアル: ツール バーへのコントロールの追加