CBCGPToolbarEditBoxButton

Detailed Description

The CBCGPToolbarEditBoxButton class provide the functionality that allows to put Windows edit control boxes on toolbars created using BCGControlBar Library framework.

To use edit box buttons in the application:

• Prepare a toolbar with a specific command
• In CMainFrame::OnToolbarReset (BCGM_RESETTOOLBAR handler) construct a CBCGPToolbarEditBoxButton object and replace the specific button with the new combo button using CBCGPToolBar::ReplaceButton.

See also

CBCGPToolbarButton

Inheritance diagram for CBCGPToolbarEditBoxButton:

Public Member Functions
	CBCGPToolbarEditBoxButton	Constructs a CBCGPToolbarEditBoxButton object.
	CreateEdit	Creates the Windows edit control and attaches it to the CBCGPToolbarEditBoxButton object
	GetEditBox	Returns a pointer the edit control.
	GetPrompt	Returns a prompt (displayed when the combo box text is empty).
	GetText	Retrieves the edit box text.
	SetContents	Sets the specified text within a button's edit control box.
	SetPrompt	Sets a prompt displayed when the edit box text is empty.
	SetStyle	Called to set a new style.
Public Member Functions inherited from CBCGPToolbarButton
	CBCGPToolbarButton	Constructs and initializes a CBCGPToolbarButton object.
	CanBeDropped	Indicates whether a button can be dropped on a toolbar.
	ExportToMenuButton	Called by the framework to copy the toolbar button into a menu button.
	GetImage	Returns a toolbar button's image.
	GetTextSize	Returns the size (in pixels) of the button text.
	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.
	OnBeforeDrag	Called by the framework before user begins to drag the button.
	OnBeforeDrop	Called by the framework before button is dropped on target.
	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.
	OnDblClick	Called by the framework when the parent toolbar handles OnLButtonDblClk.
	OnGetCustomToolTipText	Called by the framework when it needs to display a tooltip for the toolbar button.
	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.
	SetVisible	Shows or hides a toolbar button.
	Show	Makes a button visible or hidden.

Static Public Member Functions
	SetContentsAll	Given a command ID looks for a CBCGPToolbarEditBoxButton object and sets the text within its edit control.
Static Public Member Functions inherited from CBCGPToolbarButton
	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.

Additional Inherited Members
Public Attributes inherited from CBCGPToolbarButton
	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 inherited from CBCGPToolbarButton
	m_bWrapText	If TRUE, enables multi-line text labels.