CMFCRibbonCategory クラス

[アーティクル]
10/12/2023

CMFCRibbonCategory クラスは、リボンパネルのグループを含むリボンタブを実装します。

構文

class CMFCRibbonCategory : public CObject

メンバー

保護されたコンストラクター

名前	説明
CMFCRibbonCategory::CMFCRibbonCategory	コンストラクター。

パブリックメソッド

名前	説明
CMFCRibbonCategory::AddHidden	非表示の要素をリボンカテゴリに追加します。
CMFCRibbonCategory::AddPanel	リボンカテゴリに新しいパネルを追加します。
CMFCRibbonCategory::CopyFrom
CMFCRibbonCategory::FindByData
CMFCRibbonCategory::FindByID
CMFCRibbonCategory::FindPanelWithElem
CMFCRibbonCategory::GetContextID	リボンカテゴリのコンテキスト ID を返します。
CMFCRibbonCategory::GetData	リボンカテゴリに関連付けられているユーザー定義データを返します。
CMFCRibbonCategory::GetDroppedDown
CMFCRibbonCategory::GetElements
CMFCRibbonCategory::GetElementsByID
CMFCRibbonCategory::GetFirstVisibleElement	リボンカテゴリに属する最初に表示される要素を取得します。
CMFCRibbonCategory::GetFocused	フォーカスされた要素を返します。
CMFCRibbonCategory::GetHighlighted	強調表示された要素を返します。
CMFCRibbonCategory::GetImageCount
CMFCRibbonCategory::GetImageSize
CMFCRibbonCategory::GetItemIDsList
CMFCRibbonCategory::GetLastVisibleElement	リボンカテゴリに属する最後に表示される要素を取得する
CMFCRibbonCategory::GetLargeImages	リボンカテゴリが使用する大きな画像の一覧への参照を返します。
CMFCRibbonCategory::GetMaxHeight
CMFCRibbonCategory::GetName
CMFCRibbonCategory::GetPanel	指定したインデックス位置にあるリボンパネルへのポインターを返します。
CMFCRibbonCategory::GetPanelCount	リボンカテゴリ内のリボンパネルの数を返します。
CMFCRibbonCategory::GetPanelFromPoint
CMFCRibbonCategory::GetPanelIndex	指定したリボンパネルのインデックスを返します。
CMFCRibbonCategory::GetParentButton
CMFCRibbonCategory::GetParentMenuBar
CMFCRibbonCategory::GetParentRibbonBar
CMFCRibbonCategory::GetRect
CMFCRibbonCategory::GetSmallImages	カテゴリが使用する小さな画像の一覧への参照を返します。
CMFCRibbonCategory::GetTabColor	リボンカテゴリタブの現在の色を返します。
CMFCRibbonCategory::GetTabRect
CMFCRibbonCategory::GetTextTopLine
CMFCRibbonCategory::GetVisibleElements	リボンカテゴリに属するすべての表示要素を取得します。
CMFCRibbonCategory::HighlightPanel
CMFCRibbonCategory::HitTest
CMFCRibbonCategory::HitTestEx
CMFCRibbonCategory::HitTestScrollButtons
CMFCRibbonCategory::IsActive
CMFCRibbonCategory::IsVisible	リボンカテゴリを表示するかどうかを指定します。
CMFCRibbonCategory::IsWindows7Look	親リボンに Windows 7 スタイルの外観があるかどうかを示します (小さな四角形のアプリケーションボタン)
CMFCRibbonCategory::NotifyControlCommand
CMFCRibbonCategory::OnCancelMode
CMFCRibbonCategory::OnDraw
CMFCRibbonCategory::OnDrawImage
CMFCRibbonCategory::OnDrawMenuBorder
CMFCRibbonCategory::OnKey	ユーザーがキーボードボタンを押したときにフレームワークによって呼び出されます。
CMFCRibbonCategory::OnLButtonDown
CMFCRibbonCategory::OnLButtonUp
CMFCRibbonCategory::OnMouseMove
CMFCRibbonCategory::OnRTLChanged
CMFCRibbonCategory::OnScrollHorz
CMFCRibbonCategory::OnUpdateCmdUI
CMFCRibbonCategory::RecalcLayout
CMFCRibbonCategory::RemovePanel
CMFCRibbonCategory::ReposPanels
CMFCRibbonCategory::SetCollapseOrder	リボンカテゴリに存在するリボンパネルの折りたたみ順序を定義します。
CMFCRibbonCategory::SetData	ユーザー定義データをリボンカテゴリに格納します。
CMFCRibbonCategory::SetKeys	リボンカテゴリにキーヒントを割り当てます。
CMFCRibbonCategory::SetName
CMFCRibbonCategory::SetTabColor	リボンカテゴリの色を設定します。

