CMFCToolBarButton クラス

ツール バーにボタン機能を提供します。

構文

class CMFCToolBarButton : public CObject

メンバー

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

パブリック メソッド

データ メンバー

解説

CMFCToolbarButton オブジェクトは、ツール バーに存在するコントロールです。 その動作は、通常のボタンに似ています。 このオブジェクトには、画像とテキスト ラベルを割り当てることができます。 ツール バー ボタンには、コマンド ID を指定することもできます。 ユーザーがツール バー ボタンをクリックすると、フレームワークはこの ID で指定されたコマンドを実行します。

通常、ツール バー ボタンはカスタマイズできます。ユーザーはツール バー間でボタンをドラッグし、テキスト ラベルと画像をコピー、貼り付け、削除、編集できます。 ユーザーがツール バーをカスタマイズできないようにするには、2 つの方法のいずれかでツール バーをロックします。 bLocked を呼び出すときに フラグを TRUE に設定するか、CMFCToolBarButton::SetProtectedCommands メソッドを使用して、保護されたコマンドのグローバル リストに個々のボタンのコマンド ID を追加します。

CMFCToolBarButton オブジェクトには、アプリケーション内のツール バー イメージのグローバル コレクションのイメージが表示されます。 これらのコレクションは、親ツール バー CMFCToolBar クラスによって管理されます。 詳細については、「 CMFCToolBarImages クラスを参照してください。

ユーザーがツール バー ボタンをクリックすると、その親ツール バーがマウス メッセージを処理し、ボタンに適切なアクションを通知します。 ボタンに有効なコマンド ID がある場合、親ツール バーはWM_COMMAND メッセージを親フレームに送信します。

CMFCToolBarButton クラスは、CMFCToolBarMenuButton クラス、CMFCToolBarEditBoxButton クラス、CMFCToolBarComboBoxButton クラスなど、他のツール バー ボタン クラスの基本クラスです。

例

次の例では、CMFCToolBarButton クラスのさまざまなメソッドを使用してCMFCToolBarButton オブジェクトを構成する方法を示します。 この例では、マウスとキーボードの入力を有効にする方法、ボタンの画像インデックスを設定する方法、ボタンの外接する四角形を設定する方法、ボタンを表示する方法を示しています。 このコード スニペットは、 Tab Control サンプルの一部です。

CMFCToolBarButton *pOffice2007 = NULL;
int nIndex = -1;

for (UINT uiCmd = ID_VIEW_APPLOOK_2007_1; uiCmd <= ID_VIEW_APPLOOK_2007_4; uiCmd++)
{
   // CMFCToolBar m_wndToolBarTheme
   nIndex = m_wndToolBarTheme.CommandToIndex(uiCmd);

   CMFCToolBarButton *pButton = m_wndToolBarTheme.GetButton(nIndex);

   if (pButton != NULL)
   {
      pOffice2007 = pButton;
      break;
   }
}

pOffice2007->EnableWindow();
pOffice2007->SetImage(1);
pOffice2007->SetRect(CRect(1, 1, 1, 1));
pOffice2007->SetVisible();
pOffice2007->Show(true);

継承階層

CObject

CMFCToolBarButton

要件

ヘッダー: afxtoolbarbutton.h

CMFCToolBarButton::CanBeDropped

ユーザーがカスタマイズ時にツール バーまたはメニューにボタンを配置できるかどうかを指定します。

virtual BOOL CanBeDropped(CMFCToolBar* pToolbar);

パラメーター

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

戻り値

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

解説

既定では、カスタマイズ可能な (ロックされていない) ツール バーごとにツール バー ボタンを削除できます。

このメソッドの既定の実装は TRUE を返します。 ユーザーがボタンの位置を変更できないようにするには、このメソッドをオーバーライドし、FALSE を返します。

CMFCToolBarButton::CanBeStored

ボタンを格納できるかどうかを決定します。

virtual BOOL CanBeStored() const;

戻り値

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

解説

フレームワークでは、このメソッドを使用して、ボタンがドラッグ アンド ドロップ操作に参加できるかどうかを判断します。

既定の実装では、TRUE が返されます。 ドラッグ アンド ドロップ操作の一部としてボタンを保存できない場合は、このメソッドをオーバーライドします。 ドラッグ アンド ドロップ操作の詳細については、「 OLE ドラッグ アンド ドロップ」を参照してください。

CMFCToolBarButton::CanBeStretched

ユーザーがカスタマイズ中にボタンを拡大できるかどうかを指定します。

virtual BOOL CanBeStretched() const;

戻り値

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

解説

このメソッドは、ボタンをカスタマイズ モードで拡張できるかどうかを判断するためにフレームワークによって使用されます。

このメソッドの既定の実装は FALSE を返します。 コンボ ボックスやスライダーなどの可変幅コントロールに対して TRUE を返すには、このメソッドをオーバーライドします。

カスタマイズ モードの詳細については、「 CMFCToolBar::SetCustomizeModeを参照してください。

CMFCToolBarButton::CMFCToolBarButton

CMFCToolBarButton オブジェクトを構築して初期化します。

CMFCToolBarButton(
    UINT uiID,
    int iImage,
    LPCTSTR lpszText=NULL,
    BOOL bUserButton=FALSE,
    BOOL bLocked=FALSE);

パラメーター

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

iImage
[in]イメージのコレクション内のボタンのイメージ インデックス。

lpszText
[in]ボタンのテキスト ラベル。 NULL にすることができます。

bUserButton
[in]ボタンがユーザー定義かどうかを決定するブール値。 このパラメーターが TRUE の場合、ボタンはユーザー定義です。 それ以外の場合、ボタン イメージはリソースから読み込まれます。

ブロック
[in]ボタンをカスタマイズできるかどうかを決定するブール値。 このパラメーターが TRUE の場合、ボタンをカスタマイズすることはできません。 それ以外の場合は、ボタンをカスタマイズできます。

CMFCToolBarButton::CompareWith

このインスタンスを、指定された CMFCToolBarButton オブジェクトと比較します。

virtual BOOL CompareWith(const CMFCToolBarButton& other) const;

