CBasePane, classe

Classe de base pour tous les volets dans MFC.

Syntaxe

class CBasePane : public CWnd

Membres

Constructeurs publics

Nom	Description
CBasePane::CBasePane	Constructeur par défaut.
CBasePane::~CBasePane	Destructeur.

Méthodes publiques

Nom	Description
CBasePane::accHitTest	Appelé par l'infrastructure pour récupérer l'élément enfant ou l'objet enfant à un point déterminé de l'écran. (Remplacements CWnd ::accHitTest.)
CBasePane::accLocation	Appelé par l’infrastructure pour récupérer l’emplacement actuel de l’écran de l’objet spécifié. (Remplacements CWnd ::accLocation.)
CBasePane ::AccNotifyObjectFocusEvent	CBasePane n’utilise pas cette méthode.
CBasePane::accSelect	Appelé par l'infrastructure pour modifier la sélection ou déplacer le focus clavier de l'objet spécifié. (Remplacements CWnd ::accSelect.)
CBasePane ::AddPane	Ajoute un volet au gestionnaire d’ancrage.
CBasePane ::AdjustDockingLayout	Redirige un appel vers le gestionnaire d’ancrage pour ajuster la disposition d’ancrage.
CBasePane ::AdjustLayout	Appelé par l’infrastructure lorsque le volet doit ajuster sa disposition interne.
CBasePane ::CalcFixedLayout	Calcule la taille horizontale d’une barre de contrôle.
CBasePane ::CanAcceptPane	Détermine si un autre volet peut être ancré dans le volet.
CBasePane ::CanAutoHide	Détermine si le volet prend en charge le mode de masquage automatique.
CBasePane ::CanBeAttached	Détermine si le volet peut être ancré à un autre volet.
CBasePane ::CanBeClosed	Détermine si le volet peut être fermé.
CBasePane ::CanBeDocked	Détermine si le volet peut être ancré à un autre volet.
CBasePane ::CanBeResized	Détermine si le volet peut être redimensionné.
CBasePane ::CanBeTabbedDocument	Spécifie si le volet peut être converti en document à onglets MDI.
CBasePane ::CanFloat	Détermine si le volet peut flotter.
CBasePane ::CanFocus	Spécifie si le volet peut recevoir le focus.
CBasePane ::CopyState	Copie l’état d’un volet donné.
CBasePane ::CreateDefaultMiniframe	Si le volet peut flotter, crée une fenêtre mini-frame.
CBasePane ::CreateEx	Crée le contrôle de volet.
CBasePane ::D ockPane	Ancre un volet dans un autre volet ou dans une fenêtre frame.
CBasePane ::D ockPaneUsingRTTI	Ancre le volet à l’aide des informations de type d’exécution.
CBasePane ::D ockToFrameWindow	Ancre un volet d’ancrage sur un cadre.
CBasePane ::D oesAllowDynInsertBefore	Détermine si un autre volet peut être inséré dynamiquement entre ce volet et le cadre parent.
CBasePane ::EnableDocking	Active l’ancrage du volet sur le cadre principal.
CBasePane ::EnableGripper	Active ou désactive le grippeur. Si le grippeur est activé, l’utilisateur peut le faire glisser pour repositionner le volet.
CBasePane::FillWindowRect	Utilisé en interne.
CBasePane ::FloatPane	Flotte le volet.
CBasePane::get_accChild	Appelé par l'infrastructure pour récupérer l'adresse d'une interface IDispatch pour l'enfant spécifié. (Remplacements CWnd ::get_accChild.)
CBasePane::get_accChildCount	Appelé par l’infrastructure pour récupérer le nombre d’enfants qui appartiennent à cet objet. (Remplacements CWnd ::get_accChildCount.)
CBasePane::get_accDefaultAction	Appelé par l’infrastructure pour récupérer une chaîne qui décrit l’action par défaut de l’objet. (Remplacements CWnd ::get_accDefaultAction.)
CBasePane::get_accDescription	Appelé par l'infrastructure pour récupérer une chaîne qui décrit l'aspect visuel de l'objet spécifié. (Remplacements CWnd ::get_accDescription.)
CBasePane::get_accFocus	Appelé par l'infrastructure pour récupérer l'objet qui a le focus clavier. (Remplacements CWnd ::get_accFocus.)
CBasePane::get_accHelp	Appelé par l’infrastructure pour récupérer une chaîne de propriété d’aide pour l’objet. (Remplacements CWnd ::get_accHelp.)
CBasePane ::get_accHelpTopic	Appelé par l’infrastructure pour récupérer le chemin complet du fichier WinHelp associé à l’objet spécifié et à l’identificateur de la rubrique appropriée dans ce fichier. (Remplacements CWnd ::get_accHelpTopic.)
CBasePane::get_accKeyboardShortcut	Appelé par l’infrastructure pour récupérer la touche de raccourci spécifiée pour l’objet. (Remplacements CWnd ::get_accKeyboardShortcut.)
CBasePane::get_accName	Appelé par l'infrastructure pour récupérer le nom de l'objet spécifié. (Remplacements CWnd ::get_accName.)
CBasePane::get_accParent	Appelé par l’infrastructure pour récupérer l’interface IDispatch pour le parent de l’objet. (Remplacements CWnd ::get_accParent.)
CBasePane::get_accRole	Appelé par l'infrastructure pour récupérer les informations qui décrivent le rôle de l'objet spécifié. (Remplacements CWnd ::get_accRole.)
CBasePane ::get_accSelection	Appelé par l'infrastructure pour récupérer les enfants sélectionnés de cet objet. (Remplacements CWnd ::get_accSelection.)
CBasePane::get_accState	Appelé par l'infrastructure pour récupérer l'état actuel de l'objet spécifié. (Remplacements CWnd ::get_accState.)
CBasePane::get_accValue	Appelé par l'infrastructure pour récupérer la valeur de l'objet spécifié. (Remplacements CWnd ::get_accValue.)
CBasePane ::GetCaptionHeight	Retourne la hauteur de légende.
CBasePane ::GetControlBarStyle	Retourne le style de barre de contrôle.
CBasePane ::GetCurrentAlignment	Retourne l’alignement du volet actuel.
CBasePane ::GetDockingMode	Retourne le mode d’ancrage actuel pour le volet.
CBasePane ::GetDockSiteFrameWnd	Retourne un pointeur vers la fenêtre qui est le site d’ancrage du volet.
CBasePane ::GetEnabledAlignment	Retourne les styles CBRS_ALIGN_ appliqués au volet.
CBasePane ::GetMFCStyle	Retourne les styles de volet spécifiques à MFC.
CBasePane ::GetPaneIcon	Retourne une poignée à l’icône du volet.
CBasePane::GetPaneRect	Utilisé en interne.
CBasePane ::GetPaneRow	Retourne un pointeur vers l’objet CDockingPanesRowoù le volet est ancré.
CBasePane ::GetPaneStyle	Retourne le style du volet.
CBasePane ::GetParentDockSite	Retourne un pointeur vers le site d’ancrage parent.
CBasePane ::GetParentMiniFrame	Retourne un pointeur vers la fenêtre mini-frame parente.
CBasePane ::GetParentTabbedPane	Retourne un pointeur vers le volet de tabulation parent.
CBasePane ::GetParentTabWnd	Retourne un pointeur vers la fenêtre parente qui se trouve à l’intérieur d’un onglet.
CBasePane ::GetRecentVisibleState	L’infrastructure appelle cette méthode lorsqu’un volet est restauré à partir d’une archive.
CBasePane ::HideInPrintPreviewMode	Spécifie si le volet est masqué dans l’aperçu avant impression.
CBasePane ::InsertPane	Inscrit le volet spécifié auprès du gestionnaire d’ancrage.
CBasePane ::IsAccessibilityCompatible	Spécifie si le volet prend en charge l’accessibilité active.
CBasePane ::IsAutoHideMode	Détermine si un volet est en mode masquer automatiquement.
CBasePane ::IsDialogControl	Spécifie si le volet est un contrôle de boîte de dialogue.
CBasePane ::IsDocked	Détermine si le volet est ancré.
CBasePane ::IsFloating	Détermine si le volet flotte.
CBasePane ::IsHorizontal	Détermine si le volet est ancré horizontalement.
CBasePane ::IsInFloatingMultiPaneFrameWnd	Spécifie si le volet se trouve dans une fenêtre de cadre à plusieurs volets.
CBasePane ::IsMDITabbed	Détermine si le volet a été ajouté à une fenêtre enfant MDI en tant que document à onglets.
CBasePane ::IsPaneVisible	Spécifie si l’indicateur WS_VISIBLE est défini pour le volet.
CBasePane ::IsPointNearDockSite	Détermine si un point spécifié est proche du site d’ancrage.
CBasePane ::IsResizable	Détermine si le volet peut être redimensionné.
CBasePane ::IsRestoredFromRegistry	Détermine si le volet est restauré à partir du Registre.
CBasePane ::IsTabbed	Détermine si le volet a été inséré dans le contrôle Onglet d’une fenêtre à onglets.
CBasePane::IsTooltipTopmost	Utilisé en interne.
CBasePane ::IsVisible	Détermine si le volet est visible.
CBasePane ::LoadState	Charge l’état du volet à partir du Registre.
CBasePane ::MoveWindow	Déplace le volet.
CBasePane ::OnAfterChangeParent	Appelé par l’infrastructure lorsque le parent du volet a été modifié.
CBasePane ::OnBeforeChangeParent	Appelé par l’infrastructure juste avant que le volet change sa fenêtre parente.
CBasePane ::OnDrawCaption	L’infrastructure appelle cette méthode lorsque la légende est dessinée.
CBasePane ::OnMovePaneDivider	Cette méthode n’est actuellement pas utilisée.
CBasePane ::OnPaneContextMenu	Appelé par l’infrastructure lorsqu’il génère un menu qui contient une liste de volets.
CBasePane ::OnRemoveFromMiniFrame	Appelé par l’infrastructure lorsqu’un volet est supprimé de sa fenêtre mini frame parente.
CBasePane ::OnSetAccData	CBasePane n’utilise pas cette méthode.
CBasePane::OnUpdateCmdUI	Utilisé en interne.
CBasePane ::P aneFromPoint	Retourne le volet qui contient le point donné.
CBasePane::PreTranslateMessage	Utilisé par la classe CWinApp pour traduire les messages de fenêtre avant qu’ils ne soient distribués aux fonctions Windows TranslateMessage et DispatchMessage . (Substitue CWnd::PreTranslateMessage.)
CBasePane ::RecalcLayout	CBasePane n’utilise pas cette méthode.
CBasePane ::RemovePaneFromDockManager	Annule l’inscription d’un volet et le supprime de la liste dans le gestionnaire d’ancrage.
CBasePane ::SaveState	Enregistre l'état du volet dans le Registre.
CBasePane ::SelectDefaultFont	Sélectionne la police par défaut pour un contexte d’appareil donné.
CBasePane::Serialize	Lit ou écrit cet objet dans une archive. (Substitue CObject::Serialize.)
CBasePane ::SetControlBarStyle	Définit le style de barre de contrôle.
CBasePane ::SetDockingMode	Définit le mode d’ancrage du volet.
CBasePane::SetMDITabbed	Utilisé en interne.
CBasePane ::SetPaneAlignment	Définit l’alignement du volet.
CBasePane::SetPaneRect	Utilisé en interne.
CBasePane ::SetPaneStyle	Définit le style du volet.
CBasePane::SetRestoredFromRegistry	Utilisé en interne.
CBasePane ::SetWindowPos	Modifie la taille, la position et l’ordre Z d’un volet.
CBasePane ::ShowPane	Affiche ou masque le volet.
CBasePane ::StretchPane	Étire un volet sur le plan vertical ou horizontal.
CBasePane ::UndockPane	Supprime le volet du site d’ancrage, du curseur par défaut ou de la fenêtre mini-frame où il est actuellement ancré.

