BCGControlBar Pro for MFC

Detailed Description

The CBCGPRibbonCategory class implements the functionality of a logical entity containing a group of panels. The visual representation of Ribbon Category is a Ribbon Tab (CBCGPRibbonTab, which in its turn derived from CBCGPBaseRibbonElement).

Ususally you create Ribbon Categories indirectly using CBCGPRibbonBar::AddCategory, which returns a pointer to the newly created category. After that you can set up the category by adding new panels (CBCGPRibbonCategory::AddPanel).


CBCGPRibbonCategory* 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)
CBCGPRibbonPanel* pPanel = pCategory->AddPanel(
_T("Clipboard"), // Panel name
m_PanelIcons.ExtractIcon(0)); // Panel icon
+ Inheritance diagram for CBCGPRibbonCategory:

Public Member Functions

 AddHiddenAdds a hidden element to category.
 AddPanelAdds a new panel to category.
 AddPanelAdds a new panel to category.
 EnableScrollEnables or disables the Ribbon category scrolling.
 GetApplicationModesGets application modes where this category (tab) is visible.
 GetContextIDReturns context ID of category.
 GetDataReturns user-defined data associated with category.
 GetLargeImagesReturns a reference to list of category large images.
 GetPanelReturns a panel located at the specified index in the list of panels.
 GetPanelCountReturns the number of panels in category.
 GetPanelIndexGiven a pointer to a ribbon panel returns its index.
 GetSmallImagesReturns a reference to list of category small images.
 GetTabColorReturns the current tab color.
 IsScrollEnabledTells whether the Ribbon category scrolling is enabled.
 IsVisibleTells whether category is visible, or not.
 RemovePanelRemoves a panel from a Ribbon Category.
 SetApplicationModesSets application modes where this category (tab) is visible.
 SetCollapseOrderDefines the collapse order of category.
 SetDataAssociates user-defined-data with category.
 SetKeysAssigns a key tip for category.
 SetTabColorSets ribbon tab color (usually used for context tabs).

Protected Member Functions

 CBCGPRibbonCategoryConstructs a category object.
 CBCGPRibbonCategoryConstructs a category object.