Класс CMFCRibbonCategory

Класс CMFCRibbonCategory реализует вкладку ленты, содержащую группу панелей ленты.

Синтаксис

class CMFCRibbonCategory : public CObject

Участники

Защищенные конструкторы

Имя Описание
CMFCRibbonCategory::CMFCRibbonCategory Конструктор.

Открытые методы

Имя Описание
CMFCRibbonCategory::AddHidden Добавляет скрытый элемент в категорию ленты.
CMFCRibbonCategory::AddPanel Добавляет новую панель в категорию ленты.
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::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] Идентификатор ресурса списка изображений для небольших изображений, используемых элементами ленты в категории ленты.

uiLargeImagesResID
[in] Идентификатор ресурса списка изображений для больших изображений, используемых элементами ленты в категории ленты.

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

Извлекает элемент ленты, связанный с указанным идентификатором команды.

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

Параметры

uiCmdID
[in] Идентификатор команды, связанный с элементом ленты.

bVisibleOnly
[in] ЗНАЧЕНИЕ TRUE для включения элементов ленты быстрого доступа в поиск; ЗНАЧЕНИЕ FALSE, чтобы исключить элементы ленты быстрого доступа в поиске.

Возвращаемое значение

Указатель на элемент ленты, если метод выполнен успешно; в противном случае ЗНАЧЕНИЕ NULL.

Замечания

CMFCRibbonCategory::FindPanelWithElem

Извлекает панель ленты, содержащую указанный элемент ленты.

CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);

Параметры

pElement
[in] Указатель на элемент ленты.

Возвращаемое значение

Указатель на панель ленты, если метод выполнен успешно; в противном случае ЗНАЧЕНИЕ NULL.

Замечания

CMFCRibbonCategory::GetContextID

Извлекает идентификатор контекста категории ленты.

UINT GetContextID() const;

Возвращаемое значение

Идентификатор контекста категории ленты.

Замечания

Идентификатор контекста равен 0, если категория ленты не является категорией контекстной ленты.

CMFCRibbonCategory::GetData

Извлекает определяемые пользователем данные, связанные с категорией ленты.

DWORD_PTR GetData() const;

Возвращаемое значение

Определяемые пользователем данные, связанные с категорией ленты.

CMFCRibbonCategory::GetDroppedDown

Извлекает указатель на элемент ленты, который в настоящее время отображает всплывающее меню.

CMFCRibbonBaseElement* GetDroppedDown();

Возвращаемое значение

Указатель на элемент ленты, если метод выполнен успешно; в противном случае ЗНАЧЕНИЕ NULL.

Замечания

CMFCRibbonCategory::GetElements

Извлекает все элементы ленты в категории ленты.

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

Параметры

arElements
[in, out] Ссылка на CArray элементов ленты.

Замечания

Элементы ленты, предназначенные для использования на панели быстрого доступа, включены в массив.

CMFCRibbonCategory::GetElementsByID

Извлекает все элементы ленты, связанные с указанным идентификатором команды.

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

Параметры

uiCmdID
[in] Идентификатор команды, связанный с элементом ленты.

arElements
[in, out] Ссылка на 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

Извлекает идентификаторы команд для элементов ленты, содержащихся в категории ленты.

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

Параметры

lstItems
[out] Список идентификаторов команд для элементов ленты в категории ленты.

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] Отсчитываемый от нуля индекс панели ленты.

Возвращаемое значение

Указатель на панель ленты, расположенную по указанному индексу.

Замечания

Исключение возникает, если nIndex выходит за пределы диапазона.

CMFCRibbonCategory::GetPanelCount

Возвращает количество панелей ленты в категории ленты.

int GetPanelCount() const;

Возвращаемое значение

Количество панелей ленты в категории ленты.

CMFCRibbonCategory::GetPanelFromPoint

Извлекает указатель на панель ленты, если указанная точка находится в ней.

CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;

Параметры

point
[in] Координаты x и y указателя относительно левого верхнего угла окна.

Возвращаемое значение

Указатель на панель ленты, если метод выполнен успешно; в противном случае ЗНАЧЕНИЕ NULL.

Замечания