Méthodes protégées

Nom	Description
CBasePane ::D oPaint	Remplit l’arrière-plan du volet.

Notes

Si vous souhaitez créer une classe de volet qui prend en charge les fonctionnalités d’ancrage étendues disponibles dans MFC, vous devez la dériver de CBasePane ou de la classe CPane.

Conseils de personnalisation

Les conseils de personnalisation suivants concernent les CBasePane Class classes qui héritent de celle-ci :

• Lorsque vous créez un volet, vous pouvez appliquer plusieurs nouveaux styles :

  • AFX_CBRS_FLOAT fait flotter le volet.

  • AFX_CBRS_AUTOHIDE active le mode de masquage automatique.

  • AFX_CBRS_CLOSE permet de fermer le volet (masqué).

  Il s’agit d’indicateurs que vous pouvez combiner avec une opération or au niveau du bit.

CBasePane implémente les méthodes booléennes virtuelles suivantes pour refléter ces indicateurs : CBasePane ::CanBeClosed, CBasePane ::CanAutoHide, CBasePane ::CanFloat. Vous pouvez les remplacer dans les classes dérivées pour personnaliser leur comportement.

• Vous pouvez personnaliser le comportement d’ancrage en remplaçant CBasePane ::CanAcceptPane. Faites en sorte que votre volet retourne FALSE à partir de cette méthode pour empêcher un autre volet de s’y ancrer.

• Si vous souhaitez créer un volet statique qui ne peut pas flotter et qui empêche tout autre volet de s’ancrer avant lui (similaire à la barre Outlook dans l’exemple OutlookDemo), créez-le comme non flottant et remplacez CBasePane ::D oesAllowDynInsertBefore pour retourner FALSE. L’implémentation par défaut retourne FALSE si le volet est créé sans le style AFX_CBRS_FLOAT.

• Créez tous les volets avec des ID autres que -1.

• Pour déterminer la visibilité du volet, utilisez CBasePane ::IsVisible. Il gère correctement l’état de visibilité dans les modes tabulation et masque automatiquement.

• Si vous souhaitez créer un volet redimensionnable non flottant, créez-le sans le style AFX_CBRS_FLOAT et appelez CFrameWnd ::D ockControlBar.

• Pour exclure un volet d’une disposition d’ancrage ou supprimer une barre d’outils de sa barre d’accueil, appelez CBasePane ::UndockPane. N’appelez pas cette méthode pour les volets en mode masquage automatique ou pour les volets qui résident dans des onglets de fenêtres à onglets.

• Si vous souhaitez flotter ou détacher un volet en mode de masquage automatique, vous devez appeler CDockablePane ::SetAutoHideMode avec FALSE comme premier argument avant d’appeler CBasePane ::FloatPane ou CBasePane ::UndockPane.

Exemple

L’exemple suivant montre comment utiliser différentes méthodes de la classe CBasePane . L’exemple montre comment récupérer un volet de la CFrameWndEx classe et comment définir le mode d’ancrage, l’alignement du volet et le style du volet. Le code provient de l’exemple de panneau Word.

// This CMainFrame class extends the CFrameWndEx class.
// GetPane is a method in the CFrameWndEx class which
// Returns a pointer to the pane that has the specified ID.
CBasePane *pBar = GetPane(ID_VIEW_FORMATBAR);
if (pBar != NULL)
{
    // Set the docking mode, the pane alignment, and the pane style.
    pBar->SetDockingMode(DT_STANDARD);
    pBar->SetPaneAlignment(CBRS_ALIGN_LEFT);
    pBar->SetPaneStyle(pBar->GetCurrentAlignment() | CBRS_TOOLTIPS);
    pBar->ShowPane(TRUE, FALSE, FALSE);
}

