CMFCRibbonButtonsGroup Class
The CMFCRibbonButtonsGroup class allows you to organize a set of ribbon buttons into a group. All buttons in the group are directly adjacent to each other horizontally and enclosed in a border.
class CMFCRibbonButtonsGroup : public CMFCRibbonBaseElement
| Name | Description |
|---|---|
| CMFCRibbonButtonsGroup::CMFCRibbonButtonsGroup | Constructs a CMFCRibbonButtonsGroup object. |
| Name | Description |
|---|---|
| CMFCRibbonButtonsGroup::AddButton | Adds a button to a group. |
| CMFCRibbonButtonsGroup::AddButtons | Adds a list of buttons to a group. |
| CMFCRibbonButtonsGroup::GetButton | Returns a pointer to the button that is located at a specified index. |
| CMFCRibbonButtonsGroup::GetCount | Returns the number of buttons in the group. |
| CMFCRibbonButtonsGroup::GetImageSize | Returns the image size of the normal images in the ribbon group (overrides CMFCRibbonBaseElement::GetImageSize.) |
| CMFCRibbonButtonsGroup::GetRegularSize | Returns the regular size of the ribbon element (overrides CMFCRibbonBaseElement::GetRegularSize.) |
| CMFCRibbonButtonsGroup::HasImages | Reports whether the CMFCRibbonButtonsGroup object contains toolbar images. |
| CMFCRibbonButtonsGroup::OnDrawImage | Draws the appropriate image for a specified button, depending on whether the button is normal, highlighted or disabled. |
| CMFCRibbonButtonsGroup::RemoveAll | Removes all buttons from the CMFCRibbonButtonsGroup object. |
| CMFCRibbonButtonsGroup::SetImages | Assigns images to the group. |
| CMFCRibbonButtonsGroup::SetParentCategory | Sets the parent CMFCRibbonCategory of the CMFCRibbonButtonsGroup object and all the buttons within it (overrides CMFCRibbonBaseElement::SetParentCategory.) |
The group is derived from CMFCBaseRibbonElement and can be manipulated as a single entity. You can position the group on any panel or popup menu.
The following example demonstrates how to use various methods in the CMFCRibbonButtonsGroup class. The example shows how to construct a CMFCRibbonButtonsGroup object, assign images to the group of ribbon buttons, and add a button to the group of ribbon buttons. This code snippet is part of the Draw Client sample.
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"));
Header: afxribbonbuttonsgroup.h
Adds a button to a group.
void AddButton(CMFCRibbonBaseElement* pButton);
pButton
[in] A pointer to a button to add.
Adds a list of buttons to a group.
void AddButtons(
const CList<CMFCRibbonBaseElement*,CMFCRibbonBaseElement*>& lstButtons);
lstButtons
[in] A list of pointers to the buttons that you want to add.
Constructs a CMFCRibbonButtonsGroup object.
CMFCRibbonButtonsGroup();
CMFCRibbonButtonsGroup(CMFCRibbonBaseElement* pButton);
pButton
[in] Specifies a button to add to the newly created CMFCRibbonButtonsGroup object.
Returns a pointer to the button that is located at a specified index.
CMFCRibbonBaseElement* GetButton(int i) const;
i
[in] A zero-based index of a button to return.
A pointer to the button that is located at the specified index. NULL if the specified index is out of range.
Returns the number of buttons in the group.
int GetCount() const;
The number of buttons in the group.
Retrieves the source image size of the protected CMFCToolBarImages member m_Images.
const CSize GetImageSize() const;
Returns the source image size of the toolbar images, if any are present, or a CSize of zero if not.
Retrieves the maximum possible size of the ribbon group element.
virtual CSize GetRegularSize(CDC* pDC);
pDC
[in] Pointer to the device context of the ribbon group.
Reports whether the CMFCRibbonButtonsGroup object contains toolbar images.
BOOL HasImages() const;
Returns TRUE if the protected CMFCToolBarImages member m_Images contains any images, or FALSE if not.
Draws the appropriate image for a specified button, depending on whether the button is normal, highlighted or disabled.
virtual void OnDrawImage(
CDC* pDC,
CRect rectImage,
CMFCRibbonBaseElement* pButton,
int nImageIndex);
pDC
[in] Pointer to the device context of the CMFCRibbonButtonsGroup object.
rectImage
[in] The rectangle within which to draw the image.
pButton
[in] The button for which to draw the image.
nImageIndex
[in] The index of the image to draw on the button (in one of the three image arrays for normal, highlighted or disabled buttons).
Removes all buttons from the CMFCRibbonButtonsGroup object.
void RemoveAll();
Assigns images to the group of ribbon buttons.
void SetImages(
CMFCToolBarImages* pImages,
CMFCToolBarImages* pHotImages,
CMFCToolBarImages* pDisabledImages);
pImages
[in] Regular images.
pHotImages
[in] Hot images.
pDisabledImages
[in] Disabled images.
Call SetImages before you add buttons to a group. The number of images must be greater or equal to the number of buttons to be added to the group.
Note
Hot images are images that are displayed when the user hovers over the button. Disabled images are images that are displayed when the button is disabled.
Sets the parent CMFCRibbonCategory of the CMFCRibbonButtonsGroup object and all the buttons within it.
virtual void SetParentCategory(CMFCRibbonCategory* pCategory);
pCategory
[in] Pointer to the parent category to set (the tabbed groups in ribbon controls are called categories).