パラメーター

other
[in]このインスタンスと比較するオブジェクトへの参照。

戻り値

指定されたオブジェクトがこのインスタンスの値と等しい場合は 0 以外。それ以外の場合は 0。

解説

既定の実装では、指定されたオブジェクトのコマンド ID がこのインスタンスのコマンド ID と等しいかどうかを判断します。 2 つの CMFCToolBarButton オブジェクトが等しいかどうかを判断するために追加の処理を実行する必要がある場合は、このメソッドをオーバーライドします。

CMFCToolBarButton::CopyFrom

別のツール バー ボタンのプロパティを現在のボタンにコピーします。

virtual void CopyFrom(const CMFCToolBarButton& src);

パラメーター

src
[in]コピー元のソース ボタンへの参照。

解説

このツール バー ボタンに別のツール バー ボタンをコピーするには、このメソッドを呼び出します。

CMFCToolBarButton::CreateFromOleData

指定したCMFCToolBarButton オブジェクトからCOleDataObject オブジェクトを作成します。

static CMFCToolBarButton* __stdcall CreateFromOleData(COleDataObject* pDataObject);

パラメーター

pDataObject
[in]ソース OLE データ オブジェクト。

戻り値

作成される CMFCToolBarButton オブジェクト。

解説

このメソッドは、さまざまな形式でデータ転送を実行するためにフレームワークによって使用されます。 たとえば、 CMFCOutlookBarPane::OnDragOver メソッドでは、このメソッドを使用してドラッグ アンド ドロップ操作を実行します。

CMFCToolBarButton::EnableWindow

マウス入力およびキーボード入力を有効または無効にします。

virtual void EnableWindow(BOOL bEnable = TRUE);

パラメーター

bEnable
[in]入力を有効にするには TRUE、入力を無効にするには FALSE に設定します。

解説

このメソッドは、 EnableWindow 関数を呼び出して入力を有効または無効にします。 詳細については、Windows SDK の「 EnableWindow 」を参照してください。

CMFCToolBarButton::ExportToMenuButton

ツール バー ボタンからメニューにテキストをコピーします。

virtual BOOL ExportToMenuButton(CMFCToolBarMenuButton& menuButton) const;

パラメーター

menuButton
[in]ターゲット メニュー ボタンへの参照。

戻り値

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

解説

フレームワークは、このメソッドを呼び出して、ツール バー ボタンからメニュー ボタンにテキストをコピーします。 既定の実装では、ボタンのテキスト ラベルがコピーされます。 テキスト ラベルが空の場合、このメソッドはボタンのヒント テキストをコピーします。

このメソッドの既定の実装は TRUE を返します。 フレームワークが CMFCToolbarButton から派生したオブジェクトをメニュー ボタンに変換するときに、追加のアクションを実行する場合は、このメソッドをオーバーライドします。

CMFCToolBarButton::GetClipboardFormat

アプリケーションのグローバル クリップボード形式を取得します。

static CLIPFORMAT __stdcall GetClipboardFormat();

戻り値

アプリケーションのグローバル CLIPFORMAT 値。

解説

フレームワークはこのメソッドを呼び出して、OLE データ転送操作のクリップボード形式を取得します。 たとえば、 CMFCToolBarButton::CreateFromOleData メソッドは、このメソッドを使用してソース OLE データ オブジェクトからデータをコピーします。

このメソッドは、このメソッドが初めて呼び出されるときにグローバル CLIPFORMAT 値を設定します。 このメソッドの後続の呼び出しはすべて、この値を返します。

アプリケーション間でドラッグ アンド ドロップ操作を実行できるようにするには、 CMFCToolBarButton::SetClipboardFormatName メソッドを呼び出します。

MFC のクリップボードの詳細については、「 Clipboard」を参照してください。

CMFCToolBarButton::GetHwnd

ツール バー ボタンに関連付けられているウィンドウ ハンドルを取得します。

virtual HWND GetHwnd();

戻り値

ツール バー ボタンに関連付けられているウィンドウ ハンドル。ツール バー ボタンに関連付けられているウィンドウ ハンドルがない場合は NULL。

解説

このメソッドの既定の実装では NULL が返されます。 特定のコントロールのウィンドウ ハンドルを返すには、このメソッドをオーバーライドします。

CMFCToolBarButton::GetImage

ボタンのイメージ インデックスを取得します。

int GetImage() const;

戻り値

このボタンに関連付けられているイメージのインデックス。

解説

ボタンにユーザー定義イメージがある場合 (つまり、コンストラクターで bUserButton が TRUE の場合)、返されるインデックスはユーザー定義イメージのコレクション内のイメージを指定します ( CMFCToolBar::GetUserImages を参照)。 それ以外の場合、インデックスは、リソース ファイルから読み込まれるイメージのコレクション内のイメージを指定します ( CMFCToolBar::GetImages を参照)。 リソース ファイルの詳細については、「 リソース ファイルを使用した作業」を参照してください。

CMFCToolBarButton::GetInvalidateRect

再描画する必要があるボタンのクライアント領域の領域を取得します。

virtual const CRect GetInvalidateRect() const;

戻り値

再描画する必要がある領域を指定する CRect オブジェクト。

解説

このメソッドの既定の実装では、クライアント領域全体が返されます。 別の領域を再描画する場合は、このメソッドをオーバーライドします。

CMFCToolBarButton::GetParentWnd

ボタンの親ウィンドウを取得します。

CWnd* GetParentWnd() const;

戻り値

ボタンの親ウィンドウ。

CMFCToolBarButton::GetProtectedCommands

ユーザーがカスタマイズできないコマンドの一覧を取得します。

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

戻り値

保護されたコマンドの一覧。

解説

カスタマイズ モードでは、フレームワークによって、保護されているツール バー ボタン コマンドが無効になります。 ユーザーは、無効になっているツール バー ボタンに対してドラッグ アンド ドロップ操作と編集操作を実行できません。

CMFCToolBarButton::SetProtectedCommands メソッドを使用して、保護されたコマンドの一覧を定義します。

CMFCToolBarButton::GetTextSize