Hiérarchie d'héritage

CObject

CCmdTarget

CWnd

CBasePane

Spécifications

En-tête : afxbasepane.h

CBasePane ::AccNotifyObjectFocusEvent

CBasePane n’utilise pas cette méthode.

virtual void AccNotifyObjectFocusEvent(int);

Paramètres

int
[in] Non utilisé.

CBasePane ::AddPane

Ajoute un volet au gestionnaire d’ancrage.

void AddPane(CBasePane* pBar);

Paramètres

pBar
[in] Pointeur vers un volet à ajouter.

Notes

Il s’agit d’une méthode pratique qui ajoute un volet à un gestionnaire d’ancrage. À l’aide de cette méthode, vous n’avez pas besoin d’écrire du code qui analyse le type du cadre parent.

Pour plus d’informations, consultez la classe CDockingManager et CMDIFrameWndEx ::AddPane.

CBasePane ::AdjustDockingLayout

Redirige un appel vers le gestionnaire d’ancrage pour ajuster la disposition d’ancrage.

virtual void AdjustDockingLayout(HDWP hdwp=NULL);

Paramètres

hdwp
[out] Handle vers une structure contenant plusieurs positions de fenêtre.

Notes

Il s’agit d’une méthode pratique qui ajuste la disposition d’ancrage. À l’aide de cette méthode, vous n’avez pas besoin d’écrire du code qui analyse le type du cadre parent.

Pour plus d’informations, consultez CDockingManager ::AdjustDockingLayout

CBasePane ::AdjustLayout

Appelé par l’infrastructure pour ajuster la disposition interne d’un volet.

virtual void AdjustLayout();

Notes

L’infrastructure appelle cette méthode lorsqu’un volet doit ajuster sa disposition interne. L’implémentation de base ne fait rien.

CBasePane ::CalcFixedLayout

Calcule la taille horizontale d’une barre de contrôle.

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

Paramètres

bStretch
[in] Indique si la barre doit être étirée à la taille du cadre. Le paramètre bStretch n’est pas différent de zéro lorsque la barre n’est pas une barre d’ancrage (non disponible pour l’ancrage) et est 0 lorsqu’elle est ancrée ou flottante (disponible pour l’ancrage).

bHorz
[in] Indique que la barre est orientée horizontalement ou verticalement. Le paramètre bHorz est différent de zéro si la barre est orientée horizontalement et est 0 si elle est orientée verticalement.

Valeur de retour

Taille de la barre de contrôle, en pixels, d’un CSize objet.

Notes

Voir la section remarques dans CControlBar ::CalcFixedLayout

CBasePane ::CanAcceptPane

Détermine si un autre volet peut être ancré dans le volet.

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

Paramètres

pBar
[in] Pointeur vers le volet à ancrer.

Valeur de retour

TRUE si un autre volet peut être accepté ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode avant d’ancrer le volet spécifié par pBar dans le volet actif.

Utilisez cette méthode et la méthode CBasePane ::CanBeDocked pour contrôler la façon dont les volets s’ancrent dans d’autres volets de votre application.

L’implémentation par défaut retourne FALSE.

CBasePane ::CanAutoHide

Détermine si le volet prend en charge le mode de masquage automatique.

virtual BOOL CanAutoHide() const;

Valeur de retour

TRUE si ce volet prend en charge le mode de masquage automatique ; sinon FALSE.

Notes

L’infrastructure appelle cette fonction pour déterminer si le volet prend en charge le mode de masquage automatique.

Pendant la construction, vous pouvez définir cette possibilité en passant l’indicateur AFX_CBRS_AUTOHIDE à CBasePane ::CreateEx.

L’implémentation par défaut vérifie l’indicateur de AFX_CBRS_AUTOHIDE. Remplacez cette méthode dans une classe dérivée pour personnaliser ce comportement.

CBasePane ::CanBeAttached

Détermine si le volet peut être ancré dans une autre fenêtre de volet ou de cadre.

virtual BOOL CanBeAttached() const;

Valeur de retour

TRUE si le volet peut être ancré à un autre volet ou fenêtre frame ; sinon FALSE.

Notes

L’implémentation par défaut retourne FALSE. Remplacez cette méthode dans une classe dérivée pour activer ou désactiver la possibilité d’ancrer sans appeler CBasePane ::EnableDocking.

CBasePane ::CanBeClosed

Détermine si le volet peut être fermé.

virtual BOOL CanBeClosed() const;

Valeur de retour

TRUE si le volet peut être fermé ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode pour déterminer si le volet peut être fermé. Si la méthode retourne TRUE, un bouton Fermer est ajouté à la barre de titre du volet ou, si le volet est flottant, à la barre de titre de la fenêtre miniframe du volet.

Pendant la construction, vous pouvez définir cette possibilité en passant l’indicateur AFX_CBRS_CLOSE à CBasePane ::CreateEx.

L’implémentation par défaut vérifie l’indicateur de AFX_CBRS_CLOSE.

CBasePane ::CanBeDocked

Détermine si le volet peut être ancré à un autre volet.

virtual BOOL CanBeDocked(CBasePane* pDockBar) const;

Paramètres

pDockBar
[in] Pointeur vers un autre volet.

Valeur de retour

TRUE si ce volet peut être ancré à un autre volet ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode avant d’ancrer le volet spécifié par pDockBar dans le volet actif.

Utilisez cette méthode et la méthode CBasePane ::CanAcceptPane pour contrôler la façon dont les volets s’ancrent dans d’autres volets de votre application.

L’implémentation par défaut retourne FALSE.

CBasePane ::CanBeResized

Détermine si le volet peut être redimensionné.

virtual BOOL CanBeResized() const;

Valeur de retour

TRUE si le volet peut être redimensionné ; sinon, FALSE.

Notes

Cette méthode vérifie l’indicateur de AFX_CBRS_RESIZE, qui est spécifié par défaut dans CBasePane::OnCreate. Si cet indicateur n’est pas spécifié, le gestionnaire d’ancrage signale le volet en interne comme étant inabordable au lieu de l’ancrer.

CBasePane ::CanBeTabbedDocument

Spécifie si le volet peut être converti en document à onglets MDI.

virtual BOOL CanBeTabbedDocument() const;

Valeur de retour

TRUE si le volet peut être converti en document à onglets ; sinon, FALSE. CBasePane::CanBeTabbedDocument retourne toujours FALSE.

Notes

Seuls les objets de certains CBasePanetypes dérivés, tels que la classe CDockablePane, peuvent être convertis en documents à onglets.

CBasePane ::CanFloat

Détermine si le volet peut flotter.

virtual BOOL CanFloat() const;

Valeur de retour

TRUE si le volet peut flotter ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode pour déterminer si le volet peut flotter.

Pendant la construction, vous pouvez définir cette possibilité en passant l’indicateur AFX_CBRS_FLOAT à CBasePane ::CreateEx.

Remarque

L’infrastructure suppose que les volets non flottants sont statiques et que leur état d’ancrage ne peut pas changer. Par conséquent, l’infrastructure n’enregistre pas l’état d’ancrage des volets non flottants.

L’implémentation par défaut vérifie le style AFX_CBRS_FLOAT.

CBasePane ::CanFocus

Spécifie si le volet peut recevoir le focus.

virtual BOOL CanFocus() const;

Valeur de retour

TRUE si le volet peut recevoir le focus ; sinon FALSE.

Notes

Remplacez cette méthode dans une classe dérivée pour contrôler le focus. Par exemple, étant donné que les barres d’outils ne peuvent pas recevoir le focus, cette méthode retourne FALSE lorsqu’elle est appelée sur les objets de barre d’outils.

L’infrastructure tente de définir le focus d’entrée lorsqu’un volet est ancré ou flottant.

CBasePane ::CopyState

