CRecentDockSiteInfo Class

 

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

The CRecentDockSiteInfo class is a helper class that stores recent state information for the CPane Class.

Syntax

class CRecentDockSiteInfo : public CObject  

Members

Public Constructors

Name	Description
CRecentDockSiteInfo::CRecentDockSiteInfo	Default constructor.

Public Methods

Name	Description
CRecentDockSiteInfo::CleanUp
CRecentDockSiteInfo::GetRecentDefaultPaneDivider
CRecentDockSiteInfo::GetRecentDockedPercent
CRecentDockSiteInfo::GetRecentDockedRect
CRecentDockSiteInfo::GetRecentListOfPanes
CRecentDockSiteInfo::GetRecentPaneContainer
CRecentDockSiteInfo::GetRecentTabContainer
CRecentDockSiteInfo::Init
CRecentDockSiteInfo::IsRecentLeftPane
CRecentDockSiteInfo::operator =
CRecentDockSiteInfo::SaveListOfRecentPanes
CRecentDockSiteInfo::SetInfo
CRecentDockSiteInfo::StoreDockInfo

Remarks

The CRecentDockSiteInfo class is a data management class. It tracks the last state of a CPane as it transitions between being docked and floating. When a user double clicks a floating dockable pane, it becomes docked. Double clicking the docked pane returns it to its previous location, size, and state. Similarly, when the pane is re-docked it returns to its previous docking location. This data class is what makes that possible. Since the members of this class store state information for the docked pane, they should not be directly modified by your application.

A CRecentDockSiteInfo object is created every time that a pane is created. Each CPane object has a member variable, CPane::m_recentDockInfo, to store this information.

Inheritance Hierarchy

CObject

CRecentDockSiteInfo

Requirements

Header: afxrecentDockSiteInfo.h

CRecentDockSiteInfo::CleanUp

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 CleanUp();

Remarks

CRecentDockSiteInfo::CRecentDockSiteInfo

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.

CRecentDockSiteInfo(CPane* pBar);

Parameters

[in] pBar

Remarks

CRecentDockSiteInfo::GetRecentDefaultPaneDivider

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* GetRecentDefaultPaneDivider();

Return Value

Remarks

CRecentDockSiteInfo::GetRecentDockedPercent

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 GetRecentDockedPercent(BOOL bForSlider);

Parameters

[in] bForSlider

Return Value

Remarks

CRecentDockSiteInfo::GetRecentDockedRect

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.

CRect& GetRecentDockedRect(BOOL bForSlider);

Parameters

[in] bForSlider

Return Value

Remarks

CRecentDockSiteInfo::GetRecentListOfPanes

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.

CList<HWND, HWND>& GetRecentListOfPanes(BOOL bForSlider);

Parameters

[in] bForSlider

Return Value

Remarks

CRecentDockSiteInfo::GetRecentPaneContainer

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.

CPaneContainer* GetRecentPaneContainer(BOOL bForSlider);

Parameters

[in] bForSlider

Return Value

Remarks

CRecentDockSiteInfo::GetRecentTabContainer

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.

CPaneContainer* GetRecentTabContainer(BOOL bForSlider);

Parameters

[in] bForSlider

Return Value

Remarks

CRecentDockSiteInfo::Init

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 Init();

Remarks

CRecentDockSiteInfo::IsRecentLeftPane

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 IsRecentLeftPane(BOOL bForSlider);

Parameters

[in] bForSlider

Return Value

Remarks

CRecentDockSiteInfo::operator =

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.

CRecentDockSiteInfo& operator=(CRecentDockSiteInfo& src);

Parameters

[in] src

Return Value

Remarks

CRecentDockSiteInfo::SaveListOfRecentPanes

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 SaveListOfRecentPanes(CList<HWND,  
    HWND>& lstOrg,  
    BOOL bForSlider);

Parameters

[in] CList<HWND
[in] lstOrg
[in] bForSlider

Remarks

CRecentDockSiteInfo::SetInfo

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 SetInfo(
    BOOL bForSlider,  
    CRecentDockSiteInfo& srcInfo);

Parameters

[in] bForSlider
[in] srcInfo

Remarks

CRecentDockSiteInfo::StoreDockInfo

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 StoreDockInfo(
    CPaneContainer* pRecentContainer,  
    CDockablePane* pTabbedBar = NULL);

Parameters

[in] pRecentContainer
[in] pTabbedBar

Remarks

See Also

Hierarchy Chart
Classes
CDockSite Class