CDockSite-Klasse

Ausführliche Informationen finden Sie im Quellcode des Ordners VC\atlmfc\src\mfc der Visual Studio-Installation.

Stellt eine Funktionalität bereit, mit der Bereiche, die von CPane Class abgeleitet sind, in Zeilengruppen angeordnet werden können

Syntax

class CDockSite: public CBasePane

Member

Öffentliche Methoden

Name Beschreibung
CDockSite::AddRow
CDockSite::AdjustDockingLayout (Außerkraftsetzungen CBasePane::AdjustDockingLayout.)
CDockSite::AdjustLayout (Außerkraftsetzungen CBasePane::AdjustLayout.)
CDockSite::AlignDockSite
CDockSite::CalcFixedLayout (Außerkraftsetzungen CBasePane::CalcFixedLayout.)
CDockSite::CanAcceptPane (Außerkraftsetzungen CBasePane::CanAcceptPane.)
CDockSite::CreateEx (Außerkraftsetzungen CBasePane::CreateEx.)
CDockSite::CreateRow
CDockSite::D ockPane (Außerkraftsetzungen CBasePane::D ockPane.)
CDockSite::D oesAllowDynInsertBefore (Außerkraftsetzungen CBasePane::D oesAllowDynInsertBefore.)
CDockSite::FindRowIndex
CDockSite::FixupVirtualRects
CDockSite::GetDockSiteID
CDockSite::GetDockSiteRowsList
CDockSite::IsAccessibilityCompatible (Überschreibt CBasePane::IsAccessibilityCompatible.)
CDockSite::IsDragMode
CDockSite::IsLastRow
CDockSite::IsRectWithinDockSite
CDockSite::IsResizable (Außerkraftsetzungen CBasePane::IsResizable.)
CDockSite::MovePane
CDockSite::OnInsertRow
CDockSite::OnRemoveRow
CDockSite::OnResizeRow
CDockSite::OnSetWindowPos
CDockSite::OnShowRow
CDockSite::OnSizeParent
CDockSite::P aneFromPoint Gibt einen an der Dockposition angedockten Bereich anhand des angegebenen Parameters an einem bestimmten Punkt zurück.
CDockSite::D ockPaneLeftOf Dockt einen Bereich auf der linken Seite eines anderen Bereichs an.
CDockSite::FindPaneByID Gibt den Bereich zurück, der anhand der angegebenen ID bestimmt wird.
CDockSite::GetPaneList Gibt eine Liste von Bereichen zurück, die an der Dockposition angedockt sind.
CDockSite::RectSideFromPoint
CDockSite::RemovePane
CDockSite::RemoveRow
CDockSite::ReplacePane
CDockSite::RepositionPanes
CDockSite::ResizeDockSite
CDockSite::ResizeRow
CDockSite::ShowPane Zeigt den Bereich an.
CDockSite::ShowRow
CDockSite::SwapRows

Hinweise

Das Framework erstellt CDockSite Objekte automatisch, wenn Sie CFrameWndEx::EnableDocking aufrufen. Dockpositionsfenster werden am Rand des Clientbereichs des Hauptframefensters positioniert.

Normalerweise müssen Sie die von der Dockwebsite bereitgestellten Dienste nicht aufrufen, da die CFrameWndEx-Klasse diese Dienste behandelt.

Beispiel

Im folgenden Beispiel wird gezeigt, wie ein Objekt der CDockSite-Klasse erstellt wird.

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

Vererbungshierarchie

CObject
└ CCmdTarget
└ CWnd
  └ CBasePane
   └ CDockSite

Anforderungen

Header: afxDockSite.h

CDockSite::AddRow

CDockingPanesRow* AddRow(
    POSITION pos,
    int nHeight);

Parameter

[in] Pos

[in] nHeight

Rückgabewert

Bemerkungen

CDockSite::AdjustDockingLayout

virtual void AdjustDockingLayout();

Hinweise

CDockSite::AdjustLayout

virtual void AdjustLayout();

Hinweise

CDockSite::AlignDockSite

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

Parameter

[in] rectToAlignBy

[in] rectResult

[in] bMoveImmediately

Hinweise

CDockSite::CalcFixedLayout

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

Parameter

[in] bStretch

[in] bHorz

Rückgabewert

Bemerkungen

CDockSite::CanAcceptPane

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

Parameter

[in] pBar

Rückgabewert

Bemerkungen

CDockSite::CreateEx

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

Parameter

[in] dwStyleEx

[in] dwStyle

[in] rect

[in] pParentWnd

[in] dwControlBarStyle

[in] pContext

Rückgabewert

Bemerkungen

CDockSite::CreateRow

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

Parameter

[in] pParentDockBar

[in] nOffset

[in] nRowHeight

Rückgabewert

Bemerkungen

CDockSite::D ockPane

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

Parameter

[in] pWnd

[in] dockMethod

[in] lpRect

Hinweise

CDockSite::D ockPaneLeftOf

Dockt einen Bereich auf der linken Seite eines anderen Bereichs an.

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

Parameter

pBarToDock
[in, out] Ein Zeiger auf den Bereich, der links von pTargetBar angedockt werden soll.

pTargetBar
[in, out] Ein Zeiger auf den Zielbereich.

Rückgabewert

TRUE, wenn der Bereich erfolgreich angedockt ist; andernfalls FALSE.

Hinweise

CDockSite::D oesAllowDynInsertBefore

virtual BOOL DoesAllowDynInsertBefore() const;

Rückgabewert

Bemerkungen

CDockSite::FindPaneByID

Gibt den Bereich mit der angegebenen ID zurück.

CPane* FindPaneByID(UINT nID);

Parameter

Nid
[in] Die Befehls-ID des Bereichs, der gefunden werden soll.

Rückgabewert