Copie l’état d’un volet donné.

virtual void CopyState(CBasePane* pOrgBar);

Paramètres

pOrgBar
[in] Pointeur vers un autre volet.

Notes

Cette méthode copie l’état de pOrgBar dans ce volet.

CBasePane ::CreateDefaultMiniframe

Si le volet peut flotter, cette méthode crée une fenêtre mini-frame pour celle-ci.

virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);

Paramètres

rectInitial
[in] Spécifie les coordonnées initiales de la fenêtre mini-frame.

Valeur de retour

Pointeur vers la nouvelle fenêtre mini-frame ou NULL si la création a échoué.

Notes

L’infrastructure appelle cette méthode lorsqu’un volet bascule vers un état flottant. La méthode crée une fenêtre mini-frame et attache le volet à cette fenêtre.

L’implémentation par défaut retourne NULL.

CBasePane ::CreateEx

Crée le contrôle de volet.

virtual BOOL CreateEx(
    DWORD dwStyleEx,
    LPCTSTR lpszClassName,
    LPCTSTR lpszWindowName,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID,
    DWORD dwControlBarStyle=0,
    CCreateContext* pContext=NULL);

Paramètres

dwStyleEx
[in] Styles étendus (voir CWnd ::CreateEx pour plus d’informations).

lpszClassName
[in] Nom de la classe de fenêtre.

lpszWindowName
[in] Nom de la fenêtre.

dwStyle
[in] Style de fenêtre (voir CWnd ::CreateEx).

rect
[in] Rectangle initial.

pParentWnd
[in] Pointeur vers la fenêtre parente.

nID
[in] Spécifie l’ID du volet. Ils doivent être uniques.

dwControlBarStyle
[in] Indicateurs de style pour les volets.

pContext
[in] Pointeur vers CcreateContext

Valeur de retour

TRUE si le volet est créé avec succès ; sinon FALSE.

Notes

Crée une fenêtre de classe lpszClassName. Si vous spécifiez WS_CAPTION, cette méthode efface le bit de style WS_CAPTION et définit CBasePane::m_bHasCaption la valeur TRUE, car la bibliothèque ne prend pas en charge les volets avec des légendes.

Vous pouvez utiliser n’importe quelle combinaison de styles de fenêtre enfant et de styles de barre de contrôle MFC (CBRS_).

La bibliothèque ajoute plusieurs nouveaux styles pour les volets. Le tableau suivant décrit les nouveaux styles :

Style	Description
AFX_CBRS_FLOAT	Le volet peut flotter.
AFX_CBRS_AUTOHIDE	Le volet prend en charge le mode de masquage automatique
AFX_CBRS_RESIZE	Le volet peut être redimensionné. Important : ce style n’est pas implémenté.
AFX_CBRS_CLOSE	Le volet peut être fermé.
AFX_CBRS_AUTO_ROLLUP	Le volet peut être roulé lorsqu’il flotte.
AFX_CBRS_REGULAR_TABS	Lorsqu’un volet est ancré à un autre volet qui a ce style, une fenêtre à onglets standard est créée. (Pour plus d’informations, consultez CTabbedPane, classe.)
AFX_CBRS_OUTLOOK_TABS	Lorsqu’un volet est ancré à un autre volet qui a ce style, une fenêtre à onglets de style Outlook est créée. (Pour plus d’informations, consultez CMFCOutlookBar, classe.)

Pour utiliser les nouveaux styles, spécifiez-les dans dwControlBarStyle.

CBasePane ::D ockPane

Ancre un volet dans un autre volet ou dans une fenêtre frame.

virtual BOOL DockPane(
    CBasePane* pDockBar,
    LPCRECT lpRect,
    AFX_DOCK_METHOD dockMethod);

Paramètres

pDockBar
[in] Pointeur vers un autre volet.

lpRect
[in] Spécifie le rectangle de destination.

dockMethod
[in] Spécifie la méthode d’ancrage.

Valeur de retour

TRUE si la barre de contrôle a été ancrée avec succès ; sinon, FALSE.

Notes

Appelez cette fonction pour ancrer un volet vers un autre volet ou une barre d’ancrage ( classe CDockSite) spécifiée par pDockBar, ou à un cadre principal si pDockBar a la valeur NULL.

dockMethod spécifie la façon dont le volet est ancré. Consultez CPane ::D ockPane pour obtenir la liste des valeurs possibles.

CBasePane ::D ockPaneUsingRTTI

Ancre le volet à l’aide des informations de type d’exécution.

void DockPaneUsingRTTI(BOOL bUseDockSite);

Paramètres

bUseDockSite
[in] Si la valeur est TRUE, ancrez-vous sur le site d’ancrage. Si la valeur est FALSE, ancrez le cadre parent.

CBasePane ::D ockToFrameWindow

Ancre un volet d’ancrage sur un cadre.

virtual BOOL DockToFrameWindow(
    DWORD dwAlignment,
    LPCRECT lpRect = NULL,
    DWORD dwDockFlags = DT_DOCK_LAST,
    CBasePane* pRelativeBar = NULL,
    int nRelativeIndex = -1,
    BOOL bOuterEdge = FALSE);

Paramètres

dwAlignment
[in] Côté du cadre parent auquel vous souhaitez ancrer le volet.

lpRect
[in] Taille souhaitée.

dwDockFlags
[in] Ignoré.

pRelativeBar
[in] Ignoré.

nRelativeIndex
[in] Ignoré.

bOuterEdge
[in] Si TRUE et qu’il existe d’autres volets ancrés sur le côté spécifié par dwAlignment, le volet est ancré en dehors des autres volets, plus près du bord du cadre parent. Si la valeur est FALSE, le volet est ancré plus près du centre de la zone cliente.

Valeur de retour

TRUE si la méthode a réussi ; sinon FALSE.

Notes

Cette méthode échoue si un séparateur de volets ( classe CPaneDivider) ne peut pas être créé. Sinon, elle retourne toujours TRUE.

CBasePane ::D oesAllowDynInsertBefore

Détermine si un autre volet peut être inséré dynamiquement entre ce volet et le cadre parent.

virtual BOOL DoesAllowDynInsertBefore() const;

Valeur de retour

TRUE si un utilisateur peut insérer un autre volet ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode pour déterminer si un utilisateur peut insérer dynamiquement un volet avant ce volet.

Par exemple, supposons que votre application crée un volet ancré à gauche du cadre (par exemple, la barre Outlook). Pour empêcher l’utilisateur d’ancrer un autre volet à gauche du premier volet, remplacez cette méthode et retournez FALSE.

Nous vous recommandons de remplacer cette méthode et de retourner FALSE pour les volets non flottants dérivés de la classe CDockablePane.

L’implémentation par défaut retourne TRUE.

CBasePane ::D oPaint

Remplit l’arrière-plan du volet.

virtual void DoPaint(CDC* pDC);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil.

Notes

L’implémentation par défaut appelle le gestionnaire de visuels actuel pour remplir l’arrière-plan ( CMFCVisualManager ::OnFillBarBackground).

CBasePane ::EnableDocking

Active l’ancrage du volet sur le cadre principal.

virtual void EnableDocking(DWORD dwAlignment);

Paramètres

dwAlignment
[in] Spécifie l’alignement d’ancrage à activer.

Notes

Appelez cette méthode pour activer l’alignement de l’ancrage sur le cadre principal. Vous pouvez passer une combinaison d’indicateurs CBRS_ALIGN_ (pour plus d’informations, consultez CControlBar ::EnableDocking).

EnableDocking définit l’indicateur CBasePane::m_dwEnabledAlignment interne et l’infrastructure vérifie cet indicateur lorsqu’un volet est ancré.

Appelez CBasePane ::GetEnabledAlignment pour déterminer l’alignement d’ancrage d’un volet.

CBasePane ::EnableGripper

