CMFCToolBarButton クラス

  • [アーティクル]

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

構文

class CMFCToolBarButton : public CObject

メンバー

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

名前 説明
CMFCToolBarButton::CMFCToolBarButton CMFCToolBarButton オブジェクトを構築して初期化します。
CMFCToolBarButton::~CMFCToolBarButton デストラクターです。

パブリック メソッド

名前 説明
CMFCToolBarButton::CanBeDropped ユーザーがカスタマイズ中にツール バーまたはメニューにボタンを配置できるかどうかを指定します。
CMFCToolBarButton::CanBeStored ボタンを格納できるかどうかを指定します。
CMFCToolBarButton::CanBeStretched カスタマイズ中にユーザーがボタンを拡大できるかどうかを指定します。
CMFCToolBarButton::CompareWith このインスタンスを、指定された オブジェクトと比較 CMFCToolBarButton します。
CMFCToolBarButton::CopyFrom 別のツール バー ボタンのプロパティを現在のボタンにコピーします。
CMFCToolBarButton::CreateFromOleData 指定された オブジェクト CMFCToolBarButton から オブジェクトを作成 COleDataObject します。
CMFCToolBarButton::CreateObject このクラス型の動的インスタンスを作成するために、フレームワークで使用されます。
CMFCToolBarButton::EnableWindow マウス入力およびキーボード入力を有効または無効にします。
CMFCToolBarButton::ExportToMenuButton ツール バー ボタンからメニューにテキストをコピーします。
CMFCToolBarButton::GetClipboardFormat アプリケーションのグローバル クリップボード形式を取得します。
CMFCToolBarButton::GetHwnd ツール バー ボタンに関連付けられているウィンドウ ハンドルを取得します。
CMFCToolBarButton::GetImage ボタンのイメージ インデックスを取得します。
CMFCToolBarButton::GetInvalidateRect 再描画する必要があるボタンのクライアント領域の領域を取得します。
CMFCToolBarButton::GetParentWnd ボタンの親ウィンドウを取得します。
CMFCToolBarButton::GetProtectedCommands ユーザーがカスタマイズできないコマンドの一覧を取得します。
CMFCToolBarButton::GetTextSize ボタン テキストのサイズを取得します。
CMFCToolBarButton::HasFocus ボタンに現在の入力フォーカスが設定されているかどうかを判断します。
CMFCToolBarButton::HaveHotBorder ユーザーがボタンを選択するときにボタンの境界線を表示するかどうかを決定します。
CMFCToolBarButton::IsDrawImage イメージがボタンに表示されるかどうかを判断します。
CMFCToolBarButton::IsDrawText ボタンにテキスト ラベルを表示するかどうかを決定します。
CMFCToolBarButton::IsDroppedDown ボタンにサブメニューを表示するかどうかを決定します。
CMFCToolBarButton::IsEditable ボタンをカスタマイズできるかどうかを決定します。
CMFCToolBarButton::IsExtraSize ボタンを拡張境界線と一緒に表示できるかどうかを判断します。
CMFCToolBarButton::IsFirstInGroup ボタンがボタン グループの最初の位置にあるかどうかを判断します。
CMFCToolBarButton::IsHidden ボタンが非表示かどうかを判断します。
CMFCToolBarButton::IsHorizontal ボタンが水平方向のツール バーに配置されているかどうかを判断します。
CMFCToolBarButton::IsLastInGroup ボタンがボタン グループの最後の位置にあるかどうかを指定します。
CMFCToolBarButton::IsLocked ボタンがロックされている (カスタマイズできない) ツール バー上にあるかどうかを判断します。
CMFCToolBarButton::IsOwnerOf ボタンが、指定されたウィンドウ ハンドルの所有者であるかどうかを判断します。
CMFCToolBarButton::IsVisible ツール バー ボタンが表示されるかどうかを判断します。
CMFCToolBarButton::IsWindowVisible ボタンの基になるウィンドウ ハンドルが表示されるかどうかを判断します。
CMFCToolBarButton::NotifyCommand ボタンがメッセージを処理するかどうかを WM_COMMAND します。
CMFCToolBarButton::OnAddToCustomizePage ボタンが [カスタマイズ] ダイアログ ボックスに追加された場合に、フレームワーク によって呼び 出されます。
CMFCToolBarButton::OnBeforeDrag ボタンをドラッグできるかどうかを指定します。
CMFCToolBarButton::OnBeforeDrop ユーザーがターゲット ツール バーにボタンをドロップできるかどうかを指定します。
CMFCToolBarButton::OnCalculateSize 指定したデバイス コンテキストとドッキング状態のボタンのサイズを計算するためにフレームワークによって呼び出されます。
CMFCToolBarButton::OnCancelMode メッセージを処理するためにフレームワークによって WM_CANCELMODE されます。
CMFCToolBarButton::OnChangeParentWnd ボタンが新しいツール バーに挿入された場合に、フレームワークによって呼び出されます。
CMFCToolBarButton::OnClick ユーザーがマウス ボタンをクリックすると、フレームワークによって呼び出されます。
CMFCToolBarButton::OnClickUp ユーザーがマウス ボタンを離すと、フレームワークによって呼び出されます。
CMFCToolBarButton::OnContextHelp 親ツール バーがメッセージを処理するときに、フレームワークによってWM_HELPHITTESTされます。
CMFCToolBarButton::OnCtlColor 親ツール バーがメッセージを処理するときに、フレームワークによってWM_CTLCOLORされます。
CMFCToolBarButton::OnCustomizeMenu アプリケーションが親ツール バーにショートカット メニューを表示するときに、指定されたメニューを変更するボタンを許可します。
CMFCToolBarButton:: OnDblClk 親ツールバーが WM_LBUTTONDBLCLK メッセージを処理するときに、フレームワークによって呼び出されます。
CMFCToolBarButton:: OnDraw 指定されたスタイルとオプションを使用してボタンを描画するために、フレームワークによって呼び出されます。
CMFCToolBarButton:: OnDrawOnCustomizeList [カスタマイズ] ダイアログボックスの [コマンド] ウィンドウにボタンを描画するために、フレームワークによって呼び出されます。
CMFCToolBarButton:: OnGetCustomToolTipText ボタンのカスタムツールヒントテキストを取得するために、フレームワークによって呼び出されます。
CMFCToolBarButton:: Onglobalフォントの変更 グローバルフォントが変更されたときにフレームワークによって呼び出されます。
CMFCToolBarButton:: OnMove 親ツールバーが移動したときにフレームワークによって呼び出されます。
CMFCToolBarButton:: OnShow ボタンが表示または非表示になったときにフレームワークによって呼び出されます。
CMFCToolBarButton:: OnSize 親ツールバーがサイズまたは位置を変更し、この変更によってボタンのサイズを変更する必要がある場合に、フレームワークによって呼び出されます。
CMFCToolBarButton:: OnToolHitTest 親ツールバーがボタンの外接する四角形にポイントがあるかどうかを判断する必要がある場合に、フレームワークによって呼び出されます。
CMFCToolBarButton:: OnUpdateToolTip 親ツールバーがツールヒントテキストを更新するときに、フレームワークによって呼び出されます。
CMFCToolBarButton::P repareDrag ボタンがドラッグアンドドロップ操作を実行しようとしているときに、フレームワークによって呼び出されます。
CMFCToolBarButton:: Rect ボタンの外接する四角形を取得します。
CMFCToolBarButton:: ResetImageToDefault は、ボタンに関連付けられているイメージを既定値に設定します。
CMFCToolBarButton:: SaveBarState ツールバーボタンの状態を保存します。
CMFCToolBarButton:: Serialize アーカイブからこのオブジェクトを読み取るか、アーカイブに書き込みます。 ( CObject::Serializeをオーバーライドします)。
CMFCToolBarButton:: Setのデータ 指定され CAccessibilityData たオブジェクトに、ツールバーボタンのアクセシビリティデータを設定します。
CMFCToolBarButton:: Setクリップの Formatname グローバルクリップボード形式の名前を変更します。
CMFCToolBarButton:: SetImage ボタンのイメージインデックスを設定します。
CMFCToolBarButton:: SetProtectedCommands ユーザーがカスタマイズできないコマンドの一覧を設定します。
CMFCToolBarButton:: SetRadio ボタンがチェックされた状態を変更したときにフレームワークによって呼び出されます。
CMFCToolBarButton:: SetRect ボタンの外接する四角形を設定します。
CMFCToolBarButton:: System.windows.forms.control.setstyle ボタンのスタイルを設定します。
CMFCToolBarButton:: SetVisible ボタンを表示するかどうかを指定します。
CMFCToolBarButton:: Show ボタンの表示と非表示を切り替えます。