解説

通常は、新しく作成されたリボンカテゴリへのポインターを返す CMFCRibbonBar::AddCategory を呼び出して、リボンカテゴリを間接的に作成します。カテゴリにパネルを追加するには、 CMFCRibbonCategory::AddPanel を呼び出します。

CMFCRibbonTab クラスは、リボンカテゴリを描画します。これは、 CMFCRibbonBaseElement クラスから派生します。

次の例では、リボンカテゴリを作成し、それにパネルを追加する方法を示します。

// Create a new ribbon category and get a pointer to it`
CMFCRibbonCategory* pCategory = m_wndRibbonBar.AddCategory
    (_T("&Write"),           // Category name
    IDB_WRITE,               // Category small images (16 x 16)
    IDB_WRITE_LARGE);        // Category large images (32 x 32)

// Add a panel to the new category
CMFCRibbonPanel* pPanel = pCategory->AddPanel (
    _T("Clipboard"),                // Panel name
    m_PanelIcons.ExtractIcon (0));  // Panel icon

次の図は、RibbonApp サンプルアプリケーションのホームカテゴリの図を示しています。

RibbonApp サンプルアプリケーションのホームカテゴリ。

継承階層

CObject

CMFCRibbonCategory

要件

Header: afxribboncategory.h

CMFCRibbonCategory::AddHidden

指定したリボン要素を、カスタマイズダイアログボックスに表示されるリボン要素の配列に追加します。

void AddHidden(CMFCRibbonBaseElement* pElem);

パラメーター

pElem
[in]リボン要素へのポインター。

解説

カスタマイズダイアログボックスのリボン要素は、クイックアクセスツールバーに追加できるコマンドです。

CMFCRibbonCategory::AddPanel

リボンカテゴリのリボンパネルを作成します。

CMFCRibbonPanel* AddPanel(
    LPCTSTR lpszPanelName,
    HICON hIcon = 0,
    CRuntimeClass* pRTI = NULL);

パラメーター

lpszPanelName
[in]新しいリボンパネルの名前へのポインター。

hIcon
[in]新しいリボンパネルの既定のアイコンを処理します。

pRTI
[in]カスタムリボンパネルのランタイムクラス情報へのポインター。

戻り値

メソッドが成功した場合は、新しいリボンパネルへのポインター。それ以外の場合は NULL (パネルが作成されなかった場合)。

解説

カスタムリボンパネルを作成する場合は、そのランタイムクラス情報を pRTI で指定する必要があります。カスタムリボンパネルクラスは、 CMFCRibbonPanel クラスから派生する必要があります。

リボンパネルの既定のアイコンは、リボン要素を表示するための十分なスペースがない場合に表示されます。

例

次の例では、CMFCRibbonCategory クラスで AddPanel メソッドを使用する方法を示します。

// Create "Favorites" panel:
strTemp.LoadString(IDS_RIBBON_FAVORITES);
// CMFCRibbonCategory* pCategoryCustom
CMFCRibbonPanel *pPanelFavorites = pCategoryCustom->AddPanel(strTemp,
                                                             m_PanelImages.ExtractIcon(15));

CMFCRibbonCategory::CMFCRibbonCategory

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

