CBCGPTabWnd

Detailed Description

The CBCGPTabWnd class provides the functionality that allows to create tabbed widgets. This functionality is analogous to the Microsoft Windows common tab control, but the CBCGPTabWnd class has several extensions. The following is the list of additional features implemented by CBCGPTabWnd class:

• Various styles: 3D, flat, flat with shared horizontal scroll bar
• Alignment: top and bottom
• Ability to show text and/or images
• Ability to change an active tab color
• Adjustable tab's border size
• Detachable tabs

Note. Although it is possible to create a CBCGPTabWnd object in a dialog box, it was aimed for using with docking control bars (see CBCGPDockingControlBar) in Microsoft Excel- and Microsoft Visual Studio- like applications. To include a tab control in your application along with docking (resizable) control bar, follow these steps:

• Create an instance of CBCGPTabbedControlBar.
• Call CBCGPTabbedControlBar::Create.
• Use CBCGPTabWnd::AddTab or CBCGPTabWnd::InsertTab to add new tabs.
• Call CBCGPTabbedControlBar::EnableDocking if you want this tabbed window be docked at the main frame window.
• Call CBCGPTabbedControlBar::DockControlBar to dock it at the main frame.

See CBCGPTabbedControlBar documentation for example how to create tabbed window as a docking control bar.

If you want to use CBCGPTabWnd as a non-docking control, just create an instance of CBCGPTabWnd object and call CBCGPTabWnd::Create.

See also

CBCGPDockingControlBar, CBCGPBaseTabWnd

Inheritance diagram for CBCGPTabWnd:

Public Types
enum	Style
enum	TabCloseButtonMode
enum	TabDotShape
enum	TabsDocumentsMenuStyle
enum	TabsIconLocation
Public Types inherited from CBCGPAnimationManager
enum	BCGPAnimationType

Public Member Functions
	AreButtonsVisible	Tells whether tab control buttons (scroll/close/menu) are shown or hidden.
	AreDisabledScrollButtonsHidden	Tells whether the disabled scroll buttons should be visible.
	ClearNumericNotificationBadge	Clears the numeric notification badge.
	Create	Creates the Windows control and attaches it to the CBCGPTabWnd object.
	EnableActiveTabCloseButton	Shows or hides close button on active tab.
	EnableInPlaceEdit	Enables in-place editing of tab labels.
	EnableNewTab	Enables adding a new tab by user.
	EnableTabDocumentsMenu	Replaces scroll buttons with a button opening popup menu with document names.
	EnsureVisible	Ensures that a tab is visible.
	GetActiveTabExtraHeight	Returns active tab additional height (in pixels).
	GetIconLocation	Returns the tab icon location.
	GetNewTabLabel	Gets new tab label.
	GetScrollBar	Returns a pointer to the tab control's scroll bar object.
	GetTabArea	Returns the size and position of the tab area of the tabbed window.
	GetTabCloseButtonMode	Retrieve the tab close button mode.
	GetTabDocumentsMenuStyle	Gets tab documents menu style. One of: drop-down arrow, ellipsis or hamburger
	GetTabMaxWidth	Retrieves the maximal allowed width of a tab in a tabbed window.
	GetTabStateAnimationFrameDelay	Gets tab state animation frame delay.
	HideActiveWindowHorzScrollBar	Obtains a horizontal scroll bar from the window that resides on the active page and hides the scroll bar.
	HideDisabledScrollButtons	Specify whether the disabled scroll buttons should be visible.
	HideNoTabs	Enables or disables the mode when the tab window hides the tab area if there are no visible tabs.
	HideSingleTab	Sets the mode when the tab window does not display a tab for a single tabbed window.
	IsActiveTabBoldFont	Tells whether the text of the active tab should be displayed using the bold font.
	IsActiveTabCloseButton	Tells whether the close button is displayed on active tab, or at the default location at the right top corner of tab area.
	IsDrawFrame	Tells whether the tab window draws a frame rectangle around embedded bars.
	IsFlatFrame	Tells whether the frame around the tabs area is flat or 3D
	IsNewTabEnabled	Tells whether adding a new tab is enabled.
	IsTabDocumentsMenu	Tells whether the tab control displays a button opening a popup menu with document names or scroll buttons.
	IsTabStateAnimation	Tells whether tab state animation is active or not.
	IsVS2005Style	Tells whether the tab window is running in Visual Studio 2005-style mode.
	ModifyTabStyle	Modify the tab style.
	ResetTabStateAnimationStep	Resets the tab state animation current frame index.
	SetActiveTab	Activates a tab.
	SetActiveTabBoldFont	Enables or disables the feature that displays the active tab using the bold font.
	SetActiveTabExtraHeight	Specifies active tab additional height.
	SetButtonsVisible	Shows or hides all tab controls buttons.
	SetDrawFrame	Enables or disables displaying of the frame rectangle around an embedded bar.
	SetFlatFrame	Sets a flag that determines how to draw the wide frame around the tabs area.
	SetIconLocation	Specifies the tab icon location.
	SetImageList	Sets an image list.
	SetImageList	Sets an image list.
	SetNewTabLabel	Sets new tab text label.
	SetNumericNotificationBadge	Sets numeric notification badge for the specific tab.
	SetTabCloseButtonMode	Sets tab close button mode.
	SetTabMaxWidth	Sets maximal allowed tab width.
	SetTabMinWidth	Sets minimal allowed tab width.
	SetTabStateAnimationFrameDelay	Specifies tab state animation frame delay.
	SetTabStateAnimationImages	Sets tab animation ("busy" indicator) images. The image list is loaded from the resources.
	SetTabStateAnimationImages	Sets tab animation ("busy" indicator) images.
	StartTabStateAnimation	Starts tab state animation.
	StopTabStateAnimation	Stops tab state animation.
Public Member Functions inherited from CBCGPAnimationManager
	CBCGPAnimationManager	Default constructor.
	GetAnimatedValue	Gets current animated value.
	GetAnimationDuration	Gets animation duration.
	GetLastAnimationError	Gets the animation error returned by recent call to Windows Animation API.
	IsAnimated	Checks if animation is running.
	StartAnimation	Starts an animation.
	StartFlashAnimation	Starts "flash" animation.
	StopAnimation	Stops an animation.

Static Public Attributes
	m_bEnableActivate	Prevents active view from losing focus.

Additional Inherited Members
Static Public Member Functions inherited from CBCGPAnimationManager
	IsAnimationSupportedByOS	Checks if animation is supported by OS.
Protected Member Functions inherited from CBCGPAnimationManager
	OnAnimationIdle	Called by the framework in an animation idle time.