ボタン テキストのサイズを取得します。

SIZE GetTextSize() const;

戻り値

ボタン テキストのサイズ (ピクセル単位) を含む SIZE オブジェクト。

CMFCToolBarButton::HasFocus

ボタンに現在の入力フォーカスがあるかどうかを判断します。

virtual BOOL HasFocus() const;

戻り値

ボタンに入力フォーカスがある場合は 0 以外。それ以外の場合は 0。

解説

ボタンに入力フォーカスがある場合、または入力フォーカスを持つウィンドウの子ウィンドウまたは子孫ウィンドウである場合、このメソッドの既定の実装では 0 以外の値が返されます。 この関数をオーバーライドして、この動作をカスタマイズできます。

CMFCToolBarButton::HaveHotBorder

ユーザーがボタンを選択したときにボタンの境界線を表示するかどうかを指定します。

virtual BOOL HaveHotBorder() const;

戻り値

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

解説

フレームワークは、このメソッドを呼び出して、ユーザーが選択したときにツール バー ボタンの境界線を表示するかどうかを決定します。

既定の実装では、TRUE が返されます。 このメソッドをオーバーライドして、この動作をカスタマイズできます。

CMFCToolBarButton::IsDrawImage

ボタンに画像を表示するかどうかを指定します。

BOOL IsDrawImage() const;

戻り値

ボタンに画像が表示される場合は 0 以外。それ以外の場合は 0。

解説

このメソッドは、ツール バー ボタンに関連付けられたイメージがない場合 ( CMFCToolBarButton::GetImage が -1 を返す)、または CMFCToolBarButton::m_bImage が FALSE に設定されている場合に FALSE を返します。

CMFCToolBarButton::IsDrawText

ボタンにテキスト ラベルを表示するかどうかを指定します。

BOOL IsDrawText() const;

戻り値

テキスト ラベルが表示される場合は 0 以外。それ以外の場合は 0。

解説

このメソッドは、ツール バー ボタンにテキスト ラベルが関連付けられていない場合 ( CMFCToolBarButton::m_strText が空)、または CMFCToolBarButton::m_bText が FALSE に設定されている場合に FALSE を返します。

CMFCToolBarButton::IsDroppedDown

ボタンにサブメニューを表示するかどうかを指定します。

virtual BOOL IsDroppedDown() const;

戻り値

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

解説

このメソッドの既定の実装は FALSE を返します。 コントロールにサブメニューが表示される場合は、このメソッドをオーバーライドして TRUE を返します。

CMFCToolBarButton::IsEditable

ボタンをカスタマイズできるかどうかを決定します。

virtual BOOL IsEditable() const;

戻り値

ユーザーがボタンをカスタマイズできる場合は 0 以外。それ以外の場合は 0。

解説

フレームワークは、このメソッドを呼び出して、ユーザーがドラッグ アンド ドロップ操作または編集操作を使用してツール バー ボタンをカスタマイズできるかどうかを判断します。

既定の実装では、ボタンのコマンド ID が標準コマンドの場合 ( IsStandardCommand 関数を呼び出すことによってこれを確認できます)、またはコマンド ID が保護されたコマンドの一覧にある場合は FALSE が返されます。 保護されたコマンドの詳細については、「 CMFCToolBarButton::GetProtectedCommands および CMFCToolBarButton::SetProtectedCommandsを参照してください。

動作をカスタマイズするには、このメソッドをオーバーライドします。

CMFCToolBarButton::IsExtraSize

ボタンを拡張罫線で表示できるかどうかを指定します。

virtual BOOL IsExtraSize() const;

戻り値

ツール バー ボタンを拡張罫線で表示できる場合は 0 以外。それ以外の場合は 0。

解説

複数のスキンでは、ツール バー ボタンの境界線 (丸いボタンなど) に余分なサイズが使用されます。

ユーザーがこのボタンをツール バー間で移動すると、フレームワークは CMFCToolBarButton::OnChangeParentWnd メソッドを呼び出します。 CMFCToolBarButton::OnChangeParentWnd メソッドは、新しい親ツール バーの追加サイズ フラグを設定します (詳細については、「CMFCToolBar::IsButtonExtraSizeAvailable を参照してください)。

CMFCToolBarButton::IsFirstInGroup

ボタンがボタン グループの最初の位置にあるかどうかを判断します。

virtual BOOL IsFirstInGroup() const;

戻り値

ボタンがボタン グループの最初のボタンである場合は TRUE。それ以外の場合は FALSE。

解説

このメソッドは、 ボタン グループを 同じ行に配置され、区切り記号またはツールバーの境界線で囲まれたボタンの隣接するセットとして定義します。 ツール バー ボタンが Customize ボタンを参照している場合、このメソッドは FALSE を返します。 Customize ボタンの詳細については、「CMFCToolBar::GetCustomizeButtonを参照してください。

CMFCToolBarButton::IsLastInGroup メソッドを呼び出して、ボタンがボタン グループの最後の位置にあるかどうかを判断します。

CMFCToolBarButton::IsHidden

ボタンを非表示にするかどうかを指定します。

BOOL IsHidden() const;

戻り値

ボタンが非表示 (非表示) の場合は 0 以外。それ以外の場合は 0。

解説

このメソッドは、親ツール バーが引き伸ばされ、ツール バー ボタンが表示されているかどうかを判断するときに、このメソッドを呼び出します。

CMFCToolBarButton::SetVisible メソッドを使用してボタンを非表示に設定した場合は、CMFCToolBarButton::IsVisible を使用して、ツール バー ボタンが表示されているかどうかを確認します。

既定では、すべてのツール バー ボタンが表示されます。 ツール バー ボタンを非表示または表示するには、 CMFCToolBarButton::Show メソッドを使用します。

CMFCToolBarButton::IsHorizontal

ボタンが水平ツール バーに配置されているかどうかを判断します。

BOOL IsHorizontal() const;

戻り値

ツールバー ボタンが水平ツールバーにある場合は 0 以外。それ以外の場合は 0。

解説

フレームワークはこのメソッドを呼び出して、ツール バー ボタンのレイアウトを決定します。

