Skip to content

Latest commit

 

History

History
714 lines (473 loc) · 15.6 KB

File metadata and controls

714 lines (473 loc) · 15.6 KB
title CDockingPanesRow Class | Microsoft Docs
ms.custom
ms.date 11/04/2016
ms.reviewer
ms.suite
ms.technology
cpp-windows
ms.tgt_pltfrm
ms.topic reference
f1_keywords
CDockingPanesRow
AFXDOCKINGPANESROW/CDockingPanesRow
AFXDOCKINGPANESROW/CDockingPanesRow::AddPane
AFXDOCKINGPANESROW/CDockingPanesRow::AddPaneFromRow
AFXDOCKINGPANESROW/CDockingPanesRow::ArrangePanes
AFXDOCKINGPANESROW/CDockingPanesRow::CalcFixedLayout
AFXDOCKINGPANESROW/CDockingPanesRow::Create
AFXDOCKINGPANESROW/CDockingPanesRow::ExpandStretchedPanes
AFXDOCKINGPANESROW/CDockingPanesRow::ExpandStretchedPanesRect
AFXDOCKINGPANESROW/CDockingPanesRow::FixupVirtualRects
AFXDOCKINGPANESROW/CDockingPanesRow::GetAvailableLength
AFXDOCKINGPANESROW/CDockingPanesRow::GetAvailableSpace
AFXDOCKINGPANESROW/CDockingPanesRow::GetClientRect
AFXDOCKINGPANESROW/CDockingPanesRow::GetDockSite
AFXDOCKINGPANESROW/CDockingPanesRow::GetExtraSpace
AFXDOCKINGPANESROW/CDockingPanesRow::GetGroupFromPane
AFXDOCKINGPANESROW/CDockingPanesRow::GetID
AFXDOCKINGPANESROW/CDockingPanesRow::GetMaxPaneSize
AFXDOCKINGPANESROW/CDockingPanesRow::GetPaneCount
AFXDOCKINGPANESROW/CDockingPanesRow::GetPaneList
AFXDOCKINGPANESROW/CDockingPanesRow::GetRowAlignment
AFXDOCKINGPANESROW/CDockingPanesRow::GetRowHeight
AFXDOCKINGPANESROW/CDockingPanesRow::GetRowOffset
AFXDOCKINGPANESROW/CDockingPanesRow::GetVisibleCount
AFXDOCKINGPANESROW/CDockingPanesRow::GetWindowRect
AFXDOCKINGPANESROW/CDockingPanesRow::HasPane
AFXDOCKINGPANESROW/CDockingPanesRow::IsEmpty
AFXDOCKINGPANESROW/CDockingPanesRow::IsExclusiveRow
AFXDOCKINGPANESROW/CDockingPanesRow::IsHorizontal
AFXDOCKINGPANESROW/CDockingPanesRow::IsVisible
AFXDOCKINGPANESROW/CDockingPanesRow::Move
AFXDOCKINGPANESROW/CDockingPanesRow::MovePane
AFXDOCKINGPANESROW/CDockingPanesRow::OnResizePane
AFXDOCKINGPANESROW/CDockingPanesRow::RedrawAll
AFXDOCKINGPANESROW/CDockingPanesRow::RemovePane
AFXDOCKINGPANESROW/CDockingPanesRow::ReplacePane
AFXDOCKINGPANESROW/CDockingPanesRow::RepositionPanes
AFXDOCKINGPANESROW/CDockingPanesRow::Resize
AFXDOCKINGPANESROW/CDockingPanesRow::ResizeByPaneDivider
AFXDOCKINGPANESROW/CDockingPanesRow::ScreenToClient
AFXDOCKINGPANESROW/CDockingPanesRow::SetExtra
AFXDOCKINGPANESROW/CDockingPanesRow::ShowDockSiteRow
AFXDOCKINGPANESROW/CDockingPanesRow::ShowPane
AFXDOCKINGPANESROW/CDockingPanesRow::UpdateVisibleState
dev_langs
C++
helpviewer_keywords
CDockingPanesRow class
ms.assetid e7a17832-0ebb-4bce-b799-cec9b60f76fe
caps.latest.revision 25
author mikeblome
ms.author mblome
manager ghogen
translation.priority.ht
cs-cz
de-de
es-es
fr-fr
it-it
ja-jp
ko-kr
pl-pl
pt-br
ru-ru
tr-tr
zh-cn
zh-tw

CDockingPanesRow Class

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

[!INCLUDEcpp_fp_under_construction]

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.

