BCGControlBar Pro for MFC
CBCGPBaseRibbonElementabstract

Detailed Description

The CBCGPBaseRibbonElement class is the base class for all objects (elements) that can be placed on Ribbon control. For example, ribbon buttons, ribbon check boxes, combo boxes are all ribbon elements. The base element contains basic properties like command ID, text label, tooltip text, element description, state (focused, highlighted, pressed, disabled, checked, dropped down).

A ribbon element, depending on its size, displays either small, or large image. The image type (size) is defined by RibbonImageType enumerator, which can be one of the following values:

  • RibbonImageLarge
  • RibbonImageSmall
+ Inheritance diagram for CBCGPBaseRibbonElement:

Public Types

enum  RibbonElementLocation
 

Public Member Functions

 CanBeAddedToContextMenuTells whether ribbon element can be added to context menu.
 
 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.
 
 GetRegularSizeReturns regular size 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.
 
 OnDrawCalled to draw ribbon element.
 
 OnShowPopupMenuCalled when ribbon element is going to display a popup menu.
 
 SetApplicationModesSets application modes where this control is visible.
 
 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.
 

Protected Member Functions

 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.