CMFCRibbonBaseElement クラス
更新 : 2007 年 11 月
CMFCRibbonBaseElement クラスは、リボン バーに追加できるすべての要素の基本クラスです。リボン要素とは、リボン ボタン、リボン チェック ボックス、リボン コンボ ボックスなどです。
class CMFCRibbonBaseElement : public CObject
メンバ
パブリック メソッド
名前 |
説明 |
|---|---|
|
|
|
|
|
|
|
|
|
|
リボン要素のコンパクト サイズを返します。 |
|
リボン要素に関連付けられているユーザー定義データを取得します。 |
|
リボン要素の説明を返します。 |
|
リボン要素のコマンド ID を返します。 |
|
リボン要素のイメージ サイズを返します。 |
|
サイズが中間状態になっているリボン要素のサイズを返します。 |
|
リボン要素に関連付けられた KeyTip を返します。 |
|
|
|
ボタンに関連付けられた KeyTip を返します。 |
|
|
|
|
|
|
|
|
|
|
|
リボン要素の外接する四角形を返します。 |
|
リボン要素の標準サイズを返します。 |
|
リボン要素の現在のサイズを返します。 |
|
リボン要素に関連付けられたテキストを返します。 |
|
リボン要素のツールヒント テキストを返します。 |
|
リボン要素が簡易モードを持つかどうかを指定します。 |
|
リボン要素に中間モードがあるかどうかを示します。 |
|
リボン要素に大モードがあるかどうかを指定します。 |
|
|
|
|
|
|
|
リボン要素がチェックされているかどうかを示します。 |
|
リボン要素が簡易モードであるかどうかを示します。 |
|
|
|
リボン要素が無効であるかどうかを示します。 |
|
リボン要素がドロップダウンされてポップアップ メニューが表示されているかどうかを調べます。 |
|
リボン要素にフォーカスがあるかどうかを示します。 |
|
|
|
リボン要素を強調表示するかどうかを指定します。 |
|
|
|
|
|
ユーザーがリボン要素をクリックしたかどうかを示します。 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
リボン要素を描画するために、フレームワークによって呼び出されます。 |
|
|
|
|
|
リボン要素にポップアップ メニューを表示するときに、フレームワークによって呼び出されます。 |
|
データ項目をリボン要素に関連付けます。 |
|
|
|
リボン要素の説明を設定します。 |
|
リボン要素のコマンド ID を設定します。 |
|
リボン要素の KeyTip を設定します。 |
|
|
|
リボン要素のテキストを設定します。 |
|
|
|
リボン要素のツールヒント テキストを設定します。 |
|
|
|
|
プロテクト メソッド
名前 |
説明 |
|---|---|
ユーザーがキーを押したときに、フレームワークによって呼び出されます。 |
|
リボン要素が入力フォーカスを受け取ったか失ったときに、フレームワークによって呼び出されます。 |
解説
CMFCRibbonBaseElement クラスは、コマンド ID、テキスト ラベル、ツールヒント テキスト、要素の説明、および状態 (フォーカスを置く、強調表示する、押す、無効にする、チェックする、またはドロップダウンするなど) が含まれるすべてのリボン要素に共通のプロパティを定義します。
リボン要素のイメージ サイズは、RibbonImageType メンバに次のいずれかの値を指定することによって定義します。
RibbonImageLarge
RibbonImageSmall
そのサイズに応じて、リボン要素には小さいイメージと大きいイメージのいずれかが表示されます。
使用例
次の例は、CMFCRibbonBaseElement クラスのさまざまなメソッドの使用方法を説明しています。この例は、CMFCRibbonStatusBar クラスからの CMFCRibbonBaseElement オブジェクトの取得方法、リボン要素の説明の設定方法、テキストの設定方法、KeyTip の設定方法、リボン要素のツールヒント テキストの設定方法を示しています。このコード スニペットは、「DrawClient サンプル : MFC リボン ベースの OLE オブジェクト描画アプリケーション」の一部です。
// CMFCRibbonStatusBar m_wndStatusBar
CMFCRibbonBaseElement* pPane = m_wndStatusBar.FindByID(nID);
...
pPane->SetDescription(_T("a pane"));
// CString strText
pPane->SetText(strText);
pPane->SetKeys(_T("p"));
pPane->SetToolTipText(_T("this is a pane"));
継承階層
必要条件
ヘッダー : afxbaseribbonelement.h