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
Name | Description |
---|---|
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::Serialize | Reads or writes this object from or to an archive. (Overrides CObject::Serialize.) |
CPaneContainerManager::SetDefaultPaneDividerForPanes | |
CPaneContainerManager::SetPaneContainerRTC | |
CPaneContainerManager::SetResizeMode | |
CPaneContainerManager::StoreRecentDockSiteInfo |
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 ();
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);
[in] pControlBarToAdd
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);
[in] srcManager
[in] bOuterEdge
[in] pTargetControlBar
[in] dwAlignment
[in] bCopy
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);
[in] pTargetControlBar
[in] srcManager
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);
[in] plstControlBars
[in] plstSliders
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);
[in] pControlBarToAdd
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);
[in] pBarToAdd
[in] pRecentContainer
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);
[in] rectOriginal
[in] rectInserted
[in] rectSlider
[in] dwSliderStyle
[in] dwAlignment
[in] sizeMinOriginal
[in] sizeMinInserted
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;
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);
[in] pWnd
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);
[in] point
[in] ppTargetControlBar
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);
[in] pParentWnd
[in] pDefaultSlider
[in] pContainerRTC
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;
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();
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);
[in] bEnable
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);
[in] pBar
[in] bLeftBar
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);
[in] nID
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;
[in] rect
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;
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();
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;
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;
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);
[in] pSlider
[in] nMinOffset
[in] nMaxOffset
[in] nStep
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);
[in] size
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;
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;
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;
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;
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;
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;
[in] rect
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();
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);
[in] pControlBarToInsert
[in] pTargetControlBar
[in] dwAlignment
[in] lpRect
[in] dockMethod
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;
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;
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;
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();
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);
[in] pSlider
[in] uFlags
[in] nOffset
[in] hdwp
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);
[in] pBar
[in] bShow
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);
[in] point
[in] nSensitivity
[in] bExactBar
[in] bIsTabArea
[in] bCaption
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();
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();
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();
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);
[in] pSlider
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);
[in] pControlBar
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);
[in] pBarOld
[in] pBarNew
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);
[in] nSide
[in] bExpand
[in] nOffset
[in] hdwp
[in] rect
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);
[in] ar
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);
[in] pSlider
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);
[in] pContainerRTC
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);
[in] bResize
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);
[in] pBar
Hierarchy Chart
Classes
CObject Class
CPaneContainer Class
CPaneDivider Class