[!code-cppNVC_MFC_RibbonApp#26]

Inheritance Hierarchy

CObject

CDockingPanesRow

Requirements

Header: afxDockingPanesRow.h

CDockingPanesRow::AddPane

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

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

virtual CSize CalcFixedLayout(
    BOOL bStretch,  
    BOOL bHorz);

Parameters

[in] bStretch
[in] bHorz

Return Value

Remarks

CDockingPanesRow::CDockingPanesRow

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

Parameters

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

Remarks

CDockingPanesRow::Create

virtual BOOL Create();

Return Value

Remarks

CDockingPanesRow::ExpandStretchedPanes

void ExpandStretchedPanes();

Remarks

CDockingPanesRow::ExpandStretchedPanesRect

void ExpandStretchedPanesRect();

Remarks

CDockingPanesRow::FixupVirtualRects

void FixupVirtualRects(
    bool bMoveBackToVirtualRect,  
    CPane* pBarToExclude = NULL);

Parameters

[in] bMoveBackToVirtualRect
[in] pBarToExclude

Remarks

CDockingPanesRow::GetAvailableLength

virtual int GetAvailableLength(BOOL bUseVirtualRect = FALSE) const;  

Parameters

[in] bUseVirtualRect

Return Value

Remarks

CDockingPanesRow::GetAvailableSpace

virtual void GetAvailableSpace(CRect& rect);

Parameters

[in] rect

Remarks

CDockingPanesRow::GetClientRect

void GetClientRect(CRect& rect) const;  

Parameters

[in] rect

Remarks

CDockingPanesRow::GetDockSite

CDockSite* GetDockSite() const;  

Return Value

Remarks

CDockingPanesRow::GetExtraSpace

int GetExtraSpace() const;  

Return Value

Remarks

CDockingPanesRow::GetGroupFromPane

void GetGroupFromPane(
    CPane* pBar,  
    CObList& lst);

Parameters

[in] pBar
[in] lst

Remarks

CDockingPanesRow::GetID

int GetID() const;  

Return Value

Remarks

CDockingPanesRow::GetMaxPaneSize

int GetMaxPaneSize(BOOL bSkipHiddenBars = TRUE) const;  

Parameters

[in] bSkipHiddenBars

Return Value

Remarks

CDockingPanesRow::GetPaneCount

int GetPaneCount() const;  

Return Value

Remarks

CDockingPanesRow::GetPaneList

const CObList& GetPaneList() const;  

Return Value

Remarks

CDockingPanesRow::GetRowAlignment

DWORD GetRowAlignment() const;  

Return Value

Remarks

CDockingPanesRow::GetRowHeight

int GetRowHeight() const;  

Return Value

Remarks

CDockingPanesRow::GetRowOffset

int GetRowOffset() const;  

Return Value

Remarks

CDockingPanesRow::GetVisibleCount

virtual int GetVisibleCount();

Return Value

Remarks

CDockingPanesRow::GetWindowRect

void GetWindowRect(CRect& rect) const;  

Parameters

[in] rect

Remarks

CDockingPanesRow::HasPane

BOOL HasPane(CBasePane* pControlBar);

Parameters

[in] pControlBar

Return Value

Remarks

CDockingPanesRow::IsEmpty

virtual BOOL IsEmpty() const;  

Return Value

Remarks

CDockingPanesRow::IsExclusiveRow

virtual BOOL IsExclusiveRow() const;  

Return Value

Remarks

CDockingPanesRow::IsHorizontal

bool IsHorizontal() const;  

Return Value

Remarks

CDockingPanesRow::IsVisible

virtual BOOL IsVisible() const;  

Return Value

Remarks

CDockingPanesRow::Move

virtual void Move(int nOffset);

Parameters

[in] nOffset

Remarks

CDockingPanesRow::MovePane

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

virtual void OnResizePane(CBasePane* pControlBar);

Parameters

[in] pControlBar

Remarks

CDockingPanesRow::RedrawAll

void RedrawAll();

Remarks

CDockingPanesRow::RemovePane

virtual void RemovePane(CPane* pControlBar);

Parameters

[in] pControlBar

Remarks

CDockingPanesRow::ReplacePane

virtual BOOL ReplacePane(
    CPane* pBarOld,  
    CPane* pBarNew);

Parameters

[in] pBarOld
[in] pBarNew

Return Value

Remarks

CDockingPanesRow::RepositionPanes

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

virtual int Resize(int nOffset);

Parameters

[in] nOffset

Return Value

Remarks

CDockingPanesRow::ResizeByPaneDivider

virtual int ResizeByPaneDivider(int);

Parameters

[in] int

Return Value

Remarks

CDockingPanesRow::ScreenToClient

void ScreenToClient(CRect& rect) const;  

Parameters

[in] rect

Remarks

CDockingPanesRow::SetExtra

void SetExtra(
    int nExtraSpace,  
    AFX_ROW_ALIGNMENT rowExtraAlign);

Parameters

[in] nExtraSpace
[in] rowExtraAlign

Remarks

CDockingPanesRow::ShowDockSiteRow

virtual void ShowDockSiteRow(
    BOOL bShow,  
    BOOL bDelay);

Parameters

[in] bShow
[in] bDelay

Remarks

CDockingPanesRow::ShowPane

virtual BOOL ShowPane(
    CPane* pControlBar,  
    BOOL bShow,  
    BOOL bDelay = FALSE);

Parameters

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

Return Value

Remarks

CDockingPanesRow::UpdateVisibleState

virtual void UpdateVisibleState(BOOL bDelay);

Parameters

[in] bDelay

Remarks

See Also

Hierarchy Chart
Classes
CObject Class
CDockSite Class
CPane Class