データ メンバー

名前 説明
CMFCToolBarButton:: m_bImage ボタンにイメージを表示するかどうかを指定します。
CMFCToolBarButton:: m_bText ボタンにテキストラベルを表示するかどうかを指定します。
CMFCToolBarButton:: m_bTextBelow ボタンのイメージの下にテキストラベルを表示するかどうかを指定します。
CMFCToolBarButton:: m_bUserButton ボタンにユーザー定義のイメージがあるかどうかを指定します。
CMFCToolBarButton:: m_bWholeText ボタンが外接する四角形に収まりきらない場合でもフルテキストラベルを表示するかどうかを指定します。
CMFCToolBarButton:: m_bWrap 区切り記号の横にあるボタンを次の行に配置するかどうかを指定します。
CMFCToolBarButton:: m_bWrapText 複数行のテキストラベルを有効にするかどうかを指定します。
CMFCToolBarButton:: m_nID ボタンのコマンド ID。
CMFCToolBarButton:: m_nStyle ボタンのスタイル。
CMFCToolBarButton:: m_strText ボタンのテキストラベル。

注釈

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

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

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

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

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

例

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

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

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:: Setcustomization emode」を参照してください。

CMFCToolBarButton:: CMFCToolBarButton

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

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

パラメーター

uiID
からボタンのコマンド ID。