CMFCRibbonCategory(
    CMFCRibbonBar* pParenrRibbonBar,
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

パラメーター

pParenrRibbonBar
[in]リボンカテゴリの親リボンバーへのポインター。

lpszName
[in]リボンカテゴリの名前。

uiSmallImagesResID
[in]リボンカテゴリのリボン要素によって使用される小さな画像の画像リストのリソース ID。

uiLargeImagesResID
[in]リボンカテゴリのリボン要素によって使用される大きな画像の画像リストのリソース ID。

sizeSmallImage
[in]リボンカテゴリ内のリボン要素の小さい画像の既定のサイズ。

sizeLargeImage
[in]リボンカテゴリ内のリボン要素の大きな画像の既定のサイズ。

CMFCRibbonCategory::CopyFrom

指定した CMFCRibbonCategory の状態を現在の CMFCRibbonCategory オブジェクトにコピーします。

virtual void CopyFrom(CMFCRibbonCategory& src);

パラメーター

src
[in]ソース CMFCRibbonCategory オブジェクト。

解説

CMFCRibbonCategory::FindByData

指定したデータに関連付けられているリボン要素を取得します。

CMFCRibbonBaseElement* FindByData(
    DWORD_PTR dwData,
    BOOL bVisibleOnly = TRUE) const;

パラメーター

dwData
[in]リボン要素に関連付けられているデータ。

bVisibleOnly
[in]検索にクイックアクセスリボン要素を含める場合は TRUE。検索でクイックアクセスリボン要素を除外する場合は FALSE。

戻り値

メソッドが成功した場合のリボン要素へのポインター。それ以外の場合は NULL。

解説

CMFCRibbonCategory::FindByID

指定したコマンド ID に関連付けられているリボン要素を取得します。

CMFCRibbonBaseElement* FindByID(
    UINT uiCmdID,
    BOOL bVisibleOnly = TRUE) const;

パラメーター

uiCmdID
[in]リボン要素に関連付けられているコマンド ID。

bVisibleOnly
[in]検索にクイックアクセスリボン要素を含める場合は TRUE。検索でクイックアクセスリボン要素を除外する場合は FALSE。

戻り値

メソッドが成功した場合のリボン要素へのポインター。それ以外の場合は NULL。

解説

CMFCRibbonCategory::FindPanelWithElem

指定したリボン要素を含むリボンパネルを取得します。

CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);

パラメーター

pElement
[in]リボン要素へのポインター。

戻り値

メソッドが成功した場合のリボンパネルへのポインター。それ以外の場合は NULL。

解説

CMFCRibbonCategory::GetContextID

リボンカテゴリのコンテキスト ID を取得します。

UINT GetContextID() const;

戻り値

リボンカテゴリのコンテキスト ID。

解説

コンテキスト ID は、リボンカテゴリがコンテキストリボンカテゴリでない場合は 0 です。

CMFCRibbonCategory::GetData

リボンカテゴリに関連付けられているユーザー定義データを取得します。

DWORD_PTR GetData() const;

戻り値

リボンカテゴリに関連付けられているユーザー定義データ。

CMFCRibbonCategory::GetDroppedDown

現在ポップアップメニューが表示されているリボン要素へのポインターを取得します。

CMFCRibbonBaseElement* GetDroppedDown();

戻り値

メソッドが成功した場合のリボン要素へのポインター。それ以外の場合は NULL。

解説

CMFCRibbonCategory::GetElements

リボンカテゴリ内のすべてのリボン要素を取得します。

