CPaneContainerManager Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at CPaneContainerManager Class.

The CPaneContainerManager class manages the storage and display of the current docking layout.

class CPaneContainerManager : public CObject  

Public Methods

NameDescription
CPaneContainerManager::AddPane
CPaneContainerManager::AddPaneContainerManager
CPaneContainerManager::AddPaneContainerManagerToDockablePane
CPaneContainerManager::AddPanesToList
CPaneContainerManager::AddPaneToList
CPaneContainerManager::AddPaneToRecentPaneContainer
CPaneContainerManager::CalcRects
CPaneContainerManager::CanBeAttached
CPaneContainerManager::CheckAndRemoveNonValidPane
CPaneContainerManager::CheckForMiniFrameAndCaption
CPaneContainerManager::Create
CPaneContainerManager::DoesAllowDynInsertBefore
CPaneContainerManager::DoesContainFloatingPane
CPaneContainerManager::EnableGrippers
CPaneContainerManager::FindPaneContainer
CPaneContainerManager::FindTabbedPane
CPaneContainerManager::GetAvailableSpace
CPaneContainerManager::GetDefaultPaneDivider
CPaneContainerManager::GetDockSiteFrameWnd
CPaneContainerManager::GetFirstPane
CPaneContainerManager::GetFirstVisiblePane
CPaneContainerManager::GetMinMaxOffset
CPaneContainerManager::GetMinSize
CPaneContainerManager::GetNodeCount
CPaneContainerManager::GetPaneContainerRTC
CPaneContainerManager::GetPaneCount
CPaneContainerManager::GetTotalRefCount
CPaneContainerManager::GetVisiblePaneCount
CPaneContainerManager::GetWindowRect
CPaneContainerManager::HideAll
CPaneContainerManager::InsertPane
CPaneContainerManager::IsAutoHideMode
CPaneContainerManager::IsEmpty
CPaneContainerManager::IsRootPaneContainerVisible
CPaneContainerManager::NotifyPaneDivider
CPaneContainerManager::OnPaneDividerMove
CPaneContainerManager::OnShowPane
CPaneContainerManager::PaneFromPoint
CPaneContainerManager::ReleaseEmptyPaneContainers
CPaneContainerManager::RemoveAllPanesAndPaneDividers
CPaneContainerManager::RemoveNonValidPanes
CPaneContainerManager::RemovePaneDivider
CPaneContainerManager::RemovePaneFromPaneContainer
CPaneContainerManager::ReplacePane
CPaneContainerManager::ResizePaneContainers
CPaneContainerManager::SerializeReads or writes this object from or to an archive. (Overrides CObject::Serialize.)
CPaneContainerManager::SetDefaultPaneDividerForPanes
CPaneContainerManager::SetPaneContainerRTC
CPaneContainerManager::SetResizeMode
CPaneContainerManager::StoreRecentDockSiteInfo

Remarks

The framework automatically creates instances of CPaneContainerManager objects and embeds them either into CPaneDivider Class objects or into CMultiPaneFrameWnd Class objects.

The CPaneContainerManager class stores a pointer to the root of a binary tree that is built from CPaneContainer objects.

The following example demonstrates how to get a reference to a CPaneContainerManager object. This code snippet is part of the Set Pane Size sample.

		// CMultiPaneFrameWnd* pParentMiniFrame
		CPaneContainerManager& manager = pParentMiniFrame->GetPaneContainerManager ();

CObject

CPaneContainerManager

Header: afxpanecontainermanager.h

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void AddPane(CDockablePane* pControlBarToAdd);

Parameters

[in] pControlBarToAdd

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL AddPaneContainerManager(
    CPaneContainerManager& srcManager,  
    BOOL bOuterEdge);

 
virtual BOOL AddPaneContainerManager(
    CDockablePane* pTargetControlBar,  
    DWORD dwAlignment,  
    CPaneContainerManager& srcManager,  
    BOOL bCopy);

Parameters

[in] srcManager
[in] bOuterEdge
[in] pTargetControlBar
[in] dwAlignment
[in] bCopy

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL AddPaneContainerManagerToDockablePane(
    CDockablePane* pTargetControlBar,  
    CPaneContainerManager& srcManager);

Parameters

[in] pTargetControlBar
[in] srcManager

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void AddPanesToList(
    CObList* plstControlBars,  
    CObList* plstSliders);

Parameters

[in] plstControlBars
[in] plstSliders

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void AddPaneToList(CDockablePane* pControlBarToAdd);

Parameters

[in] pControlBarToAdd

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual CDockablePane* AddPaneToRecentPaneContainer(
    CDockablePane* pBarToAdd,  
    CPaneContainer* pRecentContainer);

Parameters

[in] pBarToAdd
[in] pRecentContainer

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void CalcRects(
    CRect& rectOriginal,  
    CRect& rectInserted,  
    CRect& rectSlider,  
    DWORD& dwSliderStyle,  
    DWORD dwAlignment,  
    CSize sizeMinOriginal,  
    CSize sizeMinInserted);