iImage
からイメージのコレクション内のボタンのイメージインデックス。

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

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

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

CMFCToolBarButton:: CompareWith

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

virtual BOOL CompareWith(const CMFCToolBarButton& other) const;

パラメーター

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

戻り値

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

注釈

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

CMFCToolBarButton:: CopyFrom

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

virtual void CopyFrom(const CMFCToolBarButton& src);

パラメーター

src
からコピー元のソースボタンへの参照。

注釈

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

CMFCToolBarButton:: CreateFromOleData

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

static CMFCToolBarButton* __stdcall CreateFromOleData(COleDataObject* pDataObject);

パラメーター

pDataObject
からソース OLE データオブジェクト。

戻り値

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

注釈

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

CMFCToolBarButton:: EnableWindow

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

virtual void EnableWindow(BOOL bEnable = TRUE);

パラメーター

bEnable
から入力を有効にする場合は、このパラメーターを TRUE に設定します。入力を無効にする場合は FALSE に設定します。

注釈

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

CMFCToolBarButton:: ExportToMenuButton

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

virtual BOOL ExportToMenuButton(CMFCToolBarMenuButton& menuButton) const;

パラメーター

menuButton
からターゲットメニューボタンへの参照。

戻り値

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

注釈

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

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

CMFCToolBarButton:: GetClipboardFormat

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

static CLIPFORMAT __stdcall GetClipboardFormat();

戻り値

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

注釈

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

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

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

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

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。

注釈

このメソッドは、ボタン グループを、同じ行に配置され、区切り記号またはツール バーの境界線で区切られたボタンの近隣セットとして定義します。 ツール バー ボタンが [カスタマイズ] ボタンを参照している場合、このメソッドは FALSE を返 します。 [カスタマイズ] ボタンの詳細については、「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 を返します。 [ カスタマイズ ] ボタンの詳細については、「 Cmfctoolbar:: GetCustomizeButton」を参照してください。

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

CMFCToolBarButton:: IsLocked

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

BOOL IsLocked() const;

戻り値

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

注釈

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

