CMFCBaseTabCtrl, classe

Article
03/29/2024

Implémente les fonctionnalités de base pour les fenêtres à onglets. Pour plus d’informations, consultez le code source situé dans le dossier VC\atlmfc\src\mfc de votre installation de Visual Studio.

Syntaxe

class CMFCBaseTabCtrl : public CWnd

Membres

Méthodes publiques

Nom	Description
CMFCBaseTabCtrl::AddIcon
CMFCBaseTabCtrl::AddTab	Ajoute un nouvel onglet à la fenêtre à onglets.
CMFCBaseTabCtrl::ApplyRestoredTabInfo
CMFCBaseTabCtrl::AutoDestroyWindow
CMFCBaseTabCtrl::CalcRectEdit
CMFCBaseTabCtrl::CleanUp
CMFCBaseTabCtrl::ClearImageList
CMFCBaseTabCtrl::DetachTab	Détache un onglet d'une fenêtre à onglets.
CMFCBaseTabCtrl::EnableActivateLastActive
CMFCBaseTabCtrl::EnableAutoColor	Active ou désactive la coloration d'onglet automatique.
CMFCBaseTabCtrl::EnableCustomToolTips	Active ou désactive les info-bulles personnalisées pour les onglets.
CMFCBaseTabCtrl::EnableInPlaceEdit	Active ou désactive la modification directe des étiquettes d'onglets.
CMFCBaseTabCtrl::EnableTabDetach	Active les onglets détachables.
CMFCBaseTabCtrl::EnableTabSwap	Active ou désactive la possibilité pour l'utilisateur de modifier l'ordre des onglets avec une souris.
CMFCBaseTabCtrl::EnsureVisible	Fait défiler les onglets jusqu'à ce que l'onglet spécifié soit visible. Cette méthode ne produit aucun effet si l'onglet spécifié est déjà visible.
CMFCBaseTabCtrl::EnterDragMode
CMFCBaseTabCtrl::FindTargetWnd	Retourne un volet qui contient un point spécifié.
CMFCBaseTabCtrl::FireChangeActiveTab
CMFCBaseTabCtrl::FireChangingActiveTab
CMFCBaseTabCtrl::GetActiveTab	Retourne l'index de l'onglet actif.
CMFCBaseTabCtrl::GetActiveTabColor	Retourne la couleur d'arrière-plan de l'onglet actif.
CMFCBaseTabCtrl::GetActiveTabTextColor	Retourne la couleur du texte de l'onglet actif.
CMFCBaseTabCtrl::GetActiveWnd	Retourne un pointeur vers la page active du contrôle onglet.
CMFCBaseTabCtrl::GetAutoColors	Retourne une référence au tableau de couleurs utilisées pour la coloration automatique.
CMFCBaseTabCtrl::GetFirstVisibleTab	Retourne un pointeur vers le premier onglet visible.
CMFCBaseTabCtrl::GetFirstVisibleTabNum
CMFCBaseTabCtrl::GetHighlightedTab	Retourne l'index de l'onglet actuellement en surbrillance.
CMFCBaseTabCtrl::GetImageList
CMFCBaseTabCtrl::GetImageSize
CMFCBaseTabCtrl::GetLastVisibleTab
CMFCBaseTabCtrl::GetLocation	Retourne une variable du type de données LOCATION qui indique la position de la zone d'onglet par rapport au contrôle onglet. Par exemple, au-dessus ou au-dessous.
CMFCBaseTabCtrl::GetMaxWindowSize
CMFCBaseTabCtrl::GetTabArea	Retourne la taille et la position de la zone d'onglet dans la fenêtre à onglets. La position de la zone de l'onglet est définie à l'aide de coordonnées.
CMFCBaseTabCtrl::GetTabBkColor	Retourne la couleur d'arrière-plan de l'onglet spécifié.
CMFCBaseTabCtrl::GetTabBorderSize	Retourne la taille des bordures d'onglet dans le contrôle onglet.
CMFCBaseTabCtrl::GetTabByID	Retourne l'index de l'onglet identifié par un ID spécifié.
CMFCBaseTabCtrl::GetTabCloseButton
CMFCBaseTabCtrl::GetTabFromHwnd	Retourne l'index d'un onglet qui contient un objet HWND spécifié.
CMFCBaseTabCtrl::GetTabFromPoint	Retourne l'onglet qui contient un point spécifié.
CMFCBaseTabCtrl::GetTabFullWidth
CMFCBaseTabCtrl::GetTabHicon	Retourne l'icône associée à l'onglet spécifié.
CMFCBaseTabCtrl::GetTabID	Retourne l'ID d'un onglet en utilisant son index.
CMFCBaseTabCtrl::GetTabIcon	Retourne l'ID d'icône correspondant à un onglet spécifié.
CMFCBaseTabCtrl::GetTabLabel	Retourne le texte d'un onglet spécifié.
CMFCBaseTabCtrl::GetTabRect	Récupère la taille et la position d'un onglet spécifié.
CMFCBaseTabCtrl::GetTabsHeight
CMFCBaseTabCtrl::GetTabsRect
CMFCBaseTabCtrl::GetTabTextColor	Retourne la couleur du texte d'un onglet spécifié.
CMFCBaseTabCtrl::GetTabWnd	Retourne le pointeur vers un volet qui réside sur une page d'onglet spécifiée.
CMFCBaseTabCtrl::GetTabWndNoWrapper	Retourne le pointeur direct vers un contrôle qui réside sur une page d'onglet spécifiée, même si le contrôle possède un wrapper.
CMFCBaseTabCtrl::GetTabsNum	Retourne le nombre d'onglet contenus dans le contrôle onglet.
CMFCBaseTabCtrl::GetToolTipCtrl	Retourne une référence au contrôle info-bulle (ToolTip) associé à l'objet `CMFCBaseTabCtrl` .
CMFCBaseTabCtrl::GetVisibleTabsNum	Retourne le nombre d'onglets visibles.
CMFCBaseTabCtrl::HasImage
CMFCBaseTabCtrl::HideSingleTab	Définit une option qui masque un onglet de fenêtre, mais seulement si la fenêtre à onglets présente un seul onglet visible.
CMFCBaseTabCtrl::InsertTab	Insère un nouvel onglet.
CMFCBaseTabCtrl::InvalidateTab
CMFCBaseTabCtrl::IsActiveTabCloseButton
CMFCBaseTabCtrl::IsAutoColor	Retourne une valeur qui indique si une fenêtre à onglets est en mode couleur automatique.
CMFCBaseTabCtrl::IsAutoDestroyWindow
CMFCBaseTabCtrl::IsColored
CMFCBaseTabCtrl::IsDialogControl
CMFCBaseTabCtrl::IsDrawNoPrefix
CMFCBaseTabCtrl::IsFlatFrame	Retourne une valeur qui indique si le cadre de la zone d'onglet est en 2D ou 3D.
CMFCBaseTabCtrl::IsFlatTab
CMFCBaseTabCtrl::IsHideSingleTab	Retourne une valeur qui indique si le contrôle onglet est configuré pour masquer un onglet, mais seulement si une fenêtre à onglets présente un seul onglet visible.
CMFCBaseTabCtrl::IsIconAdded
CMFCBaseTabCtrl::IsInPlaceEdit	Indique si les utilisateurs peuvent modifier l'étiquette d'un onglet.
CMFCBaseTabCtrl::IsLeftRightRounded
CMFCBaseTabCtrl::IsMDITab
CMFCBaseTabCtrl::IsOneNoteStyle	Indique si une fenêtre à onglets présente les onglets dans le style Microsoft OneNote.
CMFCBaseTabCtrl::IsPtInTabArea	Vérifie l'existence d'un point spécifié dans la zone d'onglet.
CMFCBaseTabCtrl::IsTabCloseButtonHighlighted
CMFCBaseTabCtrl::IsTabCloseButtonPressed
CMFCBaseTabCtrl::IsTabDetachable	Indique si un onglet est détachable.
CMFCBaseTabCtrl::IsTabIconOnly	Indique si les onglets affichent des icônes mais pas des étiquettes.
CMFCBaseTabCtrl::IsTabSwapEnabled	Indique si l'utilisateur peut modifier la position des onglets en les faisant glisser.
CMFCBaseTabCtrl::IsTabVisible	Indique si un onglet spécifié est visible.
CMFCBaseTabCtrl::IsVS2005Style
CMFCBaseTabCtrl::MoveTab
CMFCBaseTabCtrl::OnChangeTabs	Appelé par l'infrastructure quand le nombre d'onglets change.
CMFCBaseTabCtrl::OnDragEnter
CMFCBaseTabCtrl::OnDragLeave
CMFCBaseTabCtrl::OnDragOver
CMFCBaseTabCtrl::OnDrop
CMFCBaseTabCtrl::OnRenameTab
CMFCBaseTabCtrl::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.)
CMFCBaseTabCtrl::RecalcLayout	Recalcule la disposition interne d'une fenêtre à onglets.
CMFCBaseTabCtrl::RemoveAllTabs	Supprime tous les onglets de la fenêtre à onglets.
CMFCBaseTabCtrl::RemoveTab	Supprime un onglet d'une fenêtre à onglets.
CMFCBaseTabCtrl::RenameTab
CMFCBaseTabCtrl::ResetImageList	Réinitialise la liste d'images attachée à une fenêtre à onglets.
CMFCBaseTabCtrl::Serialize	Lit ou écrit cet objet dans une archive. (Substitue CObject::Serialize.)
CMFCBaseTabCtrl::SetActiveTab	Active un onglet.
CMFCBaseTabCtrl::SetActiveTabColor	Définit la couleur d'arrière-plan de l'onglet actif.
CMFCBaseTabCtrl::SetActiveTabTextColor	Définit la couleur du texte des onglets actifs.
CMFCBaseTabCtrl::SetAutoColors	Définit les couleurs des contrôles Onglet appliquées en mode couleur automatique.
CMFCBaseTabCtrl::SetDockingBarWrapperRTC	Définit la classe wrapper utilisée pour les objets qui ne sont pas dérivés de CDockablePane Class.
CMFCBaseTabCtrl::SetDrawNoPrefix	Active et désactive le traitement des caractères de préfixe quand les étiquettes d'onglets sont dessinées.
CMFCBaseTabCtrl::SetImageList	Définit la liste d'images d'icône.
CMFCBaseTabCtrl::SetLocation
CMFCBaseTabCtrl::SetTabBkColor	Définit la couleur d'arrière-plan d'un onglet spécifié.
CMFCBaseTabCtrl::SetTabBorderSize	Définit une nouvelle taille de bordure d'onglet.
CMFCBaseTabCtrl::SetTabHicon	Définit une icône d'onglet.
CMFCBaseTabCtrl::SetTabIcon	Définit un ID d'icône d'onglet.
CMFCBaseTabCtrl::SetTabIconOnly	Active et désactive le mode « icône uniquement » pour un onglet spécifié.
CMFCBaseTabCtrl::SetTabLabel	Définit une étiquette d'onglet de même valeur qu'une chaîne spécifiée.
CMFCBaseTabCtrl::SetTabsHeight
CMFCBaseTabCtrl::SetTabTextColor	Définit la couleur du texte d'un onglet spécifié.
CMFCBaseTabCtrl::SetTabsOrder	Réorganise les onglets dans l'ordre spécifié.
CMFCBaseTabCtrl::ShowTab	Affiche ou masque l'onglet spécifié.
CMFCBaseTabCtrl::StartRenameTab
CMFCBaseTabCtrl::SwapTabs