Active ou désactive le grippeur. Si le grippeur est activé, l’utilisateur peut le faire glisser pour repositionner le volet.

virtual void EnableGripper(BOOL bEnable);

Paramètres

bEnable
[in] TRUE pour activer le grippeur ; FALSE pour le désactiver.

Notes

L’infrastructure utilise cette méthode pour activer un gripper au lieu d’utiliser le style WS_CAPTION.

CBasePane ::FloatPane

Flotte le volet.

virtual BOOL FloatPane(
    CRect rectFloat,
    AFX_DOCK_METHOD dockMethod=DM_UNKNOWN,
    bool bShow=true);

Paramètres

rectFloat
[in] Spécifie les coordonnées de l’écran où le volet flottant s’affiche.

dockMethod
[in] Spécifie la méthode d’ancrage à utiliser pour flotter le volet.

bShow
[in] Spécifie si le volet flottant est visible (TRUE) ou masqué (FALSE).

Valeur de retour

TRUE si le volet a été flottant avec succès ; sinon FALSE.

Notes

Appelez cette méthode pour flotter un volet à la position de l’écran spécifiée par rectFloat.

CBasePane ::get_accHelpTopic

L’infrastructure appelle cette méthode pour récupérer le chemin complet du fichier WinHelp associé à l’objet spécifié et à l’identificateur de la rubrique appropriée dans ce fichier.

virtual HRESULT get_accHelpTopic(
    BSTR* pszHelpFile,
    VARIANT varChild,
    long* pidTopic);

Paramètres

pszHelpFile
[in] Adresse d’un BSTR qui reçoit le chemin complet du fichier WinHelp associé à l’objet spécifié, le cas échéant.

varChild
[in] Spécifie si la rubrique d’aide à récupérer est celle de l’objet ou de l’un des éléments enfants de l’objet. Ce paramètre peut être CHILDID_SELF (pour obtenir une rubrique d’aide pour l’objet) ou un ID enfant (pour obtenir une rubrique d’aide pour l’un des éléments enfants de l’objet).

pidTopic
[in] Identifie la rubrique de fichier d’aide associée à l’objet spécifié.

Valeur de retour

CBasePane n’implémente pas cette méthode. Par conséquent, CBasePane::get_accHelpTopic retourne toujours S_FALSE.

Notes

Cette fonction fait partie de la prise en charge de l’accessibilité active dans MFC. Remplacez cette fonction dans une classe dérivée pour fournir des informations d’aide sur votre objet.

CBasePane ::get_accSelection

L’infrastructure appelle cette méthode pour récupérer les enfants sélectionnés de cet objet.

virtual HRESULT get_accSelection(VARIANT* pvarChildren);

Paramètres

pvarChildren
[in] Reçoit des informations qui identifient les enfants sélectionnés.

Valeur de retour

CBasePane n’implémente pas cette méthode. Si pvarChildren a la valeur NULL, cette méthode retourne E_INVALIDARG. Sinon, cette méthode retourne DISP_E_MEMBERNOTFOUND.

Notes

Cette fonction fait partie de la prise en charge de l’accessibilité active dans MFC. Remplacez cette fonction dans une classe dérivée si vous avez des éléments d’interface utilisateur non fenêtrés autres que des contrôles ActiveX sans fenêtre.

CBasePane ::GetCaptionHeight

Retourne la hauteur de légende.

virtual int GetCaptionHeight() const;

Valeur de retour

Hauteur de la légende.

CBasePane ::GetControlBarStyle

Retourne le style de barre de contrôle.

virtual DWORD GetControlBarStyle() const

Valeur de retour

Combinaison or au niveau du bit des indicateurs de AFX_CBRS_.

Notes

La valeur de retour est une combinaison des valeurs possibles suivantes.

Style	Description
AFX_CBRS_FLOAT	Fait flotter la barre de contrôle.
AFX_CBRS_AUTOHIDE	Active le mode de masquage automatique.
AFX_CBRS_RESIZE	Active le redimensionnement de la barre de contrôle. Lorsque cet indicateur est défini, la barre de contrôle peut être placée dans un volet ancre.
AFX_CBRS_CLOSE	Active le masquage de la barre de contrôle.

CBasePane ::GetCurrentAlignment

Retourne l’alignement du volet actuel.

virtual DWORD GetCurrentAlignment() const;

Valeur de retour

Alignement actuel de la barre de contrôle. Le tableau suivant présente les valeurs possibles :

Valeur	Alignement
CBRS_ALIGN_LEFT	Alignement gauche.
CBRS_ALIGN_RIGHT	Alignement droit.
CBRS_ALIGN_TOP	Alignement supérieur.
CBRS_ALIGN_BOTTOM	Alignement inférieur.

CBasePane ::GetDockingMode

Retourne le mode d’ancrage actuel pour le volet.

virtual AFX_DOCK_TYPE GetDockingMode() const;

Valeur de retour

DT_STANDARD si le fait de faire glisser le volet est indiqué à l’écran par un rectangle de glisser. DT_IMMEDIATE si le contenu du volet est déplacé.

Notes

L’infrastructure appelle cette méthode pour déterminer le mode d’ancrage actuel du volet.

S’il CBasePane::m_dockMode n’est pas défini (DT_UNDEFINED), le mode d’ancrage est extrait du mode d’ancrage global (AFX_GLOBAL_DATA::m_dockModeGlobal).

En définissant m_dockMode ou en GetDockingMode remplaçant, vous pouvez contrôler le mode d’ancrage pour chaque volet.

CBasePane ::GetDockSiteFrameWnd

Retourne un pointeur vers l’objet CDockingPanesRowoù le volet est ancré.

virtual CWnd* GetDockSiteFrameWnd() const;

Valeur de retour

Pointeur vers le site d’ancrage du volet.

Notes

Appelez cette méthode pour récupérer un pointeur vers le site d’ancrage du volet. Le site d’ancrage peut être une fenêtre de cadre principal si le volet est ancré sur le cadre principal, ou une fenêtre mini-frame si le volet flotte.

CBasePane ::GetEnabledAlignment

Retourne les styles CBRS_ALIGN_ appliqués au volet.

virtual DWORD GetEnabledAlignment() const;

Valeur de retour

Combinaison de styles CBRS_ALIGN_. Le tableau suivant présente les styles possibles :

Indicateur	Alignement activé
CBRS_ALIGN_LEFT	Gauche.
CBRS_ALIGN_RIGHT	Très bien.
CBRS_ALIGN_TOP	haut.
CBRS_ALIGN_BOTTOM	Fond.
CBRS_ALIGN_ANY	Combinaison de tous les indicateurs.

Notes

Appelez cette méthode pour déterminer l’alignement activé pour le volet. L’alignement activé signifie que les côtés de la fenêtre de cadre principal auxquelles un volet peut être ancré.

Activez l’alignement d’ancrage à l’aide de CBasePane ::EnableDocking.

CBasePane ::GetMFCStyle

Retourne les styles de volet spécifiques à MFC.

virtual DWORD GetMFCStyle() const;

Valeur de retour

Combinaison de styles de volet spécifiques à la bibliothèque (AFX_CBRS_).

CBasePane ::GetPaneIcon

Retourne une poignée à l’icône du volet.

virtual HICON GetPaneIcon(BOOL bBigIcon);

Paramètres

bBigIcon
[in] Spécifie une icône de 32 pixels par 32 pixels si TRUE ; spécifie une icône de 16 pixels par 16 pixels si FALSE.

Valeur de retour

Handle vers l’icône du volet. En cas d’échec, retourne NULL.

Notes

L’implémentation par défaut appelle CWnd ::GetIcon.

CBasePane ::GetPaneRow

Retourne un pointeur vers l’objet CDockingPanesRowoù le volet est ancré.

CDockingPanesRow* GetPaneRow();

Valeur de retour

