次の方法で共有


CMFCRibbonCategory クラス

このクラスは 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 サンプル アプリケーションのホーム カテゴリの図を示しています。

Home category from the RibbonApp sample application.

継承階層

CObject

CMFCRibbonCategory

必要条件

ヘッダー: 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 必要があります。

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

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

// 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。検索でクイック アクセス リボン要素を除外する FAL Standard Edition。

戻り値

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

解説

CMFCRibbonCategory::FindByID

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

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

パラメーター

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

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

戻り値

メソッドが成功した場合のリボン要素へのポインター。それ以外の場合は 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。FAL Standard Edition小さな画像リスト内の画像の数。

戻り値

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

解説

CMFCRibbonCategory::GetImageSize

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

CSize GetImageSize(BOOL bIsLargeImage) const;

パラメーター

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

戻り値

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

解説

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

CMFCRibbonCategory::GetItemIDsList

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

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

パラメーター

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

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

解説

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。FAL Standard Edition リボン パネルのキャプションを除外します。

戻り値

メソッドが成功した場合のリボン要素へのポインター。それ以外の場合は 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。それ以外の場合は FAL Standard Edition。

解説

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

CMFCRibbonCategory::IsVisible

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

BOOL IsVisible() const;

戻り値

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

解説

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

CMFCRibbonCategory::IsWindows7Look

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

BOOL IsWindows7Look() const;

戻り値

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

解説

CMFCRibbonCategory::NotifyControlCommand

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

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

パラメーター

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

nNotifyCode
[入力] 通知コード。

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

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

戻り値

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

解説

CMFCRibbonCategory::OnCancelMode

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

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。FAL Standard Editionイメージが小さい場合。

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

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

戻り値

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

解説

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。FAL Standard Editionレイアウトが左から右の場合。

解説

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

CMFCRibbonCategory::OnScrollHorz

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

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

パラメーター

bScrollLeft
[in]TRUE の場合は左にスクロールします。FAL Standard Edition右にスクロールします。

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

戻り値

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

解説

CMFCRibbonCategory::OnUpdateCmdUI

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

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

パラメーター

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

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

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

解説

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。FAL Standard Editionパネルオブジェクトを削除せずに削除します。

戻り値

メソッドが成功した場合は 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 つメイン表示されていないパネル。

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

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

関連項目

階層図
クラス
CObject クラス