CBCGPTasksPane

Detailed Description

The CBCGPTasksPane class implements the functionality of a list of clickable items (tasks). The items can be arranged in groups and each group may have a caption. The groups can be collapsed and expanded one by one. Each item (task) may be associated with a command ID and this command will be executed. When the user clicks the task the WM_COMMAND message is sent to the owner of task pane control. It's possible to assign an icon to each item (task).

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

• Embed a CBCGPTasksPane object into the main frame window class.
• When processing the WM_CREATE message, call the CBCGPTasksPane::Create member function. You can use the regular CBCGPControlBar styles (see CBCGPControlBar::Create for more info).
• Call the CBCGPTasksPane::AddGroup() member function to add various groups.
• Call the CBCGPTasksPane::AddTask(), CBCGPTasksPane::AddLabel() or CBCGPTasksPane::AddMRUFilesList() member functions to add new items (tasks) for each group.

You can call CBCGPTasksPane::EnableGroupCollapse to specify whether the groups can be collapsed or not.

You can customize the task pane appearance adjusting various margins and offsets (use appropriate Set/Get methods).

See also

CBCGPTasksGroup, CBCGPTask, CBCGPOutlookBar, CBCGPVisualManager

Inheritance diagram for CBCGPTasksPane:

Public Member Functions
	CBCGPTasksPane	Constructs a CBCGPTasksPane object.
	AddGroup	Adds a new group of tasks to the task pane control.
	AddGroup	Adds a new group of tasks to the task pane control.
	AddLabel	Adds a new static label into the specified task group.
	AddMRUFilesList	Adds tasks specified by MRU file list into a group.
	AddPage	Adds a new page to the task pane.
	AddSeparator	Adds a separator to the specified task group.
	AddTask	Adds a new task into the specified task group.
	AddWindow	Adds a child window to the task pane.
	AreNavigationTabsEnabled	Tells whether the navigation tabs are enabled or not.
	CollapseAllGroups	Programmatically collapses all groups.
	CollapseAllGroups	Programmatically collapses all groups in the specified page.
	CollapseGroup	Programmatically collapses a group.
	CollapseGroup	Programmatically collapses a group.
	CreateMenu	Called by the framework to create the menu for the "Other Tasks Panes" menu button.
	EnableAnimation	Enables or disables animation while collapsing or expanding task groups.
	EnableAutoHideScrollBar	Scpecifies whether control's scroll bar should be hidden when scroll bar is inactive (mouse cursor is located outside of scrollbar).
	EnableGroupCollapse	Specifies whether tasks groups can be collapsed or not.
	EnableHistoryMenuButtons	Enables or disables drop-down menus in "Next"/"Previous" navigation buttons.
	EnableNavigationTabs	Enables or disables navigation tabs.
	EnableNavigationToolbar	Enables or disables navigation toolbar.
	EnableScrollButtons	Enables usage of scroll buttons instead of a scrollbar.
	EnableWrapLabels	Enables or disables word wrapping for the labels.
	EnableWrapTasks	Enables or disables word wrapping for the tasks.
	GetActivePage	Returns the zero-based index of active page.
	GetGroupCaptionHeight	Returns the height of group caption.
	GetGroupCaptionHorzOffset	Returns the current offset of a group caption from the left/right edge of task pane,
	GetGroupCaptionVertOffset	Returns the current offset of a group caption from the top/bottom edge of task pane,
	GetGroupCount	Returns the total number of groups.
	GetGroupLocation	Given a pointer to group, returns the group index in the internal group list.
	GetGroupVertOffset	Returns the group vertical offset.
	GetHorzMargin	Returns horizontal spacing between a task pane (which is a list of groups) and edges of client area.
	GetPageByGroup	Retrieves page index for the specified group.
	GetPagesCount	Returns the number of pages.
	GetSelectedTaskGroup	Retives a selected task group.
	GetTask	Retrieves a pointer to a task.
	GetTaskCount	Returns the number of tasks in the specifies group.
	GetTaskGroup	Given a group index, returns a pointer to group.
	GetTaskLocation	Given a task command returns the task's group and index.
	GetTaskLocation	Given a task command returns the task's group and index.
	GetTaskLocation	Given a task command returns the task's group and index.
	GetTasksHorzOffset	Returns the horizontal offset of tasks from the left/right edges of their parent groups.
	GetVertMargin	Returns the vertical spacing between a task pane (which is a list of groups) and edges of client area.
	HideSingleGroupCaption	Specifies whether the tasks pane hides a single group caption.
	IsAnimationEnabled	Tells whether the animation is enabled or not.
	IsBackButtonEnabled	Tells whether the back button is enabled or not.
	IsForwardButtonEnabled	Tells whether the forward button is enabled or not.
	IsHideSingleGroupCaption	Tells whether the tasks pane hides a single group caption.
	IsHistoryMenuButtonsEnabled	Tells whether "Next"/"Previous" navigation buttons have drop-down menu, or not.
	IsNavigationToolbarEnabled	Tells whether the navigation toolbar is enabled or not.
	IsScrollBarAutoHideEnabled	Tells whether control's scroll bars are auto-hidden.
	IsWrapLabelsEnabled	Tells whether the tasks pane wraps words in labels, or not.
	IsWrapTasksEnabled	Tells whether the tasks pane wraps words in tasks or not.
	OnClickTask	Called by the framework when the user clicks a task.
	OnPressBackButton	Called by the framework when the user clicks "Back" button.
	OnPressForwardButton	Called by the framework when the user clicks the "Forward" navigation button.
	OnPressHomeButton	Called by the framework when the user clicks the "Home" navigation button
	RemoveAllGroups	Removes all groups on the specifies by nPageIdx page or all groups if there is only one default page.
	RemoveAllPages	Removes all groups and all tasks from the groups except the first page.
	RemoveAllTasks	Removes all tasks in the specified by nGroup group.
	RemoveGroup	Removes a group.
	RemovePage	Removes the specifies page from the task pane.
	RemoveTask	Removes a task from a task group.
	SetActivePage	Activates page.
	SetCaption	Sets the caption name of task pane.
	SetGroupCaptionHeight	Sets the height of group caption.
	SetGroupCaptionHorzOffset	Sets horizontal offset of group caption.
	SetGroupCaptionVertOffset	Sets vertical offset of group caption.
	SetGroupName	Sets a new group name
	SetGroupTextColor	Sets text color for group's caption.
	SetGroupVertOffset	Sets the new vertical offset for a group.
	SetHorzMargin	Sets horizontal spacing between a task pane (which is a list of groups) and edges of client area.
	SetIconsList	Sets the image list associated with tasks.
	SetIconsList	Sets the image list associated with tasks.
	SetPageCaption	Sets a new caption text to a task pane page.
	SetTaskName	Sets a new task name.
	SetTasksHorzOffset	Sets the horizontal offset of tasks from the left/right edges of their parent groups.
	SetTasksIconHorzOffset	Sets horizontal spacing between tasks's icons
	SetTaskTextColor	Sets text color for a task.
	SetVertMargin	Sets vertical spacing between a task pane (which is a list of groups) and edges of client area.
	SetWindowHeight	Sets a new window height.
	SetWindowHeight	Sets a new window height.
	ShowTask	Shows or hides a task.
	ShowTaskByCmdId	Looks for a task by its command ID and shows or hides it.
	Update	Updates the task pane GUI elements.
Public Member Functions inherited from CBCGPDockingControlBar
	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.
	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.
	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.
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.

Protected Member Functions
	OnActivateTasksPanePage	Called by the framework when new task pane page is activated.
	OnAfterDrawTask	Called by the framework after drawing the task.
	OnBeforeDrawTask	Called by the framework before drawing the task.
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.
	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 CBCGPAnimationManager
	OnAnimationIdle	Called by the framework in an animation idle time.

Protected Attributes
	m_hwndFooter	Task pane footer window. Created in CBCGPTasksPane-derived class.
	m_hwndHeader	Task pane header window. Created in CBCGPTasksPane-derived class.

Additional Inherited Members
Public Types inherited from CBCGPDockingControlBar
enum	CaptionType
Public Types inherited from CBCGPAnimationManager
enum	BCGPAnimationType
Static Public Member Functions inherited from CBCGPDockingControlBar
	GetDragSencitivity	Returns the drag sensitivity of a docking control bar.
Static Public Member Functions inherited from CBCGPAnimationManager
	IsAnimationSupportedByOS	Checks if animation is supported by OS.
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.
Static Protected Attributes inherited from CBCGPDockingControlBar
	m_sizeDragSencitivity	Specifies the drag sensitivity of a docking control bar.