BCGControlBar Pro for MFC
CBCGPRibbonButtonsGroup

Detailed Description

The CBCGPRibbonButtonsGroup implements the functionality of a group of buttons. The group has a special layout behavior. It places buttons very close "side-by-side" and draws a border around the group. The group itself is derived from CBCGPBaseRibbonElement and can be manipulated as a single entity (placed on any panel, Quick Customize Toolbar or popup).

+ Inheritance diagram for CBCGPRibbonButtonsGroup:

Public Member Functions

 CBCGPRibbonButtonsGroupDefault constructor.
 
 AddButtonAdds a button to group.
 
 AddButtonsAdd buttons to group from list.
 
 GetButtonReturns a pointer to button located at the specified index.
 
 GetCountReturns the number of buttons in the group.
 
 RemoveAllRemoves all button from the group.
 
 SetImagesAssigns images to buttons in group.
 
- Public Member Functions inherited from CBCGPBaseRibbonElement
 CanBeAddedToQATTells whether ribbon element can be added to QAT.
 
 CanBeRemovedFromQATTells whether ribbon element can be removed from QAT.
 
 CanBeResizedInGroupVerticallyTells whether a ribbon element can be vertically resized in the parent group.
 
 GetApplicationModesGets application modes where this control is visible.
 
 GetBackstageAttachedViewReturns a ribbon element, which is placed at the right side of backstage and controlled by this ribbon element.
 
 GetCompactSizeReturns compact size of ribbon element.
 
 GetCursorAllows to specify a Ribbon control's custom mouse cursor.
 
 GetDataRetrieves a user-defined data associated with ribbon element.
 
 GetDescriptionReturns ribbon element description.
 
 GetIDReturns ribbon element command ID.
 
 GetImageSizeReturns image size of ribbon element.
 
 GetIntermediateSizeReturns the size of ribbon element in "intermediate" state.
 
 GetKeysReturns key tip associated with ribbon element.
 
 GetMenuKeysReturns key tips associated with split button.
 
 GetRectReturns bounding rectangle of ribbon element.
 
 GetSizeReturns current size of ribbon element.
 
 GetTextReturns ribbon element text.
 
 GetToolTipTextReturns tooltip text of ribbon element.
 
 HasCompactModeTells whether the ribbon element has "compact mode".
 
 HasIntermediateModeTells whether the ribbon element has "intermediate mode".
 
 HasLargeModeTells whether the ribbon element has "large mode".
 
 IsBackstageViewModeTells whether a ribbon element works in "backstage view" mode.
 
 IsCheckedTells whether ribbon element is checked.
 
 IsCompactModeTells whether ribbon element is in compact mode.
 
 IsDisabledTells whether ribbon element is disabled.
 
 IsDroppedDownTells whether ribbon element is dropped down (displays a popup menu).
 
 IsFocusedTells whether ribbon element is focused.
 
 IsHighlightedTells whether ribbon element is highlighted.
 
 IsPressedTells whether ribbon element is pressed.
 
 OnShowPopupMenuCalled when ribbon element is going to display a popup menu.
 
 SetDataAssociates a user-defined data with ribbon element.
 
 SetDescriptionSets ribbon element description.
 
 SetIDSets command ID of ribbon element.
 
 SetKeysSets a key tip for ribbon element.
 
 SetTextSets text to ribbon element.
 
 SetToolTipTextSets tooltip text for ribbon element.
 

Additional Inherited Members

- Public Types inherited from CBCGPBaseRibbonElement
enum  RibbonElementLocation
 
- Protected Member Functions inherited from CBCGPBaseRibbonElement
 OnBeforeDestroyParentMenuBarCalled by the framework before the parent menu windo is destroyed.
 
 OnProcessKeyCalled by the framework when a ribbon element should process keyboard input.
 
 OnSetFocusCalled by the framework when a ribbon element receives or loses the input focus.