BCGControlBar Pro for MFC: CBCGPRibbonMainButton

Detailed Description

The Ribbon Main Button (CBCGPRibbonMainButton) is a special button located in the left top corner of application window and displays a menu, which usually contains "File" command like Open, Save, Exit.

You can initialize and set the main ribbon button as following:

Copy

m_MainButton.SetMenu(IDR_FILE_MENU);
m_MainButton.SetImage(IDB_MAIN);
m_MainButton.SetToolTipText(_T("File"));
m_wndRibbonBar.SetMainButton(&m_MainButton, CSize(45, 45));

Inheritance diagram for CBCGPRibbonMainButton:

Public Member Functions
	CBCGPRibbonMainButton	Constructs main ribbon button object.

	CBCGPRibbonMainButton	Constructs main ribbon button object.

	GetScenicImage	Returns scenic image.

	GetScenicText	Returns text displayed by Main Ribbon Button in scenic mode.

	SetImage	Assigns a new image to main ribbon button.

	SetImage	Assigns a new image to main ribbon button.

	SetScenicImage	Sets resource ID or handle of image used in scenic mode.

	SetScenicImage	Sets resource ID or handle of image used in scenic mode.

	SetScenicText	Sets text for Main Ribbon Button (pearl) to be displayed in scenic mode.

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.

	OnClick	Called by the framework when user clicks a button.

	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 CBCGPBaseRibbonElement
enum	RibbonElementLocation

enum	RibbonImageType

enum	RibbonSimplifiedModeType

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.

	OnSetFocus	Called by the framework when a ribbon element receives or loses the input focus.

Detailed Description

Public Member Functions

Additional Inherited Members