このメソッドは、 m_bHorz データ メンバーを返します。 m_bHorz データ メンバーの既定値は TRUE です。CMFCToolBarButton::OnDraw メソッドを呼び出すたびにリセットされます。

CMFCToolBarButton::IsLastInGroup

ボタンがボタン グループの最後の位置にあるかどうかを指定します。

virtual BOOL IsLastInGroup() const;

戻り値

ボタンがボタン グループの最後のボタンである場合は TRUE。それ以外の場合は FALSE。

解説

このメソッドは、 ボタン グループを定義します 同じ行に配置され、区切り記号またはツール バーの境界線で囲まれているボタンの隣接するセットとして、このメソッドは返します FALSE ツールバー ボタンが親ツール バーを持っていないか、ツール バー ボタンが を参照している場合Customize ボタンです。 Customize ボタンの詳細については、「CMFCToolBar::GetCustomizeButtonを参照してください。

CMFCToolBarButton::IsFirstInGroup メソッドを呼び出して、ボタンがボタン グループの最初の位置にあるかどうかを判断します。

CMFCToolBarButton::IsLocked

ボタンがロックされている (カスタマイズ不可能な) ツール バーにあるかどうかを判断します。

BOOL IsLocked() const;

戻り値

ボタンがロックされたツールバーにある場合は 0 以外。それ以外の場合は 0。

解説

フレームワークは、このメソッドを呼び出して、ユーザーがドラッグ アンド ドロップ操作または編集操作を使用してツール バー ボタンをカスタマイズできるかどうかを判断します。 CMFCToolBar::LoadToolBar メソッドを使用して、親ツールバーのロックされた属性を設定します。 フレームワークは、この属性の値を、親ツールバーに挿入する各ツール バー ボタン ( CMFCToolbarButton) のコンストラクターに渡します。

CMFCToolBarButton::IsOwnerOf

ボタンが指定されたウィンドウ ハンドルの所有者であるかどうかを判断します。

virtual BOOL IsOwnerOf(HWND hwnd);

パラメーター

hwnd
[in]ウィンドウ ハンドル。

戻り値

ボタンが指定されたウィンドウ ハンドルの所有者である場合は 0 以外。それ以外の場合は 0。

解説

このメソッドは、 hwnd ダイレクト ウィンドウ ハンドルを参照するか、ボタンに関連付けられているウィンドウ ハンドルの子である場合は、0 以外の値を返します。 hwndが NULL の場合、このメソッドは 0 を返します。

CMFCToolBarButton::IsVisible

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

BOOL IsVisible() const;

戻り値

ツール バー ボタンが表示されている場合は 0 以外。それ以外の場合は 0。

解説

CMFCToolBarButton::SetVisible メソッドを使用して、ツール バー ボタンの表示と非表示を切り替えることができます。 CMFCToolBarButton::SetVisible を呼び出して親ツールバーのレイアウトを再計算した後、親ツール バーの CPane::AdjustSizeImmediate メソッドを呼び出します。

CMFCToolBarButton::IsWindowVisible

ボタンの基になるウィンドウ ハンドルを表示するかどうかを指定します。

virtual BOOL IsWindowVisible();

戻り値

ボタンの基になるウィンドウ ハンドルが表示されている場合は 0 以外。それ以外の場合は 0。

解説

基になるウィンドウ ハンドルの styles 属性にWS_VISIBLE スタイルが含まれている場合、このメソッドは 0 以外の値を返します。 このメソッドは、ボタンの基になるウィンドウ ハンドルが NULL の場合に FALSE を返します。

CMFCToolBarButton::m_bImage

ボタンにイメージを表示するかどうかを指定します。

BOOL m_bImage;

解説

このデータ メンバーが TRUE に設定されている場合、フレームワークはツール バー ボタンに関連付けられているイメージを表示します。それ以外の場合、フレームワークはイメージを表示しません。 このメンバーは、 CMFCToolBarButton::m_bImage メソッドの戻り値に影響します。

CMFCToolBarButton::m_bText

ボタンにテキスト ラベルを表示するかどうかを指定します。

BOOL m_bText;

解説

このデータ メンバーが TRUE に設定されている場合、フレームワークはツール バー ボタンのテキスト ラベルを表示します。それ以外の場合、フレームワークはテキスト ラベルを表示しません。 このメンバーは、 CMFCToolBarButton::m_bText メソッドの戻り値に影響します。

CMFCToolBarButton::m_bTextBelow

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

BOOL m_bTextBelow;

解説

このメンバー変数が TRUE に設定されている場合、フレームワークはイメージの下にボタンのテキストを表示します。 このメンバーの既定値は FALSE です。

CMFCToolBarButton::m_bUserButton

ボタンにユーザー定義イメージがあるかどうかを指定します

BOOL m_bUserButton;

解説

ボタンにユーザー定義イメージが関連付けられている場合、このデータ メンバーは TRUE に設定されます。

CMFCToolBarButton::m_bWholeText

ボタンが外接する四角形に収まらない場合でも、そのフルテキスト ラベルを表示するかどうかを指定します。

BOOL m_bWholeText;

解説

このデータ メンバーが TRUE に設定されている場合、フレームワークはボタンを拡大してフルテキスト ラベルを表示します。 それ以外の場合、フレームワークは省略記号 ( ...) をテキスト ラベルに切り捨てて追加します。

CMFCToolBarButton::m_bWrap

区切り記号の横にあるボタンを次の行に配置するかどうかを指定します。

BOOL m_bWrap;

解説

このデータ メンバーは、ツール バー ボタンが現在の行に収まらない場合、またはレイアウト (たとえば、1 行に特定の数のツール バー ボタン) を指定する場合に、このデータ メンバーを TRUE に設定します。

このデータ メンバーが TRUE に設定され、ツール バーが水平方向または浮動小数点型にドッキングされている場合、フレームワークはこのボタンを次の行に配置します。

このデータ メンバーの既定値は FALSE です。

CMFCToolBarButton::m_bWrapText

複数行のテキスト ラベルを有効にするかどうかを指定します。

AFX_IMPORT_DATA static BOOL m_bWrapText;

