CMultiPaneFrameWnd Class
The CMultiPaneFrameWnd class extends CPaneFrameWnd Class. It can support multiple panes. Instead of a single embedded handle to a control bar, CMultiPaneFrameWnd contains a CPaneContainerManager Class object that enables the user to dock one CMultiPaneFrameWnd to another and dynamically create multiple floating, tabbed windows.
class CMultiPaneFrameWnd : public CPaneFrameWnd
Members
Public Methods
Name |
Description |
|---|---|
Adds a pane. (Overrides CPaneFrameWnd::AddPane.) |
|
|
|
Adjusts the layout of the mini-frame window. (Overrides CPaneFrameWnd::AdjustLayout.) |
|
(Overrides CPaneFrameWnd::AdjustPaneFrames.) |
|
Calculates the expected rectangle of a docked window. (Overrides CPaneFrameWnd::CalcExpectedDockedRect.) |
|
Determines whether the current pane can dock to another pane or frame window. (Overrides CPaneFrameWnd::CanBeAttached.) |
|
Determines whether the mini-frame window can dock to a pane. (Overrides CPaneFrameWnd::CanBeDockedToPane.) |
|
(Overrides CPaneFrameWnd::CheckGripperVisibility.) |
|
(Overrides CPaneFrameWnd::CloseMiniFrame.) |
|
Converts the pane to a tabbed document. (Overrides CPaneFrameWnd::ConvertToTabbedDocument.) |
|
|
|
Docks the pane. (Overrides CPaneFrameWnd::DockPane.) |
|
|
|
Returns the caption text. (Overrides CPaneFrameWnd::GetCaptionText.) |
|
Returns a reference to the internal container manager object. |
|
Returns the first visible pane that is contained in a mini-frame window. (Overrides CPaneFrameWnd::GetFirstVisiblePane.) |
|
Returns a pane that is contained in the mini-frame window. (Overrides CPaneFrameWnd::GetPane.) |
|
Returns the number of panes that are contained in a mini-frame window. (Overrides CPaneFrameWnd::GetPaneCount.) |
|
Returns the number of visible panes that are contained in a mini-frame window. (Overrides CPaneFrameWnd::GetVisiblePaneCount.) |
|
|
|
Loads the pane's state from the registry. (Overrides CPaneFrameWnd::LoadState.) |
|
Docks the mini-frame window at its most recent position. (Overrides CPaneFrameWnd::OnDockToRecentPos.) |
|
Stops the rollup timer. (Overrides CPaneFrameWnd::OnKillRollUpTimer.) |
|
Adjusts the layout of a pane inside a mini-frame window. (Overrides CPaneFrameWnd::OnPaneRecalcLayout.) |
|
Sets the rollup timer. (Overrides CPaneFrameWnd::OnSetRollUpTimer.) |
|
Called by the framework when a pane in the mini-frame window is hidden or displayed. (Overrides CPaneFrameWnd::OnShowPane.) |
|
Returns a pane if it contains a user-supplied point inside a mini-frame window. (Overrides CPaneFrameWnd::PaneFromPoint.) |
|
Called by the framework to remove non-valid panes. (Overrides CPaneFrameWnd::RemoveNonValidPanes.) |
|
Removes a pane from the mini-frame window. (Overrides CPaneFrameWnd::RemovePane.) |
|
Replaces one pane with another. (Overrides CPaneFrameWnd::ReplacePane.) |
|
Saves the pane's state to the registry. (Overrides CPaneFrameWnd::SaveState.) |
|
(Overrides CPaneFrameWnd::Serialize.) |
|
Sets the docking state. (Overrides CPaneFrameWnd::SetDockState.) |
|
|
|
Sets the predocking state. (Overrides CPaneFrameWnd::SetPreDockState.) |
|
(Overrides CPaneFrameWnd::StoreRecentDockSiteInfo.) |
|
(Overrides CPaneFrameWnd::StoreRecentTabRelatedInfo.) |
Remarks
Most of the methods in this class override methods in the CPaneFrameWnd Class class.
If a pane uses the AFX_CBRS_AUTO_ROLLUP style and the user docks that pane to a multi-pane frame window, the user can roll up the window regardless of the style settings of the other docked panes.
The framework automatically creates a CMultiPaneFrameWnd object when the user floats a pane that uses the CBRS_FLOAT_MULTI style.
For information about deriving a class from the CPaneFrameWnd class and creating it dynamically, see CPaneFrameWnd.
Example
The following example demonstrates how to retrieve a pointer to a CMultiPaneFrameWnd object. This code snippet is part of the Set Pane Size sample.
// CDockablePane* pBar
CMultiPaneFrameWnd* pParentMiniFrame =
DYNAMIC_DOWNCAST (CMultiPaneFrameWnd, pBar->GetParentMiniFrame ()) ;
Inheritance Hierarchy
Requirements
Header: afxMultiPaneFrameWnd.h