CDockingManager::GetPaneList

Returns a list of panes that belong to the docking manager. This includes all floating panes.

void GetPaneList(
    CObList& lstBars,
    BOOL bIncludeAutohide = FALSE,
    CRuntimeClass* pRTCFilter = NULL,
    BOOL bIncludeTabs = FALSE
);

Parameters

  • [in, out] lstBars
    Contains all the panes of the current docking manager.

  • [in] bIncludeAutohide
    TRUE to include the panes that are in autohide mode; otherwise, FALSE.

  • [in] pRTCFilter
    If not NULL, the returned list contains panes only of the specified runtime class.

  • [in] bIncludeTabs
    TRUE to include tabs; otherwise, FALSE.

Remarks

If there are any tabbed panes in the docking manager, the method returns pointers to CBaseTabbedPane Class objects and you must enumerate the tabs explicitly.

Use pRTCFilter to obtain a particular class of panes. For example, you can obtain only toolbars by setting this value appropriately.

Requirements

Header: afxDockingManager.h

See Also

Reference

CDockingManager Class

Hierarchy Chart