CPaneFrameWnd Class

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.

Implements a mini-frame window that contains one pane. The pane fills the client area of the window.

class CPaneFrameWnd : public CWnd

Members

Public Methods

Name

Description

CPaneFrameWnd::AddPane

Adds a pane.

CPaneFrameWnd::AddRemovePaneFromGlobalList

Adds or removes a pane from the global list.

CPaneFrameWnd::AdjustLayout

Adjusts the layout of the mini-frame window.

CPaneFrameWnd::AdjustPaneFrames

 

CPaneFrameWnd::CalcBorderSize

Calculates the size of the borders for a mini-frame window.

CPaneFrameWnd::CalcExpectedDockedRect

Calculate the expected rectangle of a docked window.

CPaneFrameWnd::CanBeAttached

Determines whether the current pane can be docked to another pane or frame window.

CPaneFrameWnd::CanBeDockedToPane

Determines whether the mini-frame window can be docked to a pane.

CPaneFrameWnd::CheckGripperVisibility

 

CPaneFrameWnd::ConvertToTabbedDocument

Converts the pane to a tabbed document.

CPaneFrameWnd::Create

Creates a mini-frame window and attaches it to the CPaneFrameWnd object.

CPaneFrameWnd::CreateEx

Creates a mini-frame window and attaches it to the CPaneFrameWnd object.

CPaneFrameWnd::DockPane

Docks the pane.

CPaneFrameWnd::FindFloatingPaneByID

Finds a pane with the specified control ID in the global list of floating panes.

CPaneFrameWnd::FrameFromPoint

Finds the mini-frame window containing a user-supplied point.

CPaneFrameWnd::GetCaptionHeight

Returns the height of the mini-frame window caption.

CPaneFrameWnd::GetCaptionRect

Calculates the bounding rectangle of a mini-frame window caption.

CPaneFrameWnd::GetCaptionText

Returns the caption text.

CPaneFrameWnd::GetDockingManager

 

CPaneFrameWnd::GetDockingMode

Returns the docking mode.

CPaneFrameWnd::GetFirstVisiblePane

Returns the first visible pane that is contained in a mini-frame window.

CPaneFrameWnd::GetHotPoint

 

CPaneFrameWnd::GetPane

Returns a pane that is contained in the mini-frame window.

CPaneFrameWnd::GetPaneCount

Returns the number of panes that are contained in a mini-frame window.

CPaneFrameWnd::GetParent

 

CPaneFrameWnd::GetPinState

 

CPaneFrameWnd::GetRecentFloatingRect

 

CPaneFrameWnd::GetVisiblePaneCount

Returns the number of visible panes that are contained in a mini-frame window.

CPaneFrameWnd::HitTest

Determines what part of a mini-frame window is at a given point.

CPaneFrameWnd::IsCaptured

 

CPaneFrameWnd::IsDelayShow

 

CPaneFrameWnd::IsRollDown

Determines whether a mini-frame window should be rolled down.

CPaneFrameWnd::IsRollUp

Determines whether a mini-frame window should be rolled up.

CPaneFrameWnd::KillDockingTimer

Stops the docking timer.

CPaneFrameWnd::LoadState

Loads the pane's state from the registry.

CPaneFrameWnd::OnBeforeDock

Determines if docking is possible.

CPaneFrameWnd::OnDockToRecentPos

Docks the mini-frame window at its most recent position.

CPaneFrameWnd::OnKillRollUpTimer

Stops the rollup timer.

CPaneFrameWnd::OnMovePane

Moves the mini-frame window by a specified offset.

CPaneFrameWnd::OnPaneRecalcLayout

Adjusts the layout of a contained pane.

CPaneFrameWnd::OnSetRollUpTimer

Sets the rollup timer.

CPaneFrameWnd::OnShowPane

Called by the framework when a pane in the mini-frame window is hidden or displayed.

CPaneFrameWnd::PaneFromPoint

Returns a pane if it contains a user-supplied point inside a mini-frame window.

CPaneFrameWnd::Pin

 

CPaneFrameWnd::PreTranslateMessage

Used by class CWinApp to translate window messages before they are dispatched to the TranslateMessage and DispatchMessage Windows functions.

CPaneFrameWnd::RedrawAll

Redraws all mini-frame windows.

CPaneFrameWnd::RemoveNonValidPanes

Called by the framework to remove non-valid panes.

CPaneFrameWnd::RemovePane

Removes a pane from the mini-frame window.

CPaneFrameWnd::ReplacePane

Replaces one pane with another.

CPaneFrameWnd::SaveState

Saves the pane's state to the registry.

CPaneFrameWnd::Serialize

Reads or writes this object from or to an archive.

CPaneFrameWnd::SetCaptionButtons

Sets caption buttons.

CPaneFrameWnd::SetDelayShow

 

CPaneFrameWnd::SetDockingManager

 

CPaneFrameWnd::SetDockingTimer

Sets the docking timer.

CPaneFrameWnd::SetDockState

Sets the docking state.

CPaneFrameWnd::SetHotPoint

 

CPaneFrameWnd::SetPreDockState

Called by the framework to set the predocking state.

CPaneFrameWnd::SizeToContent

Adjusts the size of a mini-frame window so that it is equivalent in size to a contained pane.

CPaneFrameWnd::StartTearOff

Tears off a menu.

CPaneFrameWnd::StoreRecentDockSiteInfo

 

CPaneFrameWnd::StoreRecentTabRelatedInfo

 

Protected Methods

Name

Description

CPaneFrameWnd::OnCheckRollState

Determines whether a mini-frame window should be rolled up or down.

CPaneFrameWnd::OnDrawBorder

Draws the borders of a mini-frame window.

Data Members

Name

Description

CPaneFrameWnd::m_bUseSaveBits

Specifies whether to register the window class with the CS_SAVEBITS class style.

Remarks

The framework automatically creates a CPaneFrameWnd object when a pane is switched from a docked state to a floating state.

A mini-frame window can be dragged with its contents visible (immediate docking) or using a drag rectangle (standard docking). The docking mode of the mini-frame's container pane determines the mini-frame's dragging behavior. For more information, see CBasePane::GetDockingMode.

A mini-frame window displays buttons on the caption in accordance with the contained pane style. If the pane can be closed (CBasePane::CanBeClosed), it displays a Close button. If the pane has the AFX_CBRS_AUTO_ROLLUP style, it displays a pin.

If you derive a class from CPaneFrameWnd, you must tell the framework how to create it. Either create the class by overriding CPane::CreateDefaultMiniframe, or set the CPane::m_pMiniFrameRTC member so that it points to the runtime class information for your class.

Inheritance Hierarchy

CObject

   CCmdTarget

      CWnd

         CPaneFrameWnd

Requirements

Header: afxPaneFrameWnd.h

See Also

Reference

Hierarchy Chart

CWnd Class

Other Resources

MFC Classes