Pointeur vers CDockingPanesRow le cas où le volet est ancré ou NULL s’il est flottant.

Notes

Appelez cette méthode pour accéder à la ligne où un volet est ancré. Par exemple, pour organiser les volets d’une ligne particulière, appelez et appelez GetPaneRow CDockingPanesRow ::ArrangePanes.

CBasePane ::GetPaneStyle

Retourne le style du volet.

virtual DWORD GetPaneStyle() const;

Valeur de retour

Combinaison de styles de barre de contrôle (y compris CBRS_ styles) définis par la méthode CBasePane ::SetPaneStyle au moment de la création.

CBasePane ::GetParentDockSite

Retourne un pointeur vers le site d’ancrage parent.

virtual CDockSite* GetParentDockSite() const;

Valeur de retour

Site d’ancrage parent.

CBasePane ::GetParentMiniFrame

Retourne un pointeur vers la fenêtre mini-frame parente.

virtual CPaneFrameWnd* GetParentMiniFrame(BOOL bNoAssert=FALSE) const;

Paramètres

bNoAssert
[in] Si la valeur est TRUE, cette méthode ne vérifie pas les pointeurs non valides. Si vous appelez cette méthode lorsque votre application quitte, définissez ce paramètre sur TRUE.

Valeur de retour

Pointeur valide vers la fenêtre mini-frame parente si le volet est flottant ; sinon NULL.

Notes

Appelez cette fonction pour récupérer un pointeur vers la fenêtre mini-frame parente. Cette méthode itère à travers tous les parents et recherche un objet dérivé de la classe CPaneFrameWnd.

Permet GetParentMiniFrame de déterminer si le volet flotte.

CBasePane ::GetParentTabbedPane

Retourne un pointeur vers le volet de tabulation parent.

CBaseTabbedPane* GetParentTabbedPane() const;

Valeur de retour

Pointeur vers le volet tabulation parent s’il existe ; sinon NULL.

CBasePane ::GetParentTabWnd

Retourne un pointeur vers la fenêtre parente qui se trouve à l’intérieur d’un onglet.

CMFCBaseTabCtrl* GetParentTabWnd(HWND& hWndTab) const;

Paramètres

hWndTab
[out] Si la valeur de retour n’est pas NULL, ce paramètre contient le handle de la fenêtre de tabulation parente.

Valeur de retour

Pointeur valide vers la fenêtre de tabulation parente ou NULL.

Notes

Utilisez cette fonction pour récupérer un pointeur vers la fenêtre de tabulation parente. Parfois, il n’est pas suffisant d’appeler GetParent, car un volet peut se trouver à l’intérieur d’un wrapper d’ancrage ( classe CDockablePaneAdapter) ou à l’intérieur d’un adaptateur de volet ( classe CDockablePaneAdapter). En utilisant GetParentTabWnd vous pourrez récupérer un pointeur valide dans ces cas (en supposant que le parent est une fenêtre à onglets).

CBasePane ::GetRecentVisibleState

L’infrastructure appelle cette méthode lorsqu’un volet est restauré à partir d’une archive.

virtual BOOL GetRecentVisibleState() const;

Valeur de retour

BoOL qui spécifie l’état visible récent. Si la valeur est TRUE, le volet est visible lors de la sérialisation et doit être visible lors de la restauration. Si la valeur est FALSE, le volet a été masqué lors de la sérialisation et doit être masqué lors de la restauration.

CBasePane ::HideInPrintPreviewMode

Spécifie si le volet est masqué dans l’aperçu avant impression.

virtual BOOL HideInPrintPreviewMode() const;

Valeur de retour

TRUE si le volet n’est pas affiché en préversion avant impression ; sinon, FALSE.

Notes

Les volets de base ne sont pas affichés en préversion avant impression. Par conséquent, cette méthode retourne toujours TRUE.

CBasePane ::InsertPane

Inscrit le volet spécifié auprès du gestionnaire d’ancrage.

BOOL InsertPane(
    CBasePane* pControlBar,
    CBasePane* pTarget,
    BOOL bAfter = TRUE);

Paramètres

pControlBar
[in] Pointeur vers le volet à insérer.

pTarget
[in] Pointeur vers le volet adjacent.

bAfter
[in] Si la valeur est TRUE, pControlBar est inséré après pTarget. Si la valeur est FALSE, pControlBar est inséré avant pTarget.

Valeur de retour

TRUE si la méthode réussit, FALSE sinon.

CBasePane ::IsAccessibilityCompatible

Spécifie si le volet prend en charge l’accessibilité active.

virtual BOOL IsAccessibilityCompatible();

Valeur de retour

TRUE si le volet prend en charge l’accessibilité active ; sinon, FALSE.

CBasePane ::IsAutoHideMode

Détermine si un volet est en mode masquer automatiquement.

virtual BOOL IsAutoHideMode() const;

Valeur de retour

TRUE si le volet est en mode masquer automatiquement ; sinon, FALSE.

Notes

Les volets de base ne peuvent pas être masqués automatiquement. Cette méthode retourne toujours FALSE.

CBasePane ::IsDialogControl

Spécifie si le volet est un contrôle de boîte de dialogue.

BOOL IsDialogControl() const;

Valeur de retour

TRUE si le volet est un contrôle de boîte de dialogue ; sinon, FALSE.

Notes

L’infrastructure utilise cette méthode pour garantir la cohérence de la disposition pour tous les volets.

CBasePane ::IsDocked

Détermine si le volet est ancré.

virtual BOOL IsDocked() const;

Valeur de retour

TRUE si le parent du volet n’est pas un mini-cadre ou si le volet flotte dans un mini-cadre avec un autre volet ; sinon, FALSE.

CBasePane ::IsFloating

Détermine si le volet flotte.

virtual BOOL IsFloating() const;

Valeur de retour

TRUE si le volet flotte ; sinon, FALSE.

Notes

Cette méthode retourne la valeur opposée de CBasePane ::IsDocked.

CBasePane ::IsHorizontal

Détermine si le volet est ancré horizontalement.

virtual BOOL IsHorizontal() const;

Valeur de retour

TRUE si le volet est ancré horizontalement ; sinon FALSE.

Notes

L’implémentation par défaut vérifie l’alignement actuel de l’ancrage pour CBRS_ORIENT_HORZ.

CBasePane ::IsInFloatingMultiPaneFrameWnd

Spécifie si le volet se trouve dans une fenêtre de cadre à plusieurs volets ( classe CMultiPaneFrameWnd).

virtual BOOL IsInFloatingMultiPaneFrameWnd() const;

Valeur de retour

TRUE si le volet se trouve dans une fenêtre frame à plusieurs volets ; sinon, FALSE.

Notes

Seuls les volets ancreables peuvent flotter dans une fenêtre frame à plusieurs volets. Par conséquent, CBasePane::IsInFloatingMultiPaneFrameWnd retourne toujours FALSE.

CBasePane ::IsMDITabbed

Détermine si le volet a été ajouté à une fenêtre enfant MDI en tant que document à onglets.

virtual BOOL IsMDITabbed() const;

Valeur de retour

TRUE si le volet a été ajouté à une fenêtre enfant MDI en tant que document à onglets ; sinon, FALSE.

CBasePane ::IsPaneVisible

Spécifie si l’indicateur WS_VISIBLE est défini pour le volet.

BOOL IsPaneVisible() const;

Valeur de retour

TRUE si WS_VISIBLE est définie ; sinon, FALSE.

Notes

Utilisez CBasePane ::IsVisible pour déterminer la visibilité du volet.

CBasePane ::IsPointNearDockSite

Détermine si un point spécifié est proche du site d’ancrage.

BOOL IsPointNearDockSite(
    CPoint point,
    DWORD& dwBarAlignment,
    BOOL& bOuterEdge) const;

Paramètres

point
[in] Point spécifié.

