CBCGPToolBoxPage

Detailed Description

The CBCGPToolBoxPage class is a helper class used in conjunction with CBCGPToolBox objects. The instances of this object are created dynamically when you call CBCGPToolBox::AddToolsPage.

This class is implemented as a control bar containing an array of CBCGPToolBoxButton objects.

See also

CBCGPToolBox, CBCGPToolBoxEx, CBCGPToolBoxButton

Inheritance diagram for CBCGPToolBoxPage:

Public Types
enum	ToolBoxPageMode

Public Member Functions
	CBCGPToolBoxPage	Default constructor.
	AddButton	Adds a button.
	DeleteAllButons	Deletes all buttons from the toolbox page.
	DeleteButton	Deletes a button.
	Enable	Enable all items in this page.
	GetButtonByID	Finds a button by specified ID.
	GetButtonCount	Returns the number of buttons contained in the toolbox page.
	GetButtonUserData	Gets button user data.
	GetEmptyPagePrompt	Retrivies a message prompt displayed when the page is empty.
	GetMode	Returns the current page mode.
	GetSelected	Gets the selected item index.
	IsEnabled	Tells whether items on this page are enabled.
	IsVisible	Tells whether a specific toolbox page is visible.
	SetButtonUserData	Sets button user-defined data.
	SetEmptyPagePrompt	Call this method to specify a message prompt displayed when the page is empty.
	SetMode	Sets the new page mode.
	SetSelected	Selects toolbox page item.
	SetVisible	Shows or hides a specific toolbox page.
Public Member Functions inherited from CBCGPControlBar
	AdjustSizeImmediate	Immediately recalculates layout of a control bar.
	CalcInsideRect	Calculates the inside rectangle of a control bar taking into account the borders and grippers.
	CanBeDocked	Determines whether a control bar can be docked at the specified dock bar.
	CanBeTabbedDocument	Tells whether control bar can be converted to tabbed document.
	Create	Creates the Windows control bar and attaches it to the CBCGPControlBar object.
	CreateDefaultMiniframe	Creates a mini-frame window for a control bar when it's being floated.
	CreateEx	Creates the Windows control bar and attaches it to the CBCGPControlBar object.
	DockControlBar	Docks the control bar to a dock bar.
	DoesAllowSiblingBars	Indicates whether it is possible to dock another control bar at the same row where this control bar is docked.
	FloatControlBar	Makes the control bar floating.
	GetBorders	Returns the width of the control bar borders.
	GetExclusiveRowMode	Tells whether the control bar is in exclusive row mode or not.
	OnAfterChangeParent	Called by the framework when the parent of a control bar has changed.
	OnAfterFloat	Called by the framework when a control bar has floated.
	OnBeforeChangeParent	Called by the framework when the parent of the control bar is about to be changed as a result of docking or floating operation.
	OnBeforeFloat	Called by the framework when a control bar is about to float.
	OnPressCloseButton	Called by the framework when user presses the close button on control bar's caption.
	SetBorders	Sets the border values of the control bar.
	SetBorders	Sets the border values of the control bar.
	SetExclusiveRowMode	Enables or disables the exclusive row mode.
	SetMiniFrameRTC	Sets the runtime class information about the default mini-frame window.
	ToggleAutoHide	Toggles autohide mode.
Public Member Functions inherited from CBCGPBaseControlBar
	AddControlBar	Adds a control bar to docking manager.
	AdjustDockingLayout	Redirects a call to docking manager to adjust docking layout.
	CanAcceptBar	Determines whether another control bar can be docked to this control bar.
	CanAutoHide	Determines whether the control bar can be switched to autohide mode.
	CanBeAttached	Called by the framework to determine if the control bar can be docked to another control bar or frame window.
	CanBeClosed	Determines whether the control bar may be hidden.
	CanBeResized	Determines whether this control bar can be resized.
	CanFloat	Determines whether the control bar can float.
	CanFocus	Specifies whether a control bar can receive focus.
	CreateEx	Creates a Windows control.
	DoesAllowDynInsertBefore	Determines whether it is possible to dynamically insert a control bar before this control bar.
	EnableDocking	Enables docking to the main frame.
	EnableGripper	Enables/disables the control caption (gripper).
	GetBarIcon	Returns control bar icon.
	GetBarStyle	Returns the control bar style.
	GetBCGStyle	Returns the library specific control bar styles.
	GetCaptionHeight	Returns the gripper (caption) height.
	GetCurrentAlignment	Returns the current control bar alignment.
	GetDockMode	Returns the current dock mode for the control bar.
	GetDockRow	Returns a pointer to a dock bar row.
	GetDockSite	Returns a pointer to dock site.
	GetEnabledAlignment	Returns the enabled alignment.
	GetParentMiniFrame	Returns a pointer to the parent mini-frame window.
	GetParentTabWnd	Retrieves a pointer to the parent tabbed window.
	HideInPrintPreviewMode	Tells the framework whether control bar should be hidden in print preview mode.
	IsDocked	Determines whether the control bar is docked or not.
	IsHorizontal	Determines whether the control bar is docked horizontally.
	IsMDITabbed	Tells whether control bar is placed on MDI child window as tabbed document.
	OnControlBarContextMenu	Called by the framework when it needs to build a menu with the list of control bars.
	OnRemoveFromMiniFrame	Called by the framework when a control bar is being removed from its parent mini-frame window.
	SetBarAlignment	Sets the current alignment for a control bar.
	SetBarStyle	Sets a control bar style
	SetDockMode	Sets a new docking method for a control bar.
	ShowControlBar	Shows or hides a control bar.

Protected Attributes
	m_nVertScrollOffset	Specifies the vertical scroll position.
	m_nVertScrollSize	Specifies the scroll size and it's equal to the number of items that exceeds the number of visible items.

Additional Inherited Members
Public Attributes inherited from CBCGPControlBar
	m_recentDockInfo	Contains the recent docking information.
Static Public Attributes inherited from CBCGPControlBar
	m_bHandleMinSize	Enables consistent handling of minimal size.
Protected Member Functions inherited from CBCGPControlBar
	OnAfterDock	Called by the framework when a control bar has been docked.
	OnBeforeDock	Called by the framework when the control bar is about to be docked.