CMFCRibbonGallery クラス
Office 2007 スタイルのリボン ギャラリーを実装します。 詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
構文
class CMFCRibbonGallery : public CMFCRibbonButton
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
| CMFCRibbonGallery::CMFCRibbonGallery | CMFCRibbonGallery オブジェクトを構築して初期化します。 |
パブリック メソッド
保護メソッド
| 名前 | 説明 |
|---|---|
| CMFCRibbonGallery::OnDrawPaletteIcon | ギャラリー アイコンが描画されるときにフレームワークによって呼び出されます。 |
解説
ギャラリー ボタンは通常のメニュー ボタンと同じように動作しますが、ユーザーが開いたときにギャラリーが表示される点が異なります。 ギャラリー内の項目を選択すると、フレームワークはボタンのコマンド ID と共にWM_COMMAND メッセージを送信します。 メッセージを処理するときは、 CMFCRibbonGallery::GetLastSelectedItem を呼び出して、ギャラリーから選択された項目を確認する必要があります。
例
次の例は、CMFCRibbonGallery オブジェクトを構成するための CMFCRibbonGallery クラスのさまざまなメソッドの使用方法を示しています。 この例では、ギャラリー内の行ごとの項目数を指定し、メニュー パネルのサイズ変更を有効にし、ポップアップ メニューの左側にあるサイド バーを有効にして、リボン ギャラリーをリボン バーに直接パレットとして表示する方法を示します。 このコード スニペットは、「 クライアント サンプルの描画」の一部です。
CMFCRibbonGallery *pBtnStyles = new CMFCRibbonGallery(ID_OBJECT_STYLES, _T("Styles\nk"), 0, 0, IDB_STYLES, 40);
pBtnStyles->SetIconsInRow(7);
pBtnStyles->EnableMenuResize(TRUE, TRUE);
pBtnStyles->EnableMenuSideBar();
pBtnStyles->SetButtonMode(false);
pBtnStyles->RedrawIcons();
継承階層
CObject
└ CMFCRibbonBaseElement
└ CMFCRibbonButton
└ CMFCRibbonGallery
要件
Header: afxRibbonPaletteGallery.h
CMFCRibbonGallery::AddGroup
ギャラリーに新しいグループを追加します。
void AddGroup(
LPCTSTR lpszGroupName,
UINT uiImagesPaletteResID,
int cxPaletteImage);
void AddGroup(
LPCTSTR lpszGroupName,
CMFCToolBarImages& imagesGroup);
void AddGroup(
LPCTSTR lpszGroupName,
int nIconsNum);
パラメーター
lpszGroupName
[in]グループの名前を指定します。
uiImagesPaletteResID
[in]グループのイメージを含むイメージ リストのリソース ID を指定します。
cxPaletteImage
[in]イメージの幅をピクセル単位で指定します。
imagesGroup
[in]グループ イメージを含むイメージ リストへの参照。
nIconsNum
[in]グループ内のアイコンの数を指定します。 このパラメーターは、カスタム (所有者描画) グループにのみ指定する必要があります。
解説
このメソッドを呼び出すことで、リボン ギャラリー上の項目を複数のグループに分割できます。 各グループにはキャプションを付けることができます。
CMFCRibbonGallery::AddSubItem
ドロップダウン メニューに新しいメニュー項目を追加します。
void AddSubItem(
CMFCRibbonBaseElement* pSubItem,
int nIndex=-1,
BOOL bOnTop=FALSE);
パラメーター
pSubItem
[in]メニューに追加する項目へのポインター。
nIndex
[in]項目を挿入する場所の 0 から始まるインデックスを指定します。
bOnTop
[in]リボン ギャラリーの前に項目を挿入するように指定する場合は TRUE。それ以外の場合は FALSE。
解説
このメソッドを呼び出すことで、ポップアップ ギャラリーとポップアップ メニュー項目を組み合わせることができます。 メニュー項目は、ギャラリーの前または後に配置できます。
ギャラリーの前に項目を挿入するには、 bOnTop を TRUE に設定します。 bOnTop を FALSE に設定して、ギャラリーの下に項目を挿入します。
Note
パラメーター nIndex は、ギャラリーの上部とギャラリーの下部の両方に挿入インデックスを指定します。 たとえば、ギャラリーの 1 つ前に項目を 1 つ挿入する必要がある場合は、 nIndex を 1 に、 bOnTop を TRUE に設定します。 同様に、ギャラリーの 1 つ下に項目を挿入する必要がある場合は、 nIndex を 1 に、 bOnTop を FALSE に設定します。
CMFCRibbonGallery::Clear
ギャラリーの内容をクリアします。
virtual void Clear();
解説
リボン ギャラリーからすべてのコンテンツを削除するには、このメソッドを呼び出します。 これは、新しいリボン ギャラリーまたはグループのセットをリボン ギャラリーにアタッチする前に行う必要があります。
CMFCRibbonGallery::CMFCRibbonGallery
CMFCRibbonGallery オブジェクトを構築して初期化します。
CMFCRibbonGallery (
UINT nID,
LPCTSTR lpszText,
int nSmallImageIndex,
int nLargeImageIndex,
CMFCToolBarImages& imagesPalette);
CMFCRibbonGallery (
UINT nID,
LPCTSTR lpszText,
int nSmallImageIndex,
int nLargeImageIndex,
UINT uiImagesPaletteResID=0,
int cxPaletteImage=0);
CMFCRibbonGallery (
UINT nID,
LPCTSTR lpszText,
int nSmallImageIndex,
int nLargeImageIndex,
CSize sizeIcon,
int nIconsNum,
BOOL bDefaultButtonStyle=TRUE);
パラメーター
nID
ユーザーがボタンをクリックしたときに実行するコマンドのコマンド ID を指定します。
lpszText
ボタンに表示するテキストを指定します。
nSmallImageIndex
ボタンに表示される小さな画像の 0 から始まるインデックス。
nLargeImageIndex
ボタンに表示される大きな画像の 0 から始まるインデックス。
imagesPalette
ギャラリーに表示するイメージを含む CMFCToolBarImages オブジェクトへの参照。
uiImagesPaletteResID
ギャラリーに表示するイメージの一覧のリソース ID。
cxPaletteImage
ギャラリー上のイメージの幅をピクセル単位で指定します。
sizeIcon
ギャラリー イメージのサイズをピクセル単位で指定します。
nIconsNum
ギャラリー内のアイコンの数を指定します。
bDefaultButtonStyle
既定のボタン スタイルと所有者描画ボタン スタイルのどちらを使用するかを指定します。
解説
CMFCRibbonGallery::EnableMenuResize
メニュー パネルのサイズ変更を有効または無効にします。
void EnableMenuResize(
BOOL bEnable = TRUE,
BOOL bVertcalOnly = FALSE);
パラメーター
bEnable
[in]メニューのサイズ変更を有効にする場合は TRUE。それ以外の場合は FALSE。
bVertcalOnly
[in]ギャラリーのサイズを垂直方向にのみ変更できることを指定する場合は TRUE。ギャラリーのサイズを垂直方向と水平方向の両方で変更できることを指定する場合は FALSE。
解説
リボン ギャラリーのサイズ変更を有効または無効にするには、このメソッドを使用します。 サイズ変更を有効にすると、リボン ギャラリーに、ユーザーがサイズ変更に使用できるグリッパーが表示されます。
CMFCRibbonGallery::EnableMenuSideBar
ポップアップ メニューの左側にあるサイド バーを有効または無効にします。
void EnablMenuSideBar(BOOL bEnable=TRUE);
パラメーター
bEnable
[in]サイド バーが有効であることを指定する場合は TRUE。それ以外の場合は FALSE。
解説
メニューの左側にある Office XP スタイルのサイド バーを有効または無効にするには、このメソッドを呼び出します。
CMFCRibbonGallery::GetCompactSize
virtual CSize GetCompactSize(CDC* pDC);
パラメーター
[入力] pDC
戻り値
解説
CMFCRibbonGallery::GetDroppedDown
virtual CMFCRibbonBaseElement* GetDroppedDown();
戻り値
解説
CMFCRibbonGallery::GetGroupName
指定したインデックス位置にあるグループの名前を返します。
LPCTSTR GetGroupName(int nGroupIndex) const;
パラメーター
nGroupIndex
[in]取得する名前を持つグループの 0 から始まるインデックスを指定します。
戻り値
指定したインデックス位置にあるグループの名前。 無効なインデックスを渡すと、アサーションが失敗します。
解説
CMFCRibbonGallery::GetGroupOffset
virtual int GetGroupOffset() const;
戻り値
解説
CMFCRibbonGallery::GetIconsInRow
リボン ギャラリーの行内の項目数を返します。
int GetIconsInRow() const;
戻り値
行内の項目の数。
解説
CMFCRibbonGallery::GetItemToolTip
ギャラリー内の項目に関連付けられているツールヒント テキストを返します。
LPCTSTR GetItemToolTip(int nItemIndex) const;
パラメーター
nItemIndex
[in]ツールヒント テキストを取得する項目の 0 から始まるインデックスを指定します。
戻り値
リボン ギャラリー内の項目に割り当てられたツールヒント文字列へのポインター。 そのアイテムにヒントが割り当てられていない場合は NULL にすることができます。
解説
CMFCRibbonGallery::GetLastSelectedItem
ユーザーが選択したリボン ギャラリー内の最後の項目のインデックスを返します。
static int GetLastSelectedItem(UINT uiCmdID);
パラメーター
uiCmdID
[in]リボン ギャラリーを開いたメニュー項目のコマンド ID を指定します。
戻り値
ユーザーがリボン ギャラリー内の項目を選択すると、ライブラリはリボン ギャラリーを開いたメニュー ボタンのコマンド ID と共にWM_COMMAND メッセージを送信します。
解説
CMFCRibbonGallery::GetPaletteID
現在のパレットのコマンド ID を返します。
int GetPaletteID() const;
戻り値
現在選択されているパレットのコマンド ID。
解説
CMFCRibbonGallery::GetRegularSize
virtual CSize GetRegularSize(CDC* pDC);
パラメーター
[入力] pDC
戻り値
解説
CMFCRibbonGallery::GetSelectedItem
int GetSelectedItem() const;
戻り値
解説
CMFCRibbonGallery::HasMenu
virtual BOOL HasMenu() const;
戻り値
解説
CMFCRibbonGallery::IsButtonMode
パレットをギャラリー ボタンに含めるかどうかを指定します。
BOOL IsButtonMode() const;
戻り値
パレットがドロップダウン メニュー ボタンとして表示される場合は TRUE。パレットがリボンに直接表示される場合は FALSE。
解説
CMFCRibbonGallery::IsMenuResizeEnabled
メニューのサイズ変更を有効にするかどうかを指定します。
BOOL IsMenuResizeEnabled() const;
戻り値
メニューのサイズ変更が有効になっている場合は TRUE。それ以外の場合は FALSE。
解説
CMFCRibbonGallery::IsMenuResizeVertical
BOOL IsMenuResizeVertical() const;
戻り値
解説
CMFCRibbonGallery::IsMenuSideBar
サイド バーを有効にするか無効にするかを指定します。
BOOL IsMenuSideBar() const;
戻り値
Office XP スタイルのサイド バーがポップアップ メニューの左側に描画される場合は TRUE。それ以外の場合は FALSE。
解説
CMFCRibbonGallery::OnAfterChangeRect
virtual void OnAfterChangeRect(CDC* pDC);
パラメーター
[入力] pDC
解説
CMFCRibbonGallery::OnDraw
virtual void OnDraw(CDC* pDC);
パラメーター
[入力] pDC
解説
CMFCRibbonGallery::OnDrawPaletteIcon
ギャラリー アイコンが描画されるときにフレームワークによって呼び出されます。
virtual void OnDrawPaletteIcon(
CDC* pDC,
CRect rectIcon,
int nIconIndex,
CMFCRibbonGalleryIcon* pIcon,
COLORREF clrText);
パラメーター
pDC
[in]描画に使用されるデバイス コンテキストへのポインター。
rectIcon
[in]描画するアイコンの外接する四角形を指定します。
nIconIndex
[in]描画するアイコンのギャラリー アイコンのイメージ リスト内の 0 から始まるインデックスを指定します。
pIcon
[in]描画中のアイコンへのポインター。
clrText
[in]描画する項目のテキストの色を指定します。
解説
派生クラスでこのメソッドをオーバーライドして、リボン ギャラリーの外観をカスタマイズできます。
CMFCRibbonGallery::OnEnable
virtual void OnEnable(BOOL bEnable);
パラメーター
[入力] bEnable
解説
CMFCRibbonGallery::OnRTLChanged
virtual void OnRTLChanged(BOOL bIsRTL);
パラメーター
[入力] bIsRTL
解説
CMFCRibbonGallery::RedrawIcons
ギャラリーを再描画します。
void RedrawIcons();
解説
ギャラリーを再描画するには、この関数を呼び出します。 実行時にギャラリーの内容を変更した場合は、このメソッドを呼び出す必要があります。
CMFCRibbonGallery::RemoveItemToolTips
ギャラリー内のすべての項目からツールヒントを削除します。
void RemoveItemToolTips();
解説
CMFCRibbonGallery::SelectItem
void SelectItem(int nItemIndex);
パラメーター
[入力] nItemIndex
解説
CMFCRibbonGallery::SetACCData
リボン ギャラリーのユーザー補助データを使用して、指定された CAccessibilityData オブジェクトを設定します。
virtual BOOL SetACCData(
CWnd* pParent,
CAccessibilityData& data);
パラメーター
pParent
[in]リボン ギャラリー ウィンドウの親ウィンドウ。
data
[out]リボン ギャラリーからアクセシビリティ データを受け取る CAccessibilityData オブジェクト。
戻り値
解説
メソッドが成功した場合は TRUE。それ以外の場合は FALSE。
CMFCRibbonGallery::SetButtonMode
リボン ギャラリーをドロップダウン ボタンとして表示するか、リボンに直接パレットとして表示するかを指定します。
void SetButtonMode(BOOL bSet=TRUE);
パラメーター
bSet
[in]リボン ギャラリーをドロップダウン メニュー ボタンとして表示する場合は TRUE。リボン ギャラリーの内容をリボンに直接表示する場合は FALSE。
解説
CMFCRibbonGallery::SetGroupName
グループの名前を設定します。
void SetGroupName(
int nGroupIndex,
LPCTSTR lpszGroupName);
パラメーター
nGroupIndex
[in]名前を変更するグループの 0 から始まるインデックスを指定します。
lpszGroupName
[in]グループの新しい名前を指定します。
解説
名前を変更するグループは、 CMFCRibbonGallery::AddGroup メソッドを使用して追加する必要があります。
CMFCRibbonGallery::SetIconsInRow
ギャラリー内の行あたりの項目数を指定します。
void SetIconsInRow(int nIconsInRow);
パラメーター
nIconsInRow
[in]ギャラリーの各行に表示する項目の数を指定します。
解説
リボン ギャラリーの幅を指定するには、このメソッドを使用します。
CMFCRibbonGallery::SetItemToolTip
ギャラリー内の項目のツールヒント テキストを設定します。
void SetItemToolTip(
int nItemIndex,
LPCTSTR lpszToolTip);
パラメーター
nItemIndex
[in]ヒントを関連付けるパレット項目の 0 から始まるインデックス。
lpszToolTip
[in]ヒントに表示されるテキスト。
解説
CMFCRibbonGallery::SetPalette
リボン ギャラリーにパレットをアタッチします。
void SetPalette(CMFCToolBarImages& imagesPalette);
void SetPalette(
UINT uiImagesPaletteResID,
int cxPaletteImage);
パラメーター
imagesPalette
[in]ギャラリーに表示するアイコンを含むイメージ リストを指定します。
uiImagesPaletteResID
[in]ギャラリーに表示するアイコンを含むイメージ リストのリソース ID を指定します。
cxPaletteImage
[in]ギャラリー上のイメージの幅をピクセル単位で指定します。
解説
CMFCRibbonGallery::SetPaletteID
ユーザーがギャラリー アイテムを選択したときにWM_COMMAND メッセージで送信されるコマンド ID を定義します。
void SetPaletteID(UINT nID);
パラメーター
nID
[in]ユーザーがギャラリー 項目を選択したときにWM_COMMAND メッセージで送信されるコマンド ID を指定します。
解説
ギャラリーからユーザーが選択した特定の項目を確認するには、 CMFCRibbonGallery::GetLastSelectedItem 静的メソッドを呼び出します。
関連項目
階層図
クラス
CMFCRibbonButton クラス
CMFCRibbonGalleryMenuButton クラス