Méthodes protégées

Nom	Description
CMFCBaseTabCtrl::CreateWrapper	Crée un wrapper pour un objet dérivé de CWnd qui n'est pas dérivé de `CDockablePane`. Pour ancrer un objet `CMFCBaseTabCtrl` , chaque contrôle incorporé doit avoir un wrapper d'ancrage ou être dérivé de `CDockablePane`. La classe du wrapper est définie à l'aide de `SetDockingBayWrapperRTC`.

Données membres

Nom	Description
CMFCBaseTabCtrl::m_bActivateTabOnRightClick	Précise si les onglets sont sélectionnés par un clic gauche ou un clic droit de souris.
CMFCBaseTabCtrl::m_bAutoDestroyWindow	Précise si les volets contenus dans les onglets sont détruits automatiquement.

Notes

La classe CMFCBaseTabCtrl est une classe abstraite. Par conséquent, elle ne peut pas être instanciée. Pour créer une fenêtre à onglets, vous devez faire dériver une classe de CMFCBaseTabCtrl. La bibliothèque MFC contient des exemples de classes dérivées, parmi lesquels CMFCTabCtrl Class et CMFCOutlookBarTabCtrl Class.

À compter de Visual Studio 2015, cette classe prend en charge Microsoft Active Accessibility.

Conseils de personnalisation

Les conseils suivants se rapportent à CMFCBaseTabCtrl Class et à toutes les classes qui héritent de celui-ci :

Si vous autorisez les onglets détachables, ne gardez pas les pointeurs vers les fenêtres à onglets. Ces onglets détachables peuvent être créés et détruits de façon dynamique. De ce fait, les pointeurs peuvent devenir non valides.
Vous pouvez configurer le contrôle onglet pour permettre aux utilisateurs de déplacer les onglets de façon dynamique sur un contrôle onglet à l'aide de la souris. Cette fonctionnalité est intégrée à la classe CMFCBaseTabCtrl . Pour l’activer, appelez CMFCBaseTabCtrl::EnableTabSwap.
Par défaut, les onglets sont détachables dès lors que vous les ajoutez à un contrôle onglet. Vous pouvez aussi ajouter des onglets non détachables à l’aide de CMFCBaseTabCtrl::AddTab. Si vous attribuez au paramètre bDetachable la valeur FALSE, l'onglet n'est pas détachable. Vous pouvez aussi rendre les onglets détachables en appelant la méthode CMFCBaseTabCtrl::EnableTabDetach.
Les objets dérivés de la CWnd Class peuvent être placés sur une barre de contrôle ou un onglet ancrable. Pour ancrer le contrôle dans son intégralité, vous devez rendre l'objet CWnd ancrable. Pour ce faire, MFC utilise une classe wrapper. Cette classe wrapper est la CDockablePaneAdapter Class. Les objets CWnd qui sont ajoutés à une barre de contrôle ou à un onglet ancrable sont inclus dans un wrapper à l'intérieur d'un objet CDockablePaneAdapter . Vous pouvez désactiver l'inclusion automatique dans un wrapper en attribuant au paramètre m_bEnableWrapping de votre objet CMFCBaseTablCtrl la valeur FALSE. Vous pouvez aussi changer la classe que votre application doit utiliser comme wrapper à l’aide de la méthode CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Hiérarchie d'héritage

Spécifications

En-tête : afxbasetabctrl.h

CMFCBaseTabCtrl::AddIcon

Ajoute une icône à la liste des icônes du membre CMap m_mapAddedIcons protégé.

void AddIcon(
    HICON hIcon,
    int iIcon);

Paramètres

hIcon
[in] Handle à ajouter à l’icône.

iIcon
[in] Index de base zéro de l’icône dans le membre CImageList m_Images protégé.

Notes

CMFCBaseTabCtrl::AddTab

Ajoute un nouvel onglet au contrôle Tab.