解説

この静的メンバー変数が TRUE の場合、フレームワークでは、すべてのツール バーでツール バー ボタンに複数行のテキスト ラベルを表示できます。

このデータ メンバーの既定値は FALSE です。

CMFCToolBarButton::m_nID

ボタンのコマンド ID。

UINT m_nID;

解説

コマンド ID -1 は、ボタンが区切り記号であることを示します。 すべてのボタン区切り記号には、TBBS_SEPARATOR スタイルがあります。 ボタン のスタイルの詳細については、「 CMFCToolBarButton::m_nStyle 」を参照してください。

CMFCToolBarButton::m_nStyle

ボタンのスタイル。

UINT m_nStyle;

解説

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

CMFCToolBarButton::m_strText

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

CString m_strText;

解説

このデータ メンバーには、ボタンのテキスト ラベルが含まれています。 テキスト ラベルは空にすることができます。

CMFCToolBarButton::NotifyCommand

ボタンが WM_COMMAND メッセージを処理するかどうかを指定します。

virtual BOOL NotifyCommand(int iNotifyCode);

パラメーター

iNotifyCode
[in]コマンドに関連付けられている通知メッセージ。

戻り値

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

解説

フレームワークは、親ウィンドウに WM_COMMAND メッセージを送信しようとしているときに、このメソッドを呼び出します。

既定では、このメソッドは FALSE を返します。 WM_COMMAND メッセージを処理する場合は TRUE、親ツール バーがメッセージを処理する必要があることを示す FALSE を返すには、このメソッドをオーバーライドします。

CMFCToolBarButton::OnAddToCustomizePage

ボタンが Customize ダイアログ ボックスに追加されたときにフレームワークによって呼び出されます。

virtual void OnAddToCustomizePage();

解説

このメソッドの既定の実装では何も行われません。 ボタンが Customize ダイアログ ボックスに追加されたときに何らかのアクションを実行する場合は、このメソッドをオーバーライドします。

CMFCToolBarButton::OnBeforeDrag

ボタンをドラッグできるかどうかを指定します。

virtual BOOL OnBeforeDrag() const;

戻り値

ボタンをドラッグできる場合は TRUE。それ以外の場合は FALSE。

解説

フレームワークは、ユーザーがボタンのドラッグを開始する前に、このメソッドを呼び出します。

このメソッドの既定の実装は TRUE を返します。 ボタンのドラッグを無効にするには、このメソッドをオーバーライドして FALSE を返します。

CMFCToolBarButton::OnBeforeDrop

ユーザーがボタンをターゲット ツール バーにドロップできるかどうかを指定します。

virtual BOOL OnBeforeDrop(CMFCToolBar* pTarget);

パラメーター

pTarget
[in]ドラッグ アンド ドロップ操作のターゲット。

戻り値

指定されたターゲット ツール バーにボタンをドロップできる場合は TRUE。それ以外の場合は FALSE。

解説

ボタンがツール バーにドロップされる前に、フレームワークはこのメソッドを呼び出します。

このメソッドの既定の実装は TRUE を返します。 指定したターゲットに対するドロップ操作を無効にするには、このメソッドをオーバーライドして FALSE を返します。

CMFCToolBarButton::OnCalculateSize

指定したデバイス コンテキストとドッキング状態のボタンのサイズを計算するためにフレームワークによって呼び出されます。

virtual SIZE OnCalculateSize(
    CDC* pDC,
    const CSize& sizeDefault,
    BOOL bHorz);

パラメーター

pDC
[in]ボタンを表示するデバイス コンテキスト。

sizeDefault
[in]ボタンの既定のサイズ。

bHorz
[in]親ツールバーのドッキング状態。 このパラメーターは、ツールバーが水平方向にドッキングされている場合、または浮動している場合は TRUE、ツール バーが垂直方向にドッキングされている場合は FALSE です。

戻り値

ボタンの寸法をピクセル単位で格納する SIZE 構造体。

解説

フレームワークは、このメソッドを呼び出して、指定されたデバイス コンテキストとドッキング状態のツール バー ボタンのサイズを決定します。

既定の実装では、テキストと画像のサイズ (表示されている場合)、テキストと画像の位置 (画像の下または右側のテキスト)、およびツール バーのドッキング状態が考慮されます。

標準以外のボタン (編集ボックス ボタンなど) のサイズを指定する場合は、このメソッドをオーバーライドします。

CMFCToolBarButton::OnCancelMode

WM_CANCELMODE メッセージを処理するためにフレームワークによって呼び出されます。

virtual void OnCancelMode();

解説

このメソッドの既定の実装では何も行われません。 WM_CANCELMODE メッセージを処理する場合は、このメソッドをオーバーライドします。

CMFCToolBarButton::OnChangeParentWnd

ボタンが新しいツール バーに挿入されたときにフレームワークによって呼び出されます。

virtual void OnChangeParentWnd(CWnd* pWndParent);

パラメーター

pWndParent
[in]新しい親ウィンドウ。

解説

ボタンは、ユーザーがツール バーから別のツール バーにドラッグした場合などに、ツール バーに挿入されます。

このメソッドの既定の実装では何も行われません。

CMFCToolBarButton::OnClick

ユーザーがマウス ボタンをクリックしたときにフレームワークによって呼び出されます。

virtual BOOL OnClick(
    CWnd* pWnd,
    BOOL bDelay=TRUE);

パラメーター

pWnd
[in]ツール バー ボタンの親ウィンドウ。

bDelay
[in]メッセージを遅延で処理する必要がある場合は TRUE。

戻り値

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

解説

フレームワークは、ユーザーがツール バー ボタンをクリックすると、このメソッドを呼び出します。

既定の実装では何も行われないため、FALSE が返されます。 ボタンがクリック メッセージを処理する場合は、このメソッドをオーバーライドして 0 以外の値を返します。

CMFCToolBarButton::OnClickUp

ユーザーがマウス ボタンを離したときにフレームワークによって呼び出されます。

virtual BOOL OnClickUp();

戻り値

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

解説