void GetElements(
    CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

パラメーター

arElements
[入力、出力]リボン要素の CArray への参照。

解説

クイックアクセスツールバーで使用するように設計されたリボン要素は、配列に含まれています。

CMFCRibbonCategory::GetElementsByID

指定したコマンド ID に関連付けられているすべてのリボン要素を取得します。

void GetElementsByID(
    UINT uiCmdID,
    CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

パラメーター

uiCmdID
[in]リボン要素に関連付けられているコマンド ID。

arElements
[入力、出力]リボン要素の CArray への参照。

解説

クイックアクセスツールバーで使用するように設計されたリボン要素は、配列に含まれています。

CMFCRibbonCategory::GetFirstVisibleElement

リボンカテゴリに属する最初の表示要素を取得します。

CMFCRibbonBaseElement* GetFirstVisibleElement() const;

戻り値

最初に表示される要素へのポインター。カテゴリに表示される要素がない場合は NULL になる可能性があります。

解説

CMFCRibbonCategory::GetFocused

フォーカスされた要素を返します。

CMFCRibbonBaseElement* GetFocused();

戻り値

フォーカスされた要素または NULL へのポインター。

解説

CMFCRibbonCategory::GetHighlighted

強調表示された要素を返します。

CMFCRibbonBaseElement* GetHighlighted();

戻り値

強調表示された要素へのポインター。要素が強調表示されていない場合は NULL。

解説

CMFCRibbonCategory::GetImageCount

リボンカテゴリに含まれる、指定したイメージリスト内のイメージの数を取得します。

int GetImageCount(BOOL bIsLargeImage) const;

パラメーター

bIsLargeImage
[in]大きな画像リスト内の画像の数の場合は TRUE。小さい画像リスト内の画像の数の場合は FALSE。

戻り値

指定したイメージリスト内のイメージの数。

解説

CMFCRibbonCategory::GetImageSize

リボンカテゴリに含まれる指定したイメージリスト内のイメージのサイズを取得します。

CSize GetImageSize(BOOL bIsLargeImage) const;

パラメーター

bIsLargeImage
[in]大きな画像のサイズの場合は TRUE。小さい画像のサイズの場合は FALSE。

戻り値

指定したイメージリスト内のイメージのサイズ。

解説

取得されるサイズには、グローバルイメージスケールファクターが含まれます。

CMFCRibbonCategory::GetItemIDsList

リボンカテゴリに含まれるリボン要素のコマンド ID を取得します。

void GetItemIDsList(
    CList<UINT, UINT>& lstItems,
    BOOL bHiddenOnly = FALSE) const;

パラメーター

lstItems
[out]リボンカテゴリ内のリボン要素のコマンド ID の一覧。

bHiddenOnly
[in]TRUE を指定すると、リボンカテゴリのリボンパネルに表示されるリボン要素が除外されます。リボンカテゴリのすべてのリボン要素を含める場合は FALSE。

解説

CMFCRibbonCategory::GetLargeImages

リボンカテゴリに含まれている大きな画像の一覧を取得します。

CMFCToolBarImages& GetLargeImages();

戻り値

リボンカテゴリに含まれる大きな画像の一覧。

CMFCRibbonCategory::GetLastVisibleElement

リボンカテゴリに属する最後に表示される要素を取得します。

CMFCRibbonBaseElement* GetLastVisibleElement() const;

戻り値

最後に表示される要素へのポインター。カテゴリに表示される要素がない場合は NULL になる可能性があります。

解説

CMFCRibbonCategory::GetMaxHeight

リボンカテゴリに含まれるリボンパネルの最大高さを取得します。

int GetMaxHeight(CDC* pDC);

パラメーター

pDC
[in]リボンパネルのデバイスコンテキストへのポインター。

戻り値

リボンカテゴリに含まれるリボンパネルの最大高さ。

解説

取得される値には、リボンパネルの上下の余白の高さが含まれます。

CMFCRibbonCategory::GetName

リボンカテゴリの名前を取得します。

LPCTSTR GetName() const;

戻り値

リボンカテゴリの名前。

解説

CMFCRibbonCategory::GetPanel

指定したインデックス位置にあるリボンパネルへのポインターを返します。

CMFCRibbonPanel* GetPanel(int nIndex);

パラメーター

nIndex
[in]リボンパネルの 0 から始まるインデックス。

戻り値

指定したインデックス位置にあるリボンパネルへのポインター。

解説

nIndex が範囲外の場合、例外がスローされます。

CMFCRibbonCategory::GetPanelCount

リボンカテゴリ内のリボンパネルの数を返します。

int GetPanelCount() const;

戻り値

リボンカテゴリ内のリボンパネルの数。

CMFCRibbonCategory::GetPanelFromPoint

指定したポイントがリボンパネル内にある場合は、リボンパネルへのポインターを取得します。

CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;

パラメーター

point
[in]ウィンドウの左上隅を基準としたポインターの x 座標と y 座標。

戻り値

メソッドが成功した場合のリボンパネルへのポインター。それ以外の場合は NULL。

解説

リボンカテゴリに含まれているリボンパネルのみがテストされます。

CMFCRibbonCategory::GetPanelIndex

指定したリボンパネルの 0 から始まるインデックスを取得します。

int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;

パラメーター

pPanel
[in]リボンパネルへのポインター。

戻り値

メソッドが成功した場合の、指定したリボンパネルの 0 から始まるインデックス。それ以外の場合は -1。

解説

リボンカテゴリに含まれているリボンパネルのみが検索されます。

CMFCRibbonCategory::GetParentButton

リボンカテゴリの親リボン要素を取得します。

CMFCRibbonBaseElement* GetParentButton() const;

戻り値

親リボン要素へのポインターを返します。親要素がない場合は NULL を返します。

解説

CMFCRibbonCategory::GetParentMenuBar

CMFCRibbonCategory オブジェクトの親メニューバーへのポインターを返します。

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

戻り値

m_pParentMenuBar保護されたメンバーの内容を返します。

解説

CMFCRibbonCategory::GetParentRibbonBar

リボンカテゴリの親リボンバーを取得します。

CMFCRibbonBar* GetParentRibbonBar() const;

戻り値

リボンカテゴリの親リボンバーへのポインター。

解説

CMFCRibbonCategory::GetRect

リボンカテゴリの表示四角形を取得します。

CRect GetRect() const;

戻り値

リボンカテゴリの表示四角形。

解説

リボンカテゴリの表示四角形には、[カテゴリ] タブは含まれません。

CMFCRibbonCategory::GetSmallImages

リボンカテゴリに含まれる小さなイメージの一覧を取得します。

CMFCToolBarImages& GetSmallImages();

戻り値

リボンカテゴリに含まれる小さな画像の一覧。

CMFCRibbonCategory::GetTabColor

リボンカテゴリタブの現在の色を返します。

AFX_RibbonCategoryColor GetTabColor() const;

戻り値

リボンカテゴリタブの現在の色。

解説

戻り値には、次のいずれかの列挙値を指定できます。

AFX_CategoryColor_Red
AFX_CategoryColor_Orange
AFX_CategoryColor_Yellow
AFX_CategoryColor_Green
AFX_CategoryColor_Blue
AFX_CategoryColor_Indigo
AFX_CategoryColor_Violet

CMFCRibbonCategory::GetTabRect

リボンカテゴリタブの表示四角形を取得します。

CRect GetTabRect() const;

戻り値

リボンカテゴリタブの表示四角形。

解説

CMFCRibbonCategory::GetTextTopLine

大きな画像を表示するリボンカテゴリのリボンボタン上のテキストの垂直方向の位置を取得します。

int GetTextTopLine() const;

戻り値

大きな画像を表示するリボンボタン上のテキストの垂直方向の位置 (ピクセル単位)。

解説

CMFCRibbonCategory::GetVisibleElements

リボンカテゴリに属するすべての表示される要素を取得します。

void GetVisibleElements(
    CArray <CMFCRibbonBaseElement*,
    CMFCRibbonBaseElement*>& arElements);

パラメーター

arElements
表示されているすべての要素の配列。

解説

CMFCRibbonCategory::HighlightPanel

指定したリボンパネルを強調表示します。

CMFCRibbonPanel* HighlightPanel(
    CMFCRibbonPanel* pHLPanel,
    CPoint point);

パラメーター

pHLPanel
[in]強調表示するリボンパネルへのポインター。

point
[in]ウィンドウの左上隅を基準としたポインターの x 座標と y 座標。

戻り値

以前に強調表示されたリボンパネルへのポインター。それ以外の場合、このメソッドが呼び出されたときにリボンパネルが強調表示されていない場合は NULL。

解説

リボンパネルの強調表示の詳細については、「 CMFCRibbonPanel::Highlight」を参照してください。

CMFCRibbonCategory::HitTest

指定したポイントがリボン要素内にある場合は、リボン要素へのポインターを取得します。

CMFCRibbonBaseElement* HitTest(
    CPoint point,
    BOOL bCheckPanelCaption = FALSE) const;

パラメーター

point
[in]ウィンドウの左上隅を基準としたマウスポインターの x 座標と y 座標。

bCheckPanelCaption
[in]リボンパネルのキャプションをテストする場合は TRUE。リボンパネルのキャプションを除外する場合は FALSE。

戻り値

メソッドが成功した場合のリボン要素へのポインター。それ以外の場合は NULL。

解説

テストされるのは、リボンカテゴリに含まれているリボン要素だけです。

CMFCRibbonCategory::HitTestEx

指定したポイントがリボン要素内にある場合、リボン要素の 0 から始まるインデックスを取得します。

int HitTestEx(CPoint point) const;

パラメーター

point
[in]ウィンドウの左上隅を基準としたマウスポインターの x 座標と y 座標。

戻り値

メソッドが成功した場合のリボン要素の 0 から始まるインデックス。それ以外の場合は -1。

解説

テストされるのは、リボンカテゴリに含まれているリボン要素だけです。

CMFCRibbonCategory::HitTestScrollButtons

ポイントがリボンカテゴリの左または右のスクロールボタン内にある場合は、そのボタンへのポインターを返します。

CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;

パラメーター

point
[入力] テストするポイント。

戻り値

ポイントリボンカテゴリの左または右のスクロールボタンの外接する四角形内にある場合は、そのボタンへのポインターを返すか、それ以外の場合は NULL を返します。

解説

CMFCRibbonCategory::IsActive

リボンカテゴリがリボンバーのアクティブなカテゴリであるかどうかを示します。

BOOL IsActive() const;

戻り値

リボンカテゴリがアクティブなカテゴリの場合は TRUE。それ以外の場合は FALSE。

解説

アクティブなリボンカテゴリには、そのリボンパネルが表示されます。

CMFCRibbonCategory::IsVisible

リボンカテゴリが表示されるかどうかを示します。

BOOL IsVisible() const;

戻り値

リボンカテゴリが表示されている場合は TRUE。それ以外の場合は FALSE。

解説

表示されているリボンカテゴリには、カテゴリタブが表示されます。

CMFCRibbonCategory::IsWindows7Look

親リボンに Windows 7 の外観 (小さな四角形のアプリケーションボタン) があるかどうかを示します。

BOOL IsWindows7Look() const;

戻り値

親リボンに Windows 7 の外観がある場合は TRUE。それ以外の場合は FALSE。

解説

CMFCRibbonCategory::NotifyControlCommand

メッセージが処理されるまで、CMFCRibbonCategory内のすべてのCMFCRibbonPanel要素にWM_NOTIFYコマンドメッセージを配信します。

virtual BOOL NotifyControlCommand(
    BOOL bAccelerator,
    int nNotifyCode,
    WPARAM wParam,
    LPARAM lParam);

パラメーター

bAccelerator
[in]このコマンドがアクセラレータから発生した場合は TRUE、それ以外の場合は FALSE。

nNotifyCode
[入力] 通知コード。

wParam
[in]メッセージの WPARAM フィールド。

lParam
[in]メッセージの LPARAM フィールド。

戻り値

メッセージが処理された場合は TRUE、処理されなかった場合は FALSE を返します。

解説

CMFCRibbonCategory::OnCancelMode

CMFCRibbonCategoryのすべてのCMFCRibbonPanel要素でキャンセルモードを呼び出します。

virtual void OnCancelMode();

解説

CMFCRibbonCategory::OnDraw

リボンカテゴリを描画するためにフレームワークによって呼び出されます。

virtual void OnDraw(CDC* pDC);

パラメーター

pDC
[in]リボンカテゴリのデバイスコンテキストへのポインター。

解説

CMFCRibbonCategory::OnDrawImage

指定したイメージをリボンカテゴリに描画するためにフレームワークによって呼び出されます。

virtual BOOL OnDrawImage(
    CDC* pDC,
    CRect rect,
    CMFCRibbonBaseElement* pElement,
    BOOL bIsLargeImage,
    BOOL nImageIndex,
    BOOL bCenter);

パラメーター

pDC
[in]イメージのデバイスコンテキストへのポインター。

rect
[in]画像の四角形を表示します。

pElement
[in]イメージを含むリボン要素へのポインター。

bIsLargeImage
[in]画像が大きなサイズの場合は TRUE。イメージが小さいサイズの場合は FALSE。

nImageIndex
[in]リボンカテゴリに含まれるイメージ配列内のイメージの 0 から始まるインデックス。

bCenter
[in]表示四角形内の画像を中央に配置する場合は TRUE。表示四角形の左上隅に画像を描画する場合は FALSE。

戻り値

メソッドが成功した場合は TRUE。それ以外の場合は FALSE。

解説

CMFCRibbonCategory::OnDrawMenuBorder

ポップアップメニューの境界線を描画するためにフレームワークによって呼び出されます。

virtual void OnDrawMenuBorder(
    CDC* pDC,
    CMFCRibbonPanelMenuBar* pMenuBar);

パラメーター

pDC
[入力] このパラメーターは使用しません。

pMenuBar
[入力] このパラメーターは使用しません。

解説

既定では、このメソッドは何も行いません。ポップアップメニューの境界線を描画するには、このメソッドをオーバーライドします。

CMFCRibbonCategory::OnKey

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

virtual BOOL OnKey(UINT nChar);

パラメーター

nChar
ユーザーが押したキーの仮想キーコード。

解説

CMFCRibbonCategory::OnLButtonDown

ユーザーがマウスの左ボタンを押したときに、指定したポイントの下にあるリボン要素を取得するためにフレームワークによって呼び出されます。

virtual CMFCRibbonBaseElement* OnLButtonDown(CPoint point);

パラメーター

point
[in]ウィンドウの左上隅を基準としたマウスポインターの x 座標と y 座標。

戻り値

メソッドが成功した場合のリボン要素へのポインター。それ以外の場合は NULL。

解説

CMFCRibbonCategory::OnLButtonUp

ユーザーがマウスの左ボタンを離し、ポインターがリボンカテゴリの上にあるときに、フレームワークによって呼び出されます。

virtual void OnLButtonUp(CPoint point);

パラメーター

point
[in]ウィンドウの左上隅を基準としたポインターの x 座標と y 座標。

解説

CMFCRibbonCategory::OnMouseMove

リボンカテゴリの表示を更新するために、リボンバー上でポインターが移動したときにフレームワークによって呼び出されます。

virtual void OnMouseMove(CPoint point);

パラメーター

point
[in]ウィンドウの左上隅を基準としたポインターの x 座標と y 座標。

解説

CMFCRibbonCategory::OnRTLChanged

レイアウトの方向が変わるときにフレームワークによって呼び出されます。

virtual void OnRTLChanged(BOOL bIsRTL);

パラメーター

bIsRTL
[in]レイアウトが右から左の場合は TRUE。レイアウトが左から右の場合は FALSE。

解説

このメソッドは、リボンカテゴリに含まれるすべてのリボンパネルとリボン要素のレイアウトを調整します。

CMFCRibbonCategory::OnScrollHorz

リボンカテゴリを水平方向にスクロールします。

virtual BOOL OnScrollHorz(
    BOOL bScrollLeft,
    int nScrollOffset = 0);

パラメーター

bScrollLeft
[in]TRUE の場合は左にスクロールします。FALSE を指定すると、右にスクロールします。

nScrollOffset
[in]スクロール距離 (ピクセル単位)。

戻り値

リボンカテゴリが水平方向に移動した場合は TRUE。それ以外の場合は FALSE。

解説

CMFCRibbonCategory::OnUpdateCmdUI

CMFCRibbonCategoryの各CMFCRibbonPanel要素でOnUpdateCmdUIメンバー関数を呼び出して、それらのユーザーインターフェイス要素を有効または無効にします。

virtual void OnUpdateCmdUI(
    CMFCRibbonCmdUI* pCmdUI,
    CFrameWnd* pTarget,
    BOOL bDisableIfNoHndler);

パラメーター

pCmdUI
[in]有効にするユーザーインターフェイス要素と無効にするユーザーインターフェイス要素を指定する CMFCRibbonCmdUI オブジェクトへのポインター。

pTarget
[in]ユーザーインターフェイス要素の有効化または無効化を制御するウィンドウへのポインター。

bDisableIfNoHndler
[in]メッセージマップでハンドラーが定義されていない場合にユーザーインターフェイス項目を無効にする場合は TRUE。それ以外の場合は FALSE。

解説

CMFCRibbonCategory::RecalcLayout

リボンカテゴリ上のすべてのコントロールのレイアウトを調整します。

virtual void RecalcLayout(CDC* pDC);

パラメーター

pDC
[in]リボンカテゴリのデバイスコンテキストへのポインター。

解説

CMFCRibbonCategory::RemovePanel

リボンカテゴリからリボンパネルを削除します。

BOOL RemovePanel(
    int nIndex,
    BOOL bDelete = TRUE);

パラメーター

nIndex
[in]削除するパネルのインデックス番号。 CMFCRibbonCategory::GetPanelIndex メソッドを呼び出して取得します。

bDelete
[in]メモリからパネルオブジェクトを削除する場合は TRUE。パネルオブジェクトを削除せずに削除する場合は FALSE。

戻り値

メソッドが成功した場合は TRUE、それ以外の場合は FALSE。

CMFCRibbonCategory::ReposPanels

リボンカテゴリに含まれるリボンパネル上のすべてのコントロールのレイアウトを調整します。

virtual void ReposPanels(CDC* pDC);

パラメーター

pDC
[in]リボンカテゴリに含まれるリボンパネルのデバイスコンテキストへのポインター。

解説

CMFCRibbonCategory::SetCollapseOrder

リボンカテゴリのリボンパネルが折りたたまれる順序を定義します。

void SetCollapseOrder(const CArray<int,int>& arCollapseOrder);

パラメーター

arCollapseOrder
[in]折りたたみ順序を指定します。配列には、リボンパネルの 0 から始まるインデックスが含まれています。

解説

ライブラリは折りたたみ順序を定義します。ただし、折りたたみ順序を指定するインデックスの一覧をカテゴリに指定することで、この動作をカスタマイズできます。

カテゴリは、リボンパネルを折りたたむ必要があることを検出すると、指定されたリスト内の次の要素を探します。リストが空の場合、または十分な要素を指定していない場合、カテゴリは内部アルゴリズムを使用します。

たとえば、カテゴリには 3 つのリボンパネルがあり、すべてのパネルが完全に折りたたまれた状態になるまで数回折りたたむことができます。 0、0、2、2 の折りたたみ順序を設定できます。この場合、カテゴリはパネル0を2回折りたたみ、パネル2を2回折りたたむ。インデックスが 1 のパネルは、未表示のままです。

例

次の例では、CMFCRibbonCategory クラスで SetCollapseOrder メソッドを使用する方法を示します。この例では、折りたたみ順序の配列を作成する方法と、折りたたみ順序をリボンカテゴリに設定する方法を示します。

CArray<int, int> arCollapseOrder;
arCollapseOrder.Add(0);
arCollapseOrder.Add(1);
arCollapseOrder.Add(2);
// CMFCRibbonCategory* pCategoryHome
pCategoryHome->SetCollapseOrder(arCollapseOrder);

CMFCRibbonCategory::SetData

リボンカテゴリに関連付けるユーザー定義データを設定します。

void SetData(DWORD_PTR dwData);

パラメーター

dwData
[in]ユーザー定義データ。

CMFCRibbonCategory::SetKeys

リボンカテゴリにキーヒントを割り当てます。

void SetKeys(LPCTSTR lpszKeys);

パラメーター

lpszKeys
[in]キーヒントテキスト。

解説

ユーザーが Alt キーまたは F10 キーを押すと、キーヒントが表示されます。

CMFCRibbonCategory::SetName

リボンカテゴリに名前とキーヒントを割り当てます。

void SetName(LPCTSTR lpszName);

パラメーター

lpszName
[in]リボンカテゴリの名前とキーヒント。

解説

リボンカテゴリのキーヒントを設定するには、改行エスケープシーケンスの後にキーヒント文字 lpszNameを追加します。

CMFCRibbonCategory::SetTabColor

リボンカテゴリの色を設定します。

void SetTabColor(AFX_RibbonCategoryColor color);

パラメーター

color
[in]リボンカテゴリの新しい色を指定します。

解説

色には、次のいずれかの値を指定できます。

AFX_CategoryColor_None
AFX_CategoryColor_Red
AFX_CategoryColor_Orange
AFX_CategoryColor_Yellow
AFX_CategoryColor_Green
AFX_CategoryColor_Blue
AFX_CategoryColor_Indigo
AFX_CategoryColor_Violet

次の方法で共有

CMFCRibbonCategory クラス

構文

メンバー

保護されたコンストラクター

パブリック メソッド

解説

継承階層

要件

CMFCRibbonCategory::AddHidden

パラメーター

解説

CMFCRibbonCategory::AddPanel

パラメーター

戻り値

解説

例

CMFCRibbonCategory::CMFCRibbonCategory

パラメーター

CMFCRibbonCategory::CopyFrom

パラメーター

解説

CMFCRibbonCategory::FindByData

パラメーター

戻り値

解説

CMFCRibbonCategory::FindByID

パラメーター

戻り値

解説

CMFCRibbonCategory::FindPanelWithElem

パラメーター

戻り値

解説

CMFCRibbonCategory::GetContextID

戻り値

解説

CMFCRibbonCategory::GetData

戻り値

CMFCRibbonCategory::GetDroppedDown

戻り値

解説

CMFCRibbonCategory::GetElements

パラメーター

解説

CMFCRibbonCategory::GetElementsByID

パラメーター

解説

CMFCRibbonCategory::GetFirstVisibleElement

戻り値

解説

CMFCRibbonCategory::GetFocused

戻り値

解説

CMFCRibbonCategory::GetHighlighted

戻り値

解説

CMFCRibbonCategory::GetImageCount

パラメーター

戻り値

解説

CMFCRibbonCategory::GetImageSize

パラメーター

戻り値

解説

CMFCRibbonCategory::GetItemIDsList

パラメーター

解説

CMFCRibbonCategory::GetLargeImages

戻り値

CMFCRibbonCategory::GetLastVisibleElement

戻り値

解説

CMFCRibbonCategory::GetMaxHeight

パラメーター

戻り値

解説

CMFCRibbonCategory::GetName

戻り値

解説

パブリックメソッド