CDockSite (clase)
Para obtener información más detallada, consulta el código fuente que se ubica en la carpeta VC\atlmfc\src\mfc de la instalación de Visual Studio.
Proporciona la funcionalidad para organizar los paneles que se derivan de CPane Class en conjuntos de filas.
Sintaxis
class CDockSite: public CBasePane
Miembros
Métodos públicos
Comentarios
El marco crea objetos CDockSite automáticamente al llamar a CFrameWndEx::EnableDocking. Las ventanas del sitio de vinculación están colocadas en el borde del área de cliente de la ventana de marco principal.
Normalmente no es necesario llamar a los servicios proporcionados por el sitio de acoplamiento porque la clase CFrameWndEx controla estos servicios.
Ejemplo
En el ejemplo siguiente se muestra cómo crear un objeto de la clase CDockSite.
AFX_DOCKSITE_INFO info;
CDockSite *pDockBar = (CDockSite*)info.pDockBarRTC->CreateObject();
Jerarquía de herencia
CObject
└ CCmdTarget
└ CWnd
└ CBasePane
└ CDockSite
Requisitos
Encabezado: afxDockSite.h
CDockSite::AddRow
CDockingPanesRow* AddRow(
POSITION pos,
int nHeight);
Parámetros
[in] pos
[in] nHeight
Valor devuelto
Comentarios
CDockSite::AdjustDockingLayout
virtual void AdjustDockingLayout();
Comentarios
CDockSite::AdjustLayout
virtual void AdjustLayout();
Comentarios
CDockSite::AlignDockSite
void AlignDockSite(
const CRect& rectToAlignBy,
CRect& rectResult,
BOOL bMoveImmediately);
Parámetros
[in] rectToAlignBy
[in] rectResult
[in] bMoveImmediately
Comentarios
CDockSite::CalcFixedLayout
virtual CSize CalcFixedLayout(
BOOL bStretch,
BOOL bHorz);
Parámetros
[in] bStretch
[in] bHorz
Valor devuelto
Comentarios
CDockSite::CanAcceptPane
virtual BOOL CanAcceptPane(const CBasePane* pBar) const;
Parámetros
[in] pBar
Valor devuelto
Comentarios
CDockSite::CreateEx
virtual BOOL CreateEx(
DWORD dwStyleEx,
DWORD dwStyle,
const RECT& rect,
CWnd* pParentWnd,
DWORD dwControlBarStyle,
CCreateContext* pContext = NULL);
Parámetros
[in] dwStyleEx
[in] dwStyle
[in] rect
[in] pParentWnd
[in] dwControlBarStyle
[in] pContext
Valor devuelto
Comentarios
CDockSite::CreateRow
virtual CDockingPanesRow* CreateRow(
CDockSite* pParentDockBar,
int nOffset,
int nRowHeight);
Parámetros
[in] pParentDockBar
[in] nOffset
[in] nRowHeight
Valor devuelto
Comentarios
CDockSite::D ockPane
virtual void DockPane(
CPane* pWnd,
AFX_DOCK_METHOD dockMethod,
LPCRECT lpRect = NULL);
Parámetros
[in] pWnd
[in] dockMethod
[in] lpRect
Comentarios
CDockSite::D ockPaneLeftOf
Acopla un panel a la izquierda de otro panel.
virtual BOOL DockPaneLeftOf(
CPane* pBarToDock,
CPane* pTargetBar);
Parámetros
pBarToDock
[in, out] Puntero al panel que se va a acoplar a la izquierda de pTargetBar.
pTargetBar
[in, out] Puntero al panel de destino.
Valor devuelto
TRUE si el panel se acopla correctamente; de lo contrario, FALSE.
Comentarios
CDockSite::D oesAllowDynInsertBefore
virtual BOOL DoesAllowDynInsertBefore() const;
Valor devuelto
Comentarios
CDockSite::FindPaneByID
Devuelve el panel con el id. correspondiente.
CPane* FindPaneByID(UINT nID);
Parámetros
Nid
[in] Id. de comando del panel que se debe encontrar.
Valor devuelto
Puntero al panel con el id. de comando especificado o NULL si no se encuentra el panel.
Comentarios
CDockSite::FindRowIndex
int FindRowIndex(CDockingPanesRow* pRow);
Parámetros
[in] pRow
Valor devuelto
Comentarios
CDockSite::FixupVirtualRects
virtual void FixupVirtualRects();
Comentarios
CDockSite::GetDockSiteID
virtual UINT GetDockSiteID() const;
Valor devuelto
Comentarios
CDockSite::GetDockSiteRowsList
const CObList& GetDockSiteRowsList() const;
Valor devuelto
Comentarios
CDockSite::GetPaneList
Devuelve una lista de paneles acoplados en el sitio de acoplamiento.
const CObList& GetPaneList() const;
Valor devuelto
Referencia de solo lectura a la lista de paneles acoplados actualmente en la barra de acoplamiento.
CDockSite::IsAccessibilityCompatible
virtual BOOL IsAccessibilityCompatible();
Valor devuelto
Comentarios
CDockSite::IsDragMode
virtual BOOL IsDragMode() const;
Valor devuelto
Comentarios
CDockSite::IsLastRow
bool IsLastRow(CDockingPanesRow* pRow) const;
Parámetros
[in] pRow
Valor devuelto
Comentarios
CDockSite::IsRectWithinDockSite
BOOL IsRectWithinDockSite(
CRect rect,
CPoint& ptDelta);
Parámetros
[in] rect
[in] ptDelta
Valor devuelto
Comentarios
CDockSite::IsResizable
virtual BOOL IsResizable() const;
Valor devuelto
Comentarios
CDockSite::MovePane
virtual BOOL MovePane(
CPane* pWnd,
UINT nFlags,
CPoint ptOffset);
Parámetros
[in] pWnd
[in] nFlags
[in] ptOffset
Valor devuelto
Comentarios
CDockSite::OnInsertRow
virtual void OnInsertRow(POSITION pos);
Parámetros
[in] pos
Comentarios
CDockSite::OnRemoveRow
virtual void OnRemoveRow(
POSITION pos,
BOOL bByShow = FALSE);
Parámetros
[in] pos
[in] bByShow
Comentarios
CDockSite::OnResizeRow
virtual int OnResizeRow(
CDockingPanesRow* pRowToResize,
int nOffset);
Parámetros
[in] pRowToResize
[in] nOffset
Valor devuelto
Comentarios
CDockSite::OnSizeParent
virtual void OnSizeParent(
CRect& rectAvailable,
UINT nSide,
BOOL bExpand,
int nOffset);
Parámetros
[in] rectAvailable
[in] nSide
[in] bExpand
[in] nOffset
Comentarios
CDockSite::OnSetWindowPos
virtual BOOL OnSetWindowPos(
const CWnd* pWndInsertAfter,
const CRect& rectWnd,
UINT nFlags);
Parámetros
[in] pWndInsertAfter
[in] rectWnd
[in] nFlags
Valor devuelto
Comentarios
CDockSite::OnShowRow
virtual void OnShowRow(
POSITION pos,
BOOL bShow);
Parámetros
[in] pos
[in] bShow
Comentarios
CDockSite::P aneFromPoint
Devuelve un panel que está acoplado en el sitio de vinculación en el punto especificado por el parámetro dado.
virtual CPane* PaneFromPoint(CPoint pt);
Parámetros
pt
[in] Punto, en coordenadas de pantalla, para el panel que se va a recuperar.
Valor devuelto
Puntero al panel ubicado en el punto especificado o NULL si no hay ningún panel presente en el punto especificado.
Comentarios
CDockSite::RectSideFromPoint
static int __stdcall RectSideFromPoint(
const CRect& rect,
const CPoint& point);
Parámetros
[in] rect
[in] point
Valor devuelto
Comentarios
CDockSite::RemovePane
virtual void RemovePane(
CPane* pWnd,
AFX_DOCK_METHOD dockMethod);
Parámetros
[in] pWnd
[in] dockMethod
Comentarios
CDockSite::RemoveRow
void RemoveRow(CDockingPanesRow* pRow);
Parámetros
[in] pRow
Comentarios
CDockSite::ReplacePane
BOOL ReplacePane(
CPane* pOldBar,
CPane* pNewBar);
Parámetros
[in] pOldBar
[in] pNewBar
Valor devuelto
Comentarios
CDockSite::RepositionPanes
virtual void RepositionPanes(CRect& rectNewClientArea);
Parámetros
[in] rectNewClientArea
Comentarios
CDockSite::ResizeDockSite
void ResizeDockSite(
int nNewWidth,
int nNewHeight);
Parámetros
[in] nNewWidth
[in] nNewHeight
Comentarios
CDockSite::ResizeRow
int ResizeRow(
CDockingPanesRow* pRow,
int nNewSize,
BOOL bAdjustLayout = TRUE);
Parámetros
[in] pRow
[in] nNewSize
[in] bAdjustLayout
Valor devuelto
Comentarios
CDockSite::ShowPane
Muestra el panel.
virtual BOOL ShowPane(
CBasePane* pBar,
BOOL bShow,
BOOL bDelay,
BOOL bActivate);
Parámetros
pBar
[in, out] Puntero al panel que se va a mostrar u ocultar.
bShow
[in] TRUE para especificar que se va a mostrar el panel; FALSE para especificar que el panel se va a ocultar.
bDelay
[in] TRUE para especificar que el diseño del panel debe retrasarse hasta después de que se muestre el panel; de lo contrario, FALSE.
bActivate
[in] Este parámetro no se utiliza.
Valor devuelto
TRUE si el panel se ha mostrado u ocultado correctamente. FALSE si el panel especificado no pertenece a este sitio de acoplamiento.
Comentarios
Llame a este método para mostrar u ocultar paneles acoplados. Normalmente, no es necesario llamar a CDockSite::ShowPane directamente, ya que se llama por la ventana primaria del marco o el panel base.
CDockSite::ShowRow
void ShowRow(
CDockingPanesRow* pRow,
BOOL bShow,
BOOL bAdjustLayout);
Parámetros
[in] pRow
[in] bShow
[in] bAdjustLayout
Comentarios
CDockSite::SwapRows
void SwapRows(
CDockingPanesRow* pFirstRow,
CDockingPanesRow* pSecondRow);
Parámetros
[in] pFirstRow
[in] pSecondRow