CDockingPanesRow Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

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

Manages a list of panes that are located in the same horizontal or vertical row (column) of a dock site.

Syntax

class CDockingPanesRow : public CObject  

Members

Public Constructors

Name	Description
CDockingPanesRow::CDockingPanesRow	Default constructor.

Public Methods

Name	Description
CDockingPanesRow::AddPane
CDockingPanesRow::AddPaneFromRow
CDockingPanesRow::ArrangePanes	Arranges the panes in a row according to the specified margin and spacing parameters.
CDockingPanesRow::CalcFixedLayout
CDockingPanesRow::Create
CDockingPanesRow::ExpandStretchedPanes
CDockingPanesRow::ExpandStretchedPanesRect
CDockingPanesRow::FixupVirtualRects
CDockingPanesRow::GetAvailableLength
CDockingPanesRow::GetAvailableSpace
CDockingPanesRow::GetClientRect
CDockingPanesRow::GetDockSite
CDockingPanesRow::GetExtraSpace
CDockingPanesRow::GetGroupFromPane
CDockingPanesRow::GetID
CDockingPanesRow::GetMaxPaneSize
CDockingPanesRow::GetPaneCount
CDockingPanesRow::GetPaneList
CDockingPanesRow::GetRowAlignment
CDockingPanesRow::GetRowHeight
CDockingPanesRow::GetRowOffset
CDockingPanesRow::GetVisibleCount
CDockingPanesRow::GetWindowRect
CDockingPanesRow::HasPane
CDockingPanesRow::IsEmpty
CDockingPanesRow::IsExclusiveRow
CDockingPanesRow::IsHorizontal
CDockingPanesRow::IsVisible
CDockingPanesRow::Move
CDockingPanesRow::MovePane
CDockingPanesRow::OnResizePane
CDockingPanesRow::RedrawAll
CDockingPanesRow::RemovePane
CDockingPanesRow::ReplacePane
CDockingPanesRow::RepositionPanes
CDockingPanesRow::Resize
CDockingPanesRow::ResizeByPaneDivider
CDockingPanesRow::ScreenToClient
CDockingPanesRow::SetExtra
CDockingPanesRow::ShowDockSiteRow
CDockingPanesRow::ShowPane
CDockingPanesRow::UpdateVisibleState

Remarks

CDockingPanesRow objects are created internally by dock site objects.

Example

The following example demonstrates how to get a CDockingPanesRow object from a CMFCAutoHideBar object.

    CMFCAutoHideBar* pParentBar = new CMFCAutoHideBar();
    CDockingPanesRow* pParentRow = pParentBar->GetDockSiteRow();

Inheritance Hierarchy

CObject

CDockingPanesRow

Requirements

Header: afxDockingPanesRow.h

CDockingPanesRow::AddPane

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 AddPane(
    CPane* pControlBar,  
    AFX_DOCK_METHOD dockMethod,  
    LPCRECT lpRect = NULL,  
    BOOL bAddLast = FALSE);

Parameters

[in] pControlBar
[in] dockMethod
[in] lpRect
[in] bAddLast

Remarks

CDockingPanesRow::AddPaneFromRow

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 AddPaneFromRow(
    CPane* pControlBar,  
    AFX_DOCK_METHOD dockMethod);

Parameters

[in] pControlBar
[in] dockMethod

Remarks

CDockingPanesRow::ArrangePanes

Arranges docking panes in a row according to the specified margin and spacing parameters.

virtual void ArrangePanes(
    int nMargin,  
    int nSpacing);

Parameters

[in] nMargin
Specifies the offset, in pixels, of the first pane from the upper-left corner of the row.

[in] nSpacing
Specifies the spacing, in pixels, between panes.

Remarks

Call this method to arrange panes in the row where they will dock. After calling this method, you must call CDockingPanesRow::FixupVirtualRects(FALSE, NULL).

CDockingPanesRow::CalcFixedLayout

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 CSize CalcFixedLayout(
    BOOL bStretch,  
    BOOL bHorz);

Parameters

[in] bStretch
[in] bHorz

Return Value

Remarks

CDockingPanesRow::CDockingPanesRow

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.

CDockingPanesRow(
    CDockSite* pParentDockBar,  
    int nOffset,  
    int nHeight);

Parameters

[in] pParentDockBar
[in] nOffset
[in] nHeight

Remarks

CDockingPanesRow::Create

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

Return Value

Remarks

CDockingPanesRow::ExpandStretchedPanes

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

Remarks

CDockingPanesRow::ExpandStretchedPanesRect

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

Remarks

CDockingPanesRow::FixupVirtualRects

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 FixupVirtualRects(
    bool bMoveBackToVirtualRect,  
    CPane* pBarToExclude = NULL);

Parameters

[in] bMoveBackToVirtualRect
[in] pBarToExclude

Remarks

CDockingPanesRow::GetAvailableLength

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 int GetAvailableLength(BOOL bUseVirtualRect = FALSE) const;  

Parameters

[in] bUseVirtualRect

Return Value

Remarks

CDockingPanesRow::GetAvailableSpace

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 GetAvailableSpace(CRect& rect);

Parameters

[in] rect

Remarks

CDockingPanesRow::GetClientRect

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 GetClientRect(CRect& rect) const;  

Parameters

[in] rect

Remarks

