CBCGPRibbonUndoButton

Detailed Description

The CBCGPRibbonUndoButton class implements the functionality of a split button with drop down list. It is possible to select a couple of actions from this list and execute ("undo" or "redo") all of them. If the button itself is clicked, then only one (last added) action should be executed. In fact, the button acts as LIFO stack.

Call AddUndoAction() to add a new action to stack. Call GetActionNumber() to determine how many actions to execute have been selected by user. CleanUpUndoList() removes all actions from the stack.

See also

CBCGPRibbonButton

Inheritance diagram for CBCGPRibbonUndoButton:

Public Member Functions
	CBCGPRibbonUndoButton	The constructor.
	CBCGPRibbonUndoButton
	AddUndoAction	Adds a new action to the list.
	CleanUpUndoList	Removes all actions from the action list.
	GetActionNumber	Returns the number of actions selected by the user.
Public Member Functions inherited from CBCGPRibbonPaletteButton
	CBCGPRibbonPaletteButton	Constructs a ribbon palette button (gallery) object.
	CBCGPRibbonPaletteButton	Constructs a ribbon palette button (gallery) object.
	CBCGPRibbonPaletteButton	Constructs a ribbon palette button (gallery) object.
	AddGroup	Adds a new group to the gallery.
	AddGroup	Adds a new group to the gallery.
	AddGroup	Adds a new group to the gallery.
	AddSubItem	Adds a new menu item to the drop down popup menu.
	Clear	Clears the palette (gallery) content.
	EnableAutoLightIcons	Enables or disables the gallery icons colors lighting in the dark themes.
	EnableItemCheckBoxes	Enables or disables gallery item check boxes.
	EnableItemTextLabels	Enables or disables Ribbon Gallery items text labels.
	EnableMenuResize	Enables or disables resizing of panel.
	EnablMenuSideBar	Enables or disables Office XP-style side bar at the left of popup.
	GetCheckBoxLocation	Gets Ribbon Gallery item check box location.
	GetGroupName	Returns the name of group located at the specified index.
	GetIconsInRow	Returns a number of items in row.
	GetItemToolTip	Returns a tooltip text assigned to a palette item.
	GetItemUserData	Retrieves an user-defined data asociated with the gallery item.
	GetPaletteID	Returns the current palette Command ID.
	GetSelectedItem	Gets a currently selected item.
	GetTextLabelColor	Gets text label color.
	GetTextLabelLocation	Gets text label location.
	IsAutoLightIcons	Tells whether the gallery icons colors are automatically changed in the dark themes.
	IsButtonMode	Tells whether the palette button works in button, or in-place gallery mode.
	IsCalcIconPositions	Tells whether the gallery item relative positions (e.g., first in the column) should calculated.
	IsCheckBoxOverlapsIcon	Tells whether a Ribbon Gallery item check boxes are drawing over the icon.
	IsComboMode	Tells whether the galley has a combo mode.
	IsItemCheckBoxesEnabled	Tells whether a Ribbon Gallery items have check boxes.
	IsItemTextLabelsEnabled	Tells whether Ribbon Gallery items text labels are enabled.
	IsMenuResizeEnabled	Tells whether menu resizing is enabled, or disabled.
	IsMenuSideBar	Tells whether the Office XP-style side bar is enabled or disabled.
	IsShowSelectedImage	Tells whether to show the selected image instead of default in the button.
	RedrawIcons	Redraws the palette (gallery).
	RemoveItemToolTips	Removes tooltips from all palette items.
	SelectItem	Select an item.
	SetButtonMode	Sets the palette (gallery) button mode.
	SetCalcIconPositions	Specifies whether the gallery item relative positions (e.g., first in the column) should calculated.
	SetGroupName	Sets the group name.
	SetIconsInRow	Defines number of items in palette row.
	SetItemToolTip	Sets a tooltip for a palette item.
	SetItemUserData	Set user data associated with the gallery item.
	SetPalette	Attaches a palette (gallery) to the ribbon palette button.
	SetPalette	Attaches a palette (gallery) to the ribbon palette button.
	SetPaletteID	Defines a Command ID, which is being sent along with WM_COMMAND, when a palette item has been selected.
	ShowSelectedImage	Specifies whether to display the selected image in the gallery button.
Public Member Functions inherited from CBCGPRibbonButton
	CBCGPRibbonButton	Construct ribbon button object.
	CBCGPRibbonButton	Construct ribbon button object.
	CBCGPRibbonButton	Construct ribbon button object.
	AddSubItem	Allows to create a popup menu on the fly by dynamically adding new ribbon elements.
	ClosePopupDlg	Called by the framework when the popup dialog is closed.
	EnablePopupDialog	Enables the popup dialog associated with this button.
	EnablePopupDialog	Enables the popup dialog associated with this button.
	FindSubItemIndexByID	Returns index of sub-item by its command ID.
	GetImageIndex	Returns button's image index in associated image list.
	GetMenu	Returns a handle to Windows menu assigned to button.
	IsDefaultCommand	Tells whether button can execute its default command.
	IsRightAlignMenu	Tells whether the menu is right aligned, or not.
	OnBeforeShowPopupDlg	Called by the framework before the popup dialog is displayed.
	RemoveAllSubItems	Removes all menu items from popup menu.
	RemoveSubItem	Removes a sub-item.
	SetAlwaysLargeImage	Enables or disables transition to collapsed state.
	SetDefaultCommand	Tells the button that it can execute its default command.
	SetImageIndex	Sets button's image index in associated image list.
	SetMenu	Assigns a popup menu to ribbon button.
	SetMenu	Assigns a popup menu to ribbon button.
	SetRightAlignMenu	Sets popup menu alignment.
Public Member Functions inherited from CBCGPBaseRibbonElement
	CanBeRemovedFromQAT	Tells whether ribbon element can be removed from QAT.
	GetApplicationModes	Gets application modes where this control is visible.
	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.
	GetKeys	Returns key tip associated with ribbon element.
	GetMenuKeys	Returns key tips associated with split button.
	GetRect	Returns bounding rectangle 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.
	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.
	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.
	SetData	Associates a user-defined data with ribbon element.
	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.
	SetToolTipText	Sets tooltip text for ribbon element.

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