Ein Zeiger auf den Bereich mit der angegebenen Befehls-ID oder NULL, wenn der Bereich nicht gefunden wird.

Hinweise

CDockSite::FindRowIndex

int FindRowIndex(CDockingPanesRow* pRow);

Parameter

[in] Bug

Rückgabewert

Bemerkungen

CDockSite::FixupVirtualRects

virtual void FixupVirtualRects();

Hinweise

CDockSite::GetDockSiteID

virtual UINT GetDockSiteID() const;

Rückgabewert

Bemerkungen

CDockSite::GetDockSiteRowsList

const CObList& GetDockSiteRowsList() const;

Rückgabewert

Bemerkungen

CDockSite::GetPaneList

Gibt eine Liste von Bereichen zurück, die an der Dockwebsite angedockt sind.

const CObList& GetPaneList() const;

Rückgabewert

Ein schreibgeschützter Verweis auf die Liste der Bereiche, die derzeit in der Docking-Leiste verankert sind.

CDockSite::IsAccessibilityCompatible

virtual BOOL IsAccessibilityCompatible();

Rückgabewert

Bemerkungen

CDockSite::IsDragMode

virtual BOOL IsDragMode() const;

Rückgabewert

Bemerkungen

CDockSite::IsLastRow

bool IsLastRow(CDockingPanesRow* pRow) const;

Parameter

[in] Bug

Rückgabewert

Bemerkungen

CDockSite::IsRectWithinDockSite

BOOL IsRectWithinDockSite(
    CRect rect,
    CPoint& ptDelta);

Parameter

[in] rect

[in] ptDelta

Rückgabewert

Bemerkungen

CDockSite::IsResizable

virtual BOOL IsResizable() const;

Rückgabewert

Bemerkungen

CDockSite::MovePane

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

Parameter

[in] pWnd

[in] nFlags

[in] ptOffset

Rückgabewert

Bemerkungen

CDockSite::OnInsertRow

virtual void OnInsertRow(POSITION pos);

Parameter

[in] Pos

Hinweise

CDockSite::OnRemoveRow

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

Parameter

[in] Pos

[in] bByShow

Hinweise

CDockSite::OnResizeRow

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

Parameter

[in] pRowToResize

[in] nOffset

Rückgabewert

Bemerkungen

CDockSite::OnSizeParent

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

Parameter

[in] rectAvailable

[in] nSide

[in] bExpand

[in] nOffset

Hinweise

CDockSite::OnSetWindowPos

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

Parameter

[in] pWndInsertAfter

[in] rectWnd

[in] nFlags

Rückgabewert

Bemerkungen

CDockSite::OnShowRow

virtual void OnShowRow(
    POSITION pos,
    BOOL bShow);

Parameter

[in] Pos

[in] bShow

Hinweise

CDockSite::P aneFromPoint

Gibt einen an der Dockposition angedockten Bereich anhand des angegebenen Parameters an einem bestimmten Punkt zurück.

virtual CPane* PaneFromPoint(CPoint pt);

Parameter

pt
[in] Ein Punkt in Bildschirmkoordinaten, damit der Bereich abgerufen werden kann.

Rückgabewert

Ein Zeiger auf den Bereich, der sich am angegebenen Punkt befindet, oder NULL, wenn kein Bereich am angegebenen Punkt vorhanden war.

Hinweise

CDockSite::RectSideFromPoint

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

Parameter

[in] rect

[in] Punkt

Rückgabewert

Bemerkungen

CDockSite::RemovePane

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

Parameter

[in] pWnd

[in] dockMethod

Hinweise

CDockSite::RemoveRow

void RemoveRow(CDockingPanesRow* pRow);

Parameter

[in] Bug

Hinweise

CDockSite::ReplacePane

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

Parameter

[in] pOldBar

[in] pNewBar

Rückgabewert

Bemerkungen

CDockSite::RepositionPanes

virtual void RepositionPanes(CRect& rectNewClientArea);

Parameter

[in] rectNewClientArea

Hinweise

CDockSite::ResizeDockSite

void ResizeDockSite(
    int nNewWidth,
    int nNewHeight);

Parameter

[in] nNewWidth

[in] nNewHeight

Hinweise

CDockSite::ResizeRow

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

Parameter

[in] Bug

[in] nNewSize

[in] bAdjustLayout

Rückgabewert

Bemerkungen

CDockSite::ShowPane

Zeigt den Bereich an.

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

Parameter

pBar
[in, out] Ein Zeiger auf den Bereich, der angezeigt oder ausgeblendet werden soll.

bShow
[in] TRUE, um anzugeben, dass der Bereich angezeigt werden soll; FALSE, um anzugeben, dass der Bereich ausgeblendet werden soll.

bDelay
[in] TRUE, um anzugeben, dass das Layout des Bereichs verzögert werden soll, bis der Bereich angezeigt wird; andernfalls FALSE.

bActivate
[in] Dieser Parameter wird nicht verwendet.

Rückgabewert

TRUE, wenn der Bereich erfolgreich angezeigt oder ausgeblendet wurde. FALSE, wenn der angegebene Bereich nicht zu dieser Dockwebsite gehört.

Hinweise

Rufen Sie diese Methode auf, um angedockte Bereiche ein- oder auszublenden. Normalerweise müssen Sie nicht direkt aufrufen CDockSite::ShowPane , da sie vom übergeordneten Framefenster oder vom Basisbereich aufgerufen wird.

CDockSite::ShowRow

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

Parameter

[in] Bug

[in] bShow

[in] bAdjustLayout

Hinweise

CDockSite::SwapRows

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

Parameter

[in] pFirstRow

[in] pSecondRow

Hinweise

Weitere Informationen

Hierarchiediagramm
Klassen
CBasePane-Klasse