フレームワークは、ユーザーがツール バー ボタンを離すと、このメソッドを呼び出します。

既定の実装では何も行われないため、FALSE が返されます。 ボタンがクリック メッセージを処理する場合は、このメソッドをオーバーライドして 0 以外の値を返します。

CMFCToolBarButton::OnContextHelp

親ツール バーがWM_HELPHITTEST メッセージを処理するときにフレームワークによって呼び出されます。

virtual BOOL OnContextHelp(CWnd* pWnd);

パラメーター

pWnd
[in]ツール バー ボタンの親ウィンドウ。

戻り値

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

解説

このメソッドの既定の実装では何も行われないため、FALSE が返されます。 ボタンがヘルプ メッセージを処理する場合は、このメソッドをオーバーライドして 0 以外の値を返します。

WM_HELPHITTEST メッセージの詳細については、「 TN028: 状況依存のヘルプ サポート」を参照してください。

CMFCToolBarButton::OnCtlColor

親ツール バーがWM_CTLCOLOR メッセージを処理するときにフレームワークによって呼び出されます。

virtual HBRUSH OnCtlColor(
    CDC* pDC,
    UINT nCtlColor);

パラメーター

pDC
[in]ボタンを表示するデバイス コンテキスト。

nCtlColor
[in]特定の色の通知。

戻り値

ボタンの背景を描画するためにフレームワークが使用するブラシ オブジェクトのハンドル。

解説

フレームワークは、親ツール バーが Windows コントロールを含むツール バー ボタンのWM_CTLCOLOR メッセージを処理するときに、このメソッドを呼び出します。 ツール バー ボタンがウィンドウレスの場合、フレームワークはこのメソッドを呼び出しません。

フレームワークは、ツール バー フレームワークがカスタマイズ モードで、ツール バー ボタンのロックが解除されている場合に、このメソッドを呼び出します。 カスタマイズ モードの詳細については、「 CMFCToolBar::SetCustomizeModeを参照してください。 ツール バー ボタンのロックの詳細については、「 CMFCToolBarButton::IsLockedを参照してください。

既定の実装では何も行われないため、NULL が返されます。

CMFCToolBarButton::OnCustomizeMenu

アプリケーションが親ツール バーにショートカット メニューを表示するときに、指定されたメニューを変更できるようにします。

virtual BOOL OnCustomizeMenu(CMenu* pMenu);

パラメーター

pMenu
[in]カスタマイズするメニュー。

戻り値

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

解説

既定の実装では何も行われないため、FALSE が返されます。 指定されたメニューの内容を変更する場合は、このメソッドをオーバーライドし、0 以外の値を返します。

CMFCToolBarButton::OnDblClk

親ツール バーが WM_LBUTTONDBLCLK メッセージを処理するときにフレームワークによって呼び出されます。

virtual void OnDblClk(CWnd* pWnd);

パラメーター

pWnd
[入力] - ボタンの親ウィンドウ。

解説

このメソッドは、親ツール バーがCMFCToolBar::OnLButtonDblClk メッセージを処理するときに、 メソッドによって呼び出されます。

このメソッドの既定の実装では何も行われません。

CMFCToolBarButton::OnDraw

指定したスタイルとオプションを使用してボタンを描画するために、フレームワークによって呼び出されます。

virtual void OnDraw(
    CDC* pDC,
    const CRect& rect,
    CMFCToolBarImages* pImages,
    BOOL bHorz=TRUE,
    BOOL bCustomizeMode=FALSE,
    BOOL bHighlight=FALSE,
    BOOL bDrawBorder=TRUE,
    BOOL bGrayDisabledButtons=TRUE);

パラメーター

pDC
[in]ボタンを表示するデバイス コンテキスト。

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

pImages
[in]ボタンに関連付けられているツール バー イメージのコレクション。

bHorz
[in]親ツールバーのドッキング状態。 このパラメーターは、ボタンが水平方向にドッキングされている場合は TRUE、ボタンが垂直方向にドッキングされている場合は FALSE です。

bCustomizeMode
[in]ツール バーがカスタマイズ モードかどうかを指定します。 このパラメーターは、ツール バーがカスタマイズ モードの場合は TRUE、ツール バーがカスタマイズ モードでない場合は FALSE です。

bHighlight
[in]ボタンを強調表示するかどうかを指定します。 このパラメーターは、ボタンが強調表示されている場合は TRUE、ボタンが強調表示されていない場合は FALSE です。

bDrawBorder
[in]ボタンの境界線を表示するかどうかを指定します。 このパラメーターは、ボタンの境界線を表示する場合は TRUE、ボタンの境界線を表示しない場合は FALSE です。

bGrayDisabledButtons
[in]無効なボタンを網掛けするか、無効にしたイメージ コレクションを使用するかを指定します。 このパラメーターは、無効なボタンを網掛けする必要がある場合は TRUE、無効なイメージ コレクションを使用するメソッドの場合は FALSE です。

解説

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

CMFCToolBarButton::OnDrawOnCustomizeList

Customize ダイアログ ボックスの Commands ペインにボタンを描画するためにフレームワークによって呼び出されます。

virtual int OnDrawOnCustomizeList(
    CDC* pDC,
    const CRect& rect,
    BOOL bSelected);

パラメーター

pDC
[in]ボタンを表示するデバイス コンテキスト。

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

bSelected
[in]ボタンを選択するかどうかを指定します。 このパラメーターが TRUE の場合、ボタンが選択されます。 このパラメーターが FALSE の場合、ボタンは選択されていません。

戻り値

指定したデバイス コンテキストのボタンの幅 (ピクセル単位)。

解説

このメソッドは、ボタンが所有者描画リスト ボックスに表示されようとしているときに、カスタマイズ ダイアログ ボックス ( Commands タブ) によって呼び出されます。

このメソッドの既定の実装では、使用可能な場合は、ボタンの画像とテキスト ラベルが表示されます。 ボタンのテキスト ラベルが使用できない場合、メソッドはツールヒントテキストを表示します。

カスタム描画を実行するには、このメソッドをオーバーライドします。

CMFCToolBarButton::OnGetCustomToolTipText

