CPane Class

Articolo
07/24/2011

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.

The CPane class is an enhancement of the CControlBar Class. If you are upgrading an existing MFC project, you need to replace all occurrences of CControlBar with CPane.

class CPane : public CBasePane

Members

Public Constructors

Name	Description
CPane::~CPane	Destructor.

Public Methods

Name	Description
CPane::AdjustSizeImmediate	Immediately recalculates the layout of a pane.
CPane::AllocElements	Allocates storage for internal use.
CPane::AllowShowOnPaneMenu
CPane::CalcAvailableSize	Calculates the difference in size between a specified rectangle and the current window rectangle.
CPane::CalcInsideRect	Calculates the inside rectangle of a pane, taking into account the borders and grippers.
CPane::CalcRecentDockedRect	Calculates the recently docked rectangle.
CPane::CalcSize	Calculates the size of the pane.
CPane::CanBeDocked	Determines if the pane can be docked at the specified base pane.
CPane::CanBeTabbedDocument	Determines if the pane can be converted to a tabbed document.
CPane::ConvertToTabbedDocument
CPane::CopyState	Copies the state of a pane. (Overrides CBasePane::CopyState.)
CPane::Create	Creates a control bar and attaches it to the CPane object.
CPane::CreateDefaultMiniframe	Creates a mini frame window for a floating pane.
CPane::CreateEx	Creates a control bar and attaches it to the CPane object.
CPane::CreateObject	Used by the framework to create a dynamic instance of this class type.
CPane::DockByMouse	Docks a pane by using the mouse docking methodl.
CPane::DockPane	Docks the floating pane to a base pane.
CPane::DockPaneStandard
CPane::DockToFrameWindow	(Overrides CBasePane::DockToFrameWindow.)
CPane::DoesAllowSiblingBars	Indicates whether you can dock another pane at the same row where the current pane is docked.
CPane::FloatPane	Floats the pane.
CPane::GetAvailableExpandSize
CPane::GetAvailableStretchSize
CPane::GetBorders	Returns the width of the borders of the pane.
CPane::GetClientHotSpot
CPane::GetDockSiteRow
CPane::GetExclusiveRowMode	Determines if the pane is in exclusive row mode.
CPane::GetHotSpot
CPane::GetMinLength
CPane::GetMinSize
CPane::GetPaneName
CPane::GetResizeStep
CPane::GetThisClass	Used by the framework to obtain a pointer to the CRuntimeClass object that is associated with this class type.
CPane::GetVirtualRect
CPane::IsChangeState
CPane::IsDragMode
CPane::IsInFloatingMultiPaneFrameWnd	(Overrides CBasePane::IsInFloatingMultiPaneFrameWnd.)
CPane::IsLastPaneOnLastRow
CPane::IsLeftOf
CPane::IsResizable	Determines whether the pane can be resized. (Overrides CBasePane::IsResizable.)
CPane::IsTabbed	Determines whether the pane has been inserted in the tab control of a tabbed window. (Overrides CBasePane::IsTabbed.) (Overrides CBasePane::IsTabbed.)
CPane::LoadState	Loads the pane's state from the registry. (Overrides CBasePane::LoadState.) (Overrides CBasePane::LoadState.)
CPane::MoveByAlignment
CPane::MovePane
CPane::OnAfterChangeParent	Called by the framework when the parent of a pane has changed.
CPane::OnBeforeChangeParent	Called by the framework when the parent of the pane is about to change.
CPane::OnPressCloseButton	Called by the framework when the user presses the close button on the caption for the pane.
CPane::OnProcessDblClk
CPane::OnShowControlBarMenu
CPane::OnShowControlBarMenu	Called by the framework when a special pane menu is about to be displayed.
CPane::PrepareToDock
CPane::RecalcLayout	(Overrides CBasePane::RecalcLayout.)
CPane::SaveState	Saves the pane's state to the registry. (Overrides CBasePane::SaveState.) (Overrides CBasePane::SaveState.)
CPane::SetActiveInGroup
CPane::SetBorders	Sets the border values of the pane.
CPane::SetClientHotSpot
CPane::SetDockState
CPane::SetExclusiveRowMode	Enables or disables the exclusive row mode.
CPane::SetMiniFrameRTC	Sets the runtime class information for the default mini frame window.
CPane::SetMinSize
CPane::SetRecentTabWindowInfo
CPane::SetVirtualRect
CPane::StretchPaneDeferWndPos
CPane::ToggleAutoHide	Toggles auto hide mode.
CPane::UndockPane	Removes the pane from the dock site, default slider, or mini-frame window where it is currently docked. (Overrides CBasePane::UndockPane.)
CPane::UpdateVirtualRect

Protected Methods

Name	Description
CPane::OnAfterDock	Called by the framework when a pane has been docked.
CPane::OnAfterFloat	Called by the framework when a pane has floated.
CPane::OnBeforeDock	Called by the framework when the pane is about to be docked.
CPane::OnBeforeFloat	Called by the framework when a pane is about to float.

Data Members

Name	Description
CPane::m_bHandleMinSize	Enables consistent handling of the minimal size for panes.
CPane::m_recentDockInfo	Contains recent docking information.

Remarks

Usually you do not instantiate CPane objects directly. If you need a pane with docking functionality, you should derive your object from CDockablePane. If you need toolbar functionality, you should derive your object from CMFCToolBar.

When you derive your class from CPane, your class can be docked in a CDockSite and it can float in a CPaneFrameWnd.