Classe CDockSite

Para mais detalhes, consulte o código-fonte localizado na pasta VC\atlmfc\src\mfc da sua instalação no Visual Studio.

Fornece funcionalidade para organizar painéis derivados da Classe CPane em conjuntos de linhas.

Sintaxe

class CDockSite: public CBasePane

Membros

Métodos Públicos

Observações

O framework cria CDockSite objetos automaticamente quando chamas o CFrameWndEx::EnableDocking. As janelas do local das docas estão posicionadas na extremidade da área do cliente, na janela principal.

Normalmente não é necessário ligar para os serviços prestados pelo local do cais porque a CFrameWndEx Class trata destes serviços.

Example

O exemplo seguinte demonstra como criar um objeto da CDockSite classe.

AFX_DOCKSITE_INFO info;
CDockSite *pDockBar = (CDockSite*)info.pDockBarRTC->CreateObject();

Hierarquia de herança

CObject
└ CCmdTarget
 └ CWnd
  └ CBasePane
   └ CDockSite

Requerimentos

Cabeçalho: afxDockSite.h

CDockSite::AddRow

CDockingPanesRow* AddRow(
    POSITION pos,
    int nHeight);

Parâmetros

[dentro] pos

[dentro] nAltura

Valor de retorno

Observações

CDockSite::AdjustDockingLayout

virtual void AdjustDockingLayout();

Observações

CDockSite::AdjustLayout

virtual void AdjustLayout();

Observações

CDockSite::AlignDockSite

void AlignDockSite(
    const CRect& rectToAlignBy,
    CRect& rectResult,
    BOOL bMoveImmediately);

Parâmetros

[dentro] rectToAlignBy

[dentro] rectResult

[dentro] bMoveImediatamente

Observações

CDockSite::CalcFixedLayout

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

Parâmetros

[dentro] bStretch

[dentro] bHorz

Valor de retorno

Observações

CDockSite::CanAcceptPane

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

Parâmetros

[dentro] pBar

Valor de retorno

Observações

CDockSite::CreateEx

virtual BOOL CreateEx(
    DWORD dwStyleEx,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    DWORD dwControlBarStyle,
    CCreateContext* pContext = NULL);

Parâmetros

[dentro] dwStyleEx

[dentro] dwStyle

[dentro] Rect

[dentro] pParentWnd

[dentro] dwControlBarStyle

[dentro] pContexto

Valor de retorno

Observações

CDockSite::CreateRow

virtual CDockingPanesRow* CreateRow(
    CDockSite* pParentDockBar,
    int nOffset,
    int nRowHeight);

Parâmetros

[dentro] pParentDockBar

[dentro] nOffset

[dentro] nRowHeight

Valor de retorno

Observações

CDockSite::D ockPane

virtual void DockPane(
    CPane* pWnd,
    AFX_DOCK_METHOD dockMethod,
    LPCRECT lpRect = NULL);

Parâmetros

[dentro] pWnd

[dentro] dockMethod

[dentro] lpRect

Observações

CDockSite::D ockPaneLeftOf

Atraca um vidro à esquerda de outro vidro.

virtual BOOL DockPaneLeftOf(
    CPane* pBarToDock,
    CPane* pTargetBar);

Parâmetros

pBarToDock
[inspira, expira] Um apontador para o painel a ser acoplado à esquerda do pTargetBar.

pTargetBar
[inspira, expira] Um apontador para o painel alvo.

Valor de retorno

TRUE se o painel for acoplado com sucesso; caso contrário, FALSO.

Observações

CDockSite::D oesAllowDynInsertBefore

virtual BOOL DoesAllowDynInsertBefore() const;

Valor de retorno

Observações

CDockSite::FindPaneByID

Devolve o painel com o ID indicado.

CPane* FindPaneByID(UINT nID);

Parâmetros

nID
[dentro] O ID do comando do painel será encontrado.

Valor de retorno

Um apontador para o painel com o ID de comando especificado, ou NULL se o painel não for encontrado.

Observações

CDockSite::FindRowIndex

int FindRowIndex(CDockingPanesRow* pRow);

Parâmetros

[dentro] pRow

Valor de retorno

Observações

CDockSite::FixupVirtualRects

virtual void FixupVirtualRects();

Observações

CDockSite::GetDockSiteID

virtual UINT GetDockSiteID() const;

Valor de retorno

Observações

CDockSite::GetDockSiteRowsList

const CObList& GetDockSiteRowsList() const;

Valor de retorno

Observações

CDockSite::GetPaneList

Devolve uma lista de painéis que estão acoplados ao local da doca.

const CObList& GetPaneList() const;

Valor de retorno

Uma referência de apenas leitura à lista de painéis atualmente ancorados na barra de acoplamento.

CDockSite::ÉAcessívelCompatível

virtual BOOL IsAccessibilityCompatible();

Valor de retorno

Observações

CDockSite::IsDragMode

virtual BOOL IsDragMode() const;

Valor de retorno

Observações

CDockSite::IsLastRow

bool IsLastRow(CDockingPanesRow* pRow) const;

Parâmetros

[dentro] pRow

Valor de retorno

Observações

CDockSite::IsRectWithinDockSite

BOOL IsRectWithinDockSite(
    CRect rect,
    CPoint& ptDelta);

Parâmetros

[dentro] Rect