Тестируются только панели ленты, содержащиеся в категории ленты.

CMFCRibbonCategory::GetPanelIndex

Извлекает отсчитываемый от нуля индекс указанной панели ленты.

int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;

Параметры

pPanel
[in] Указатель на панель ленты.

Возвращаемое значение

Отсчитываемый от нуля индекс указанной панели ленты, если метод выполнен успешно; в противном случае - 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

Извлекает отсчитываемый от нуля индекс элемента ленты, если указанная точка находится в ней.

int HitTestEx(CPoint point) const;

Параметры

point
[in] Координаты указателя мыши x и y относительно левого верхнего угла окна.

Возвращаемое значение

Отсчитываемый от нуля индекс элемента ленты, если метод выполнен успешно; в противном случае - 1.

Замечания

Тестируются только элементы ленты, содержащиеся в категории ленты.

CMFCRibbonCategory::HitTestScrollButtons

Если точка попадает в левую или правую кнопку прокрутки ленты, возвращает указатель на эту кнопку.

CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;

Параметры

point
[in] Точка для проверки.

Возвращаемое значение

Если точка попадает в ограничивающий прямоугольник левой или правой кнопки прокрутки категории ленты, возвращает указатель на эту кнопку или возвращает значение NULL.

Замечания

CMFCRibbonCategory::IsActive

Указывает, является ли категория ленты активной категорией на панели ленты.

BOOL IsActive() const;

Возвращаемое значение

ЗНАЧЕНИЕ TRUE, если категория ленты является активной категорией; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

В активной категории ленты отображаются панели ленты.

CMFCRibbonCategory::IsVisible

Указывает, отображается ли категория ленты.

BOOL IsVisible() const;

Возвращаемое значение

ЗНАЧЕНИЕ TRUE, если категория ленты видна; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

Категории ленты, которые отображаются на вкладке категорий.

CMFCRibbonCategory::IsWindows7Look

Указывает, имеет ли родительская лента вид Windows 7 (небольшая прямоугольная кнопка приложения).

BOOL IsWindows7Look() const;

Возвращаемое значение

ЗНАЧЕНИЕ TRUE, если родительская лента имеет вид Windows 7; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonCategory::NotifyControlCommand

Доставляет сообщение команды WM_NOTIFY всем CMFCRibbonPanel элементам в сообщении CMFCRibbonCategory , пока сообщение не будет обработано.

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

Параметры

bAccelerator
[in] Значение TRUE, если эта команда возникла из акселератора или FALSE.

nNotifyCode
[in] Код уведомления.

wParam
[in] Поле WPARAM сообщения.

lParam
[in] Поле LPARAM сообщения.

Возвращаемое значение

Возвращает значение TRUE, если сообщение было обработано или false, если нет.

Замечания

CMFCRibbonCategory::OnCancelMode

Вызывает режим отмены во всех CMFCRibbonPanel элементах CMFCRibbonCategory.

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] Отсчитываемый от нуля индекс изображения в массиве изображений, который содержится в категории ленты.

bCenter
[in] ЗНАЧЕНИЕ TRUE для центра изображения в прямоугольнике отображения; Значение FALSE для рисования изображения в левом верхнем углу прямоугольника отображения.

Возвращаемое значение

ЗНАЧЕНИЕ TRUE, если метод выполнен успешно; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonCategory::OnDrawMenuBorder

Вызывается платформой для рисования границы всплывающего меню.

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

Параметры

pDC
[in] Этот параметр не используется.

pMenuBar
[in] Этот параметр не используется.

Замечания

По умолчанию этот метод ничего не делает. Переопределите этот метод, чтобы нарисовать границу всплывающего меню.

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

OnUpdateCmdUI Вызывает функцию-член в каждом из CMFCRibbonPanel элементов элемента, чтобы включить или отключить элементы пользовательского CMFCRibbonCategory интерфейса в них.

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, 0, 2, 2. В этом случае категория свернет панель 0 два раза, панель 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] Имя и подсказка для категории ленты.

Замечания

Чтобы задать подсказку для категории ленты, добавьте новую строку escape-последовательности, за которой следует символы клавиши 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