CBCGPBaseRibbonElement

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
enum	RibbonImageType
enum	RibbonSimplifiedModeType

Public Member Functions
	CanBeAddedToContextMenu	Tells whether ribbon element can be added to context menu.
	CanBeAddedToQAT	Tells whether ribbon element can be added to QAT.
	CanBeRemovedFromQAT	Tells whether ribbon element can be removed from QAT.
	CanBeResizedInGroupVertically	Tells whether a ribbon element can be vertically resized in the parent group.
	GetApplicationModes	Gets application modes where this control is visible.
	GetBackstageAttachedView	Returns a ribbon element, which is placed at the right side of backstage and controlled by this ribbon element.
	GetCompactSize	Returns compact size of ribbon element.
	GetControlValue	Retrieves the ribbon control value
	GetCursor	Allows to specify a Ribbon control's custom mouse cursor.
	GetData	Retrieves a user-defined data associated with ribbon element.
	GetDescription	Returns ribbon element description.
	GetID	Returns ribbon element command ID.
	GetImageSize	Returns image size of ribbon element.
	GetIntermediateSize	Returns the size of ribbon element in "intermediate" state.
	GetKeys	Returns key tip associated with ribbon element.
	GetMenuKeys	Returns key tips associated with split button.
	GetRect	Returns bounding rectangle of ribbon element.
	GetRegularSize	Returns regular size of ribbon element.
	GetSimplifiedModeType	Retrieves a ribbon element appearance in the Ribbon simplified mode.
	GetSize	Returns current size of ribbon element.
	GetText	Returns ribbon element text.
	GetToolTipText	Returns tooltip text of ribbon element.
	HasCompactMode	Tells whether the ribbon element has "compact mode".
	HasIntermediateMode	Tells whether the ribbon element has "intermediate mode".
	HasLargeMode	Tells whether the ribbon element has "large mode".
	IsBackstageViewMode	Tells whether a ribbon element works in "backstage view" mode.
	IsChecked	Tells whether ribbon element is checked.
	IsCompactMode	Tells whether ribbon element is in compact mode.
	IsDisabled	Tells whether ribbon element is disabled.
	IsDroppedDown	Tells whether ribbon element is dropped down (displays a popup menu).
	IsFocused	Tells whether ribbon element is focused.
	IsHiddenInFullMode	Tells whether a ribbon element is invisible in the Ribbon classic (non-simplified) mode.
	IsHighlighted	Tells whether ribbon element is highlighted.
	IsPressed	Tells whether ribbon element is pressed.
	OnDPIChanged	Called by the framework when the Ribbon DPI is changed
	OnDraw	Called to draw ribbon element.
	OnShowPopupMenu	Called when ribbon element is going to display a popup menu.
	SetApplicationModes	Sets application modes where this control is visible.
	SetData	Associates a user-defined data with ribbon element.
	SetDescription	Sets ribbon element description.
	SetID	Sets command ID of ribbon element.
	SetKeys	Sets a key tip for ribbon element.
	SetSimplifiedModeType	Specifies a ribbon element appearance in the Ribbon simplified mode.
	SetText	Sets text to ribbon element.
	SetToolTipText	Sets tooltip text for ribbon element.

Protected Member Functions
	OnBeforeDestroyParentMenuBar	Called by the framework before the parent menu windo is destroyed.
	OnProcessKey	Called by the framework when a ribbon element should process keyboard input.
	OnSetFocus	Called by the framework when a ribbon element receives or loses the input focus.