dwBarAlignment
[out] Spécifie le bord proche du point. Les valeurs possibles sont CBRS_ALIGN_LEFT, CBRS_ALIGN_RIGHT, CBRS_ALIGN_TOP et CBRS_ALIGN_BOTTOM

bOuterEdge
[out] TRUE si le point est proche de la bordure externe du site d’ancrage ; FALSE dans le cas contraire.

Valeur de retour

TRUE si le point est proche du site d’ancrage ; sinon FALSE.

Notes

Le point est proche du site d’ancrage lorsqu’il se trouve dans l’ensemble de sensibilité défini dans le gestionnaire d’ancrage. La sensibilité par défaut est de 15 pixels.

CBasePane ::IsResizable

Détermine si le volet peut être redimensionné.

virtual BOOL IsResizable() const;

Valeur de retour

TRUE si le volet peut être redimensionné par l’utilisateur ; sinon, FALSE.

Notes

Les volets de la classe CDockablePane peuvent être redimensionnés.

La barre d’état ( CMFCStatusBar Class) et la barre d’ancrage ( classe CDockSite) ne peuvent pas être redimensionnées.

CBasePane ::IsRestoredFromRegistry

Détermine si le volet est restauré à partir du Registre.

virtual BOOL IsRestoredFromRegistry() const;

Valeur de retour

TRUE si le volet est restauré à partir du Registre ; sinon, FALSE.

CBasePane ::IsTabbed

Détermine si le volet a été inséré dans le contrôle Onglet d’une fenêtre à onglets.

virtual BOOL IsTabbed() const;

Valeur de retour

TRUE si la barre de contrôle est insérée dans un onglet d’une fenêtre à onglets ; sinon FALSE.

Notes

Cette méthode récupère un pointeur vers le parent immédiat et détermine si la classe runtime du parent est CMFCBaseTabCtrl, classe.

CBasePane ::IsVisible

Détermine si le volet est visible.

virtual BOOL IsVisible() const;

Valeur de retour

TRUE si le volet est visible ; sinon FALSE.

Notes

Utilisez cette méthode pour déterminer la visibilité d’un volet. N’utilisez pas ::IsWindowVisible.

Si le volet n’est pas tabulé (voir CBasePane ::IsTabbed), cette méthode recherche le style WS_VISIBLE. Si le volet est tabulé, cette méthode vérifie la visibilité de la fenêtre de tabulation parente. Si la fenêtre parente est visible, la fonction vérifie la visibilité de l’onglet du volet à l’aide de CMFCBaseTabCtrl ::IsTabVisible.

CBasePane ::LoadState

Charge l'état du volet à partir du Registre.

virtual BOOL LoadState(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

Paramètres

lpszProfileName
[in] Nom du profil.

nIndex
[in] Index de profil.

uiID
[in] ID du volet.

Valeur de retour

TRUE si l’état du volet a été chargé avec succès ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode pour charger l’état du volet à partir du Registre. Remplacez-le dans une classe dérivée pour charger des informations supplémentaires enregistrées par CBasePane ::SaveState.

CBasePane ::MoveWindow

Déplace le volet.

virtual HDWP MoveWindow(
    CRect& rect,
    BOOL bRepaint = TRUE,
    HDWP hdwp = NULL);

Paramètres

rect
[in] Rectangle spécifiant le nouvel emplacement et la nouvelle taille du volet.

bRepaint
[in] Si la valeur est TRUE, le volet est repeint. Si la valeur est FALSE, le volet n’est pas repeint.

hdwp
[in] Gérer vers une structure de position de fenêtre différée.

Valeur de retour

Handle vers une structure de position de fenêtre différée ou NULL.

Notes

Si vous passez NULL en tant que paramètre hdwp , cette méthode déplace normalement la fenêtre. Si vous passez un handle, cette méthode effectue un déplacement de fenêtre différée. Vous pouvez obtenir un handle en appelant BeginDeferWindowPos ou en stockant la valeur de retour d’un appel précédent à cette méthode.

CBasePane ::OnAfterChangeParent

Appelé par l’infrastructure après la modification du parent du volet.

virtual void OnAfterChangeParent(CWnd* pWndOldParent);

Paramètres

pWndOldParent
[in] Pointeur vers le parent précédent.

Notes

L’infrastructure appelle cette méthode après la modification du parent du volet, généralement en raison d’une opération d’ancrage ou flottante.

L'implémentation par défaut n'exécute aucune opération.

CBasePane ::OnBeforeChangeParent

Appelé par l’infrastructure juste avant que le volet change sa fenêtre parente.

virtual void OnBeforeChangeParent(
    CWnd* pWndNewParent,
    BOOL bDelay=FALSE);

Paramètres

pWndNewParent
[in] Pointeur vers une nouvelle fenêtre parente.

bDelay
[in] Spécifie si les ajustements de disposition doivent être retardés.

Notes

L’infrastructure appelle cette méthode juste avant que le parent du volet ne change, généralement en raison d’une opération d’ancrage, flottante ou de masquage automatique.

L'implémentation par défaut n'exécute aucune opération.

CBasePane ::OnDrawCaption

L’infrastructure appelle cette méthode lorsque la légende est dessinée.

virtual void OnDrawCaption();

Notes

Cette méthode n’a aucune fonctionnalité pour la CBasePane classe.

CBasePane ::OnMovePaneDivider

Cette méthode n’est actuellement pas utilisée.

virtual void OnMovePaneDivider(CPaneDivider* /* unused */);

Paramètres

inutilisé
[in] Non utilisé.

CBasePane ::OnPaneContextMenu

Appelé par l’infrastructure lorsqu’il génère un menu qui contient une liste de volets.

virtual void OnPaneContextMenu(
    CWnd* pParentFrame,
    CPoint point);

Paramètres

pParentFrame
[in] Pointeur vers le cadre parent.

point
[in] Spécifie l’emplacement du menu contextuel.

Notes

OnPaneContextMenu appelle le gestionnaire d’ancrage, qui gère la liste des volets qui appartiennent à la fenêtre frame actuelle. Cette méthode ajoute les noms des volets à un menu contextuel et l’affiche. Les commandes du menu affichent ou masquent des volets individuels.

Remplacez cette méthode pour personnaliser ce comportement.

CBasePane ::OnRemoveFromMiniFrame

Appelé par l’infrastructure lorsqu’un volet est supprimé de sa fenêtre mini frame parente.

virtual void OnRemoveFromMiniFrame(CPaneFrameWnd* pMiniFrame);

Paramètres

pMiniFrame
[in] Pointeur vers une fenêtre mini-frame à partir de laquelle le volet est supprimé.

Notes

L’infrastructure appelle cette méthode lorsqu’un volet est supprimé de sa fenêtre mini-frame parente (par exemple).

L'implémentation par défaut n'exécute aucune opération.

CBasePane ::OnSetAccData

CBasePane n’utilise pas cette méthode.

virtual BOOL OnSetAccData(long lVal);

Paramètres

lVal
[in] Non utilisé.

Valeur de retour

Cette méthode retourne toujours TRUE.

Notes

CBasePane ::P aneFromPoint

Retourne le volet qui contient le point donné.

CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    bool bExactBar = false,
    CRuntimeClass* pRTCBarType = NULL) const;

Paramètres

point
[in] Spécifie le point, dans les coordonnées de l’écran, à vérifier.

nSensitivity
[in] Augmentez la zone de recherche de cette quantité. Un volet répond aux critères de recherche si le point donné tombe dans la zone augmentée.

bExactBar
[in] TRUE pour ignorer le paramètre nSensitivity ; sinon, FALSE.

pRTCBarType
[in] Si elle n’est pas NULL, la méthode recherche uniquement les volets du type spécifié.

Valeur de retour

Objet CBasePanedérivé qui contient le point donné, ou NULL si aucun volet n’a été trouvé.