ボタンのカスタム ヒント テキストを取得するためにフレームワークによって呼び出されます。

virtual BOOL OnGetCustomToolTipText(CString& strToolTip);

パラメーター

strToolTip
[out]カスタムツールヒントテキストを受け取る CString オブジェクト。

戻り値

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

解説

フレームワークは、ツール バー ボタンのヒントを表示するときに、このメソッドを呼び出します。 このメソッドが FALSE を返す場合、フレームワークは既定のツールヒントを使用します。

既定の実装では何も行われないため、FALSE が返されます。 このメソッドをオーバーライドし、0 以外の値を返して、ツール バー ボタンのカスタム ヒント テキストを提供します。

CMFCToolBarButton::OnGlobalFontsChanged

グローバル フォントが変更されたときにフレームワークによって呼び出されます。

virtual void OnGlobalFontsChanged();

解説

このメソッドの既定の実装では何も行われません。 ボタン テキストの表示に使用するフォントを更新するには、このメソッドをオーバーライドします。

CMFCToolBarButton::OnMove

親ツールバーが移動したときにフレームワークによって呼び出されます。

virtual void OnMove();

解説

このメソッドの既定の実装では何も行われません。 親ツールバーが移動したときにボタンの位置を変更するには、このメソッドをオーバーライドします。

CMFCToolBarButton::OnShow

ボタンが表示または非表示になったときにフレームワークによって呼び出されます。

virtual void OnShow(BOOL bShow);

パラメーター

bShow
[in]ボタンを表示するかどうかを指定します。 このパラメーターが TRUE の場合、ボタンが表示されます。 それ以外の場合、ボタンは表示されません。

解説

このメソッドの既定の実装では何も行われません。 ボタンの表示を更新するには、このメソッドをオーバーライドします。

CMFCToolBarButton::OnSize

親ツール バーのサイズまたは位置が変更され、この変更によってボタンのサイズが変更されたときに、フレームワークによって呼び出されます。

virtual void OnSize(int iSize);

パラメーター

iSize
[in]ボタンの新しい幅。

解説

このメソッドの既定の実装では何も行われません。 親ツールバーのサイズまたは位置が変更されたときにボタンのサイズを変更するには、このメソッドをオーバーライドします。

CMFCToolBarButton::OnToolHitTest

親ツール バーがボタンの外接する四角形内にポイントがあるかどうかを判断する必要がある場合に、フレームワークによって呼び出されます。

virtual BOOL OnToolHitTest(
    const CWnd* pWnd,
    TOOLINFO* pTI);

パラメーター

pWnd
[in]ボタンの親ウィンドウ。 NULL にすることができます。

pTI
[in]ツールヒント コントロール内のツールに関する情報を含む TOOLINFO 構造体。

戻り値

ボタンが親フレーム ウィンドウへのポインターを取得できる場合は OnMenuButtonToolHitTest の結果。それ以外の場合は FALSE。

解説

親ウィンドウを有効なフレーム オブジェクトに変換できる場合、このメソッドは次のいずれかのメソッドを呼び出します。

• CMDIFrameWndEx::OnMenuButtonToolHitTest

• CFrameWndEx::OnMenuButtonToolHitTest

• COleIPFrameWndEx::OnMenuButtonToolHitTest

CMFCToolBarButton::OnUpdateToolTip

親ツール バーがツール ヒント テキストを更新するときに、フレームワークによって呼び出されます。

virtual BOOL OnUpdateToolTip(
    CWnd* pWndParent,
    int iButtonIndex,
    CToolTipCtrl& wndToolTip,
    CString& str);

パラメーター

pWndParent
[in]親ウィンドウ。

iButtonIndex
[in]親ボタン コレクション内のボタンの 0 から始まるインデックス。

wndToolTip
[in]ヒント テキストを表示するコントロール。

str
[out]更新されたツールヒント テキストを受け取る CString オブジェクト。

戻り値

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

解説

このメソッドの既定の実装では何も行われないため、FALSE が返されます。 ツールヒントテキスト文字列を指定する場合は、このメソッドをオーバーライドして 0 以外の値を返します。

CMFCToolBarButton::P repareDrag

ボタンがドラッグ アンド ドロップ操作を実行しようとしているときにフレームワークによって呼び出されます。

virtual BOOL PrepareDrag(COleDataSource& srcItem);

パラメーター

srcItem
[in]ドラッグ アンド ドロップ操作に関する状態情報を格納する COleDataSource オブジェクト。

戻り値

操作が成功した場合は TRUE。それ以外の場合は FALSE。

解説

フレームワークは、このメソッドを呼び出して、指定された COleDataSource オブジェクトにその状態を格納するためのツール バー ボタンを準備します。 このメソッドは、自身を共有ファイルにシリアル化し、そのファイルを COleDataSource::CacheGlobalData メソッドに渡すことによって、その状態を格納します。 ツール バー ボタンのシリアル化の詳細については、「 CMFCToolBarButton::Serializeを参照してください。

このメソッドは何も実行せず、ボタンを格納できない場合は TRUE を返します ( CMFCToolBarButton::CanBeStored メソッドは FALSE を返します)。 オブジェクトのシリアル化中に例外が発生した場合、FALSE が返されます。

OLE のドラッグ アンド ドロップ操作の詳細については、「 OLE ドラッグ アンド ドロップを参照してください。

CMFCToolBarButton::Rect

ボタンの外接する四角形を取得します。

const CRect& Rect() const;

戻り値

ボタンの外接する四角形を含む CRect オブジェクト。

CMFCToolBarButton::ResetImageToDefault

ボタンに関連付けられているイメージの既定値に設定します。

virtual void ResetImageToDefault();

解説

このメソッドは、 CMFCToolBar::GetDefaultImage メソッドを使用して、親ツール バーから既定のイメージを取得します。 ボタンに既定のイメージが関連付けられていない場合、このメソッドは、 CStringT::LoadString メソッドを使用して、文字列リソースに従ってボタンのテキスト ラベルを設定します。 文字列リソースの詳細については、「 リソース ファイルを使用した作業」を参照してください。

