CBCGPOutlookBar

Detailed Description

The CBCGPOutlookBar class is intended to provide docking support for CBCGPOutlookWnd objects.

To use the CBCGPOutlookBar control in application you have to perform the following steps:

• Embed a CBCGPOutlookBar object into main frame window class.
• Use the SetMode2003() function in order to enable Microsoft Office 2003-like mode.
• When processing the WM_CREATE message in the main frame, call the Create() member function.
• Obtain a pointer to the underlined CBCGPOutlookWnd using CBCGPBaseTabbedBar::GetUnderlinedWindow.
• For Mode2003 only. Use CBCGPOutlookWnd::SetToolbarImageList in order to assign images to be displayed on the bottom toolbar. Image index should correspond to a tab index for which the image is intended.
• Create CBCGPOutlookBarPane objects for each page containing outlook buttons.
• Call CBCGPOutlookWnd::AddTab to add the pages. Set bDetachable to FALSE if you want to keep a page non-detachable. You can use CBCGPOutlookWnd::AddControl in order to quickly add detachable pages.
• If you want to put a CWnd - derived control on an outlook page, just create the required control and call CBCGPOutlookWnd::AddTab for it.
• If you want to allow the user to add new pages or delete dynamically added pages at runtime use CreateCustomPage() / RemoveCustomPage() respectively.

Note. You should use the unique control IDs for each CBCGPOutlookBarPane object as well as for CWnd - derived objects.

Inheritance diagram for CBCGPOutlookBar:

Public Member Functions
	Create	Creates the Windows control and attaches it to the CBCGPOutlookBar object.
	CreateCustomPage	Creates a custom page at the runtime.
	DoesAllowDynInsertBefore	Indicates whether it is possible to dynamically dock control bars at the outer edge of an outlook bar.
	GetButtonsFont	Returns a font currently used to display text on outlook buttons.
	GetTabArea	Returns the size and position of the tab area of the outlook bar control.
	IsDrawActiveTabNameOnCaption	Tells whether to draw active tab name on caption.
	IsMode2003	Tells whether the outlook bar is running in Microsoft Office 2003-like mode.
	IsMode2013	Tells whether the outlook bar is running in Microsoft Office 2013/2016-like mode.
	RemoveCustomPage	Removes a custom (user-created) page.
	SetButtonsFont	Sets a font to be used for outlook button's text.
	SetDrawActiveTabNameOnCaption	Enables or disables drawing the active tab (page) name on the Outlook bar caption.
	SetMode2003	Enables or disables Office 2003-like mode.
	SetMode2013	Enables or disables Office 2013/2016-like mode.
Public Member Functions inherited from CBCGPBaseTabbedBar
	AddTab	Adds a new tab to a tabbed bar.
	ApplyRestoredTabInfo	Applies information loaded from registry to a tabbed control bar
	EnableSetCaptionTextToTabName	Turns on or off the ability to synchronize the caption text with the label of the active tab.
	FindBarByID	Given a control bar ID returns a pointer to a control bar.
	FindBarByTabNumber	Given the zero-based tab index returns a control bar that resides in the tab.
	GetTabsNum	Returns the number of tabs in a tab window.
	GetUnderlinedWindow	Gives the access to the underlined (wrapped) tab window.
	GetVisibleTabsNum	Returns the number of visible tabs.
	HasAutoHideMode	Determines if the bar can be switched to the autohide mode.
	IsHideSingleTab	Determines whether the tabbed control bar is in the mode when a single tab is not shown.
	RemoveControlBar	Removes a control bar from the tabbed control bar.
	SetAutoDestroy	Sets auto destroy mode.
	ShowTab	Shows or hides a control bar residing in a tab.
Public Member Functions inherited from CBCGPDockingControlBar
	CBCGPDockingControlBar	Constructs the object.
	AttachToTabWnd	Attaches the control bar to another control bar creating a tabbed 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.
	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.
	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.
	OnAfterDockFromMiniFrame	Called by the framework when a docking bar has been docked to frame window from floating state.
	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.
	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.
	CanFocus	Specifies whether a control bar can receive focus.
	CreateEx	Creates a Windows control.
	EnableDocking	Enables docking to the main frame.
	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.

Additional Inherited Members
Public Types inherited from CBCGPDockingControlBar
enum	CaptionType
Static Public Member Functions inherited from CBCGPDockingControlBar
	GetDragSencitivity	Returns the drag sensitivity of a docking control bar.
Public Attributes inherited from CBCGPControlBar
	m_recentDockInfo	Contains the recent docking information.
Static Public Attributes inherited from CBCGPDockingControlBar
	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 inherited from CBCGPDockingControlBar
	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 inherited from CBCGPDockingControlBar
	m_sizeDragSencitivity	Specifies the drag sensitivity of a docking control bar.