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
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
Requirements
Header: afxrecentDockSiteInfo.h
CRecentDockSiteInfo::CleanUp
void CleanUp();
Remarks
CRecentDockSiteInfo::CRecentDockSiteInfo
CRecentDockSiteInfo(CPane* pBar);
Parameters
[in] pBar
Remarks
CRecentDockSiteInfo::GetRecentDefaultPaneDivider
CPaneDivider* GetRecentDefaultPaneDivider();
Return Value
Remarks
CRecentDockSiteInfo::GetRecentDockedPercent
int GetRecentDockedPercent(BOOL bForSlider);
Parameters
[in] bForSlider
Return Value
Remarks
CRecentDockSiteInfo::GetRecentDockedRect
CRect& GetRecentDockedRect(BOOL bForSlider);
Parameters
[in] bForSlider
Return Value
Remarks
CRecentDockSiteInfo::GetRecentListOfPanes
CList<HWND, HWND>& GetRecentListOfPanes(BOOL bForSlider);
Parameters
[in] bForSlider
Return Value
Remarks
CRecentDockSiteInfo::GetRecentPaneContainer
CPaneContainer* GetRecentPaneContainer(BOOL bForSlider);
Parameters
[in] bForSlider
Return Value
Remarks
CRecentDockSiteInfo::GetRecentTabContainer
CPaneContainer* GetRecentTabContainer(BOOL bForSlider);
Parameters
[in] bForSlider
Return Value
Remarks
CRecentDockSiteInfo::Init
void Init();
Remarks
CRecentDockSiteInfo::IsRecentLeftPane
BOOL IsRecentLeftPane(BOOL bForSlider);
Parameters
[in] bForSlider
Return Value
Remarks
CRecentDockSiteInfo::operator =
CRecentDockSiteInfo& operator=(CRecentDockSiteInfo& src);
Parameters
[in] src
Return Value
Remarks
CRecentDockSiteInfo::SaveListOfRecentPanes
void SaveListOfRecentPanes(CList<HWND,
HWND>& lstOrg,
BOOL bForSlider);
Parameters
[in] CList<HWND
[in] lstOrg
[in] bForSlider
Remarks
CRecentDockSiteInfo::SetInfo
virtual void SetInfo(
BOOL bForSlider,
CRecentDockSiteInfo& srcInfo);
Parameters
[in] bForSlider
[in] srcInfo
Remarks
CRecentDockSiteInfo::StoreDockInfo
virtual void StoreDockInfo(
CPaneContainer* pRecentContainer,
CDockablePane* pTabbedBar = NULL);
Parameters
[in] pRecentContainer
[in] pTabbedBar