ボタンにユーザー定義イメージがある場合、このメソッドは何も行いません。

CMFCToolBarButton::SaveBarState

ツール バー ボタンの状態を保存します。

virtual void SaveBarState();

解説

フレームワークは、ドラッグ アンド ドロップ操作の結果として CMFCToolBarButton オブジェクトを作成するときに、このメソッドを呼び出します。

このメソッドの既定の実装では何も行われません。 ツール バー ボタンの状態を外部データ ソースに保存するには、このメソッドをオーバーライドします。

CMFCToolBarButton::Serialize

このオブジェクトをアーカイブから読み取るか、アーカイブに書き込みます。

virtual void Serialize(CArchive& ar);

パラメーター

ar
[in]シリアル化元またはシリアル化先の CArchive オブジェクト。

解説

このメソッドは、クリップボードやドラッグ アンド ドロップ操作などのデータ転送プロセスをサポートします。 指定された CArchive オブジェクトとの間で、ID、テキスト ラベル、イメージ ID などのボタンのプロパティを読み取りまたは書き込みます。

シリアル化の例については、「 シリアル化: オブジェクトのシリアル化」を参照してください。

CMFCToolBarButton::SetACCData

指定した CAccessibilityData オブジェクトにツール バー ボタンのアクセシビリティ データを設定します。

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

パラメーター

pParent
[in]ツール バー ボタンの親ウィンドウ。

data
[in]ツール バー ボタンのアクセシビリティ データが設定された CAccessibilityData オブジェクト。

戻り値

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

解説

ツール バー ボタンにアクセシビリティ データが提供されない場合は、このメソッドをオーバーライドして FALSE を返します。

CMFCToolBarButton::SetClipboardFormatName

グローバル クリップボード形式の名前を変更します。

static void __stdcall SetClipboardFormatName(LPCTSTR lpszName);

パラメーター

lpszName
[in]グローバル クリップボード形式の新しい名前。 Nll は指定できません。

解説

このメソッドを使用すると、複数のアプリケーション間でドラッグ アンド ドロップ操作を実行できます。 各アプリケーションは、同じクリップボード形式の名前を指定する必要があります。

フレームワークが CMFCToolBarButton::GetClipboardFormat を呼び出す前に、このメソッドを呼び出す必要があります。

CMFCToolBarButton::SetImage

ボタンのイメージ インデックスを設定します。

virtual void SetImage(int iImage);

パラメーター

iImage
[in]ツール バー イメージのコレクション内のイメージのインデックス。

解説

ツールバー ボタンが区切り記号の場合、 iImage は区切り記号ボタンの新しい幅を参照します。

iImage が 0 未満の場合、このメソッドはイメージの描画を無効にし、ボタンのテキスト ラベルの描画を有効にします。

CMFCToolBarButton::SetProtectedCommands

ユーザーがカスタマイズできないコマンドの一覧を設定します。

static void SetProtectedCommands(const CList<UINT,UINT>& lstCmds);

パラメーター

lstCmds
[in]保護されたコマンドの一覧。

解説

カスタマイズ モードでは、フレームワークによって、保護されているツール バー ボタン コマンドが無効になります。 ユーザーは、無効になっているツール バー ボタンに対してドラッグ アンド ドロップ操作と編集操作を実行できません。

CMFCToolBarButton::GetProtectedCommands メソッドを使用して、保護されたコマンドの一覧を取得します。

CMFCToolBarButton::SetRadio

ボタンのチェック状態が変更されたときにフレームワークによって呼び出されます。

virtual void SetRadio();

解説

このメソッドの既定の実装では何も行われません。 ボタンのチェック状態が変更されたときにカスタム アクションを実行するには、このメソッドをオーバーライドします。

CMFCToolBarButton::SetRect

ボタンの外接する四角形を設定します。

void SetRect(const CRect rect);

パラメーター

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

解説

このメソッドは、新しい外接する四角形を設定した後、 CMFCToolBarButton::OnMove メソッドを呼び出します。

CMFCToolBarButton::SetStyle

ボタンのスタイルを設定します。

virtual void SetStyle(UINT nStyle);

パラメーター

nStyle
[in]ボタンの新しいスタイル。

解説

既定の実装では、 CMFCToolBarButton::m_nStyle データ メンバーを nStyle に設定します。 スタイルの変更を処理するために追加の処理を実行する場合は、このメソッドをオーバーライドします。 有効なスタイル フラグの一覧については、「 ToolBar コントロール のスタイル 」を参照してください。

CMFCToolBarButton::SetVisible

ボタンを表示するかどうかを指定します。

void SetVisible(BOOL bShow=TRUE);

パラメーター

bShow
[in]ボタンを表示または非表示にするかどうかを指定するブール値。 このパラメーターが TRUE の場合、ボタンが表示されます。 パラメーターが FALSE の場合、ボタンは非表示になります。

解説

この関数を使用して、特定のツール バー ボタンを非表示または表示します。 このメソッドを呼び出した後、 CPane::AdjustSizeImmediate メソッドを呼び出します。

CMFCToolBarButton::Show

ボタンを表示または非表示にします。

void Show(BOOL bShow);

パラメーター

bShow
[in]ボタンを表示または非表示にするかどうかを指定するブール値。 このパラメーターが TRUE の場合、ボタンが表示されます。 パラメーターが FALSE の場合、ボタンは非表示になります。

解説

フレームワークは、このメソッドを呼び出して、親ツールバーのサイズが変更されたときにツール バー ボタンの表示を更新します。 ボタンがツールバーの境界内に収まっていない場合、フレームワークは bShow を FALSE に設定してこのメソッドを呼び出します。 ボタンのサイズを変更した後にツール バーの境界内に収まる場合、フレームワークは bShow を TRUE に設定してこのメソッドを呼び出します。

ボタンの一般的な可視性を設定するには、 CMFCToolBarButton::SetVisible メソッドを使用します。

このメソッドは、ボタンの表示状態を更新した後、 CMFCToolBarButton::OnShow メソッドを呼び出します。

関連項目

階層図
クラス
CMFCToolBar クラス
CMFCToolBarImages クラス