CDockSite, classe
Pour plus d’informations, consultez le code source situé dans le dossier VC\atlmfc\src\mfc de votre installation de Visual Studio.
Fournit les fonctionnalités de réorganisation des volets dérivés de CPane Class en ensembles de lignes.
Syntaxe
class CDockSite: public CBasePane
Membres
Méthodes publiques
Notes
L’infrastructure crée CDockSite automatiquement des objets lorsque vous appelez CFrameWndEx ::EnableDocking. Les fenêtres du site d'ancrage sont positionnées à l'extrémité de la zone cliente de la fenêtre frame principale.
Vous n’avez généralement pas besoin d’appeler les services fournis par le site d’ancrage, car la classe CFrameWndEx gère ces services.
Exemple
L'exemple suivant montre comment créer un objet de la classe CDockSite.
AFX_DOCKSITE_INFO info;
CDockSite *pDockBar = (CDockSite*)info.pDockBarRTC->CreateObject();
Hiérarchie d'héritage
CObject
└ CCmdTarget
└ CWnd
└ CBasePane
└ CDockSite
Spécifications
En-tête : afxDockSite.h
CDockSite ::AddRow
CDockingPanesRow* AddRow(
POSITION pos,
int nHeight);
Paramètres
[in] Pos
[in] nHeight
Valeur de retour
Notes
CDockSite ::AdjustDockingLayout
virtual void AdjustDockingLayout();
Notes
CDockSite ::AdjustLayout
virtual void AdjustLayout();
Notes
CDockSite ::AlignDockSite
void AlignDockSite(
const CRect& rectToAlignBy,
CRect& rectResult,
BOOL bMoveImmediately);
Paramètres
[in] rectToAlignBy
[in] rectResult
[in] bMoveImmediately
Notes
CDockSite ::CalcFixedLayout
virtual CSize CalcFixedLayout(
BOOL bStretch,
BOOL bHorz);
Paramètres
[in] bStretch
[in] bHorz
Valeur de retour
Notes
CDockSite ::CanAcceptPane
virtual BOOL CanAcceptPane(const CBasePane* pBar) const;
Paramètres
[in] pBar
Valeur de retour
Notes
CDockSite ::CreateEx
virtual BOOL CreateEx(
DWORD dwStyleEx,
DWORD dwStyle,
const RECT& rect,
CWnd* pParentWnd,
DWORD dwControlBarStyle,
CCreateContext* pContext = NULL);
Paramètres
[in] dwStyleEx
[in] dwStyle
[in] rect
[in] pParentWnd
[in] dwControlBarStyle
[in] pContext
Valeur de retour
Notes
CDockSite ::CreateRow
virtual CDockingPanesRow* CreateRow(
CDockSite* pParentDockBar,
int nOffset,
int nRowHeight);
Paramètres
[in] pParentDockBar
[in] nOffset
[in] nRowHeight
Valeur de retour
Notes
CDockSite ::D ockPane
virtual void DockPane(
CPane* pWnd,
AFX_DOCK_METHOD dockMethod,
LPCRECT lpRect = NULL);
Paramètres
[in] pWnd
[in] dockMethod
[in] lpRect
Notes
CDockSite ::D ockPaneLeftOf
Ancre un volet à gauche d'un autre volet.
virtual BOOL DockPaneLeftOf(
CPane* pBarToDock,
CPane* pTargetBar);
Paramètres
pBarToDock
[in, out] Pointeur vers le volet à ancrer à gauche de pTargetBar.
pTargetBar
[in, out] Pointeur vers le volet cible.
Valeur de retour
TRUE si le volet est ancré avec succès ; sinon, FALSE.
Notes
CDockSite ::D oesAllowDynInsertBefore
virtual BOOL DoesAllowDynInsertBefore() const;
Valeur de retour
Notes
CDockSite ::FindPaneByID
Retourne le volet avec l’ID donné.
CPane* FindPaneByID(UINT nID);
Paramètres
nID
[in] ID de commande du volet à trouver.
Valeur de retour
Pointeur vers le volet avec l’ID de commande spécifié ou NULL si le volet est introuvable.
Notes
CDockSite ::FindRowIndex
int FindRowIndex(CDockingPanesRow* pRow);
Paramètres
[in] proue
Valeur de retour
Notes
CDockSite ::FixupVirtualRects
virtual void FixupVirtualRects();
Notes
CDockSite ::GetDockSiteID
virtual UINT GetDockSiteID() const;
Valeur de retour
Notes
CDockSite ::GetDockSiteRowsList
const CObList& GetDockSiteRowsList() const;
Valeur de retour
Notes
CDockSite ::GetPaneList
Retourne une liste de volets ancrés dans le site d’ancrage.
const CObList& GetPaneList() const;
Valeur de retour
Référence en lecture seule à la liste des volets actuellement ancrés dans la barre d’ancrage.
CDockSite ::IsAccessibilityCompatible
virtual BOOL IsAccessibilityCompatible();
Valeur de retour
Notes
CDockSite ::IsdragMode
virtual BOOL IsDragMode() const;
Valeur de retour
Notes
CDockSite ::IsLastRow
bool IsLastRow(CDockingPanesRow* pRow) const;
Paramètres
[in] proue
Valeur de retour
Notes
CDockSite ::IsRectWithinDockSite
BOOL IsRectWithinDockSite(
CRect rect,
CPoint& ptDelta);
Paramètres
[in] rect
[in] ptDelta
Valeur de retour
Notes
CDockSite ::IsResizable
virtual BOOL IsResizable() const;
Valeur de retour
Notes
CDockSite ::MovePane
virtual BOOL MovePane(
CPane* pWnd,
UINT nFlags,
CPoint ptOffset);
Paramètres
[in] pWnd
[in] nFlags
[in] ptOffset
Valeur de retour
Notes
CDockSite ::OnInsertRow
virtual void OnInsertRow(POSITION pos);
Paramètres
[in] Pos
Notes
CDockSite ::OnRemoveRow
virtual void OnRemoveRow(
POSITION pos,
BOOL bByShow = FALSE);
Paramètres
[in] Pos
[in] bByShow
Notes
CDockSite ::OnResizeRow
virtual int OnResizeRow(
CDockingPanesRow* pRowToResize,
int nOffset);
Paramètres
[in] pRowToResize
[in] nOffset
Valeur de retour
Notes
CDockSite ::OnSizeParent
virtual void OnSizeParent(
CRect& rectAvailable,
UINT nSide,
BOOL bExpand,
int nOffset);
Paramètres
[in] rectAvailable
[in] nSide
[in] bExpand
[in] nOffset
Notes
CDockSite ::OnSetWindowPos
virtual BOOL OnSetWindowPos(
const CWnd* pWndInsertAfter,
const CRect& rectWnd,
UINT nFlags);
Paramètres
[in] pWndInsertAfter
[in] rectWnd
[in] nFlags
Valeur de retour
Notes
CDockSite ::OnShowRow
virtual void OnShowRow(
POSITION pos,
BOOL bShow);
Paramètres
[in] Pos
[in] bShow
Notes
CDockSite ::P aneFromPoint
Retourne un volet ancré dans le site d'ancrage au point spécifié par le paramètre donné.
virtual CPane* PaneFromPoint(CPoint pt);
Paramètres
pt
[in] Point, dans les coordonnées de l’écran, pour que le volet récupère.
Valeur de retour
Pointeur vers le volet situé au point spécifié ou NULL si aucun volet n’était présent au point spécifié.
Notes
CDockSite ::RectSideFromPoint
static int __stdcall RectSideFromPoint(
const CRect& rect,
const CPoint& point);
Paramètres
[in] rect
[in] point
Valeur de retour
Notes
CDockSite ::RemovePane
virtual void RemovePane(
CPane* pWnd,
AFX_DOCK_METHOD dockMethod);
Paramètres
[in] pWnd
[in] dockMethod
Notes
CDockSite ::RemoveRow
void RemoveRow(CDockingPanesRow* pRow);
Paramètres
[in] proue
Notes
CDockSite ::ReplacePane
BOOL ReplacePane(
CPane* pOldBar,
CPane* pNewBar);
Paramètres
[in] pOldBar
[in] pNewBar
Valeur de retour
Notes
CDockSite ::RepositionPanes
virtual void RepositionPanes(CRect& rectNewClientArea);
Paramètres
[in] rectNewClientArea
Notes
CDockSite ::ResizeDockSite
void ResizeDockSite(
int nNewWidth,
int nNewHeight);
Paramètres
[in] nNewWidth
[in] nNewHeight
Notes
CDockSite ::ResizeRow
int ResizeRow(
CDockingPanesRow* pRow,
int nNewSize,
BOOL bAdjustLayout = TRUE);
Paramètres
[in] proue
[in] nNewSize
[in] bAdjustLayout
Valeur de retour
Notes
CDockSite ::ShowPane
Affiche le volet.
virtual BOOL ShowPane(
CBasePane* pBar,
BOOL bShow,
BOOL bDelay,
BOOL bActivate);
Paramètres
pBar
[in, out] Pointeur vers le volet à afficher ou masquer.
bShow
[in] TRUE pour spécifier que le volet doit être affiché ; FALSE pour spécifier que le volet doit être masqué.
bDelay
[in] TRUE pour spécifier que la disposition du volet doit être retardée jusqu’à ce que le volet soit affiché ; sinon, FALSE.
bActivate
[in] Ce paramètre n’est pas utilisé.
Valeur de retour
TRUE si le volet a été affiché ou masqué avec succès. FALSE si le volet spécifié n’appartient pas à ce site d’ancrage.
Notes
Appelez cette méthode pour afficher ou masquer les volets ancrés. Normalement, vous n’avez pas besoin d’appeler CDockSite::ShowPane directement, car il est appelé par la fenêtre cadre parente ou par le volet de base.
CDockSite ::ShowRow
void ShowRow(
CDockingPanesRow* pRow,
BOOL bShow,
BOOL bAdjustLayout);
Paramètres
[in] proue
[in] bShow
[in] bAdjustLayout
Notes
CDockSite ::SwapRows
void SwapRows(
CDockingPanesRow* pFirstRow,
CDockingPanesRow* pSecondRow);
Paramètres
[in] pFirstRow
[in] pSecondRow