Parameters

[in] rectOriginal
[in] rectInserted
[in] rectSlider
[in] dwSliderStyle
[in] dwAlignment
[in] sizeMinOriginal
[in] sizeMinInserted

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL CanBeAttached() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

BOOL CheckAndRemoveNonValidPane(CWnd* pWnd);

Parameters

[in] pWnd

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL CheckForMiniFrameAndCaption(
    CPoint point,  
    CDockablePane** ppTargetControlBar);

Parameters

[in] point
[in] ppTargetControlBar

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL Create(
    CWnd* pParentWnd,  
    CPaneDivider* pDefaultSlider,  
    CRuntimeClass* pContainerRTC = NULL);

Parameters

[in] pParentWnd
[in] pDefaultSlider
[in] pContainerRTC

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL DoesAllowDynInsertBefore() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL DoesContainFloatingPane();

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void EnableGrippers(BOOL bEnable);

Parameters

[in] bEnable

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual CPaneContainer* FindPaneContainer(
    CDockablePane* pBar,  
    BOOL& bLeftBar);

Parameters

[in] pBar
[in] bLeftBar

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

CDockablePane* FindTabbedPane(UINT nID);

Parameters

[in] nID

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void GetAvailableSpace(CRect& rect) const;  

Parameters

[in] rect

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

CPaneDivider* GetDefaultPaneDivider() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual CWnd* GetDockSiteFrameWnd();

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual CBasePane* GetFirstPane() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual CWnd* GetFirstVisiblePane() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void GetMinMaxOffset(
    CPaneDivider* pSlider,  
    int& nMinOffset,  
    int& nMaxOffset,  
    int& nStep);

Parameters

[in] pSlider
[in] nMinOffset
[in] nMaxOffset
[in] nStep

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void GetMinSize(CSize& size);

Parameters

[in] size

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

int GetNodeCount() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

CRuntimeClass* GetPaneContainerRTC() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

int GetPaneCount() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

int GetTotalRefCount() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual int GetVisiblePaneCount() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void GetWindowRect(CRect& rect) const;  

Parameters

[in] rect

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void HideAll();

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL InsertPane(
    CDockablePane* pControlBarToInsert,  
    CDockablePane* pTargetControlBar,  
    DWORD dwAlignment,  
    LPCRECT lpRect = NULL,  
    AFX_DOCK_METHOD dockMethod = DM_UNKNOWN);

Parameters

[in] pControlBarToInsert
[in] pTargetControlBar
[in] dwAlignment
[in] lpRect
[in] dockMethod

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

BOOL IsAutoHideMode() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

BOOL IsEmpty() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL IsRootPaneContainerVisible() const;  

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void NotifyPaneDivider();

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual int OnPaneDividerMove(
    CPaneDivider* pSlider,  
    UINT uFlags,  
    int nOffset,  
    HDWP& hdwp);

Parameters

[in] pSlider
[in] uFlags
[in] nOffset
[in] hdwp

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL OnShowPane(
    CDockablePane* pBar,  
    BOOL bShow);

Parameters

[in] pBar
[in] bShow

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual CDockablePane* PaneFromPoint(
    CPoint point,  
    int nSensitivity,  
    BOOL bExactBar,  
    BOOL& bIsTabArea,  
    BOOL& bCaption);

Parameters

[in] point
[in] nSensitivity
[in] bExactBar
[in] bIsTabArea
[in] bCaption

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void ReleaseEmptyPaneContainers();

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void RemoveAllPanesAndPaneDividers();

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void RemoveNonValidPanes();

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void RemovePaneDivider(CPaneDivider* pSlider);

Parameters

[in] pSlider

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL RemovePaneFromPaneContainer(CDockablePane* pControlBar);

Parameters

[in] pControlBar

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual BOOL ReplacePane(
    CDockablePane* pBarOld,  
    CDockablePane* pBarNew);

Parameters

[in] pBarOld
[in] pBarNew

Return Value

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void ResizePaneContainers(
    UINT nSide,  
    BOOL bExpand,  
    int nOffset,  
    HDWP& hdwp);

 
virtual void ResizePaneContainers(
    CRect rect,  
    HDWP& hdwp);

Parameters

[in] nSide
[in] bExpand
[in] nOffset
[in] hdwp
[in] rect

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void Serialize(CArchive& ar);

Parameters

[in] ar

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void SetDefaultPaneDividerForPanes(CPaneDivider* pSlider);

Parameters

[in] pSlider

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

void SetPaneContainerRTC(CRuntimeClass* pContainerRTC);

Parameters

[in] pContainerRTC

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void SetResizeMode(BOOL bResize);

Parameters

[in] bResize

Remarks

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

virtual void StoreRecentDockSiteInfo(CDockablePane* pBar);

Parameters

[in] pBar

Remarks

Hierarchy Chart
Classes
CObject Class
CPaneContainer Class
CPaneDivider Class

Show: