CBaseTabbedPane, classe

Étend les fonctionnalités de CDockablePane Class pour prendre en charge la création de fenêtres à onglet.

Syntaxe

class CBaseTabbedPane : public CDockablePane

Membres

Constructeurs publics

Nom	Description
CBaseTabbedPane::CBaseTabbedPane	Constructeur par défaut.

Méthodes publiques

Nom	Description
CBaseTabbedPane ::AddTab	Ajoute un nouvel onglet à un volet à onglets.
CBaseTabbedPane ::AllowDestroyEmptyTabbedPane	Spécifie si un volet à onglets vide peut être détruit.
CBaseTabbedPane ::ApplyRestoredTabInfo	Applique les paramètres d’onglet, qui sont chargés à partir du Registre, dans un volet à onglets.
CBaseTabbedPane ::CanFloat	Détermine si le volet peut flotter. (Remplacements CBasePane ::CanFloat.)
CBaseTabbedPane ::CanSetCaptionTextToTabName	Détermine si la légende du volet à onglets doit afficher le même texte que l’onglet actif.
CBaseTabbedPane ::ConvertToTabbedDocument	(Remplacements CDockablePane ::ConvertToTabbedDocument.)
CBaseTabbedPane ::D etachPane	Convertit un ou plusieurs volets ancrés en documents à ongletS MDI.
CBaseTabbedPane ::EnableSetCaptionTextToTabName	Active ou désactive la possibilité du volet à onglets de synchroniser le texte de légende avec le texte de l’étiquette sous l’onglet actif.
CBaseTabbedPane ::FillDefaultTabsOrderArray	Restaure l’ordre de tabulation interne à un état par défaut.
CBaseTabbedPane ::FindBarByTabNumber	Retourne un volet qui réside dans un onglet lorsque l’onglet est identifié par un index de tabulation de base zéro.
CBaseTabbedPane ::FindPaneByID	Retourne un volet identifié par l’ID de volet.
CBaseTabbedPane ::FloatTab	Fait flotter un volet, mais seulement si le volet réside actuellement dans un onglet détachable.
CBaseTabbedPane ::GetDefaultTabsOrder	Retourne l’ordre par défaut des onglets dans le volet.
CBaseTabbedPane ::GetFirstVisibleTab	Récupère un pointeur vers le premier onglet affiché.
CBaseTabbedPane ::GetMinSize	Récupère la taille minimale autorisée pour le volet. (Remplacements CPane ::GetMinSize.)
CBaseTabbedPane ::GetPaneIcon	Retourne une poignée à l’icône du volet. (Remplacements CBasePane ::GetPaneIcon.)
CBaseTabbedPane ::GetPaneList	Retourne une liste de volets contenus dans le volet à onglets.
CBaseTabbedPane ::GetTabArea	Retourne les rectangles englobants pour les zones d’onglet supérieur et inférieur.
CBaseTabbedPane ::GetTabsNum	Retourne le nombre d’onglets dans une fenêtre d’onglet.
CBaseTabbedPane ::GetUnderlyingWindow	Obtient la fenêtre d’onglet sous-jacente (encapsulée).
CBaseTabbedPane ::GetVisibleTabsNum	Retourne le nombre d’onglets affichés.
CBaseTabbedPane ::HasAutoHideMode	Détermine si le volet à onglets peut être basculé en mode de masquage automatique.
CBaseTabbedPane ::IsHideSingleTab	Détermine si le volet à onglets est masqué si un seul onglet est affiché.
CBaseTabbedPane::LoadSiblingPaneIDs	Utilisé en interne lors de la sérialisation.
CBaseTabbedPane ::RecalcLayout	Recalcule les informations de disposition pour le volet. (Remplacements CPane ::RecalcLayout.)
CBaseTabbedPane ::RemovePane	Supprime un volet du volet à onglets.
CBaseTabbedPane::SaveSiblingBarIDs	Utilisé en interne lors de la sérialisation.
CBaseTabbedPane::Serialize	(Remplacements CDockablePane ::Serialize.)
CBaseTabbedPane::SerializeTabWindow	Utilisé en interne lors de la sérialisation.
CBaseTabbedPane ::SetAutoDestroy	Détermine si la barre de contrôle à onglets sera détruite automatiquement.
CBaseTabbedPane ::SetAutoHideMode	Bascule le volet d’ancrage entre le mode affiché et le mode de masquage automatique. (Remplacements CDockablePane ::SetAutoHideMode.)
CBaseTabbedPane ::ShowTab	Affiche ou masque un onglet.

Notes

Cette classe est une classe abstraite et ne peut pas être instanciée. Il implémente les services communs à tous les types de volets à onglets.

Actuellement, la bibliothèque comprend deux classes de volet à onglets dérivées : CTabbedPane Class et CMFCOutlookBar, classe.

Un CBaseTabbedPane objet encapsule un pointeur vers un objet CMFCBaseTabCtrl, classe . CMFCBaseTabCtrl, classe devient ensuite une fenêtre enfant du volet à onglets.

Pour plus d’informations sur la création de volets à onglets, consultez la classe CDockablePane, la classe CTabbedPane et la classe CMFCOutlookBar.

Hiérarchie d'héritage

CObject

CCmdTarget

CWnd

CBasePane

CPane

CDockablePane

CBaseTabbedPane

Spécifications

En-tête : afxBaseTabbedPane.h

CBaseTabbedPane ::AddTab

Ajoute un nouvel onglet à un volet à onglets.

virtual BOOL AddTab(
    CWnd* pNewBar,
    BOOL bVisible = TRUE,
    BOOL bSetActive = TRUE,
    BOOL bDetachable = TRUE);

Paramètres

pNewBar
[in, out] Pointeur vers le volet à ajouter. Ce pointeur peut devenir non valide après avoir appelé cette méthode. Pour plus d'informations, consultez la section Notes.

bVisible
[in] TRUE pour rendre l’onglet visible ; sinon, FALSE.

bSetActive
[in] TRUE pour rendre l’onglet actif ; sinon, FALSE.

bDetachable
[in] TRUE pour faire en sorte que l’onglet soit détachable ; sinon, FALSE.

Valeur de retour

TRUE si le volet a été ajouté en tant qu’onglet et n’a pas été détruit dans le processus. FALSE si le volet ajouté est un objet de type CBaseTabbedPane. Pour plus d'informations, consultez la section Notes.

Notes

Appelez cette méthode pour ajouter un volet sous la forme d’un nouvel onglet dans un volet à onglets. Si pNewBar pointe vers un objet de type CBaseTabbedPane, tous ses onglets sont copiés dans le volet à onglets, puis pNewBar est détruit. Par conséquent, pNewBar devient un pointeur non valide et ne doit pas être utilisé.

CBaseTabbedPane ::AllowDestroyEmptyTabbedPane

Spécifie si un volet à onglets vide peut être détruit.

virtual BOOL AllowDestroyEmptyTabbedPane() const;

Valeur de retour

TRUE si un volet à onglets vide peut être détruit ; sinon, FALSE. L’implémentation par défaut retourne toujours TRUE.

Notes

Si un volet à onglets vide n’est pas autorisé à être détruit, l’infrastructure masque le volet à la place.

CBaseTabbedPane ::ApplyRestoredTabInfo

Charge les paramètres d’onglet à partir du Registre et les applique à un volet à onglets.

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

Paramètres

bUseTabIndexes
[in] Ce paramètre est utilisé en interne par l’infrastructure.

Notes

Cette méthode est appelée par l’infrastructure lorsqu’elle recharge les informations d’état d’ancrage à partir du Registre. La méthode obtient des informations sur l’ordre de tabulation et les noms d’onglets pour un volet à onglets.

CBaseTabbedPane ::CanFloat

Spécifie si le volet à onglets peut flotter.

virtual BOOL CanFloat() const;

Valeur de retour

TRUE si le volet peut flotter ; sinon, FALSE.

CBaseTabbedPane ::CanSetCaptionTextToTabName

Détermine si la légende du volet à onglets doit afficher le même texte que l’onglet actif.

virtual BOOL CanSetCaptionTextToTabName() const;

Valeur de retour

TRUE si le texte de légende du volet à onglets est défini sur le texte de l’onglet actif ; sinon, FALSE.

Notes

La méthode est utilisée pour déterminer si le texte affiché sur la légende du volet à onglets duplique l’étiquette de l’onglet actif. Vous pouvez activer ou désactiver cette fonctionnalité en appelant CBaseTabbedPane ::EnableSetCaptionTextToTabName.

CBaseTabbedPane ::ConvertToTabbedDocument

Convertit un ou plusieurs volets ancrés en documents à ongletS MDI.

virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);

Paramètres

bActiveTabOnly
[in] Lorsque vous convertissez un volet à onglets, spécifiez TRUE pour convertir uniquement l’onglet actif. Spécifiez FALSE pour convertir tous les onglets du volet.

CBaseTabbedPane ::D etachPane

Détache un volet du volet à onglets.

virtual BOOL DetachPane(
    CWnd* pBar,
    BOOL bHide = FALSE);

Paramètres

pBar
[in] Pointeur vers le volet pour détacher.

bHide
[in] Paramètre booléen qui spécifie si l’infrastructure masque le volet une fois qu’il est détaché.

Valeur de retour

TRUE si l’infrastructure détache correctement le volet ; FALSE si pBar est NULL ou fait référence à un volet qui n’est pas dans le volet à onglets.

Notes

Le framework flotte le volet détaché si possible. Pour plus d’informations, consultez CBasePane ::CanFloat.

CBaseTabbedPane ::EnableSetCaptionTextToTabName

Active ou désactive la possibilité du volet à onglets de synchroniser le texte de légende avec le texte de l’étiquette sous l’onglet actif.

virtual void EnableSetCaptionTextToTabName(BOOL bEnable);

Paramètres

bEnable
[in] TRUE pour synchroniser la légende du volet à onglets avec la légende d’onglet active ; sinon, FALSE.

CBaseTabbedPane ::FillDefaultTabsOrderArray

Restaure l’ordre de tabulation interne à un état par défaut.

void FillDefaultTabsOrderArray();

Notes

Cette méthode est appelée lorsque l’infrastructure restaure une barre Outlook à un état initial.

CBaseTabbedPane ::FindPaneByID

Retourne un volet identifié par l’ID du volet.

virtual CWnd* FindPaneByID(UINT uBarID);

Paramètres

uBarID
[in] Spécifie l’ID du volet à rechercher.

Valeur de retour

Pointeur vers le volet s’il a été trouvé ; sinon, NULL.

Notes

Cette méthode compare tous les onglets du volet et retourne l’ID spécifié par le paramètre uBarID .

CBaseTabbedPane ::FindBarByTabNumber

Retourne un volet qui réside dans un onglet.

virtual CWnd* FindBarByTabNumber(
    int nTabNum,
    BOOL bGetWrappedBar = FALSE);

Paramètres

nTabNum
[in] Spécifie l’index de base zéro de l’onglet à récupérer.

bGetWrappedBar
[in] TRUE pour retourner la fenêtre sous-jacente (encapsulée) du volet au lieu du volet lui-même ; sinon FALSE. Cela s’applique uniquement aux volets dérivés de CDockablePaneAdapter.

Valeur de retour

Si le volet est trouvé, un pointeur valide vers le volet recherché est retourné ; sinon, NULL.

Notes

Appelez cette méthode pour récupérer le volet résidant dans l’onglet spécifié par le paramètre nTabNum .

CBaseTabbedPane ::FloatTab

Fait flotter un volet, mais seulement si le volet réside actuellement dans un onglet détachable.

virtual BOOL FloatTab(
    CWnd* pBar,
    int nTabID,
    AFX_DOCK_METHOD dockMethod,
    BOOL bHide = FALSE);

Paramètres

pBar
[in, out] Pointeur vers le volet à flotter.

nTabID
[in] Spécifie l’index de base zéro de l’onglet à flotter.

dockMethod
[in] Spécifie la méthode à utiliser pour faire flotter le volet. Pour plus d'informations, consultez la section Notes.

bHide
[in] TRUE pour masquer le volet avant de flotter ; sinon, FALSE.

Valeur de retour

TRUE si le volet flotte ; sinon, FALSE.

Notes

Appelez cette méthode pour flotter un volet qui réside actuellement dans un onglet détachable.

Si vous souhaitez détacher un volet par programmation, spécifiez DM_SHOW pour le paramètre dockMethod . Si vous souhaitez flotter le volet dans la même position qu’il a précédemment flottant, spécifiez DM_DBL_CLICK comme paramètre dockMethod .

CBaseTabbedPane ::GetDefaultTabsOrder

Retourne l’ordre par défaut des onglets dans le volet.

const CArray<int,int>& GetDefaultTabsOrder();

Valeur de retour

Objet CArray qui spécifie l’ordre par défaut des onglets dans le volet.

Notes

L’infrastructure appelle cette méthode lorsqu’une barre Outlook est réinitialisée à un état initial.

CBaseTabbedPane ::GetFirstVisibleTab

Récupère un pointeur vers le premier onglet affiché.

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

Paramètres