CBasePane ::RecalcLayout

CBasePane n’utilise pas cette méthode.

virtual void RecalcLayout();

CBasePane ::RemovePaneFromDockManager

Annule l’inscription d’un volet et le supprime de la liste dans le gestionnaire d’ancrage.

void RemovePaneFromDockManager(
    CBasePane* pBar,
    BOOL bDestroy = TRUE,
    BOOL bAdjustLayout = FALSE,
    BOOL bAutoHide = FALSE,
    CBasePane* pBarReplacement = NULL);

Paramètres

pBar
[in] Pointeur vers un volet à supprimer.

bDestroy
[in] Si la valeur est TRUE, le volet supprimé est détruit.

bAdjustLayout
[in] Si la valeur est TRUE, ajustez immédiatement la disposition d’ancrage.

bAutoHide
[in] Si la valeur est TRUE, la disposition d’ancrage est liée à la liste des barres d’autohide. Si la valeur est FALSE, la disposition d’ancrage est liée à la liste des volets standard.

pBarReplacement
[in] Pointeur vers un volet qui remplace le volet supprimé.

CBasePane ::SaveState

Enregistre l'état du volet dans le Registre.

virtual BOOL SaveState(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

Paramètres

lpszProfileName
[in] Nom du profil.

nIndex
[in] Index de profil.

uiID
[in] ID du volet.

Valeur de retour

TRUE si l’état a été enregistré avec succès ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode lorsqu’elle enregistre l’état du volet dans le Registre. Remplacez SaveState dans une classe dérivée pour stocker des informations supplémentaires.

CBasePane ::SelectDefaultFont

Sélectionne la police par défaut pour un contexte d’appareil donné.

CFont* SelectDefaultFont(CDC* pDC);

Paramètres

pDC
[in] Contexte d’appareil.

Valeur de retour

Pointeur vers l’objet CFont Class par défaut.

CBasePane ::SetControlBarStyle

Définit le style de barre de contrôle.

virtual void SetControlBarStyle(DWORD dwNewStyle);

Paramètres

dwNewStyle
[in] Combinaison or au niveau du bit des valeurs possibles suivantes.

Style	Description
AFX_CBRS_FLOAT	Fait flotter la barre de contrôle.
AFX_CBRS_AUTOHIDE	Active le mode de masquage automatique.
AFX_CBRS_RESIZE	Active le redimensionnement de la barre de contrôle. Lorsque cet indicateur est défini, la barre de contrôle peut être placée dans un volet ancre.
AFX_CBRS_CLOSE	Active le masquage de la barre de contrôle.

CBasePane ::SetDockingMode

Définit le mode d’ancrage du volet.

void SetDockingMode(AFX_DOCK_TYPE dockModeNew);

Paramètres

dockModeNew
[in] Spécifie le nouveau mode d’ancrage pour le volet.

Notes

L’infrastructure prend en charge deux modes d’ancrage : standard et immédiat.

En mode d’ancrage standard, les volets et les fenêtres mini-cadres sont déplacés à l’aide d’un rectangle de glissement. En mode d’ancrage immédiat, les barres de contrôle et les fenêtres mini-frame sont déplacées immédiatement avec leur contexte.

Initialement, le mode d’ancrage est défini globalement par CDockingManager ::m_dockModeGlobal. Vous pouvez définir le mode d’ancrage pour chaque volet individuellement à l’aide de la SetDockingMode méthode.

CBasePane ::SetPaneAlignment

Définit l’alignement du volet.

virtual void SetPaneAlignment(DWORD dwAlignment);

Paramètres

dwAlignment
[in] Spécifie le nouvel alignement.

Notes

En règle générale, l’infrastructure appelle cette méthode lorsqu’un volet est ancré d’un côté du cadre principal à un autre.

Le tableau suivant présente les valeurs possibles pour dwAlignment :

Valeur	Alignement
CBRS_ALIGN_LEFT	Alignement gauche.
CBRS_ALIGN_RIGHT	Alignement droit.
CBRS_ALIGN_TOP	Alignement supérieur.
CBRS_ALIGN_BOTTOM	Alignement inférieur.

CBasePane ::SetPaneStyle

Définit le style du volet.

virtual void SetPaneStyle(DWORD dwNewStyle);

Paramètres

dwNewStyle
[in] Spécifie le nouveau style à définir.

Notes

Cette méthode peut être utilisée pour définir l’un des styles CBRS_ définis dans afxres.h. Étant donné que le style de volet et l’alignement du volet sont stockés ensemble, définissez le nouveau style en le combinant avec l’alignement actuel comme suit.

pPane->SetPaneStyle (pPane->GetCurrentAlignment() | CBRS_TOOLTIPS);

CBasePane ::SetWindowPos

Modifie la taille, la position et l’ordre Z d’un volet.

virtual HDWP SetWindowPos(
    const CWnd* pWndInsertAfter,
    int x,
    int y,
    int cx,
    int cy,
    UINT nFlags,
    HDWP hdwp = NULL);

Paramètres

pWndInsertAfter
[in] Identifie l’objet CWnd qui vient avant cet CWnd objet dans l’ordre Z. Pour plus d’informations, consultez CWnd ::SetWindowPos.

x
[in] Spécifie la position du côté gauche de la fenêtre.

y
[in] Spécifie la position du haut de la fenêtre.

cx
[in] Spécifie la largeur de la fenêtre.

Cy
[in] Spécifie la hauteur de la fenêtre.

nFlags
[in] Spécifie les options de taille et de position. Pour plus d’informations, consultez CWnd ::SetWindowPos.

hdwp
[in] Gérez une structure qui contient des informations de taille et de position pour une ou plusieurs fenêtres.

Valeur de retour

Handle vers une structure de position de fenêtre différée mise à jour, ou NULL.

Notes

Si pWndInsertAfter a la valeur NULL, cette méthode appelle CWnd ::SetWindowPos. Si pWndInsertAfter n’est pas NULL, cette méthode appelle DeferWindowPos.

CBasePane ::ShowPane

Affiche ou masque le volet.

virtual void ShowPane(
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

Paramètres

bShow
[in] Spécifie s’il faut afficher (TRUE) ou masquer (FALSE) un volet.

bDelay
[in] Si la valeur est TRUE, le recalcul de la disposition d’ancrage est retardé.

bActivate
[in] Si la valeur est TRUE, le volet est actif lorsqu’il est affiché.

Notes

Cette méthode affiche ou masque un volet. Utilisez cette méthode au lieu de ShowWindow cela, car cette méthode informe les gestionnaires d’ancrage pertinents sur les modifications apportées à la visibilité du volet.

Utilisez CBasePane ::IsVisible pour déterminer la visibilité actuelle d’un volet.

CBasePane ::StretchPane

Étire un volet sur le plan vertical ou horizontal.

virtual CSize StretchPane(
    int nLength,
    BOOL bVert);

Paramètres

nLength
[in] Longueur par laquelle étirer le volet.

bVert
[in] Si la valeur est TRUE, étirez le volet verticalement. Si la valeur est FALSE, étirez le volet horizontalement.

Valeur de retour

Taille du volet étendu.

CBasePane ::UndockPane

Supprime le volet du site d’ancrage, du curseur par défaut ou de la fenêtre mini-frame où il est actuellement ancré.

virtual void UndockPane(BOOL bDelay=FALSE);

Paramètres

bDelay
Si la valeur est TRUE, la disposition d’ancrage n’est pas recalculée immédiatement.

Notes

Appelez cette méthode pour manipuler l’état du volet ou exclure le volet de la disposition d’ancrage.

Si vous souhaitez continuer à utiliser ce volet, appelez CBasePane ::D ockPane ou CBasePane ::FloatPane avant d’appeler cette méthode.

Voir aussi

Graphique hiérarchique
Classes
CPane
CWnd, classe