BCGControlBar Pro for MFC
CBCGPRibbonQuickStepsButton

Detailed Description

The class CBCGPRibbonQuickStepsButton implements Office-style Ribbon Quick Steps control.

+ Inheritance diagram for CBCGPRibbonQuickStepsButton:

Public Member Functions

 CBCGPRibbonQuickStepsButtonConstructor.
 
 CBCGPRibbonQuickStepsButtonConstructor.
 
 AddQuickStepAdds a quick step.
 
- Public Member Functions inherited from CBCGPRibbonPaletteButton
 CBCGPRibbonPaletteButtonConstructs a ribbon palette button (gallery) object.
 
 CBCGPRibbonPaletteButtonConstructs a ribbon palette button (gallery) object.
 
 CBCGPRibbonPaletteButtonConstructs a ribbon palette button (gallery) object.
 
 AddGroupAdds a new group to the gallery.
 
 AddGroupAdds a new group to the gallery.
 
 AddGroupAdds a new group to the gallery.
 
 AddSubItemAdds a new menu item to the drop down popup menu.
 
 ClearClears the palette (gallery) content.
 
 EnableItemCheckBoxesEnables or disables gallery item check boxes.
 
 EnableItemTextLabelsEnables or disables Ribbon Gallery items text labels.
 
 EnableMenuResizeEnables or disables resizing of panel.
 
 EnablMenuSideBarEnables or disables Office XP-style side bar at the left of popup.
 
 GetCheckBoxLocationGets Ribbon Gallery item check box location.
 
 GetGroupNameReturns the name of group located at the specified index.
 
 GetIconsInRowReturns a number of items in row.
 
 GetItemToolTipReturns a tooltip text assigned to a palette item.
 
 GetItemUserDataRetrieves an user-defined data asociated with the gallery item.
 
 GetPaletteIDReturns the current palette Command ID.
 
 GetSelectedItemGets a currently selected item.
 
 GetTextLabelColorGets text label color.
 
 GetTextLabelLocationGets text label location.
 
 IsButtonModeTells whether the palette button works in button, or in-place gallery mode.
 
 IsCheckBoxOverlapsIconTells whether a Ribbon Gallery item check boxes are drawing over the icon.
 
 IsComboModeTells whether the galley has a combo mode.
 
 IsItemCheckBoxesEnabledTells whether a Ribbon Gallery items have check boxes.
 
 IsItemTextLabelsEnabledTells whether Ribbon Gallery items text labels are enabled.
 
 IsMenuResizeEnabledTells whether menu resizing is enabled, or disabled.
 
 IsMenuSideBarTells whether the Office XP-style side bar is enabled or disabled.
 
 IsShowSelectedImageTells whether to show the selected image instead of default in the button.
 
 RedrawIconsRedraws the palette (gallery).
 
 RemoveItemToolTipsRemoves tooltips from all palette items.
 
 SelectItemSelect an item.
 
 SetButtonModeSets the palette (gallery) button mode.
 
 SetGroupNameSets the group name.
 
 SetIconsInRowDefines number of items in palette row.
 
 SetItemToolTipSets a tooltip for a palette item.
 
 SetItemUserDataSet user data associated with the gallery item.
 
 SetPaletteAttaches a palette (gallery) to the ribbon palette button.
 
 SetPaletteAttaches a palette (gallery) to the ribbon palette button.
 
 SetPaletteIDDefines a Command ID, which is being sent along with WM_COMMAND, when a palette item has been selected.
 
 ShowSelectedImageSpecifies whether to display the selected image in the gallery button.
 
- Public Member Functions inherited from CBCGPRibbonButton
 CBCGPRibbonButtonConstruct ribbon button object.
 
 CBCGPRibbonButtonConstruct ribbon button object.
 
 CBCGPRibbonButtonConstruct ribbon button object.
 
 AddSubItemAllows to create a popup menu on the fly by dynamically adding new ribbon elements.
 
 ClosePopupDlgCalled by the framework when the popup dialog is closed.
 
 EnablePopupDialogEnables the popup dialog associated with this button.
 
 EnablePopupDialogEnables the popup dialog associated with this button.
 
 FindSubItemIndexByIDReturns index of sub-item by its command ID.
 
 GetImageIndexReturns button's image index in associated image list.
 
 GetMenuReturns a handle to Windows menu assigned to button.
 
 IsDefaultCommandTells whether button can execute its default command.
 
 IsRightAlignMenuTells whether the menu is right aligned, or not.
 
 OnBeforeShowPopupDlgCalled by the framework before the popup dialog is displayed.
 
 OnClickCalled by the framework when user clicks a button.
 
 RemoveAllSubItemsRemoves all menu items from popup menu.
 
 RemoveSubItemRemoves a sub-item.
 
 SetAlwaysLargeImageEnables or disables transition to collapsed state.
 
 SetDefaultCommandTells the button that it can execute its default command.
 
 SetImageIndexSets button's image index in associated image list.
 
 SetMenuAssigns a popup menu to ribbon button.
 
 SetMenuAssigns a popup menu to ribbon button.
 
 SetRightAlignMenuSets popup menu alignment.
 
- Public Member Functions inherited from CBCGPBaseRibbonElement
 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.
 
 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.
 
 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.
 
 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.
 
 IsFocusedTells whether ribbon element is focused.
 
 IsHighlightedTells whether ribbon element is highlighted.
 
 IsPressedTells whether ribbon element is pressed.
 
 SetDataAssociates a user-defined data with ribbon element.
 
 SetIDSets command ID of ribbon element.
 
 SetKeysSets a key tip for ribbon element.
 
 SetToolTipTextSets tooltip text for ribbon element.
 

Additional Inherited Members

- Public Types inherited from CBCGPRibbonPaletteButton
enum  RibbonPalleteCheckboxLocation
 
enum  RibbonPalleteTextLabelLocation
 
- Public Types inherited from CBCGPBaseRibbonElement
enum  RibbonElementLocation
 
- Static Public Member Functions inherited from CBCGPRibbonPaletteButton
 GetLastSelectedItemReturns index of item that was selected last time when user selected an item in popup palette.
 
- 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.