CMFCToolBarButton:: IsOwnerOf

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

virtual BOOL IsOwnerOf(HWND hwnd);

パラメーター

hwnd
からウィンドウハンドル。

戻り値

ボタンが、指定されたウィンドウハンドルの所有者である場合は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;

注釈

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

このデータメンバーが 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 を返します。 このメソッドをオーバーライドして、メッセージを処理する場合は TRUE WM_COMMAND、親ツール バーでメッセージを処理する必要がある場合は FALSE を返します。

CMFCToolBarButton::OnAddToCustomizePage

ボタンが [カスタマイズ] ダイアログ ボックスに追加された場合に、フレームワーク によって呼び 出されます。

virtual void OnAddToCustomizePage();

注釈

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

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 メッセージの詳細については、「 テクニカルノート 28: Context-Sensitive Help Support」を参照してください。

CMFCToolBarButton:: OnCtlColor

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

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

パラメーター

pDC
からボタンを表示するデバイスコンテキスト。

nCtlColor
から特定の色の通知。

戻り値

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

注釈

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

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

既定の実装では、何も実行されず、NULL が返されます。

CMFCToolBarButton:: Onカスタマイズ Emenu

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

virtual BOOL OnCustomizeMenu(CMenu* pMenu);

パラメーター

pMenu
からカスタマイズするメニュー。

戻り値

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

注釈

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

CMFCToolBarButton:: OnDblClk

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

virtual void OnDblClk(CWnd* pWnd);

パラメーター

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

注釈

このメソッドは、親ツールバーがWM_LBUTTONDBLCLKメッセージを処理するときに、 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
からボタンを表示するデバイスコンテキスト。

rect
からボタンの外接する四角形。

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

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

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

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

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

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

注釈

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

CMFCToolBarButton:: OnDrawOnCustomizeList

[カスタマイズ] ダイアログボックスの [コマンド] ウィンドウにボタンを描画するために、フレームワークによって呼び出されます。

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

パラメーター

pDC
からボタンを表示するデバイスコンテキスト。

rect
からボタンの外接する四角形。

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

戻り値

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

注釈

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

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

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

CMFCToolBarButton:: OnGetCustomToolTipText

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

virtual BOOL OnGetCustomToolTipText(CString& strToolTip);

パラメーター

strToolTip
入出力 CString カスタムのツールヒントテキストを受け取るオブジェクト。

戻り値

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

注釈

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

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

CMFCToolBarButton:: Onglobalフォントの変更

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

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。

注釈

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

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 化の対象またはシリアル化するオブジェクト。

注釈

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

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

CMFCToolBarButton::SetACCData

ツール バー ボタンから提供 CAccessibilityData されたオブジェクトにアクセシビリティ データを設定します。

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

パラメーター

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

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

戻り値

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

注釈

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

CMFCToolBarButton:: Setクリップの Formatname

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

static void __stdcall SetClipboardFormatName(LPCTSTR lpszName);

パラメーター

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

解説

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

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

CMFCToolBarButton:: SetImage

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

virtual void SetImage(int iImage);

パラメーター

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

注釈

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

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

CMFCToolBarButton:: SetProtectedCommands

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

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

パラメーター

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

注釈

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

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

CMFCToolBarButton:: SetRadio

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

virtual void SetRadio();

注釈

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

CMFCToolBarButton:: SetRect

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

void SetRect(const CRect rect);

パラメーター

rect
からボタンの新しい外接する四角形。

注釈

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

CMFCToolBarButton:: System.windows.forms.control.setstyle

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

virtual void SetStyle(UINT nStyle);

パラメーター

nStyle
からボタンの新しいスタイル。

注釈

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

CMFCToolBarButton:: SetVisible

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

void SetVisible(BOOL bShow=TRUE);

パラメーター

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

注釈

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

CMFCToolBarButton:: Show

ボタンの表示と非表示を切り替えます。

void Show(BOOL bShow);

パラメーター

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

注釈

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

CMFCToolBarButton:: SetVisibleメソッドを使用して、ボタンの全般的な表示を設定します。

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

関連項目

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