virtual void AddTab(
    CWnd* pTabWnd,
    LPCTSTR lpszTabLabel,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

virtual void AddTab(
    CWnd* pTabWnd,
    UINT uiResTabLabel,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

Paramètres

pTabWnd
[in] Pointeur vers la fenêtre que cette méthode représente sous la forme d’un nouvel onglet.

lpszTabLabel
[in] Chaîne qui contient l’étiquette du nouvel onglet.

uiImageId
[in] ID d’image de la liste d’images. Le contrôle Tab utilise cette image comme icône pour le nouvel onglet.

uiResTabLabel
[in] ID de ressource de l’étiquette.

bDetachable
[in] Paramètre booléen qui détermine si le nouvel onglet est détachable.

Notes

Si pTabWnd pointe vers un objet qui n’est pas dérivé de la classe CDockablePane et si bDetachable est TRUE, l’infrastructure crée automatiquement un wrapper pour l’objet pTabWnd. Le wrapper rend l’objet pTabWnd détachable. Par défaut, le wrapper est une instance de la classe CDockablePaneAdapter. Si la fonctionnalité proposée par le wrapper par défaut est inacceptable, utilisez la méthode CMFCBaseTabCtrl::SetDockingBarWrapperRTC pour spécifier un autre wrapper.

CMFCBaseTabCtrl::ApplyRestoredTabInfo

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

Paramètres

[in] bUseTabIndexes

Notes

CMFCBaseTabCtrl::AutoDestroyWindow

void AutoDestroyWindow(BOOL bAutoDestroy = TRUE);

Paramètres

[in] bAutoDestroy

Notes

CMFCBaseTabCtrl::CalcRectEdit

virtual void CalcRectEdit(CRect& rectEdit);

Paramètres

[in] rectEdit

Notes

CMFCBaseTabCtrl::CleanUp

virtual void CleanUp();

Notes

CMFCBaseTabCtrl::ClearImageList

virtual void ClearImageList();

Notes

CMFCBaseTabCtrl::CreateWrapper

Crée un wrapper pour une fenêtre frame dérivée de la classe CWnd, mais qui n’est pas dérivée de la classe CDockablePane.

virtual CWnd* CreateWrapper(
    CWnd* pWndToWrap,
    LPCTSTR lpszTabLabel,
    BOOL bDetachable);

Paramètres

pWndToWrap
[in] Pointeur vers la fenêtre frame qui est encapsulée.

lpszTabLabel
[in] Chaîne qui contient l’étiquette de la fenêtre.

bDetachable
[in] Paramètre booléen qui indique si la fenêtre est détachable.

Valeur de retour

Pointeur vers wrapper dérivé de la classe CDockablePane si CreateWrapper crée correctement une classe wrapper pour pWndToWrap. Si la méthode échoue, elle retourne pWndToWrap.

Notes

Une fenêtre à onglets peut ancrer n’importe quel objet dérivé de CWnd. Toutefois, pour qu’un objet CMFCBaseTabCtrl Class soit ancré, chaque objet sur CMFCBaseTabCtrl doit être détachable. Par conséquent, CMFCBaseTabCtrl encapsule automatiquement tous les objets qui ne sont pas dérivés de CDockablePane.

Par défaut, CMFCBaseTabCtrl crée des instances de la classe CDockablePaneAdapter. Pour modifier la classe par défaut du wrapper, appelez CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Si pWndToWrap est dérivé de CDockablePane, cette méthode ne crée pas de wrapper. Au lieu de cela, elle échouera et retournera pWndToWrap.

CMFCBaseTabCtrl::DetachTab

L’infrastructure appelle cette méthode pour détacher un onglet du contrôle Tab.

virtual BOOL DetachTab(
    AFX_DOCK_METHOD dockMethod,
    int nTabNum = -1,
    BOOL bHide = FALSE);

Paramètres

dockMethod
[in] Type de données énuméré fourni par la classe CBasePane. Ce type de données spécifie la méthode utilisée pour détacher l’onglet.

nTabNum
[in] Index de base zéro de l’onglet à détacher.

bHide
[in] Paramètre booléen qui indique si l’infrastructure doit masquer l’onglet détaché.

Valeur de retour

Valeur différente de zéro cas de réussite ; sinon, 0.

Notes

Si l’onglet spécifié par nTabNum n’est pas détachable, cette fonction échoue et retourne FALSE.

CMFCBaseTabCtrl::EnableActivateLastActive

void EnableActivateLastActive(BOOL bLastActive = TRUE);

Paramètres

[in] bLastActive

Notes

CMFCBaseTabCtrl::EnableAutoColor

Contrôle si l’infrastructure utilise les couleurs d’arrière-plan automatiques lors du dessin d’un onglet.

void EnableAutoColor(BOOL bEnable = TRUE);

Paramètres

bEnable
[in] Paramètre booléen qui détermine si l’infrastructure utilise des couleurs automatiques.

Notes

Un contrôle tabulation a un tableau de plusieurs couleurs prédéfinies. Lorsque l’infrastructure utilise des couleurs automatiques, chaque onglet d’une série d’onglets est affecté à la couleur suivante de ce tableau.

Par défaut, les couleurs automatiques sont déterminées par les couleurs définies par la bibliothèque. Vous pouvez fournir un tableau personnalisé de couleurs en appelant CMFCBaseTabCtrl::SetAutoColors.

CMFCBaseTabCtrl::EnableCustomToolTips

Active les info-bulles personnalisées pour le contrôle tabulation.

BOOL EnableCustomToolTips(BOOL bEnable = TRUE);

Paramètres

bEnable
[in] Valeur booléenne qui détermine s’il faut utiliser des info-bulles personnalisées.

Valeur de retour

TRUE en cas de réussite, sinon FALSE.

Notes

Si des info-bulles personnalisées sont activées, le contrôle tabulation envoie le message AFX_WM_ON_GET_TAB_TOOLTIP au cadre principal. Si vous souhaitez prendre en charge les info-bulles personnalisées dans votre application, la fenêtre cadre principale doit gérer cette méthode et fournir le texte d’info-bulle personnalisé. Pour plus d’informations sur la fourniture de texte d’info-bulle personnalisé, consultez CMFCTabToolTipInfo Structure.

CMFCBaseTabCtrl::EnableInPlaceEdit

Active la modification directe des étiquettes d’onglets par l’utilisateur.

virtual void EnableInPlaceEdit(BOOL bEnable) = 0;

Paramètres

bEnable
[in] Paramètre booléen qui spécifie s’il faut activer la modification directe des étiquettes d’onglet.

Notes

Par défaut, la modification directe des étiquettes d’onglets est désactivée pour les contrôles tabulation.

Vous pouvez activer la modification directe pour un sous-ensemble des onglets du contrôle tabulation. Pour ce faire, remplacez la méthode CMFCBaseTabCtrl::StartRenameTab. StartRenameTab doit retourner une valeur différente de zéro pour tous les onglets qui prennent en charge la modification directe des étiquettes d’onglets.

Dans CMFCBaseTabCtrl Class, cette méthode est une fonction virtuelle pure et n’a aucune implémentation. Si vous dérivez une classe de CMFCBaseTabCtrl, vous devez implémenter cette fonction.

CMFCBaseTabCtrl::EnableTabDetach

Active les onglets détachables.

virtual BOOL EnableTabDetach(
    int iTab,
    BOOL bEnable);

Paramètres

iTab
[in] Index de base zéro d’un onglet.

bEnable
[in] Boolean qui indique s’il faut détacher l’onglet.

Valeur de retour

TRUE en cas de réussite, sinon FALSE.

CMFCBaseTabCtrl::EnableTabSwap

Permet à l’utilisateur de modifier l’ordre de tabulation à l’aide d’une souris.

void EnableTabSwap(BOOL bEnable);

Paramètres

bEnable
[in] Valeur booléenne qui indique s’il faut activer l’échange de tabulation.

Notes

Lorsque l’échange de tabulation est activé, l’utilisateur peut faire glisser un onglet et modifier sa position relative dans le contrôle Tab.

CMFCBaseTabCtrl::EnsureVisible

Fait défiler les onglets jusqu'à ce que l'onglet spécifié soit visible.

virtual BOOL EnsureVisible(int iTab);

Paramètres

iTab
[in] Index de base zéro d’un onglet.

Valeur de retour

Valeur différente de zéro cas de réussite ; sinon, 0.

Notes

Cette méthode n’a aucun effet si l’onglet indiqué par iTab est déjà visible.

Par défaut, cette méthode n’est pas prise en charge par le CMFCBaseTabCtrl Class. Vous devez implémenter cette fonction dans une classe personnalisée dérivée de CMFCBaseTabCtrl si ce contrôle tabulation personnalisé prend en charge le défilement des onglets. Cette méthode est prise en charge par la classe CMFCTabCtrl.

CMFCBaseTabCtrl::EnterDragMode

void EnterDragMode();

Notes

CMFCBaseTabCtrl::FindTargetWnd

Identifie le volet qui contient un point spécifié.

virtual CWnd* FindTargetWnd(const CPoint& pt) = 0;

Paramètres

pt
[in] Point défini à l’aide des coordonnées de zone client de l’objet CMFCBaseTabCtrl.

Valeur de retour

Pointeur vers un objet CWnd en cas de réussite ; sinon NULL.

Notes

Dans la classe CMFCBaseTabCtrl, cette méthode est une fonction virtuelle pure : vous devez l’implémenter si vous dérivez une classe de CMFCBaseTabCtrl.

CMFCBaseTabCtrl::FireChangeActiveTab

virtual void FireChangeActiveTab(int nNewTab);

Paramètres

[in] nNewTab

Notes

CMFCBaseTabCtrl::FireChangingActiveTab

virtual BOOL FireChangingActiveTab(int nNewTab);

Paramètres

[in] nNewTab

Valeur de retour

Notes

CMFCBaseTabCtrl::GetActiveTab

Récupère l’index de l’onglet actif.

virtual int GetActiveTab() const;

Valeur de retour

Index de base zéro de l’onglet actif ; -1 s’il n’existe aucun onglet actif.

CMFCBaseTabCtrl::GetActiveTabColor

Récupère la couleur d’arrière-plan de l’onglet actif.

virtual COLORREF GetActiveTabColor() const;

Valeur de retour

Valeur COLORREF qui spécifie la couleur d’arrière-plan de l’onglet actif.

Notes

Par défaut, la couleur d’arrière-plan de l’onglet actif est COLOR_WINDOW. Vous pouvez modifier la couleur d’arrière-plan de l’onglet actif à l’aide de la méthode CMFCBaseTabCtrl::SetActiveTabColor.

CMFCBaseTabCtrl::GetActiveTabTextColor

Récupère la couleur de texte de l’onglet actif.

virtual COLORREF GetActiveTabTextColor() const;

Valeur de retour

Valeur COLORREF qui spécifie la couleur de texte de l’onglet actif.

Notes

Par défaut, la couleur de texte des onglets actifs est COLOR_WINDOWTEXT. Vous pouvez modifier la couleur du texte avec la méthode CMFCBaseTabCtrl::SetActiveTabTextColor.

CMFCBaseTabCtrl::GetActiveWnd

Récupère un pointeur vers la fenêtre d’onglet actuellement active.

virtual CWnd* GetActiveWnd() const;

Valeur de retour

Pointeur vers une fenêtre.

CMFCBaseTabCtrl::GetAutoColors

Récupère le tableau de couleurs utilisé pour la coloration automatique.

const CArray<COLORREF,COLORREF>& GetAutoColors() const;

Valeur de retour

Référence à un tableau de valeurs COLORREF que l’objet CMFCBaseTabCtrlutilise pour la coloration automatique des onglets.

Notes

Par défaut, l’infrastructure initialise le tableau de couleurs en couleurs définies par la bibliothèque. Vous pouvez fournir un tableau personnalisé de couleurs en appelant la méthode CMFCBaseTabCtrl::SetAutoColors.

CMFCBaseTabCtrl::GetFirstVisibleTab

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

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

virtual CWnd* GetFirstVisibleTab(
    int iStartFrom,
    int& iTabNum);

Paramètres

iTabNum
[out] Référence à un entier. Cette méthode écrit l’index de base zéro du premier onglet visible dans ce paramètre.

iStartFrom
[in] Index de base zéro du premier onglet à vérifier.

Valeur de retour

Pointeur vers le premier onglet visible en cas de réussite ; sinon NULL.

Notes

Si cette méthode échoue, elle écrit la valeur -1 dans iStartFrom.

Si iStartFrom est supérieur ou égal au nombre d’onglets dans le contrôle tabulation, GetFirstVisibleTab échoue automatiquement.

CMFCBaseTabCtrl::GetFirstVisibleTabNum

virtual int GetFirstVisibleTabNum() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::GetHighlightedTab

Récupère l’index de l’onglet actuellement mis en surbrillance.

int GetHighlightedTab() const;

Valeur de retour

Index de base zéro de l’onglet mis en surbrillance.

CMFCBaseTabCtrl::GetImageList

virtual const CImageList* GetImageList() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::GetImageSize

virtual CSize GetImageSize() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::GetLastVisibleTab

virtual CWnd* GetLastVisibleTab(int& iTabNum);

Paramètres

[in] iTabNum

Valeur de retour

Notes

CMFCBaseTabCtrl::GetLocation

Récupère l’emplacement de la partie zone d’onglet du contrôle Tab.

Location GetLocation() const;

Valeur de retour

Emplacement de la zone d’onglet.

Notes

Les valeurs d’emplacement de la zone d’onglet possibles sont LOCATION_BOTTOM et LOCATION_TOP.

CMFCBaseTabCtrl::GetMaxWindowSize

virtual CSize GetMaxWindowSize() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::GetTabArea

Récupère la taille et la position de la zone de tabulation du contrôle Tab.

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

Paramètres

rectTabAreaTop
[in] Référence à un objet CRect. GetTabArea utilise cet objet pour stocker la taille et la position de la zone d’onglet supérieure.

rectTabAreaBottom
[in] Référence à un objet CRect. GetTabArea utilise cet objet pour stocker la taille et la position de la zone d’onglet inférieure.

Notes

Une fois GetTabArea retourné, les paramètres CRect contiennent la taille et la position de la zone de tabulation dans les coordonnées clientes du contrôle tabulation. S’il n’existe aucune zone d’onglet en haut ou en bas du contrôle Tab, rectTabAreaTop ou rectTabAreaBottom s’il est vide.

Dans CMFCBaseTabCtrl Class, cette méthode est une fonction virtuelle pure et n’a aucune implémentation. Si vous dérivez une classe de CMFCBaseTabCtrl, vous devez implémenter cette fonction.

CMFCBaseTabCtrl::GetTabBkColor

Récupère la couleur d’arrière-plan de l’onglet spécifié.

virtual COLORREF GetTabBkColor(int iTab) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet.

Valeur de retour

Valeur COLORREF qui indique la couleur d’arrière-plan de l’onglet spécifié ; -1 si iTab est hors limites.

CMFCBaseTabCtrl::GetTabBorderSize

Récupère la taille des bordures de tabulation dans le contrôle tabulation.

virtual int GetTabBorderSize() const;

Valeur de retour

Taille de la bordure de tabulation, en pixels.

Notes

La taille par défaut de la bordure de tabulation est de trois pixels. Vous pouvez modifier cette taille de bordure avec la méthode CMFCBaseTabCtrl::SetTabBorderSize.

CMFCBaseTabCtrl::GetTabByID

Récupère l’index d’un onglet en fonction d’un ID d’onglet.

virtual int GetTabByID(int id) const;

Paramètres

id
[in] ID d’onglet.

Valeur de retour

Index de base zéro d’un onglet s’il est trouvé ; -1 si l’ID d’onglet est introuvable.

Notes

Les ID d’onglet sont attribués automatiquement lorsque des onglets sont ajoutés à un contrôle tabulation.

CMFCBaseTabCtrl::GetTabCloseButton

CRect GetTabCloseButton() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::GetTabFromHwnd

Récupère l’index de l’onglet qui contient l’objet HWND spécifié.

virtual int GetTabFromHwnd(HWND hwnd) const;

Paramètres

hwnd
[in] Poignée d’une fenêtre.

Valeur de retour

Index de base zéro de l’onglet en cas de réussite ; -1 si aucun onglet ne contient hwnd.

CMFCBaseTabCtrl::GetTabFromPoint

Récupère l’onglet qui contient un point spécifié.

virtual int GetTabFromPoint(CPoint& pt) const;

Paramètres

pt
[in] Point dans les coordonnées du client du contrôle tabulation.

Valeur de retour

Index de l’onglet qui contient pt; -1 si aucun onglet ne contient pt.

CMFCBaseTabCtrl::GetTabFullWidth

virtual int GetTabFullWidth(int iTab) const;

Paramètres

[in] iTab

Valeur de retour

Notes

CMFCBaseTabCtrl::GetTabHicon

Retourne le HICON associé à l’onglet spécifié.

virtual HICON GetTabHicon(int iTab) const;

Paramètres

iTab
[in] Index de base zéro pour l’onglet.

Valeur de retour

HICON associé à une étiquette d’onglet en cas de réussite ; NULL s’il n’y a pas HICON ou si la méthode échoue.

CMFCBaseTabCtrl::GetTabIcon

Récupère l’icône associée à l’onglet spécifié.

virtual UINT GetTabIcon(int iTab) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet.

Valeur de retour

ID d’icône de l’onglet spécifié en cas de réussite ; -1 si l’index n’est pas valide.

Notes

L’objet CMFCBaseTabCtrl stocke les icônes dans l’objet CImageList interne.

CMFCBaseTabCtrl::GetTabID

Récupère l’ID d’un onglet spécifié par l’index de tabulation.

int GetTabID(int iTab) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet.

Valeur de retour

ID de l’onglet ou -1 si iTab est hors limites.

CMFCBaseTabCtrl::GetTabLabel

Récupère le texte d’une étiquette d’onglet.

virtual BOOL GetTabLabel(
    int iTab,
    CString& strLabel) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet.

strLabel
[out] Référence à un objet CString. Cette méthode stocke l’étiquette de l’onglet dans ce paramètre.

Valeur de retour

TRUE si cela réussit ; FALSE dans le cas contraire.

Notes

Cette méthode échoue si l’index iTab n’est pas valide.

Vous définissez l’étiquette d’un onglet lorsque vous créez l’onglet à l’aide de CMFCBaseTabCtrl::AddTab. Vous pouvez également modifier l’étiquette après la création avec la méthode CMFCBaseTabCtrl::SetTabLabel.

CMFCBaseTabCtrl::GetTabRect

Récupère la taille et la position de l’onglet spécifié.

virtual BOOL GetTabRect(
    int iTab,
    CRect& rect) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet.

rect
[out] Référence à un objet CRect. Cette méthode stocke la taille et la position de l’onglet dans ce paramètre.

Valeur de retour

TRUE si elle réussit ; FALSE si l’index de tabulation n’est pas valide.

CMFCBaseTabCtrl::GetTabsHeight

virtual int GetTabsHeight() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::GetTabsNum

Récupère le nombre d’onglets dans le contrôle Tab.

virtual int GetTabsNum() const;

Valeur de retour

Nombre d’onglets dans le contrôle Tab.

CMFCBaseTabCtrl::GetTabsRect

virtual void GetTabsRect(CRect& rect) const;

Paramètres

[in] rect

Notes

CMFCBaseTabCtrl::GetTabTextColor

Récupère la couleur de texte de l’onglet spécifié.

virtual COLORREF GetTabTextColor(int iTab) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet.

Valeur de retour

Le paramètre COLORREF qui indique la couleur de texte de l’onglet spécifié ; -1 si iTab est hors limites.

CMFCBaseTabCtrl::GetTabWnd

Retourne le pointeur vers le volet qui réside sous l’onglet spécifié.

virtual CWnd* GetTabWnd(int iTab) const;

Paramètres

iTab
[in] Index de base zéro d’un onglet.

Valeur de retour

Pointeur vers l’objet CWnd qui réside sous l’onglet spécifié par iTab. NULL si iTab n’est pas valide.

Notes

L’objet retourné est celui que l’application a ajouté lorsqu’elle a appelé CMFCBaseTabCtrl::AddTab ou CMFCBaseTabCtrl::InsertTab.

Si l’objet d’un onglet a un wrapper, cette méthode retourne le wrapper de l’objet. Pour plus d’informations sur les wrappers, consultez CMFCBaseTabCtrl::CreateWrapper. Si vous souhaitez accéder à un pointeur vers l’objet direct sans wrapper, utilisez la méthode CMFCBaseTabCtrl::GetTabWndNoWrapper.

CMFCBaseTabCtrl::GetTabWndNoWrapper

Retourne un pointeur vers le contrôle qui réside sur un onglet, même si le contrôle a un wrapper.

virtual CWnd* GetTabWndNoWrapper(int iTab) const;

Paramètres

iTab
[in] Index de base zéro d’un onglet.

Valeur de retour

Pointeur vers l’objet CWnd qui réside sous l’onglet spécifié ; NULL si iTab n’est pas valide.

Notes

Cette méthode récupère un pointeur direct vers l’objet CWnd que vous avez ajouté à l’aide de la méthode CMFCBaseTabCtrl::AddTab ou CMFCBaseTabCtrl::InsertTab. GetTabWndNoWrapper récupère un pointeur vers l’élément ajouté CWnd, même si l’infrastructure a ajouté un wrapper pour l’objet. Pour plus d’informations sur les wrappers et la classe CMFCBaseTabCtrl, consultez CMFCBaseTabCtrl::CreateWrapper.

Utilisez la méthode CMFCBaseTabCtrl::GetTabWnd si vous ne souhaitez pas ignorer la classe wrapper.

CMFCBaseTabCtrl::GetToolTipCtrl

Récupère une référence au contrôle de l'infobulle.

CToolTipCtrl& GetToolTipCtrl() const;

Valeur de retour

Référence au contrôle d’info-bulle.

CMFCBaseTabCtrl::GetVisibleTabsNum

Récupère le nombre d’onglets actuellement visibles.

virtual int GetVisibleTabsNum() const;

Valeur de retour

Nombre d’onglets visibles.

CMFCBaseTabCtrl::HasImage

virtual BOOL HasImage(int iTab) const;

Paramètres

[in] iTab

Valeur de retour

Notes

CMFCBaseTabCtrl::HideSingleTab

Définit l’option permettant de masquer les onglets du contrôle tabulation lorsqu’il existe un onglet visible.

virtual void HideSingleTab(BOOL bHide = TRUE);

Paramètres

bHide
[in] Boolean qui spécifie s’il faut activer le masquage d’onglets uniques.

Notes

Lorsque votre application est configurée pour masquer des onglets uniques, l’infrastructure affiche automatiquement les onglets lorsqu’un deuxième onglet est ajouté au contrôle tabulation.

CMFCBaseTabCtrl::InsertTab

Insère un onglet dans le contrôle Tab.

Virtual void InsertTab(
    CWnd* pNewWnd,
    LPCTSTR lpszTabLabel,
    int nInsertAt,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

virtual void InsertTab(
    CWnd* pNewWnd,
    UINT uiResTabLabel,
    int nInsertAt,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

Paramètres

pNewWnd
[in] Pointeur vers la fenêtre que cette méthode ajoute sous la forme d’un nouvel onglet.

lpszTabLabel
[in] Chaîne qui contient l’étiquette du nouvel onglet.

nInsertAt
[in] Index de base zéro du nouvel onglet.

uiImageId
[in] ID d’image de la liste d’images. Le contrôle Tab utilise cette image comme icône pour le nouvel onglet.

bDetachable
[in] Paramètre booléen qui détermine si le nouvel onglet est détachable.

uiResTabLabel
[in] ID de ressource de l’étiquette.

Notes

Si l’objet indiqué par pNewWnd n’est pas dérivé de la classe CDockablePane et si le paramètre bDetachable est TRUE, l’infrastructure crée un wrapper spécial pour le nouvel onglet. Par défaut, le wrapper est une instance de la classe CDockablePaneAdapter. Utilisez la méthode CMFCBaseTabCtrl::SetDockingBarWrapperRTC pour créer une autre classe wrapper. Toute classe wrapper personnalisée doit être dérivée de CDockablePaneAdapter.

CMFCBaseTabCtrl::InvalidateTab

void InvalidateTab(int iTab);

Paramètres

[in] iTab

Notes

CMFCBaseTabCtrl::IsActiveTabCloseButton

virtual BOOL IsActiveTabCloseButton() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsAutoColor

Détermine si le contrôle tabulation est en mode couleur automatique.

BOOL IsAutoColor() const;

Valeur de retour

TRUE si le contrôle Tab est en mode couleur automatique ; FALSE dans le cas contraire.

Notes

Vous pouvez activer ou désactiver le mode de coloration automatique à l’aide de la méthode CMFCBaseTabCtrl::EnableAutoColor.

CMFCBaseTabCtrl::IsAutoDestroyWindow

BOOL IsAutoDestroyWindow() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsColored

virtual BOOL IsColored() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsDialogControl

BOOL IsDialogControl() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsDrawNoPrefix

BOOL IsDrawNoPrefix() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsFlatFrame

Indique si le cadre du contrôle Tab est rendu dans un style plat ou dans un style 3D.

virtual BOOL IsFlatFrame() const;

Valeur de retour

TRUE si le cadre du contrôle Tab est rendu dans un style plat ; FALSE si le cadre est rendu dans un style 3D.

Notes

Utilisez CMFCTabCtrl::SetFlatFrame pour modifier le style du cadre du contrôle Tab.

Les contrôles tabulation qui utilisent le style Outlook ne peuvent pas être rendus avec des cadres plats. Cela inclut la classe CMFCOutlookBarTabCtrl et toutes les classes dérivées de cette classe.

CMFCBaseTabCtrl::IsFlatTab

virtual BOOL IsFlatTab() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsHideSingleTab

Détermine si le contrôle Tab masque l’étiquette de tabulation s’il n’y a qu’un seul onglet.

virtual BOOL IsHideSingleTab() const;

Valeur de retour

TRUE si le contrôle Tab masque l’étiquette de tabulation lorsqu’il a un onglet ; sinon FALSE.

Notes

Utilisez la méthode CMFCBaseTabCtrl::HideSingleTab pour activer le masquage de l’étiquette d’onglet lorsqu’il n’existe qu’un seul onglet.

CMFCBaseTabCtrl::IsIconAdded

BOOL IsIconAdded(
    HICON hIcon,
    int& iIcon);

Paramètres

[in] hIcon

[in] iIcon

Valeur de retour

Notes

CMFCBaseTabCtrl::IsInPlaceEdit

Indique si le contrôle tabulation est configuré pour permettre à l’utilisateur de modifier dynamiquement les étiquettes d’onglet.

virtual BOOL IsInPlaceEdit() const;

Valeur de retour

Différent de zéro si la modification sur place est activée ; sinon 0.

Notes

Vous pouvez activer ou désactiver la modification sur place en appelant la méthode CMFCBaseTabCtrl::EnableInPlaceEdit.

CMFCBaseTabCtrl::IsLeftRightRounded

virtual BOOL IsLeftRightRounded() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsMDITab

BOOL IsMDITab() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsOneNoteStyle

Détermine si les onglets sont affichés dans le style de Microsoft OneNote.

virtual BOOL IsOneNoteStyle() const;

Valeur de retour

TRUE si les onglets sont affichés dans le style de Microsoft OneNote ; sinon FALSE.

Notes

Appelez la méthode CMDIFrameWndEx::EnableMDITabs pour activer le style Microsoft OneNote. Vous pouvez également activer ce style lorsque vous instanciez la classe CMFCTabCtrl: transmettez simplement le style STYLE_3D_ONENOTE à la méthode CMFCTabCtrl::Create.

Par défaut, le style Microsoft OneNote n’est pas pris en charge dans une classe personnalisée dérivée du CMFCBaseTabCtrl Class. Toutefois, elle est prise en charge dans la classeCMFCTabCtrl.

CMFCBaseTabCtrl::IsPtInTabArea

Détermine si un point se trouve à l’intérieur de la zone d’onglet.

virtual BOOL IsPtInTabArea(CPoint point) const = 0;

Paramètres

point
[in] Point à tester.

Valeur de retour

Différent de zéro si le point se trouve dans la zone de tabulation ; Sinon, 0.

Notes

Dans CMFCBaseTabCtrl Class, cette méthode est une fonction virtuelle pure et n’a aucune implémentation. Si vous dérivez une classe de CMFCBaseTabCtrl, vous devez implémenter cette fonction.

CMFCBaseTabCtrl::IsTabCloseButtonHighlighted

BOOL IsTabCloseButtonHighlighted() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsTabCloseButtonPressed

BOOL IsTabCloseButtonPressed() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::IsTabDetachable

Détermine si un onglet est détachable.

virtual BOOL IsTabDetachable(int iTab) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet à vérifier.

Valeur de retour

TRUE si l’onglet est détachable ; FALSE dans le cas contraire.

Notes

Pour rendre un onglet détachable, utilisez la méthode CMFCBaseTabCtrl::EnableTabDetach.

CMFCBaseTabCtrl::IsTabIconOnly

Détermine si une étiquette d’onglet contient uniquement des icônes et aucun texte.

virtual BOOL IsTabIconOnly(int iTab) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet.

Valeur de retour

TRUE si une étiquette d’onglet comporte uniquement des icônes ; FALSE dans le cas contraire.

Notes

Pour définir les onglets de votre application pour afficher uniquement les icônes, appelez la méthode CMFCBaseTabCtrl::SetTabIconOnly.

CMFCBaseTabCtrl::IsTabSwapEnabled

Détermine si le contrôle Tab permet à l’utilisateur de modifier les positions des onglets à l’aide de la souris.

BOOL IsTabSwapEnabled() const;

Valeur de retour

Différent de zéro si les positions de tabulation peuvent être modifiées par l’utilisateur ; sinon 0.

Notes

Par défaut, les utilisateurs ne peuvent pas modifier l’ordre des onglets dans un contrôle tabulation. Utilisez la méthode CMFCBaseTabCtrl::EnableTabSwap pour activer cette fonctionnalité.

CMFCBaseTabCtrl::IsTabVisible

Indique si l’onglet spécifié est visible.

virtual BOOL IsTabVisible(int iTab) const;

Paramètres

iTab
[in] Index de base zéro de l’onglet à vérifier.

Valeur de retour

Différent de zéro si l’onglet spécifié est visible ; sinon 0.

CMFCBaseTabCtrl::IsVS2005Style

virtual BOOL IsVS2005Style() const;

Valeur de retour

Notes

CMFCBaseTabCtrl::m_bActivateTabOnRightClick

m_bActivateTabOnRightClick détermine si les onglets sont en focus lorsque l’utilisateur clique sur une étiquette d’onglet à l’aide du bouton droit de la souris.

BOOL m_bActivateTabOnRightClick;

Notes

La valeur par défaut de ce membre de données est FALSE.

CMFCBaseTabCtrl::m_bAutoDestroyWindow

m_bAutoDestroyWindow détermine si l’infrastructure détruit automatiquement les objets sur les onglets lorsque les onglets sont supprimés.

BOOL m_bAutoDestroyWindow;

Notes

Par défaut, ce membre a la valeur FALSE.

CMFCBaseTabCtrl::MoveTab

virtual void MoveTab(
    int nSource,
    int nDest);

Paramètres

[in] nSource

[in] nDest

Notes

CMFCBaseTabCtrl::OnChangeTabs

L’infrastructure appelle cette méthode lorsque le nombre d’onglets d’un contrôle onglet change.

virtual void OnChangeTabs();

Notes

Par défaut, cette méthode ne fait rien. Remplacez cette méthode pour exécuter du code personnalisé lorsque le nombre d’onglets sur le contrôle tabulation change.

CMFCBaseTabCtrl::OnDrop

virtual BOOL OnDrop(
    COleDataObject*,
    DROPEFFECT,
    CPoint);

Paramètres

[in] COleDataObject*

[in] DROPEFFECT

[in] CPoint

Valeur de retour

Notes

CMFCBaseTabCtrl::OnDragOver

virtual DROPEFFECT OnDragOver(
    COleDataObject*,
    DWORD,
    CPoint);

Paramètres

[in] COleDataObject*

[in] DWORD

[in] CPoint

Valeur de retour

Notes

CMFCBaseTabCtrl::OnDragLeave

virtual void OnDragLeave();

Notes

CMFCBaseTabCtrl::OnDragEnter

virtual DROPEFFECT OnDragEnter(
    COleDataObject*,
    DWORD,
    CPoint);

Paramètres

[in] COleDataObject*

[in] DWORD

[in] CPoint

Valeur de retour

Notes

CMFCBaseTabCtrl::OnRenameTab

virtual BOOL OnRenameTab(int, CString&);

Paramètres

[in] int

[in] CString&

Valeur de retour

Notes

CMFCBaseTabCtrl::PreTranslateMessage

virtual BOOL PreTranslateMessage(MSG* pMsg);

Paramètres

[in] pMsg

Valeur de retour

Notes

CMFCBaseTabCtrl::RecalcLayout

Recalcule la disposition interne du contrôle Tab.

virtual void RecalcLayout() = 0;

Notes

Dans la CMFCBaseTabCtrl Class, cette méthode est une fonction virtuelle pure. Si vous dérivez une classe de CMFCBaseTabCtrl, vous devez implémenter cette fonction.

CMFCBaseTabCtrl::RemoveAllTabs

Supprime tous les onglets du contrôle Tab.

virtual void RemoveAllTabs();

Notes

Si CMFCBaseTabCtrl::m_bAutoDestroyWindow a la valeur TRUE, l’infrastructure supprime tous les objets CWnd attachés aux onglets supprimés.

CMFCBaseTabCtrl::RemoveTab

Supprime un onglet du contrôle Tab.

virtual BOOL RemoveTab(
    int iTab,
    BOOL bRecalcLayout = TRUE);

Paramètres

iTab
[in] Index de base zéro d’un onglet.

bRecalcLayout
[in] Paramètre booléen qui spécifie s’il faut recalculer la disposition de l’onglet.

Valeur de retour

TRUE si la méthode supprime l’onglet avec succès ; sinon FALSE.

Notes

Si CMFCBaseTabCtrl::m_bAutoDestroyWindow a la valeur TRUE, RemoveTab détruit l’objet CWnd associé à l’onglet spécifié.

CMFCBaseTabCtrl::RenameTab

virtual BOOL RenameTab();

Valeur de retour

Notes

CMFCBaseTabCtrl::ResetImageList

Réinitialise la liste d’images d’une instance de la classe CMFCBaseTabCtrl.

void ResetImageList();

CMFCBaseTabCtrl::Serialize

virtual void Serialize(CArchive& ar);

Paramètres

[in] ar

Notes

CMFCBaseTabCtrl::SetActiveTab

Active l’onglet spécifié.

virtual BOOL SetActiveTab(int iTab) = 0;

Paramètres

iTab
[in] Index de base zéro d’un onglet. SetActiveTab rend l’onglet actif avec cet index.

Valeur de retour

TRUE en cas de réussite, sinon FALSE.

Notes

Dans la CMFCBaseTabCtrl Class, cette méthode est une fonction virtuelle pure. Si vous dérivez une classe de CMFCBaseTabCtrl, vous devez implémenter cette fonction.

CMFCBaseTabCtrl::SetActiveTabColor

Définit la couleur d’arrière-plan de l’onglet actif.

virtual void SetActiveTabColor(COLORREF clr);

Paramètres

clr
[in] Spécifie la nouvelle couleur d’arrière-plan.

Notes

L’infrastructure obtient la couleur d’arrière-plan par défaut pour les onglets actifs à partir de la méthode GetSysColor.

CMFCBaseTabCtrl::SetActiveTabTextColor

Définit la couleur du texte des onglets actifs.

virtual void SetActiveTabTextColor(COLORREF clr);

Paramètres

clr
[in] Paramètre COLORREF qui spécifie la nouvelle couleur de texte.

Notes

Par défaut, l’infrastructure obtient la couleur de texte de GetSysColor. Remplacez cette couleur par défaut à l’aide de la méthode SetActiveTabTextColor.

CMFCBaseTabCtrl::SetAutoColors

Définit les couleurs du contrôle tabulation utilisé par l’infrastructure en mode de couleur automatique.

void SetAutoColors(const CArray<COLORREF,COLORREF>& arColors);

Paramètres

arColors
[in] Tableau de couleurs RVB.

Notes

Si vous fournissez un tableau personnalisé de couleurs, le tableau par défaut de couleurs est ignoré. Si le paramètre arColors est vide, l’infrastructure revient au tableau de couleurs par défaut.

Pour activer le mode de coloration automatique, utilisez la méthode CMFCBaseTabCtrl::EnableAutoColor.

CMFCBaseTabCtrl::SetDockingBarWrapperRTC

Définit la classe wrapper utilisée pour les objets qui ne sont pas dérivés de CDockablePane Class.

void SetDockingBarWrapperRTC(CRuntimeClass* pRTC);

Paramètres

pRTC
[in] Informations de classe runtime pour la nouvelle classe wrapper.

Notes

Vous ajoutez des onglets à un contrôle tabulation à l’aide des méthodes CMFCBaseTabCtrl::AddTab et CMFCBaseTabCtrl::InsertTab. Lorsque vous ajoutez un onglet, chaque contrôle de cet onglet doit être ancré. Tous les objets qui ne sont pas dérivés de CDockablePane doivent être encapsulés. AddTab et InsertTab créez un wrapper pour ces objets. La classe wrapper par défaut est la classe CDockablePaneAdapter. La méthode SetDockingBarWrapperRTC vous permet de modifier la classe utilisée comme classe wrapper. La classe wrapper que vous fournissez doit être dérivée de CDockablePaneAdapter.

CMFCBaseTabCtrl::SetDrawNoPrefix

Active et désactive le traitement des caractères de préfixe dans les étiquettes d’onglet.

void SetDrawNoPrefix(
    BOOL bNoPrefix,
    BOOL bRedraw = TRUE);

Paramètres

bNoPrefix
[in] TRUE si vous souhaitez traiter les caractères de préfixe ; sinon FALSE.

bRedraw
[in] TRUE si vous souhaitez redessiner la fenêtre à onglets ; sinon FALSE.

Notes

Un caractère de préfixe est un caractère mnémonique précédé d’un ampersand (&).

CMFCBaseTabCtrl::SetImageList

Définit la liste d’images d’icône pour le contrôle Tab.

virtual BOOL SetImageList(
    UINT uiID,
    int cx = 15,
    COLORREF clrTransp = RGB(255, 0, 255));

virtual BOOL SetImageList(HIMAGELIST hImageList);

Paramètres

uiID
[in] ID de ressource bitmap. SetImageList charge la liste d’images à partir de cette ressource.

cx
[in] Largeur de chaque image en pixels.

clrTransp
[in] Paramètre COLORREF qui indique la couleur transparente de l’image.

hImageList
[in] Handle vers une liste d’images préchargée.

Valeur de retour

Différent de zéro si la méthode a réussi ; Sinon, 0.

Notes

Les images de la liste d’images d’icône sont affichées en même temps que les étiquettes de l’onglet. Pour afficher une icône, vous devez spécifier son index lorsque vous appelez CMFCBaseTabCtrl::AddTab.

SetImageList échouera si le contrôle tabulation a été créé avec un style plat. Elle échoue également si l’infrastructure ne peut pas charger l’image indiquée par uiID.

Cette méthode recalcule la hauteur de l’onglet en fonction des tailles d’image et de texte.

CMFCBaseTabCtrl::SetLocation

virtual void SetLocation(Location location);

Paramètres

[in] Emplacement

Notes

CMFCBaseTabCtrl::SetTabBkColor

Définit la couleur d’arrière-plan de l’onglet spécifié.

virtual BOOL SetTabBkColor(
    int iTab,
    COLORREF color = (COLORREF)-1);

Paramètres

iTab
[in] Index de base zéro de l’onglet.

color
[in] Couleur à définir.

Valeur de retour

TRUE si cela réussit ; FALSE dans le cas contraire.

CMFCBaseTabCtrl::SetTabBorderSize

Définit une nouvelle taille de bordure pour le contrôle Tab.

virtual void SetTabBorderSize(
    int nTabBorderSize,
    BOOL bRepaint = TRUE);

Paramètres

nTabBorderSize
[in] Nouvelle taille de bordure, en pixels.

bRepaint
[in] Paramètre booléen qui indique si l’infrastructure redessine le contrôle.

CMFCBaseTabCtrl::SetTabHicon

Définit l’icône d’une étiquette d’onglet.

virtual BOOL SetTabHicon(
    int iTab,
    HICON hIcon);

Paramètres

iTab
[in] Index de base zéro d’un onglet. Cette méthode modifie l’icône de cet onglet.

hIcon
[in] Handle vers une icône.

Valeur de retour

TRUE en cas de réussite, sinon FALSE.

CMFCBaseTabCtrl::SetTabIcon

Définit l’icône d’un onglet.

virtual BOOL SetTabIcon(
    int iTab,
    UINT uiIcon);

Paramètres

iTab
[in] Index de base zéro de l’onglet à mettre à jour.

uiIcon
[in] ID d’icône de la nouvelle icône. Cet ID fait référence à l’objet interne CImageList.

Valeur de retour

TRUE en cas de réussite, sinon FALSE.

CMFCBaseTabCtrl::SetTabIconOnly

Active l’affichage d’une icône (et pas d’étiquette de texte) sous un onglet spécifique.

virtual BOOL SetTabIconOnly(
    int iTab,
    BOOL bIconOnly = TRUE,
    BOOL bShowTooltipAlways = FALSE);

Paramètres

iTab
[in] Index de base zéro de l’onglet à modifier.

bIconOnly
[in] Paramètre booléen qui détermine s’il faut afficher uniquement les icônes.

bShowTooltipAlways
[in] Paramètre booléen qui détermine si l’infrastructure affiche des info-bulles pour une étiquette d’onglet qui affiche uniquement les icônes.

Valeur de retour

TRUE en cas de réussite, sinon FALSE.

Notes

Par défaut, un contrôle Tab affiche l’icône et l’étiquette de texte pour chaque onglet.

CMFCBaseTabCtrl::SetTabLabel

Définit le texte d’une étiquette d’onglet.

virtual BOOL SetTabLabel(
    int iTab,
    const CString& strLabel);

Paramètres

iTab
[in] Index de base zéro de l’onglet à mettre à jour.

strLabel
[in] Référence à une chaîne qui contient le nouveau texte de l’étiquette d’onglet.

Valeur de retour

Différent de zéro si cela ; Sinon, 0.

CMFCBaseTabCtrl::SetTabsHeight

virtual void SetTabsHeight();

Notes

CMFCBaseTabCtrl::SetTabsOrder

Organise les onglets dans l’ordre spécifié.

BOOL SetTabsOrder(const CArray<int,int>& arOrder);

Paramètres

arOrder
[in] Tableau d’index de base zéro qui définit le nouvel ordre de tabulation.

Valeur de retour

TRUE si cela réussit ; FAIL sinon.

Notes

La taille du tableau arOrder doit être égale au nombre d’onglets dans le contrôle tabulation.

CMFCBaseTabCtrl::SetTabTextColor

Définit la couleur de texte d’un onglet spécifique.

virtual BOOL SetTabTextColor(
    int iTab,
    COLORREF color = (COLORREF)-1);

Paramètres

iTab
[in] Index de base zéro de l’onglet.

color
[in] Paramètre COLORREF qui indique la nouvelle couleur de texte.

Valeur de retour

Différent de zéro si cela ; Sinon, 0.

CMFCBaseTabCtrl::ShowTab

Affiche ou masque l'onglet spécifié.

virtual BOOL ShowTab(
    int iTab,
    BOOL bShow = TRUE,
    BOOL bRecalcLayout = TRUE,
    BOOL bActivate = FALSE);

Paramètres

iTab
[in] Index de l’onglet qui ShowTab affiche ou masque.

bShow
[in] Paramètre booléen qui indique s’il faut afficher l’onglet.

bRecalcLayout
[in] Paramètre booléen qui indique s’il faut recalculer immédiatement la disposition de la fenêtre.

bActivate
[in] Paramètre booléen qui indique s’il faut sélectionner l’onglet spécifié par iTab.

Valeur de retour

Valeur différente de zéro cas de réussite ; sinon, 0.

Notes

Le paramètre bActivate s’applique uniquement si bShow a la valeur TRUE. Si bActivate a la valeur TRUE et si ShowTab est réussit, ShowTab envoie le message AFX_WM_CHANGE_ACTIVE_TAB au parent de la fenêtre d’onglet.

CMFCBaseTabCtrl::StartRenameTab

virtual BOOL StartRenameTab(int iTab);

Paramètres

[in] iTab

Valeur de retour

Notes

CMFCBaseTabCtrl::SwapTabs

virtual void SwapTabs(
    int nFisrtTabID,
    int nSecondTabID);

Paramètres

[in] nFisrtTabID

[in] nSecondTabID

Notes

Voir aussi

Graphique hiérarchique
Classes
CMFCTabCtrl, classe
CMFCOutlookBarTabCtrl, classe

Partager via

CMFCBaseTabCtrl, classe

Syntaxe

Membres

Méthodes publiques

Méthodes protégées

Données membres

Notes

Conseils de personnalisation

Hiérarchie d'héritage

Spécifications

CMFCBaseTabCtrl::AddIcon

Paramètres

Notes

CMFCBaseTabCtrl::AddTab

Paramètres

Notes

CMFCBaseTabCtrl::ApplyRestoredTabInfo

Paramètres

Notes

CMFCBaseTabCtrl::AutoDestroyWindow

Paramètres

Notes

CMFCBaseTabCtrl::CalcRectEdit

Paramètres

Notes

CMFCBaseTabCtrl::CleanUp

Notes

CMFCBaseTabCtrl::ClearImageList

Notes

CMFCBaseTabCtrl::CreateWrapper

Paramètres

Valeur de retour

Notes

CMFCBaseTabCtrl::DetachTab

Paramètres

Valeur de retour

Notes

CMFCBaseTabCtrl::EnableActivateLastActive

Paramètres

Notes

CMFCBaseTabCtrl::EnableAutoColor

Paramètres

Notes

CMFCBaseTabCtrl::EnableCustomToolTips

Paramètres

Valeur de retour

Notes

CMFCBaseTabCtrl::EnableInPlaceEdit

Paramètres

Notes

CMFCBaseTabCtrl::EnableTabDetach

Paramètres

Valeur de retour

CMFCBaseTabCtrl::EnableTabSwap

Paramètres

Notes

CMFCBaseTabCtrl::EnsureVisible

Paramètres

Valeur de retour

Notes

CMFCBaseTabCtrl::EnterDragMode

Notes

CMFCBaseTabCtrl::FindTargetWnd

Paramètres

Valeur de retour

Notes

CMFCBaseTabCtrl::FireChangeActiveTab

Paramètres

Notes

CMFCBaseTabCtrl::FireChangingActiveTab

Paramètres

Valeur de retour

Notes

CMFCBaseTabCtrl::GetActiveTab

Valeur de retour

CMFCBaseTabCtrl::GetActiveTabColor

Valeur de retour

Notes

CMFCBaseTabCtrl::GetActiveTabTextColor