BCGControlBar Pro for MFC
CBCGPDockBar

Detailed Description

The CBCGPDockBar class implements the functionality of a special window that can accept various control bars derived from the CBCGPControBar class and arrange them in a set of rows. It maintains a list of control bars and rows.

CBCGPDockBar object are created automatically by the framework when you call CBCGPFrameWnd::EnableDocking. Dock bar windows are placed at the edges of the main frame window client area.

Usually, you don't need to call directly the services provided by the dock bar.

+ Inheritance diagram for CBCGPDockBar:

Public Member Functions

 ControlBarFromPointGiven a point in screen coordinates returns a pointer to a control bar docked at the dock bar.
 
 DockControlBarLeftOfDocks one control bar at the left side of another control bar.
 
 FindBarByIDGiven a control bar ID returns a pointer to the control bar.
 
 GetControlBarListReturns a list of control bars docked at the dock bar.
 
 ShowControlBarCall to show the control bar.
 
- Public Member Functions inherited from CBCGPBaseControlBar
 AddControlBarAdds a control bar to docking manager.
 
 AdjustDockingLayoutRedirects a call to docking manager to adjust docking layout.
 
 CanAutoHideDetermines whether the control bar can be switched to autohide mode.
 
 CanBeAttachedCalled by the framework to determine if the control bar can be docked to another control bar or frame window.
 
 CanBeClosedDetermines whether the control bar may be hidden.
 
 CanBeDockedDetermines whether this control bar can be docked to another control bar.
 
 CanBeResizedDetermines whether this control bar can be resized.
 
 CanFloatDetermines whether the control bar can float.
 
 CanFocusSpecifies whether a control bar can receive focus.
 
 CreateDefaultMiniframeCreates a mini-frame window if can float.
 
 CreateExCreates a Windows control.
 
 DockControlBarDocks control bar to another control bar or frame window.
 
 EnableDockingEnables docking to the main frame.
 
 EnableGripperEnables/disables the control caption (gripper).
 
 FloatControlBarFloats the control bar.
 
 GetBarIconReturns control bar icon.
 
 GetBarStyleReturns the control bar style.
 
 GetBCGStyleReturns the library specific control bar styles.
 
 GetCaptionHeightReturns the gripper (caption) height.
 
 GetCurrentAlignmentReturns the current control bar alignment.
 
 GetDockModeReturns the current dock mode for the control bar.
 
 GetDockRowReturns a pointer to a dock bar row.
 
 GetDockSiteReturns a pointer to dock site.
 
 GetEnabledAlignmentReturns the enabled alignment.
 
 GetParentMiniFrameReturns a pointer to the parent mini-frame window.
 
 GetParentTabWndRetrieves a pointer to the parent tabbed window.
 
 HideInPrintPreviewModeTells the framework whether control bar should be hidden in print preview mode.
 
 IsDockedDetermines whether the control bar is docked or not.
 
 IsHorizontalDetermines whether the control bar is docked horizontally.
 
 IsMDITabbedTells whether control bar is placed on MDI child window as tabbed document.
 
 IsTabbedDetermines whether the control bar is inserted in a tab of a tabbed window.
 
 IsVisibleDetermines whether a control bar is visible or not.
 
 LoadStateLoads the control bar state from the registry.
 
 OnAfterChangeParentCalled by the framework when the control bar's parent has been changed.
 
 OnBeforeChangeParentCalled by the framework just before the parent window is changed.
 
 OnControlBarContextMenuCalled by the framework when it needs to build a menu with the list of control bars.
 
 OnRemoveFromMiniFrameCalled by the framework when a control bar is being removed from its parent mini-frame window.
 
 SaveStateSaves state to the Windows registry.
 
 SetBarAlignmentSets the current alignment for a control bar.
 
 SetBarStyleSets a control bar style
 
 SetDockModeSets a new docking method for a control bar.
 
 ShowControlBarShows or hides a control bar.
 
 UnDockControlBarRemoves control bar from dock bar or from default slider or from mini-frame window.
 

Additional Inherited Members

- Protected Member Functions inherited from CBCGPBaseControlBar
 DoPaintPaints the control bar.