CMFCRibbonButtonsGroup クラス
CMFCRibbonButtonsGroup クラスを使用すると、リボン ボタンのセットをグループにまとめることができます。 グループ内のすべてのボタンは互いに隣接して水平に並べられ、1 つの枠で囲まれます。
構文
class CMFCRibbonButtonsGroup : public CMFCRibbonBaseElement
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
| CMFCRibbonButtonsGroup::CMFCRibbonButtonsGroup | CMFCRibbonButtonsGroup オブジェクトを構築します。 |
パブリック メソッド
| 名前 | 説明 |
|---|---|
| CMFCRibbonButtonsGroup::AddButton | グループにボタンを追加します。 |
| CMFCRibbonButtonsGroup::AddButtons | ボタンの一覧をグループに追加します。 |
| CMFCRibbonButtonsGroup::GetButton | 指定したインデックス位置にあるボタンへのポインターを返します。 |
| CMFCRibbonButtonsGroup::GetCount | グループ内のボタンの数を返します。 |
| CMFCRibbonButtonsGroup::GetImageSize | リボン グループ内の通常のイメージのイメージ サイズを返します ( CMFCRibbonBaseElement::GetImageSize をオーバーライドします)。 |
| CMFCRibbonButtonsGroup::GetRegularSize | リボン要素の標準サイズを返します ( CMFCRibbonBaseElement::GetRegularSize をオーバーライドします)。 |
| CMFCRibbonButtonsGroup::HasImages | CMFCRibbonButtonsGroup オブジェクトにツール バー イメージが含まれているかどうかを報告します。 |
| CMFCRibbonButtonsGroup::OnDrawImage | ボタンが標準、強調表示、無効のいずれであるかに応じて、指定したボタンに適したイメージを描画します。 |
| CMFCRibbonButtonsGroup::RemoveAll | CMFCRibbonButtonsGroup オブジェクトからすべてのボタンを削除します。 |
| CMFCRibbonButtonsGroup::SetImages | グループにイメージを割り当てます。 |
| CMFCRibbonButtonsGroup::SetParentCategory | CMFCRibbonButtonsGroup オブジェクトとその中のすべてのボタンの親CMFCRibbonCategoryを設定します (CMFCRibbonBaseElement::SetParentCategory をオーバーライドします)。 |
解説
グループは CMFCBaseRibbonElement から派生し、1 つのエンティティとして操作できます。 任意のパネルまたはポップアップ メニューにグループを配置できます。
例
CMFCRibbonButtonsGroup クラスのさまざまなメソッドの使用方法を次の例に示します。 この例では、 CMFCRibbonButtonsGroup オブジェクトを作成し、リボン ボタンのグループに画像を割り当て、リボン ボタンのグループにボタンを追加する方法を示します。 このコード スニペットは、「 クライアント サンプルの描画」の一部です。
CMFCRibbonButtonsGroup *pSBGroup = new CMFCRibbonButtonsGroup;
CMFCToolBarImages images;
images.SetImageSize(CSize(14, 14));
CMFCToolBarImages hotimages;
hotimages.SetImageSize(CSize(14, 14));
if (images.Load(IDB_STATUSBAR_1) && hotimages.Load(IDB_STATUSBAR_2))
{
pSBGroup->SetImages(&images, &hotimages, NULL);
}
pSBGroup->AddButton(new CMFCRibbonButton(ID_FILE_PRINT_PREVIEW, _T(""), 0));
pSBGroup->AddButton(new CMFCRibbonButton(ID_FILE_SUMMARYINFO, _T(""), 1));
// CMFCRibbonStatusBar m_wndStatusBar
m_wndStatusBar.AddExtendedElement(pSBGroup, _T("View Shortcuts"));
継承階層
要件
Header: afxribbonbuttonsgroup.h
CMFCRibbonButtonsGroup::AddButton
グループにボタンを追加します。
void AddButton(CMFCRibbonBaseElement* pButton);
パラメーター
pButton
[in]追加するボタンへのポインター。
CMFCRibbonButtonsGroup::AddButtons
ボタンの一覧をグループに追加します。
void AddButtons(
const CList<CMFCRibbonBaseElement*,CMFCRibbonBaseElement*>& lstButtons);
パラメーター
lstButtons
[in]追加するボタンへのポインターの一覧。
CMFCRibbonButtonsGroup::CMFCRibbonButtonsGroup
CMFCRibbonButtonsGroup オブジェクトを構築します。
CMFCRibbonButtonsGroup();
CMFCRibbonButtonsGroup(CMFCRibbonBaseElement* pButton);
パラメーター
pButton
[in]新しく作成した CMFCRibbonButtonsGroup オブジェクトに追加するボタンを指定します。
戻り値
解説
CMFCRibbonButtonsGroup::GetButton
指定したインデックス位置にあるボタンへのポインターを返します。
CMFCRibbonBaseElement* GetButton(int i) const;
パラメーター
i
[in]返すボタンの 0 から始まるインデックス。
戻り値
指定したインデックス位置にあるボタンへのポインター。 指定したインデックスが範囲外の場合は NULL。
解説
CMFCRibbonButtonsGroup::GetCount
グループ内のボタンの数を返します。
int GetCount() const;
戻り値
グループ内のボタンの数。
CMFCRibbonButtonsGroup::GetImageSize
保護された CMFCToolBarImages メンバー m_Imagesのソース イメージ サイズを取得します。
const CSize GetImageSize() const;
戻り値
ツール バー イメージのソース イメージ サイズ (存在する場合) を返し、存在しない場合は 0 の CSize を返します。
解説
CMFCRibbonButtonsGroup::GetRegularSize
リボン グループ要素の最大サイズを取得します。
virtual CSize GetRegularSize(CDC* pDC);
パラメーター
pDC
[in]リボン グループのデバイス コンテキストへのポインター。
戻り値
解説
CMFCRibbonButtonsGroup::HasImages
CMFCRibbonButtonsGroup オブジェクトにツール バー イメージが含まれているかどうかを報告します。
BOOL HasImages() const;
戻り値
保護された CMFCToolBarImages メンバー m_Images にイメージが含まれている場合は TRUE を返し、含まれていない場合は FALSE を返します。
解説
CMFCRibbonButtonsGroup::OnDrawImage
ボタンが標準、強調表示、無効のいずれであるかに応じて、指定したボタンに適したイメージを描画します。
virtual void OnDrawImage(
CDC* pDC,
CRect rectImage,
CMFCRibbonBaseElement* pButton,
int nImageIndex);
パラメーター
pDC
[in] CMFCRibbonButtonsGroup オブジェクトのデバイス コンテキストへのポインター。
rectImage
[in]画像を描画する四角形。
pButton
[in]画像を描画するボタン。
nImageIndex
[in]ボタンに描画する画像のインデックス (標準、強調表示、無効のボタンの 3 つの画像配列のいずれか)。
解説
CMFCRibbonButtonsGroup::RemoveAll
CMFCRibbonButtonsGroup オブジェクトからすべてのボタンを削除します。
void RemoveAll();
解説
CMFCRibbonButtonsGroup::SetImages
リボン ボタンのグループにイメージを割り当てます。
void SetImages(
CMFCToolBarImages* pImages,
CMFCToolBarImages* pHotImages,
CMFCToolBarImages* pDisabledImages);
パラメーター
pImages
[in]通常の画像。
pHotImages
[in]ホット イメージ。
pDisabledImages
[in]無効なイメージ。
解説
グループにボタンを追加する前に、 SetImages を呼び出します。 イメージの数は、グループに追加するボタンの数以上である必要があります。
Note
ホット イメージは、ユーザーがボタンの上にマウス ポインターを置いたときに表示される画像です。 無効なイメージは、ボタンが無効になっているときに表示されるイメージです。
CMFCRibbonButtonsGroup::SetParentCategory
CMFCRibbonButtonsGroup オブジェクトとその中のすべてのボタンの親CMFCRibbonCategoryを設定します。
virtual void SetParentCategory(CMFCRibbonCategory* pCategory);
パラメーター
pCategory
[in]設定する親カテゴリへのポインター (リボン コントロールのタブ付きグループはカテゴリと呼ばれます)。