CBCGPCaptionBar

Detailed Description

A CBCGPCaptionBar object is a control bar with a row of "elements": button, text label and image. It can contain only one element of each type in one time. Each element can be aligned to the left or right edges of the control or to the center. A caption bar has top and bottom borders with flat or 3D style.

To create a caption bar, follow these steps:

• Construct the CBCGPCaptionBar object. Usually it is good idea to embed this object into frame window object.
• Call the Create() function to create the caption bar window and attach it to the CBCGPCaptionBar object.
• Call SetButton(), SetText(), SetIcon(), SetBitmap() to set the caption bar elements.

When you set the button element, you assign a command ID to the button. The caption bar routes WM_COMMAND message with this ID to the parent frame when the user clicks the button.

In addition, the caption bar can work in the "message bar mode". This style was introduced in Microsoft Office 2007. In this mode caption bar displays a bitmap at the left side, message text next to the image and a button (which usually displays some option dialog) next to the text. It's possible to set a tooltip for the image.

To enable the "message bar mode", just call Create() with the fourth parameter bIsMessageBarMode set to TRUE

Inheritance diagram for CBCGPCaptionBar:

Public Member Functions
	Create	Creates the Windows control and attaches it to the CBCGPCaptionBar object.
	EnableButton	Enables or disables a button, which has been placed on the caption bar.
	GetAlignment	Returns alignment of the specified element.
	GetBorderSize	Returns border size of a caption bar.
	GetButtonRect	Retrieves the bounding rectangle of a caption bar's button.
	GetLinkText	Returns a hyperlink text.
	GetMargin	Returns the distance between edges of the caption bar elements and edges of the caption bar control.
	GetText	Gets the caption bar text.
	IsCaptionFont	Checks whether the caption (large) font is specified.
	IsMessageBarMode	Tells whether the caption bar works in the "message bar mode".
	RemoveBitmap	Removes a bitmap from a caption bar.
	RemoveButton	Removes the button from a caption bar.
	RemoveIcon	Removes an icon from a caption bar.
	RemoveText	Removes a text label from a caption bar.
	SetBitmap	Set the bitmap image on the caption bar.
	SetBitmap	Set the bitmap image on the caption bar.
	SetBorderSize	Sets the caption bar border size.
	SetButton	Sets the button on a caption bar.
	SetButtonPressed	Forces a button to stay pressed.
	SetButtonToolTip	Sets tooltip for the button.
	SetCaptionFont	Specifies whether caption text is renderred using caption (large) font
	SetFlatBorder	Sets the border style of a caption bar.
	SetIcon	Sets an icon on a caption bar.
	SetImageIndex	Specifies the index of the active icon. Should work in conjunction with the SetImageList() method.
	SetImageList	Set the image strip for the caption bar. You can use only one icon from this list at a time.
	SetImageToolTip	Call this method to set a tooltip for the image.
	SetMargin	Sets the distance between edges of caption bar elements and edges of the caption bar control.
	SetMessageBarMode	Sets "message bar mode".
	SetText	Sets a text label on a caption bar.
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.
	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.
	IsVisible	Determines whether a control bar is visible or not.
	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.

Public Attributes
	m_clrBarBackground	The background color of the caption bar.
	m_clrBarBorder	The color of the caption bar's border.
	m_clrBarHyperlink	The foreground color of the caption bar's hyper-link.
	m_clrBarText	The color of the caption bar's text.
Public Attributes inherited from CBCGPControlBar
	m_recentDockInfo	Contains the recent docking information.

Protected Member Functions
	OnDrawBackground	Called by the framework when the background of a caption bar is filled.
	OnDrawBorder	Called by the framework when the border of a caption bar is about to be redrawn.
	OnDrawButton	Called by the framework when it displays the caption bar's button.
	OnDrawImage	Called by the framework to display an image on the caption bar.
	OnDrawText	Called by the framework to display the caption bar text.
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.

Additional Inherited Members
Static Public Attributes inherited from CBCGPControlBar
	m_bHandleMinSize	Enables consistent handling of minimal size.