[dentro] ptDelta

Valor de retorno

Observações

CDockSite::IsResdimensionável

virtual BOOL IsResizable() const;

Valor de retorno

Observações

CDockSite::MovePane

virtual BOOL MovePane(
    CPane* pWnd,
    UINT nFlags,
    CPoint ptOffset);

Parâmetros

[dentro] pWnd

[dentro] nFlags

[dentro] ptOffset

Valor de retorno

Observações

CDockSite::OnInsertRow

virtual void OnInsertRow(POSITION pos);

Parâmetros

[dentro] pos

Observações

CDockSite::OnRemoveRow

virtual void OnRemoveRow(
    POSITION pos,
    BOOL bByShow = FALSE);

Parâmetros

[dentro] pos

[dentro] bByShow

Observações

CDockSite::OnRedimensionRow

virtual int OnResizeRow(
    CDockingPanesRow* pRowToResize,
    int nOffset);

Parâmetros

[dentro] pRowParaRedimensionar

[dentro] nOffset

Valor de retorno

Observações

CDockSite::OnSizeParent

virtual void OnSizeParent(
    CRect& rectAvailable,
    UINT nSide,
    BOOL bExpand,
    int nOffset);

Parâmetros

[dentro] rectDisponível

[dentro] nSide

[dentro] bExpandir

[dentro] nOffset

Observações

CDockSite::OnSetWindowPos

virtual BOOL OnSetWindowPos(
    const CWnd* pWndInsertAfter,
    const CRect& rectWnd,
    UINT nFlags);

Parâmetros

[dentro] pWndInsertAfter

[dentro] direitaWnd

[dentro] nFlags

Valor de retorno

Observações

CDockSite::OnShowRow

virtual void OnShowRow(
    POSITION pos,
    BOOL bShow);

Parâmetros

[dentro] pos

[dentro] bShow

Observações

CDockSite::P aneFromPoint

Devolve um painel que está acoplado no local da doca no ponto especificado pelo parâmetro indicado.

virtual CPane* PaneFromPoint(CPoint pt);

Parâmetros

pt
[dentro] Um ponto, nas coordenadas do ecrã, para o painel recuperar.

Valor de retorno

Um ponteiro para o painel localizado no ponto especificado ou NULL se não houvesse nenhum painel presente nesse ponto especificado.

Observações

CDockSite::RectSideFromPoint

static int __stdcall RectSideFromPoint(
    const CRect& rect,
    const CPoint& point);

Parâmetros

[dentro] Rect

[dentro] ponto

Valor de retorno

Observações

CDockSite::RemovePane

virtual void RemovePane(
    CPane* pWnd,
    AFX_DOCK_METHOD dockMethod);

Parâmetros

[dentro] pWnd

[dentro] dockMethod

Observações

CDockSite::RemoveRow

void RemoveRow(CDockingPanesRow* pRow);

Parâmetros

[dentro] pRow

Observações

CDockSite::ReplacePane

BOOL ReplacePane(
    CPane* pOldBar,
    CPane* pNewBar);

Parâmetros

[dentro] pOldBar

[dentro] pNewBar

Valor de retorno

Observações

CDockSite::RepositionPanes

virtual void RepositionPanes(CRect& rectNewClientArea);

Parâmetros

[dentro] rectNewClienteArea

Observações

CDockSite::RedimensionDockSite

void ResizeDockSite(
    int nNewWidth,
    int nNewHeight);

Parâmetros

[dentro] nNewWidth

[dentro] nNewHeight

Observações

CDockSite::RedimensionRow

int ResizeRow(
    CDockingPanesRow* pRow,
    int nNewSize,
    BOOL bAdjustLayout = TRUE);

Parâmetros

[dentro] pRow

[dentro] nNewSize

[dentro] bAdajustLayout

Valor de retorno

Observações

CDockSite::ShowPane

Mostra o painel.

virtual BOOL ShowPane(
    CBasePane* pBar,
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

Parâmetros

pBar
[inspira, expira] Um apontador para o painel a ser mostrado ou escondido.

bShow
[dentro] TRUE para especificar que o painel deve ser mostrado; FALSE para especificar que o painel deve ser escondido.

bDelay
[dentro] TRUE para especificar que a disposição do painel deve ser adiada até depois de o painel ser mostrado; caso contrário, FALSO.

bAtivar
[dentro] Este parâmetro não é utilizado.

Valor de retorno

VERDADE se o painel foi mostrado ou escondido com sucesso. FALSE se o painel especificado não pertencer a este local de doca.

Observações

Chame-se a este método para mostrar ou esconder painéis acoplados. Normalmente, não tens de chamar CDockSite::ShowPane diretamente, porque é chamado pela janela da moldura principal ou pelo painel base.

CDockSite::ShowRow

void ShowRow(
    CDockingPanesRow* pRow,
    BOOL bShow,
    BOOL bAdjustLayout);

Parâmetros

[dentro] pRow

[dentro] bShow

[dentro] bAdajustLayout

Observações

CDockSite::SwapRows

void SwapRows(
    CDockingPanesRow* pFirstRow,
    CDockingPanesRow* pSecondRow);

Parâmetros

[dentro] pFirstRow

[dentro] pSegundaLinha

Observações

Consulte também

Gráfico de Hierarquia
Classes
Classe CBasePane