iTabNum
[in] Référence à un entier. Cette méthode écrit l’index de base zéro du premier onglet affiché dans ce paramètre, ou -1 si aucun onglet affiché n’est trouvé.

Valeur de retour

En cas de réussite, un pointeur vers le premier onglet affiché ; sinon, NULL.

CBaseTabbedPane ::GetMinSize

Récupère la taille minimale autorisée pour le volet.

virtual void GetMinSize(CSize& size) const;

Paramètres

size
[out] Objet CSize rempli avec la taille minimale autorisée.

Notes

Si la gestion cohérente des tailles de volet minimales est active ( CPane ::m_bHandleMinSize), la taille est remplie avec la taille minimale autorisée pour l’onglet actif. Sinon, la taille est remplie avec la valeur renvoyée de CPane ::GetMinSize.

CBaseTabbedPane ::GetPaneIcon

Récupère la taille minimale autorisée pour le volet.

virtual void GetMinSize(CSize& size) const;

Paramètres

size
[out] Objet CSize rempli avec la taille minimale autorisée.

Notes

Si la gestion cohérente des tailles de volet minimales est active ( CPane ::m_bHandleMinSize), la taille est remplie avec la taille minimale autorisée pour l’onglet actif. Sinon, la taille est remplie avec la valeur renvoyée de CPane ::GetMinSize.

CBaseTabbedPane ::GetPaneList

Retourne une liste de volets contenus dans le volet à onglets.

virtual void GetPaneList(
    CObList& lst,
    CRuntimeClass* pRTCFilter = NULL);

Paramètres

Lst
[out] Qui CObList est rempli avec les volets contenus dans le volet à onglets.

pRTCFilter
[in] S’il n’est pas NULL, la liste retournée contient uniquement des volets qui sont de la classe runtime spécifiée.

CBaseTabbedPane ::GetTabArea

Retourne les rectangles englobants pour les zones d’onglet supérieur et inférieur.

virtual void GetTabArea(
    CRect& rectTabAreaTop,
    CRect& rectTabAreaBottom) const = 0;

Paramètres

rectTabAreaTop
[out] Reçoit les coordonnées de l’écran de la zone d’onglet supérieure.

rectTabAreaBottom
[out] Reçoit les coordonnées de l’écran de la zone d’onglet inférieure.

Notes

Appelez cette méthode pour déterminer les rectangles englobants, en coordonnées d’écran, pour les zones de tabulation supérieure et inférieure.

CBaseTabbedPane ::GetTabsNum

Retourne le nombre d’onglets dans une fenêtre d’onglet.

virtual int GetTabsNum() const;

Valeur de retour

Nombre d’onglets dans le volet à onglets.

CBaseTabbedPane ::GetUnderlyingWindow

Obtient la fenêtre d’onglet sous-jacente (encapsulée).

virtual CMFCBaseTabCtrl* GetUnderlyingWindow();

Valeur de retour

Pointeur vers la fenêtre d’onglet sous-jacente.

CBaseTabbedPane ::GetVisibleTabsNum

Retourne le nombre d’onglets visibles.

virtual int GetVisibleTabsNum() const;

Valeur de retour

Nombre d’onglets visibles, qui seront supérieurs ou égaux à zéro.

Notes

Appelez cette méthode pour déterminer le nombre d’onglets visibles dans le volet à onglets.

CBaseTabbedPane ::HasAutoHideMode

Détermine si le volet à onglets peut passer en mode masquage automatique.

virtual BOOL HasAutoHideMode() const;

Valeur de retour

TRUE si le volet peut être basculé en mode d’autohide ; sinon, FALSE.

Notes

Si le mode d’autohide est désactivé, aucun bouton épingle n’est affiché sur la légende du volet tablé.

CBaseTabbedPane ::IsHideSingleTab

Détermine si le volet à onglets est masqué si un seul onglet est affiché.

virtual BOOL IsHideSingleTab() const;

Valeur de retour

TRUE si la fenêtre d’onglet n’est pas affichée lorsqu’il n’y a qu’un seul onglet visible ; sinon, FALSE.

Notes

Si le volet n’est pas affiché, car un seul onglet est ouvert, vous pouvez appeler cette méthode pour déterminer si le volet à onglets fonctionne correctement.

CBaseTabbedPane ::RemovePane

Supprime un volet du volet à onglets.

virtual BOOL RemovePane(CWnd* pBar);

Paramètres

pBar
[in, out] Pointeur vers le volet à supprimer du volet à onglets.

