CBCGPToolbarButton

Detailed Description

CBCGPToolbarButton objects are non-Windows controls that reside on toolbars. Their behavior is similar to the regular buttons and they can be assigned an image and a text label. In addition, a toolbar button can have a command ID. This command is executed when the user clicks the button.

The CBCGPToolbarButton class can serve as a base class for more complicated toolbar button objects, like "menu button", "edit box button" or "combo box button".

Usually, toolbar buttons can be customized, the user is able to drag them from one toolbar to another, copy, paste, delete, edit text labels and images. If you want to make a toolbar button non-editable, you can lock the button or "protect" the button's command ID (SetProtectedCommands()).

The CBCGPToolbarButton objects display images from collections of toolbar images (CBCGPToolBarImages). These collections are maintained by a parent toolbar object (CBCGPToolBar). The parent toolbar manages an internal collection of toolbar buttons and notifies them about the user input.

When the user clicks a toolbar button:

• its parent toolbar processes the message
• changes the button's state
• asks the button to redraw itself according to the new state
• gives the button a chance to process this click
• notifies the parent frame window about a command to be executed, if the button has a valid command ID

See also

CBCGPToolBar, CBCGPToolBarImages, OnClick, NotifyCommand

Inheritance diagram for CBCGPToolbarButton:

Public Member Functions
	CBCGPToolbarButton	Constructs and initializes a CBCGPToolbarButton object.
	CanBeDropped	Indicates whether a button can be dropped on a toolbar.
	CanBeStretched	Indicates whether a button can be stretched in customization mode.
	CopyFrom	Copies another toolbar button to the button.
	ExportToMenuButton	Called by the framework to copy the toolbar button into a menu button.
	GetHwnd	Returns a handle to a window associated with a toolbar button.
	GetImage	Returns a toolbar button's image.
	GetTextSize	Returns the size (in pixels) of the button text.
	HaveHotBorder	Determines whether a button displays the border in selected state or not.
	IsDrawImage	Tells whether a button's image is displayed.
	IsDrawText	Tells whether a button's text label is displayed.
	IsEditable	Tells whether a button is customizable or not.
	IsExtraSize	Determines whether the border's extra size should be taken into account.
	IsHidden	Tells whether a button is hidden or not.
	IsLocked	Returns a flag indicating whether a button belongs to the locked (non-customizable) toolbar and can't be customized (dragged, dropped or edited).
	IsOnGlass	Checks if button is located on DWM ("Glass") area of the parent toolbar.
	IsVisible	Determines whether a toolbar button is visible or not.
	NotifyCommand	Called by the framework when the WM_COMMAND message is about to be send to a parent window.
	OnBeforeDrag	Called by the framework before user begins to drag the button.
	OnBeforeDrop	Called by the framework before button is dropped on target.
	OnCalculateSize	Called by the framework when it needs to determine the size of the toolbar button for the specified device context.
	OnChangeParentWnd	Called by the framework when a button is inserted into a toolbar.
	OnClick	Called by the framework when the user clicks the button.
	OnClickUp	Called by the framework when the user releases the toolbar button.
	OnContextHelp	Called by the framework when the parent toolbar processes the WM_HELPHITTEST message.
	OnCtlColor	Called by the framework when the parent toolbar processes OnCtlColor.
	OnDblClick	Called by the framework when the parent toolbar handles OnLButtonDblClk.
	OnDPIChanged	Called by the framework when the parent toolbar DPI is changed
	OnDraw	Called by the framework when the button is required to display itself.
	OnDrawOnCustomizeList	Called by the framework when the button is required to draw itself on the customize list in the customization dialog.
	OnGetCustomToolTipText	Called by the framework when it needs to display a tooltip for the toolbar button.
	OnGlobalFontsChanged	Called by the framework when the global font has been changed.
	OnMove	Called by the framework when the parent toolbar is moved.
	OnShow	Called by the framework to notify the button that it becomes visible or invisible.
	OnSize	Called by the framework to notify the button that its parent toolbar has changed its size and/or position and the button should resize itself accordingly.
	OnToolHitTest	Called by the framework when the parent toolbar needs to determine whether a point is in the bounding rectangle of the specified tool.
	Rect	Returns a buttons' bounding rectangle.
	SetImage	Sets a button's image.
	SetRadio	Called by the framework when a button changes its check state.
	SetRect	Sets a new button's bounding rectangle.
	SetStyle	Sets a new button's style.
	SetVisible	Shows or hides a toolbar button.
	Show	Makes a button visible or hidden.

Static Public Member Functions
	GetProtectedCommands	Returns a reference to CList object, which contains a collection of commands that can't be customized by the user.
	SetProtectedCommands	Sets a list of protected commands.

Public Attributes
	m_bImage	Indicates whether the image of the toolbar button is displayed or not.
	m_bText	Indicates whether the text label of the toolbar button is displayed or not.
	m_bTextBelow	Indicates whether the button's text label is displayed below the image.
	m_bUserButton	Indicates whether a button has the user-defined image (TRUE) or not (FALSE).
	m_bWholeText	Indicates whether a button displays full text label (TRUE), or clips the text and replace the rest by "..." if the text doesn't fit to the bounding rectangle.
	m_bWrap	If this flag is TRUE for a separator, the next to the separator button will be placed on the next row.
	m_nID	Contains the command ID of a button.
	m_nStyle	Contains the style of a toolbar button.
	m_strText	Contains the text label of a button.

Static Public Attributes
	m_bWrapText	If TRUE, enables multi-line text labels.