CBCGPDockingControlBar

Detailed Description

The CBCGPDockingControlBar class implements a control bar with the following functionality:

• dock to a main frame window
• switch to autohide mode
• attach to a tabbed window
• float in a mini frame
• dock to another control bar that is floating in a mini frame window
• free resizing
• load/save state from/to the Windows registry
• can be created with or without caption. The caption may have a text and may be filled with gradient color
• can be dragged with or without (using drag rectangle) context

To use a docking control bar in your application you must derive your control bar class from the CBCGPDockingControlBar class. It's advisable to embed the derived object into the main frame window object (or to a window object that will control the instance of your bar). Call the CBCGPDockingControlBar::Create or CBCGPDockingControlBar::CreateEx member function when you process WM_CREATE message in the main frame window. Setup the control bar object by calling CBCGPDockingControlBar::EnableDocking, CBCGPDockingControlBar::DockControlBar, CBCGPDockingControlBar::AttachToTabWnd.

Inheritance diagram for CBCGPDockingControlBar:

Public Types
enum	CaptionType

Public Member Functions
	CBCGPDockingControlBar	Constructs the object.
	AttachToTabWnd	Attaches the control bar to another control bar creating a tabbed control bar.
	CanAcceptBar	Determines whether another control bar can be docked to this control bar.
	CanBeAttached	Called by the framework to determine if the control bar can be docked to another control bar or frame window.
	Create	Creates the Windows control and attaches it to the CBCGPDockingControlBar object.
	Create	Creates the Windows control and attaches it to the CBCGPDockingControlBar object.
	CreateEx	Creates the Windows control and attaches it to the CBCGPDockingControlBar object.
	CreateTabbedControlBar	Called by the framework when it needs to create a tabbed control bar from this control bar.
	DockToWindow	Docks the docking control bar to another docking control bar.
	EnableAutohideAll	Enables/disables auto-hide mode
	EnableGripper	Shows or hides the caption (gripper).
	GetCaption	Gets a panes' caption.
	GetCaptionHeight	Returns the current caption's height.
	GetDefaultSlider	Returns a pointer to the default slider of the control bar's container.
	GetIconIndex	Return a docking pane icon index.
	GetPaneInfo	Called by the framework to obtain the docking pane information displayed in Windows Navigator (invoked by Ctrl+Tab).
	GetTabbedControlBarRTC	Returns a pointer to the runtime class information of a tabbed window to be created when another control bar is docked to this control bar as a new tab.
	GetTabCustomLabel	Gets a tab custom label.
	HasAutoHideMode	Tells whether a docking control bar can be switched to the autohide mode.
	HitTest	Called by the framework to get a hit-test value from the point.
	IsAutohideAllEnabled	Indicates whether the docking control bar can be put into autohide mode along with other control bars in container, when the user presses pin button holding Ctrl key.
	IsAutoHideMode	Determines whether a control bar is in autohide mode or not.
	IsDocked	Determines whether the control bar is docked or not.
	IsHideInAutoHideMode	Called by the framework to determine the control bar behavior in autohide mode when the control bar is shown or hidden by ShowControlBar().
	IsVisible	Determines whether the control bar is visible or not.
	IsVisibleInWindowsNavigator	Called by the framework to check whether this pane should be visible in Windows Navigator.
	OnAfterDockFromMiniFrame	Called by the framework when a docking bar has been docked to frame window from floating state.
	SetAutoHideMode	Switches the bar to the autohide mode and back
	SetIconIndex	Sets the docking pane icon index.
	SetTabbedControlBarRTC	Sets the runtime class information of a tabbed window to be created when two docking control bars produce a tabbed window.
	SetTabCustomLabel	Sets a tab custom label.
	ShowControlBar	Shows or hides a control bar.
	Slide	Called by the framework to begin showing or hiding of a control bar in autohide mode.
	UnDockControlBar	Undocks a control bar from the main frame window or from multiminiframe window container.
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.
	OnAfterFloat	Called by the framework when a control bar has floated.
	OnShowControlBarMenu	Called by the framework when a special control bar menu is about to be displayed.
	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.
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.
	AdjustLayout	Called by the framework when a control bar should adjust its internal layout according to a new size or position.
	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.
	GetBarIcon	Returns control bar icon.
	GetBarStyle	Returns the control bar style.
	GetBCGStyle	Returns the library specific control bar styles.
	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.
	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.

Static Public Member Functions
	GetDragSencitivity	Returns the drag sensitivity of a docking control bar.

Static Public Attributes
	m_bDisableAnimation	If TRUE, the autohide animation will be disabled. If FALSE, autohide animation will be enabled.
	m_bHideInAutoHideMode	Determines the control bar behavior in autohide mode.
	m_nSlideSteps	Specifies the number of steps to show or hide in autohide mode.
Static Public Attributes inherited from CBCGPControlBar
	m_bHandleMinSize	Enables consistent handling of minimal size.

Protected Member Functions
	CheckAutoHideCondition	Called be the framework to determine whether the docking control bar should be hidden (in autohide mode).
	CheckStopSlideCondition	Called by the framework to determine when an autohide docking control bar should stop sliding.
	DrawCaption	Draws the docking control bar caption (gripper).
	OnPressButtons	Called when the user presses a caption button other than HTCLOSE_BCG and HTMAXBUTTON buttons.
	OnScrollClient	Called by the framework when it needs to scroll content of a docking control bar.
	OnSlide	Called by the framework to render the autohide effect when the control bar is being shown or hidden.
	ScrollHorzAvailable	Called by the framework to determine whether a docking control bar can be scrolled horizontally.
	ScrollVertAvailable	Called by the framework to determine whether a docking control bar can be scrolled vertically.
Protected Member Functions inherited from CBCGPControlBar
	OnBeforeDock	Called by the framework when the control bar is about to be docked.
Protected Member Functions inherited from CBCGPBaseControlBar
	DoPaint	Paints the control bar.

Static Protected Attributes
	m_sizeDragSencitivity	Specifies the drag sensitivity of a docking control bar.

Additional Inherited Members
Public Attributes inherited from CBCGPControlBar
	m_recentDockInfo	Contains the recent docking information.