Valeur de retour

TRUE si le volet a été supprimé avec succès du volet à onglets et si le volet à onglets est toujours valide. FALSE si le dernier volet a été supprimé du volet à onglets et que le volet à onglets est sur le point d’être détruit. Si la valeur de retour est FALSE, n’utilisez plus le volet tabulation.

Notes

Appelez cette méthode pour supprimer le volet spécifié par le paramètre pBar du volet à onglets.

CBaseTabbedPane ::SetAutoDestroy

Détermine si la barre de contrôle à onglets sera détruite automatiquement.

void SetAutoDestroy(BOOL bAutoDestroy = TRUE);

Paramètres

bAutoDestroy
[in] TRUE si le volet à onglets a été créé dynamiquement et que vous ne contrôlez pas sa durée de vie ; sinon, FALSE.

Notes

Définissez le mode de destruction automatique sur TRUE si vous créez un volet à onglets dynamiquement et si vous ne contrôlez pas sa durée de vie. Si le mode de destruction automatique est TRUE, le volet à onglets est détruit automatiquement par l’infrastructure.

CBaseTabbedPane ::ShowTab

Affiche ou masque un onglet.

virtual BOOL ShowTab(
    CWnd* pBar,
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

Paramètres

pBar
[in] Pointeur vers le volet pour afficher ou masquer.

bShow
[in] TRUE pour afficher le volet ; FALSE pour masquer le volet.

bDelay
[in] TRUE pour retarder l’ajustement de la disposition de l’onglet ; sinon, FALSE.

bActivate
[in] TRUE pour rendre l’onglet actif ; sinon, FALSE.

Valeur de retour

TRUE si l’onglet a été affiché ou masqué avec succès ; sinon, FALSE.

Notes

Lorsque vous appelez cette méthode, un volet est affiché ou masqué, selon la valeur du paramètre bShow . Si vous masquez un onglet et qu’il s’agit du dernier onglet visible dans la fenêtre de l’onglet sous-jacent, le volet à onglets est masqué. Si vous affichez un onglet lorsqu’il n’y avait auparavant aucun onglet visible, le volet à onglets s’affiche.

CBaseTabbedPane ::RecalcLayout

Recalcule les informations de disposition pour le volet.

virtual void RecalcLayout();

Notes

Si le volet flotte, cette méthode informe l’infrastructure de redimensionner le volet à la taille actuelle du mini-frame.

Si le volet est ancré, cette méthode ne fait rien.

CBaseTabbedPane ::SetAutoHideMode

Définit le mode de masquage automatique pour les volets détachables dans le volet à onglets.

virtual CMFCAutoHideToolBar* SetAutoHideMode(
    BOOL bMode,
    DWORD dwAlignment,
    CMFCAutoHideToolBar* pCurrAutoHideBar = NULL,
    BOOL bUseTimer = TRUE);

Paramètres

bMode
[in] TRUE pour activer le mode de masquage automatique ; FALSE pour activer le mode d’ancrage standard.

dwAlignment
[in] Spécifie l’alignement du volet de masquage automatique à créer. Pour obtenir la liste des valeurs possibles, consultez CPane ::MoveByAlignment.

pCurrAutoHideBar
[in, out] Pointeur vers la barre d’outils de masquage automatique actuelle. Sa valeur peut être NULL.

bUseTimer
[in] Spécifie s’il faut utiliser l’effet de masquage automatique lorsque l’utilisateur bascule le volet en mode masque automatiquement ou pour masquer immédiatement le volet.

Valeur de retour

Pointeur vers la barre d’outils de masquage automatique créée lors du passage au mode de masquage automatique, ou NULL si aucune barre d’outils n’est créée.

Notes

L’infrastructure appelle cette méthode lorsqu’un utilisateur choisit le bouton épingle pour basculer le volet à onglets en mode masquer automatiquement ou en mode d’ancrage standard.

Le mode de masquage automatique est défini pour chaque volet détachable dans le volet à onglets. Les volets qui ne sont pas détachables sont ignorés. Pour plus d’informations, consultez CMFCBaseTabCtrl ::EnableTabDetach.

Appelez cette méthode pour basculer un volet à onglets en mode masquage automatique par programmation. Le volet doit être ancré dans la fenêtre de cadre principale ( CDockablePane ::GetDefaultPaneDivider doit retourner un pointeur valide vers le CPaneDivider).

Voir aussi

Graphique hiérarchique
Classes
CDockablePane, classe