Класс CMFCRibbonButtonsGroup

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

Синтаксис

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 и может управляться как единая сущность. Группу можно разместить на любой панели или всплывающем меню.

Пример

В приведенном ниже примере демонстрируется использование различных методов класса CMFCRibbonButtonsGroup . В примере показано, как создать CMFCRibbonButtonsGroup объект, назначить изображения группе кнопок ленты и добавить кнопку в группу кнопок ленты. Этот фрагмент кода входит в состав примера Draw Client.

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"));

Иерархия наследования

CObject

CMFCRibbonBaseElement

CMFCRibbonButtonsGroup

Требования

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

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

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

Замечания

CMFCRibbonButtonsGroup::GetCount

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

int GetCount() const;

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

Количество кнопок в группе.

CMFCRibbonButtonsGroup::GetImageSize

Извлекает исходный размер образа защищенного CMFCToolBarImages элемента m_Images.

const CSize GetImageSize() const;

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

Возвращает размер исходного изображения изображений панели инструментов, если они присутствуют, или CSize нулевое значение, если нет.

Замечания

CMFCRibbonButtonsGroup::GetRegularSize

Извлекает максимальный размер элемента группы ленты.

virtual CSize GetRegularSize(CDC* pDC);

Параметры

pDC
[in] Указатель на контекст устройства группы ленты.

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

Замечания

CMFCRibbonButtonsGroup::HasImages

Сообщает, содержит ли CMFCRibbonButtonsGroup объект изображения панели инструментов.

BOOL HasImages() const;

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

Возвращает значение TRUE, если защищенный CMFCToolBarImages член m_Images содержит любые изображения или false, если нет.

Замечания

CMFCRibbonButtonsGroup::OnDrawImage

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

virtual void OnDrawImage(
    CDC* pDC,
    CRect rectImage,
    CMFCRibbonBaseElement* pButton,
    int nImageIndex);

Параметры

pDC
[in] Указатель на контекст CMFCRibbonButtonsGroup устройства объекта.

rectImage
[in] Прямоугольник, в котором нужно нарисовать изображение.

pButton
[in] Кнопка, для которой нужно нарисовать изображение.

nImageIndex
[in] Индекс изображения, нарисованного на кнопке (в одном из трех массивов изображений для обычных, выделенных или отключенных кнопок).

Замечания

CMFCRibbonButtonsGroup::RemoveAll

Удаляет все кнопки из CMFCRibbonButtonsGroup объекта.

void RemoveAll();

Замечания

CMFCRibbonButtonsGroup::SetImages

Назначает изображения группе кнопок ленты.

void SetImages(
    CMFCToolBarImages* pImages,
    CMFCToolBarImages* pHotImages,
    CMFCToolBarImages* pDisabledImages);

Параметры

pImages
[in] Обычные изображения.

pHotImages
[in] Горячие изображения.

pDisabledImages
[in] Отключенные изображения.

Замечания

Вызов SetImages перед добавлением кнопок в группу. Число изображений должно быть больше или равно количеству кнопок, добавляемых в группу.

Примечание.

Горячие изображения — это изображения, отображаемые при наведении указателя мыши на кнопку. Отключенные изображения — это изображения, отображаемые при отключении кнопки.

CMFCRibbonButtonsGroup::SetParentCategory

Задает родительский CMFCRibbonButtonsGroup объект CMFCRibbonCategory и все кнопки внутри него.

virtual void SetParentCategory(CMFCRibbonCategory* pCategory);

Параметры

pCategory
[in] Указатель на родительскую категорию для задания (группы с вкладками в элементах управления лентами называются категориями).

Замечания

См. также

Диаграмма иерархии
Классы