CDockingPanesRow::GetDockSite

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.

CDockSite* GetDockSite() const;  

Return Value

Remarks

CDockingPanesRow::GetExtraSpace

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 GetExtraSpace() const;  

Return Value

Remarks

CDockingPanesRow::GetGroupFromPane

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 GetGroupFromPane(
    CPane* pBar,  
    CObList& lst);

Parameters

[in] pBar
[in] lst

Remarks

CDockingPanesRow::GetID

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 GetID() const;  

Return Value

Remarks

CDockingPanesRow::GetMaxPaneSize

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 GetMaxPaneSize(BOOL bSkipHiddenBars = TRUE) const;  

Parameters

[in] bSkipHiddenBars

Return Value

Remarks

CDockingPanesRow::GetPaneCount

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 GetPaneCount() const;  

Return Value

Remarks

CDockingPanesRow::GetPaneList

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.

const CObList& GetPaneList() const;  

Return Value

Remarks

CDockingPanesRow::GetRowAlignment

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.

DWORD GetRowAlignment() const;  

Return Value

Remarks

CDockingPanesRow::GetRowHeight

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 GetRowHeight() const;  

Return Value

Remarks

CDockingPanesRow::GetRowOffset

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 GetRowOffset() const;  

Return Value

Remarks

CDockingPanesRow::GetVisibleCount

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 int GetVisibleCount();

Return Value

Remarks

CDockingPanesRow::GetWindowRect

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 GetWindowRect(CRect& rect) const;  

Parameters

[in] rect

Remarks

CDockingPanesRow::HasPane

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 HasPane(CBasePane* pControlBar);

Parameters

[in] pControlBar

Return Value

Remarks

CDockingPanesRow::IsEmpty

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 BOOL IsEmpty() const;  

Return Value

Remarks

CDockingPanesRow::IsExclusiveRow

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 BOOL IsExclusiveRow() const;  

Return Value

Remarks

CDockingPanesRow::IsHorizontal

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 IsHorizontal() const;  

Return Value

Remarks

CDockingPanesRow::IsVisible

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 BOOL IsVisible() const;  

Return Value

Remarks

CDockingPanesRow::Move

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 Move(int nOffset);

Parameters

[in] nOffset

Remarks

CDockingPanesRow::MovePane

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 MovePane(
    CPane* pControlBar,  
    CPoint ptOffset,  
    BOOL bSwapControlBars,  
    HDWP& hdwp);

 
void MovePane(
    CPane* pControlBar,  
    CRect rectTarget,  
    HDWP& hdwp);

 
void MovePane(
    CPane* pControlBar,  
    int nOffset,  
    bool bForward,  
    HDWP& hdwp);

 
void MovePane(
    CPane* pControlBar,  
    int nAbsolutOffset,  
    HDWP& hdwp);

Parameters

[in] pControlBar
[in] ptOffset
[in] bSwapControlBars
[in] hdwp
[in] rectTarget
[in] nOffset
[in] bForward
[in] nAbsolutOffset

Remarks

CDockingPanesRow::OnResizePane

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 OnResizePane(CBasePane* pControlBar);

Parameters

[in] pControlBar

Remarks

CDockingPanesRow::RedrawAll

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

Remarks

CDockingPanesRow::RemovePane

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 RemovePane(CPane* pControlBar);

Parameters

[in] pControlBar

Remarks

CDockingPanesRow::ReplacePane

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 BOOL ReplacePane(
    CPane* pBarOld,  
    CPane* pBarNew);

Parameters

[in] pBarOld
[in] pBarNew

Return Value

Remarks

CDockingPanesRow::RepositionPanes

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 RepositionPanes(
    CRect& rectNewParentBarArea,  
    UINT nSide = (UINT)-1,  
    BOOL bExpand = FALSE,  
    int nOffset = 0);

Parameters

[in] rectNewParentBarArea
[in] nSide
[in] bExpand
[in] nOffset

Remarks

CDockingPanesRow::Resize

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 int Resize(int nOffset);

Parameters

[in] nOffset

Return Value

Remarks

CDockingPanesRow::ResizeByPaneDivider

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 int ResizeByPaneDivider(int);

Parameters

[in] int

Return Value

Remarks

CDockingPanesRow::ScreenToClient

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 ScreenToClient(CRect& rect) const;  

Parameters

[in] rect

Remarks

CDockingPanesRow::SetExtra

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 SetExtra(
    int nExtraSpace,  
    AFX_ROW_ALIGNMENT rowExtraAlign);

Parameters

[in] nExtraSpace
[in] rowExtraAlign

Remarks

CDockingPanesRow::ShowDockSiteRow

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 ShowDockSiteRow(
    BOOL bShow,  
    BOOL bDelay);

Parameters

[in] bShow
[in] bDelay

Remarks

CDockingPanesRow::ShowPane

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 BOOL ShowPane(
    CPane* pControlBar,  
    BOOL bShow,  
    BOOL bDelay = FALSE);

Parameters

[in] pControlBar
[in] bShow
[in] bDelay

Return Value

Remarks

CDockingPanesRow::UpdateVisibleState

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 UpdateVisibleState(BOOL bDelay);

Parameters

[in] bDelay

Remarks

See Also

Hierarchy Chart
Classes
CObject Class
CDockSite Class
CPane Class