La classe CToolBarCtrl

Fournit les fonctionnalités du contrôle commun de barre d'outils Windows.

Syntaxe

class CToolBarCtrl : public CWnd

Membres

Constructeurs publics

Méthodes publiques

Notes

Ce contrôle (et par conséquent la CToolBarCtrl classe) est disponible uniquement pour les programmes exécutés sous Windows 95/98 et Windows NT version 3.51 et ultérieure.

Un contrôle commun de la barre d’outils Windows est une fenêtre enfant rectangulaire qui contient un ou plusieurs boutons. Ces boutons peuvent afficher une image bitmap, une chaîne ou les deux. Lorsque l’utilisateur choisit un bouton, il envoie un message de commande à la fenêtre propriétaire de la barre d’outils. En règle générale, les boutons d’une barre d’outils correspondent aux éléments du menu de l’application ; ils fournissent un moyen plus direct pour l’utilisateur d’accéder aux commandes d’une application.

CToolBarCtrl les objets contiennent plusieurs structures de données internes importantes : une liste de bitmaps d’image de bouton ou une liste d’images, une liste de chaînes d’étiquettes de bouton et une liste de TBBUTTON structures qui associent une image et/ou une chaîne à la position, au style, à l’état et à l’ID de commande du bouton. Chacun des éléments de ces structures de données est référencé par un index de base zéro. Avant de pouvoir utiliser un CToolBarCtrl objet, vous devez configurer ces structures de données. La liste des chaînes ne peut être utilisée que pour les étiquettes de bouton ; vous ne pouvez pas récupérer de chaînes à partir de la barre d’outils.

Pour utiliser un CToolBarCtrl objet, vous devez généralement suivre les étapes suivantes :

1. Construisez l’objet CToolBarCtrl .

2. Appelez Create pour créer le contrôle commun de la barre d’outils Windows et l’attacher à l’objet CToolBarCtrl . Indiquez le style de barre d’outils à l’aide de styles, tels que TBSTYLE_TRANSPARENT pour une barre d’outils transparente ou TBSTYLE_DROPDOWN pour une barre d’outils qui prend en charge les boutons de style déroulant.

3. Identifiez la façon dont vous souhaitez que les boutons de la barre d’outils s’affichent :

   • Pour utiliser des images bitmap pour les boutons, ajoutez les bitmaps de bouton à la barre d’outils en appelant AddBitmap.

   • Pour utiliser des images affichées à partir d’une liste d’images pour les boutons, spécifiez la liste d’images en appelant SetImageList, SetHotImageListou SetDisabledImageList.

   • Pour utiliser des étiquettes de chaîne pour les boutons, ajoutez les chaînes à la barre d’outils en appelant AddString et/ou AddStrings.

4. Ajoutez des structures de bouton à la barre d’outils en appelant AddButtons.

5. Si vous souhaitez obtenir des conseils d’outil pour un bouton de barre d’outils dans une fenêtre propriétaire qui n’est pas un CFrameWnd, vous devez gérer les TTN_NEEDTEXT messages dans la fenêtre propriétaire de la barre d’outils, comme décrit dans Gestion des notifications d’info-bulles. Si la fenêtre parente de la barre d’outils est dérivée CFrameWndde , les info-bulles s’affichent sans aucun effort supplémentaire car CFrameWnd fournit un gestionnaire par défaut.

6. Si vous souhaitez que votre utilisateur puisse personnaliser la barre d’outils, gérez les messages de notification de personnalisation dans la fenêtre propriétaire, comme décrit dans Gestion des notifications de personnalisation.

Vous pouvez utiliser SaveState pour enregistrer l’état actuel d’un contrôle de barre d’outils dans le Registre et RestoreState restaurer l’état en fonction des informations précédemment stockées dans le Registre. Outre l’enregistrement de l’état de la barre d’outils entre les utilisations de l’application, les applications stockent généralement l’état avant que l’utilisateur commence à personnaliser la barre d’outils si l’utilisateur souhaite ultérieurement restaurer la barre d’outils à son état d’origine.

Prise en charge d’Internet Explorer version 4.0 et ultérieure

Pour prendre en charge les fonctionnalités introduites dans Internet Explorer, version 4.0 et ultérieures, MFC fournit la prise en charge de la liste d’images et des styles transparents et plats pour les contrôles de barre d’outils.

Une barre d’outils transparente permet au client sous la barre d’outils de s’afficher. Pour créer une barre d’outils transparente, utilisez les deux TBSTYLE_FLAT styles.TBSTYLE_TRANSPARENT Fonctionnalités transparentes de suivi à chaud des barres d’outils ; autrement dit, lorsque le pointeur de la souris se déplace sur un bouton chaud dans la barre d’outils, l’apparence du bouton change. Les barres d’outils créées avec uniquement le TBSTYLE_FLAT style contiennent des boutons qui ne sont pas transparents.

La prise en charge de la liste d’images permet un contrôle plus souple pour le comportement par défaut, les images chaudes et les images désactivées. Utilisez GetImageList, GetHotImageListet GetDisabledImageList avec la barre d’outils transparente pour manipuler l’image en fonction de son état :

Pour plus d’informations sur l’utilisation CToolBarCtrl, consultez Contrôles et utilisation CToolBarCtrl.

Hiérarchie d'héritage

CObject

CCmdTarget

CWnd

CToolBarCtrl

Spécifications

En-tête : afxcmn.h

CToolBarCtrl::AddBitmap

Ajoute une ou plusieurs images de bouton à la liste des images de bouton stockées dans le contrôle de barre d’outils.

int AddBitmap(
    int nNumButtons,
    UINT nBitmapID);

int AddBitmap(
    int nNumButtons,
    CBitmap* pBitmap);

Paramètres

nNumButtons
Nombre d’images de bouton dans la bitmap.

nBitmapID
Identificateur de ressource de la bitmap qui contient l’image de bouton ou les images à ajouter.

pBitmap
Pointeur vers l’objet CBitmap qui contient l’image de bouton ou les images à ajouter.

Valeur de retour

Index de base zéro de la première nouvelle image en cas de réussite ; sinon - 1.

Notes

Vous pouvez utiliser l’API CreateMappedBitmap Windows pour mapper les couleurs avant d’ajouter la bitmap à la barre d’outils. Si vous passez un pointeur vers un CBitMap objet, vous devez vous assurer que la bitmap n’est pas détruite tant que la barre d’outils n’est pas détruite.

CToolBarCtrl::AddButtons

Ajoute un ou plusieurs boutons à un contrôle de barre d’outils.

BOOL AddButtons(
    int nNumButtons,
    LPTBBUTTON lpButtons);

Paramètres

nNumButtons
Nombre de boutons à ajouter.

lpButtons
Adresse d’un tableau de TBBUTTON structures qui contient des informations sur les boutons à ajouter. Il doit y avoir le même nombre d’éléments dans le tableau que les boutons spécifiés par nNumButtons.

Valeur de retour

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

Notes

Le lpButtons pointeur pointe vers un tableau de TBBUTTON structures. Chaque TBBUTTON structure associe le bouton ajouté au style, à l’image et/ou à la chaîne du bouton, à l’ID de commande, à l’état et aux données définies par l’utilisateur :

typedef struct _TBBUTTON {
    int iBitmap;    // zero-based index of button image
    int idCommand;  // command to be sent when button pressed
    BYTE fsState;   // button state--see below
    BYTE fsStyle;   // button style--see below
    DWORD dwData;   // application-defined value
    int iString;    // zero-based index of button label string
} TBBUTTON;

Les membres sont les suivants :

• iBitmap

  Index de base zéro de l’image de bouton, -1 si aucune image pour ce bouton.

• idCommand

  Identificateur de commande associé au bouton. Cet identificateur est envoyé dans un WM_COMMAND message lorsque le bouton est choisi. Si le fsStyle membre a la TBSTYLE_SEP valeur, ce membre doit être égal à zéro.

• fsState

  Indicateurs d’état du bouton. Il peut s’agir d’une combinaison des valeurs répertoriées ci-dessous :

  • TBSTATE_CHECKED Le bouton a le TBSTYLE_CHECKED style et est enfoncé.

  • TBSTATE_ENABLED Le bouton accepte l’entrée utilisateur. Un bouton qui n’a pas cet état n’accepte pas l’entrée utilisateur et est grisé.

  • TBSTATE_HIDDEN Le bouton n’est pas visible et ne peut pas recevoir d’entrée utilisateur.

  • TBSTATE_INDETERMINATE Le bouton est grisé.

  • TBSTATE_PRESSED Le bouton est enfoncé.

  • TBSTATE_WRAP Un saut de ligne suit le bouton. Le bouton doit également avoir l’état TBSTATE_ENABLED .

• fsStyle

  Style de bouton. Il peut s’agir d’une combinaison des valeurs répertoriées ci-dessous :

  • TBSTYLE_BUTTON Crée un bouton Push standard.

  • TBSTYLE_CHECK Crée un bouton qui bascule entre les états appuyés et non enfoncés chaque fois que l’utilisateur clique dessus. Le bouton a une couleur d’arrière-plan différente lorsqu’il est dans l’état enfoncé.

  • TBSTYLE_CHECKGROUP Crée un bouton de vérification qui reste enfoncé jusqu’à ce qu’un autre bouton du groupe soit appuyé.

  • TBSTYLE_GROUP Crée un bouton qui reste enfoncé jusqu’à ce qu’un autre bouton du groupe soit appuyé.

  • TBSTYLE_SEP Crée un séparateur, fournissant un petit écart entre les groupes de boutons. Un bouton doté de ce style ne reçoit pas d’entrée utilisateur.

• dwData

  Données définies par l’utilisateur.

• iString

  Index de base zéro de la chaîne à utiliser comme étiquette du bouton, -1 s’il n’y a pas de chaîne pour ce bouton.

Image et/ou chaîne dont vous fournissez l’index doit avoir été précédemment ajouté à la liste du contrôle de barre d’outils à l’aide AddBitmapde , AddStringet/ou AddStrings.

CToolBarCtrl::AddString

Ajoute une nouvelle chaîne, passée en tant qu’ID de ressource, à la liste interne de chaînes de la barre d’outils.

int AddString(UINT nStringID);

Paramètres

nStringID
Identificateur de ressource de la ressource de chaîne à ajouter à la liste de chaînes du contrôle de barre d’outils.

Valeur de retour

Index de base zéro de la première nouvelle chaîne ajoutée en cas de réussite ; sinon -1.

CToolBarCtrl::AddStrings

Ajoute une nouvelle chaîne ou chaîne à la liste des chaînes disponibles pour un contrôle de barre d’outils.

int AddStrings(LPCTSTR lpszStrings);

Paramètres

lpszStrings
Adresse d’une mémoire tampon qui contient une ou plusieurs NULLchaînes -terminated à ajouter à la liste de chaînes de la barre d’outils. La dernière chaîne doit être arrêtée avec deux NULL caractères.

Valeur de retour

Index de base zéro de la première nouvelle chaîne ajoutée en cas de réussite ; sinon -1.

Notes

Les chaînes de la mémoire tampon doivent être séparées par un NULL caractère. Vous devez vous assurer que la dernière chaîne a deux NULL terminateurs. Pour mettre correctement en forme une chaîne constante, vous pouvez l’écrire comme suit :

// one null added automatically
lpszStrings = _T("Only one string to add\0");

ou :

// adds three strings with one call
lpszStrings = _T("String 1\0String 2\0String 3\0");

Vous ne devez pas passer un CString objet à cette fonction, car il n’est pas possible d’avoir plusieurs NULL caractères dans un CString.

CToolBarCtrl::AutoSize

Redimensionne l’intégralité du contrôle de barre d’outils.

void AutoSize();

Notes

Vous devez appeler cette fonction lorsque la taille de la fenêtre parente change ou lorsque la taille de la barre d’outils change (par exemple, lorsque vous définissez la taille du bouton ou de la bitmap, ou ajoutez des chaînes).

CToolBarCtrl::ChangeBitmap

Modifie la bitmap d’un bouton dans le contrôle de barre d’outils actuel.

BOOL ChangeBitmap(
    int idButton,
    int iBitmap);

Paramètres

idButton
[in] Identificateur de commande du bouton qui doit recevoir une nouvelle bitmap.

iBitmap
[in] Index de base zéro d’une image dans la liste d’images du contrôle de barre d’outils actuel.

Valeur de retour

TRUE si cette méthode réussit ; sinon, FALSE.

Notes

Si cette méthode réussit, le système affiche l’image spécifiée dans le bouton spécifié.

Cette méthode envoie le TB_CHANGEBITMAP message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

Exemple

L’exemple de code suivant modifie la bitmap du bouton Enregistrer du fichier en bitmap pour le bouton À propos.

{
   // Change the bitmap for the File Save button, whose
   // command ID is ID_FILE_SAVE, to the bitmap for the
   // About button, whose index is 7.
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   BOOL bRet = m_toolBarCtrl.ChangeBitmap(ID_FILE_SAVE, 7);
}

CToolBarCtrl::CheckButton

Vérifie ou efface un bouton donné dans un contrôle de barre d’outils.

BOOL CheckButton(
    int nID,
    BOOL bCheck = TRUE);

Paramètres

nID
Identificateur de commande du bouton à vérifier ou effacer.

bCheck
TRUE pour vérifier le bouton, FALSE pour l’effacer.

Valeur de retour

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

Notes

Lorsqu’un bouton a été activé, il semble avoir été enfoncé. Si vous souhaitez modifier plusieurs états de bouton, envisagez d’appeler SetState à la place.

CToolBarCtrl::CommandToIndex

Récupère l’index de base zéro pour le bouton associé à l’identificateur de commande spécifié.

UINT CommandToIndex(UINT nID) const;

Paramètres

nID
ID de commande dont vous souhaitez rechercher l’index de bouton.

Valeur de retour

Index de base zéro pour le bouton associé à l’ID de commande.

Notes

CToolBarCtrl::Create

Crée un contrôle de barre d’outils et l’attache à un CToolBarCtrl objet.

virtual BOOL Create(
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

Paramètres

dwStyle
Spécifie le style du contrôle de barre d’outils. Les barres d’outils doivent toujours avoir le WS_CHILD style. En outre, vous pouvez spécifier n’importe quelle combinaison de styles de barre d’outils et de styles de fenêtre, comme décrit sous Remarques.

rect
Spécifie éventuellement la taille et la position du contrôle de barre d’outils. Il peut s’agir d’un objet ou d’une CRect RECT structure.

pParentWnd
Spécifie la fenêtre parente du contrôle de barre d’outils. Il ne doit pas être NULL.

nID
Spécifie l’ID du contrôle de barre d’outils.

Valeur de retour

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

Notes

Vous construisez une CToolBarCtrl étape en deux étapes. Tout d’abord, appelez le constructeur, puis appelez Create, qui crée le contrôle de barre d’outils et l’attache à l’objet CToolBarCtrl . Appliquez les styles de fenêtre suivants à un contrôle de barre d’outils.

• WS_CHILD Toujours

• WS_VISIBLE Habituellement

• WS_DISABLED Rarement

Consultez CreateWindow le Kit de développement logiciel (SDK) Windows pour obtenir une description des styles de fenêtre.

Si vous le souhaitez, appliquez une combinaison de styles de contrôle courants, comme décrit dans le Kit de développement logiciel (SDK) Windows.

Appliquez une combinaison de styles de barre d’outils au contrôle ou aux boutons eux-mêmes. Les styles sont décrits dans la rubrique Contrôles de barre d’outils et Styles de bouton dans le Kit de développement logiciel (SDK) Windows.

Pour utiliser des styles de barre d’outils étendus, appelez SetExtendedStyle après l’appel Create. Pour créer une barre d’outils avec des styles de fenêtre étendus, appelez CToolBarCtrl::CreateEx plutôt que Create.

Le contrôle de barre d’outils définit automatiquement la taille et la position de la fenêtre de barre d’outils. La hauteur est basée sur la hauteur des boutons de la barre d’outils. La largeur est identique à la largeur de la zone cliente de la fenêtre parente. Les CCS_TOP styles et CCS_BOTTOM déterminent si la barre d’outils est positionnée le long du haut ou du bas de la zone cliente. Par défaut, une barre d’outils a le CCS_TOP style.

CToolBarCtrl::CreateEx

Crée un contrôle (fenêtre enfant) et l’associe à l’objet CToolBarCtrl .

virtual BOOL CreateEx(
    DWORD dwExStyle,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

Paramètres

dwExStyle
Spécifie le style étendu du contrôle en cours de création. Pour obtenir la liste des styles Windows étendus, consultez le dwExStyle paramètre correspondant CreateWindowEx dans le Kit de développement logiciel (SDK) Windows.

dwStyle
Spécifie le style du contrôle de barre d’outils. Les barres d’outils doivent toujours avoir le WS_CHILD style. En outre, vous pouvez spécifier n’importe quelle combinaison de styles de barre d’outils et de styles de fenêtre, comme décrit dans la section Remarques de Create.

rect
Référence à une RECT structure décrivant la taille et la position de la fenêtre à créer, dans les coordonnées clientes de pParentWnd.

pParentWnd
Pointeur vers la fenêtre qui est le parent du contrôle.

nID
ID de la fenêtre enfant du contrôle.

Valeur de retour

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

Notes

Utilisez CreateEx plutôt que d’appliquer Create des styles Windows étendus, spécifiés par le préface WS_EX_de style étendu Windows. CreateEx crée le contrôle avec les styles Windows étendus spécifiés par dwExStyle. Définissez des styles étendus spécifiques à un contrôle à l’aide SetExtendedStylede . Par exemple, utilisez CreateEx pour définir des styles tels que WS_EX_CONTEXTHELP, mais utilisez SetExtendedStyle pour définir des styles tels que TBSTYLE_EX_DRAWDDARROWS. Pour plus d’informations, consultez les styles décrits dans les styles étendus de la barre d’outils dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::CToolBarCtrl

Construit un objet CToolBarCtrl.

CToolBarCtrl();

Notes

Vous devez appeler Create pour rendre la barre d’outils utilisable.

CToolBarCtrl::Customize

Affiche la boîte de dialogue Personnaliser la barre d’outils.

void Customize();

Notes

Cette boîte de dialogue permet à l’utilisateur de personnaliser la barre d’outils en ajoutant et en supprimant des boutons. Pour prendre en charge la personnalisation, la fenêtre parente de votre barre d’outils doit gérer les messages de notification de personnalisation, comme décrit dans Gestion des notifications de personnalisation. Votre barre d’outils doit également avoir été créée avec le CCS_ADJUSTABLE style, comme décrit dans CToolBarCtrl::Create.

CToolBarCtrl::DeleteButton

Supprime un bouton du contrôle de barre d’outils.

BOOL DeleteButton(int nIndex);

Paramètres

nIndex
Index de base zéro du bouton à supprimer.

Valeur de retour

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

Notes

CToolBarCtrl::EnableButton

Active ou désactive le bouton spécifié dans un contrôle de barre d’outils.

BOOL EnableButton(
    int nID,
    BOOL bEnable = TRUE);

Paramètres

nID
Identificateur de la commande du bouton à activer ou désactiver.

bEnable
TRUE pour activer le bouton ; FALSE pour désactiver le bouton.

Valeur de retour

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

Notes

Quand un bouton a été activé, il peut être enfoncé et coché. Si vous souhaitez modifier plusieurs états de bouton, envisagez d’appeler SetState à la place.

CToolBarCtrl::GetAnchorHighlight

Récupère le paramètre de mise en surbrillance de l’ancre pour une barre d’outils.

BOOL GetAnchorHighlight() const;

Valeur de retour

Si ce n’est pas différent de zéro, la mise en surbrillance de l’ancrage est activée. Si zéro, la mise en surbrillance de l’ancrage est désactivée.

Notes

Cette fonction membre implémente le comportement du message TB_GETANCHORHIGHLIGHT Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetBitmap

Récupère l’index de la bitmap associée à un bouton dans une barre d’outils.

int GetBitmap(int nID) const;

Paramètres

nID
Identificateur de commande du bouton dont l’index bitmap doit être récupéré.

Valeur de retour

Retourne l’index de l’image bitmap en cas de réussite ou de zéro dans le cas contraire.

Notes

Implémente les fonctionnalités du TB_GETBITMAP Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::GetBitmapFlags

Récupère les indicateurs bitmap de la barre d’outils.

UINT GetBitmapFlags() const;

Valeur de retour

Qui UINT a l’indicateur TBBF_LARGE défini si l’affichage peut prendre en charge les bitmaps de barre d’outils volumineuses, effacez sinon.

Notes

Vous devez l’appeler après avoir créé la barre d’outils, mais avant d’ajouter des bitmaps à la barre d’outils. La valeur de retour indique si l’affichage prend en charge les bitmaps volumineuses ou non. Si l’affichage prend en charge les images bitmap volumineuses et si vous choisissez de les utiliser, appelez SetBitmapSize et SetButtonSize avant d’ajouter votre grande bitmap à l’aide AddBitmapde .

CToolBarCtrl::GetButton

Récupère des informations sur le bouton spécifié dans un contrôle de barre d’outils.

BOOL GetButton(
    int nIndex,
    LPTBBUTTON lpButton) const;

Paramètres

nIndex
Index de base zéro du bouton pour lequel récupérer des informations.

lpButton
Adresse de la TBBUTTON structure qui doit recevoir une copie des informations du bouton. Consultez CToolBarCtrl::AddButtons pour plus d’informations sur la TBBUTTON structure.

Valeur de retour

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

CToolBarCtrl::GetButtonCount

Récupère le nombre de boutons actuellement dans le contrôle de barre d’outils.

int GetButtonCount() const;

Valeur de retour

Nombre de boutons.

CToolBarCtrl::GetButtonInfo

Récupère les informations d’un bouton dans une barre d’outils.

int GetButtonInfo(
    int nID,
    TBBUTTONINFO* ptbbi) const;

Paramètres

nID
Identificateur du bouton.

ptbbi
Pointeur vers une TBBUTTONINFO structure qui reçoit les informations du bouton.

Valeur de retour

Index de base zéro du bouton, s’il réussit ; sinon -1.

Notes

Cette fonction membre implémente le comportement du message TB_GETBUTTONINFO Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetButtonSize

Obtient la taille d’un bouton de barre d’outils.

DWORD GetButtonSize() const;

Valeur de retour

Valeur DWORD qui contient les valeurs de largeur et de hauteur dans les valeurs HIWORDet LOWORD , respectivement.

CToolBarCtrl::GetButtonText

Récupère le texte d’affichage d’un bouton spécifié dans le contrôle de barre d’outils actuel.

CString GetButtonText(int idButton) const;

Paramètres

idButton
[in] Identificateur du bouton dont le texte d’affichage est récupéré.

Valeur de retour

Qui CString contient le texte d’affichage du bouton spécifié.

Notes

Cette méthode envoie le TB_GETBUTTONTEXT message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::GetColorScheme

Récupère le jeu de couleurs du contrôle de barre d’outils actuel.

BOOL GetColorScheme(COLORSCHEME* lpColorScheme) const;

Paramètres

lpColorScheme
[out] Pointeur vers une COLORSCHEME structure qui reçoit les informations du jeu de couleurs. Lorsque cette méthode est retournée, la structure décrit la couleur de surbrillance et la couleur d’ombre du contrôle de barre d’outils.

Valeur de retour

TRUE si cette méthode réussit ; sinon, FALSE.

Notes

Cette méthode envoie le TB_GETCOLORSCHEME message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::GetDisabledImageList

Récupère la liste d’images utilisée par un contrôle de barre d’outils pour afficher les boutons désactivés.

CImageList* GetDisabledImageList() const;

Valeur de retour

Pointeur vers un CImageList objet ou NULL si aucune liste d’images désactivée n’est définie.

Notes

Cette fonction membre implémente le comportement du message TB_GETDISABLEDIMAGELIST Win32, comme décrit dans le SDK Windows. L’implémentation MFC d’utilise GetDisabledImageList un CImageList objet contenant les images de bouton du contrôle de barre d’outils, plutôt qu’un handle vers une liste d’images.

CToolBarCtrl::GetDropTarget

Récupère l’interface d’un IDropTarget contrôle de barre d’outils.

HRESULT GetDropTarget(IDropTarget** ppDropTarget) const;

Paramètres

ppDropTarget
Pointeur vers un pointeur d’interface IDropTarget . Si une erreur se produit, un NULL pointeur est placé dans cette adresse.

Valeur de retour

Retourne une HRESULT valeur indiquant la réussite ou l’échec de l’opération.

Notes

Cette fonction membre implémente le comportement du message TB_GETOBJECT Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetExtendedStyle

Récupère les styles étendus d’un contrôle de barre d’outils.

DWORD GetExtendedStyle() const;

Valeur de retour

Qui DWORD représente les styles étendus actuellement utilisés pour le contrôle de barre d’outils. Pour obtenir la liste des styles, consultez Styles étendus de la barre d’outils, dans le Kit de développement logiciel (SDK) Windows.

Notes

Cette fonction membre implémente le comportement du message TB_GETEXTENDEDSTYLE Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetHotImageList

Récupère la liste d’images utilisée par un contrôle de barre d’outils pour afficher des boutons « chauds ». Un bouton chaud s’affiche en surbrillance lorsque le pointeur de la souris est au-dessus de celui-ci.

CImageList* GetHotImageList() const;

Valeur de retour

Pointeur vers un CImageList objet ou NULL si aucune liste d’images désactivée n’est définie.

Notes

Cette fonction membre implémente le comportement du message TB_GETHOTIMAGELIST Win32, comme décrit dans le SDK Windows. Un bouton chaud s’affiche en surbrillance lorsque le pointeur de la souris est au-dessus de celui-ci.

CToolBarCtrl::GetHotItem

Récupère l’index de l’élément actif dans une barre d’outils.

int GetHotItem() const;

Valeur de retour

Index de base zéro de l’élément actif dans une barre d’outils.

Notes

Cette fonction membre implémente le comportement du message TB_GETHOTITEM Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetImageList

Récupère la liste d’images utilisée par un contrôle de barre d’outils pour afficher les boutons dans leur état par défaut.

CImageList* GetImageList() const;

Valeur de retour

Pointeur vers un CImageList objet ou NULL si aucune liste d’images n’est définie.

Notes

Cette fonction membre implémente le comportement du message TB_GETIMAGELIST Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetInsertMark

Récupère la marque d’insertion actuelle de la barre d’outils.

void GetInsertMark(TBINSERTMARK* ptbim) const;

Paramètres

ptbim
Pointeur vers une TBINSERTMARK structure qui reçoit la marque d’insertion.

Notes

Cette fonction membre implémente le comportement du message TB_GETINSERTMARK Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetInsertMarkColor

Récupère la couleur utilisée pour dessiner la marque d’insertion de la barre d’outils.

COLORREF GetInsertMarkColor() const;

Valeur de retour

Valeur COLORREF qui contient la couleur de marque d’insertion actuelle.

Notes

Cette fonction membre implémente le comportement du message TB_GETINSERTMARKCOLOR Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetItemRect

Récupère le rectangle englobant d’un bouton dans un contrôle de barre d’outils.

BOOL GetItemRect(
    int nIndex,
    LPRECT lpRect) const;

Paramètres

nIndex
Index de base zéro du bouton pour lequel récupérer des informations.

lpRect
Adresse d’une RECT structure ou d’un CRect objet qui reçoit les coordonnées du rectangle englobant.

Valeur de retour

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

Notes

Cette fonction ne récupère pas le rectangle englobant pour les boutons dont l’état est défini TBSTATE_HIDDENsur .

CToolBarCtrl::GetMaxSize

Récupère la taille totale de tous les boutons et séparateurs visibles dans la barre d’outils.

BOOL GetMaxSize(LPSIZE pSize) const;

Paramètres

pSize
Pointeur vers une SIZE structure qui reçoit la taille des éléments.

Valeur de retour

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

Notes

Cette fonction membre implémente le comportement du message TB_GETMAXSIZE Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetMaxTextRows

Récupère le nombre maximal de lignes de texte affichées sur un bouton de barre d’outils.

int GetMaxTextRows() const;

Valeur de retour

Nombre maximal de lignes de texte affichées sur un bouton de barre d’outils.

CToolBarCtrl::GetMetrics

Récupère les métriques de l’objet CToolBarCtrl .

void GetMetrics(LPTBMETRICS ptbm) const;

Paramètres

ptbm
Pointeur vers la TBMETRICS structure de l’objet CToolBarCtrl .

Notes

Cette fonction membre émule les fonctionnalités du TB_GETMETRICS message, comme décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::GetPadding

Récupère le remplissage horizontal et vertical du contrôle de barre d’outils actuel.

BOOL GetPadding(
    int* pnHorzPadding,
    int* pnVertPadding) const;

Paramètres

pnHorzPadding
[out] Entier qui reçoit le remplissage horizontal du contrôle de barre d’outils, en pixels.

pnVertPadding
[out] Entier qui reçoit le remplissage vertical du contrôle de barre d’outils, en pixels.

Valeur de retour

TRUE si cette méthode réussit ; sinon, FALSE.

Notes

Cette méthode envoie le TB_GETPADDING message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::GetPressedImageList

Récupère la liste d’images utilisée par le contrôle de barre d’outils actuel pour représenter les boutons dans l’état appuyé.

CImageList* GetPressedImageList();

Valeur de retour

Pointeur vers un CImageList qui contient la liste d’images pour le contrôle actif ou NULL si aucune liste d’images n’est définie.

Notes

Cette méthode envoie le TB_GETPRESSEDIMAGELIST message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::GetRect

Récupère le rectangle englobant d’un bouton de barre d’outils spécifié.

BOOL GetRect(
    int nID,
    LPRECT lpRect) const;

Paramètres

nID
Identificateur du bouton.

lpRect
Pointeur vers une RECT structure pour recevoir les informations de rectangle englobant.

Valeur de retour

TRUE en cas de réussite ; sinon, FALSE.

Notes

Cette fonction membre implémente le comportement du message TB_GETRECT Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetRows

Récupère le nombre de lignes de boutons actuellement affichées par le contrôle de barre d’outils.

int GetRows() const;

Valeur de retour

Nombre de lignes de boutons actuellement affichées dans la barre d’outils.

Notes

Notez que le nombre de lignes sera toujours un, sauf si la barre d’outils a été créée avec le TBSTYLE_WRAPABLE style.

CToolBarCtrl::GetState

Récupère des informations sur l’état du bouton spécifié dans un contrôle de barre d’outils, par exemple s’il est activé, appuyé ou activé.

int GetState(int nID) const;

Paramètres

nID
Identificateur de commande du bouton pour lequel récupérer des informations.

Valeur de retour

Informations d’état du bouton si elle réussit ou -1 sinon. Les informations d’état du bouton peuvent être une combinaison des valeurs répertoriées dans CToolBarCtrl::AddButtons.

Notes

Cette fonction est particulièrement pratique si vous souhaitez récupérer plusieurs états de bouton. Pour récupérer un seul état, utilisez l’une des fonctions membres suivantes : IsButtonEnabled, , IsButtonChecked, IsButtonPressed, IsButtonHiddenou IsButtonIndeterminate. Toutefois, la GetState fonction membre est la seule façon de détecter l’état du TBSTATE_WRAP bouton.

CToolBarCtrl::GetString

Récupère une chaîne de barre d’outils.

int GetString(
    int nString,
    LPTSTR lpstrString,
    int cchMaxLen) const;

int GetString(
    int nString,
    CString& str) const;

Paramètres

nString
Index de la chaîne.

lpstrString
Pointeur vers une mémoire tampon utilisée pour retourner la chaîne.

cchMaxLen
Longueur de la mémoire tampon en octets.

str
Chaîne.

Valeur de retour

Longueur de la chaîne si elle réussit, -1 si ce n’est pas le cas.

Notes

Cette fonction membre implémente le comportement du message TB_GETSTRING Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::GetStyle

Obtient les styles actuellement appliqués à un contrôle de barre d’outils.

DWORD GetStyle() const;

Valeur de retour

Contenant DWORD une combinaison de styles de contrôle de barre d’outils, comme décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::GetToolTips

Récupère le handle du contrôle info-bulle, le cas échéant, associé au contrôle de barre d’outils.

CToolTipCtrl* GetToolTips() const;

Valeur de retour

Pointeur vers l’objet CToolTipCtrl associé à cette barre d’outils ou NULL si la barre d’outils n’a pas de contrôle d’info-bulle associé.

Notes

Étant donné que le contrôle de barre d’outils crée et gère normalement son propre contrôle d’info-bulle, la plupart des programmes n’ont pas besoin d’appeler cette fonction.

CToolBarCtrl::HitTest

Détermine l’emplacement où se trouve un point dans un contrôle de barre d’outils.

int HitTest(LPPOINT ppt) const;

Paramètres

ppt
Pointeur vers une POINT structure qui contient la coordonnée x du test de positionnement dans le x membre et la coordonnée y du test de positionnement dans le y membre. Les coordonnées sont relatives à la zone cliente de la barre d’outils.

Valeur de retour

Valeur entière indiquant l’emplacement d’un point dans une barre d’outils. Si la valeur est égale à zéro ou à une valeur positive, cette valeur de retour est l’index de base zéro de l’élément non-parateur dans lequel se trouve le point.

Si la valeur de retour est négative, le point ne se trouve pas dans un bouton. La valeur absolue de la valeur de retour est l’index d’un élément de séparation ou de l’élément nonparateur le plus proche.

Notes

Cette fonction membre implémente le comportement du message TB_HITTEST Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::HideButton

Masque ou affiche le bouton spécifié dans un contrôle de barre d’outils.

BOOL HideButton(
    int nID,
    BOOL bHide = TRUE);

Paramètres

nID
Identifiant de commande du bouton à masquer ou à afficher.

bHide
TRUE pour masquer le bouton, FALSE pour l’afficher.

Valeur de retour

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

Notes

Si vous souhaitez modifier plusieurs états de bouton, envisagez d’appeler SetState à la place.

CToolBarCtrl::Indeterminate

Définit ou efface l’état indéterminé du bouton spécifié dans un contrôle de barre d’outils.

BOOL Indeterminate(
    int nID,
    BOOL bIndeterminate = TRUE);

Paramètres

nID
Identificateur de commande du bouton dont l’état indéterminé doit être défini ou effacé.

bIndeterminate
TRUE pour définir l’état indéterminé du bouton spécifié, FALSE pour l’effacer.

Valeur de retour

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

Notes

Les boutons indéterminés sont grisés, par exemple la façon dont le bouton gras de la barre d’outils d’un traitement de texte ressemblerait lorsque le texte sélectionné contient des caractères gras et réguliers. Si vous souhaitez modifier plusieurs états de bouton, envisagez d’appeler SetState à la place.

CToolBarCtrl::InsertButton

Insère un bouton dans un contrôle de barre d’outils.

BOOL InsertButton(
    int nIndex,
    LPTBBUTTON lpButton);

Paramètres

nIndex
Index de base zéro d’un bouton. Cette fonction insère le nouveau bouton à gauche de ce bouton.

lpButton
Adresse d’une TBBUTTON structure contenant des informations sur le bouton à insérer. Consultez CToolBarCtrl::AddButtons une description de la TBBUTTON structure.

Valeur de retour

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

Notes

Image et/ou chaîne dont vous fournissez l’index doit avoir été précédemment ajouté à la liste du contrôle de barre d’outils à l’aide AddBitmapde , AddStringet/ou AddStrings.

CToolBarCtrl::InsertMarkHitTest

Récupère les informations de marque d’insertion d’un point dans une barre d’outils.

BOOL InsertMarkHitTest(
    LPPOINT ppt,
    LPTBINSERTMARK ptbim) const;

Paramètres

ppt
Pointeur vers une POINT structure qui contient les coordonnées de test d’accès, par rapport à la zone cliente de la barre d’outils.

ptbim
Pointeur vers une TBINSERTMARK structure qui reçoit les informations de marque d’insertion.

Valeur de retour

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

Notes

Cette fonction membre implémente le comportement du message TB_INSERTMARKHITTEST Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::IsButtonChecked

Détermine si le bouton spécifié dans un contrôle de barre d’outils est activé.

BOOL IsButtonChecked(int nID) const;

Paramètres

nID
Identificateur de commande du bouton dans la barre d’outils.

Valeur de retour

Différent de zéro si le bouton est activé ; sinon zéro.

Notes

Envisagez d’appeler GetState si vous souhaitez récupérer plusieurs états de bouton.

CToolBarCtrl::IsButtonEnabled

Détermine si le bouton spécifié dans un contrôle de barre d’outils est activé.

BOOL IsButtonEnabled(int nID) const;

Paramètres

nID
Identificateur de commande du bouton dans la barre d’outils.

Valeur de retour

Différent de zéro si le bouton est activé ; sinon zéro.

Notes

Envisagez d’appeler GetState si vous souhaitez récupérer plusieurs états de bouton.

CToolBarCtrl::IsButtonHidden

Détermine si le bouton spécifié dans un contrôle de barre d’outils est masqué.

BOOL IsButtonHidden(int nID) const;

Paramètres

nID
Identificateur de commande du bouton dans la barre d’outils.

Valeur de retour

Différent de zéro si le bouton est masqué ; sinon zéro.

Notes

Envisagez d’appeler GetState si vous souhaitez récupérer plusieurs états de bouton.

CToolBarCtrl::IsButtonHighlighted

Vérifie l’état de surbrillance d’un bouton de barre d’outils.

BOOL IsButtonHighlighted(int nID) const;

Paramètres

nID
[in] ID de commande du bouton de barre d’outils.

Valeur de retour

Entier positif si le bouton est mis en surbrillance, 0 si le bouton n’est pas mis en surbrillance, ou -1 si une erreur se produit.

CToolBarCtrl::IsButtonIndeterminate

Détermine si le bouton spécifié dans un contrôle de barre d’outils est indéterminé.

BOOL IsButtonIndeterminate(int nID) const;

Paramètres

nID
[in] Identificateur de commande du bouton dans la barre d’outils.

Valeur de retour

Entier positif si le bouton est indéterminé, zéro si le bouton n’est pas indéterminé ou -1 si une erreur se produit.

Notes

Les boutons indéterminés sont affichés grisés, comme le bouton gras dans la barre d’outils d’un traitement de texte lorsque le texte sélectionné contient des caractères gras et réguliers. Envisagez d’appeler GetState si vous souhaitez récupérer plusieurs états de bouton.

CToolBarCtrl::IsButtonPressed

Détermine si le bouton spécifié dans un contrôle de barre d’outils est enfoncé.

BOOL IsButtonPressed(int nID) const;

Paramètres

nID
Identificateur de commande du bouton dans la barre d’outils.

Valeur de retour

Différent de zéro si le bouton est enfoncé, sinon zéro.

Notes

Envisagez d’appeler GetState si vous souhaitez récupérer plusieurs états de bouton.

CToolBarCtrl::LoadImages

Charge des bitmaps dans la liste d’images d’un contrôle de barre d’outils.

void LoadImages(
    int iBitmapID,
    HINSTANCE hinst);

Paramètres

iBitmapID
ID d’une bitmap qui contient les images à charger. Pour spécifier votre propre ressource bitmap, définissez ce paramètre sur l’ID d’une ressource bitmap et définissez sur hInst NULL. Votre ressource bitmap est ajoutée à la liste d’images sous la forme d’une seule image. Vous pouvez ajouter des bitmaps standard définies par le système en définissant hinst HINST_COMMCTRL et en définissant ce paramètre sur l’un des ID suivants :

hinst
Handle d’instance de programme pour l’application appelante. Ce paramètre peut être HINST_COMMCTRL de charger une liste d’images standard.

Notes

Cette fonction membre implémente le comportement du message TB_LOADIMAGES Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::MapAccelerator

Mappe un caractère accélérateur à un bouton de barre d’outils.

BOOL MapAccelerator(
    TCHAR chAccel,
    UINT* pIDBtn);

Paramètres

chAccel
Caractère accélérateur à mapper. Ce caractère est le même caractère que celui souligné dans le texte du bouton.

pIDBtn
Pointeur vers un UINT qui reçoit l’identificateur de commande du bouton qui correspond à l’accélérateur spécifié dans chAccel.

Valeur de retour

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

Notes

Cette fonction membre implémente le comportement du message TB_MAPACCELERATOR Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::MarkButton

Permet de définir l’état de surbrillance d’un bouton donné dans un contrôle de barre d’outils.

BOOL MarkButton(
    int nID,
    BOOL fHighlight = TRUE);

Paramètres

nID
Identificateur du bouton.

fHighlight
Spécifie l’état de surbrillance à définir. Par défaut, TRUE. Si la valeur est définie FALSE, le bouton est défini sur son état par défaut.

Valeur de retour

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

Notes

Cette fonction membre implémente le comportement du message TB_MARKBUTTON Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::MoveButton

Déplace un bouton d’un index vers un autre.

BOOL MoveButton(
    UINT nOldPos,
    UINT nNewPos);

Paramètres

nOldPos
Index de base zéro du bouton à déplacer.

nNewPos
Index de base zéro de la destination du bouton.

Valeur de retour

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

Notes

Cette fonction membre implémente le comportement du message TB_MOVEBUTTON Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::PressButton

Appuie ou relâche le bouton spécifié dans un contrôle de barre d’outils.

BOOL PressButton(int nID, BOOL bPress = TRUE);

Paramètres

nID
[in] Identificateur de commande du bouton pour appuyer ou libérer.

bPress
[in] TRUE pour appuyer sur le bouton spécifié ; FALSE pour libérer le bouton spécifié. La valeur par défaut est TRUE.

Valeur de retour

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

Notes

Si vous souhaitez modifier plusieurs états de bouton, envisagez d’appeler SetState à la place.

Cette méthode envoie le TB_PRESSBUTTON message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::ReplaceBitmap

Remplace la bitmap existante dans le contrôle de barre d’outils actuel par une nouvelle bitmap.

BOOL ReplaceBitmap(LPTBREPLACEBITMAP pReplaceBitmap);

Paramètres

pReplaceBitmap
[in] Pointeur vers une TBREPLACEBITMAP structure qui décrit la bitmap à remplacer et la nouvelle bitmap.

Valeur de retour

TRUE si cette méthode réussit ; sinon, FALSE.

Notes

Cette méthode envoie le TB_REPLACEBITMAP message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

Exemple

L’exemple de code suivant remplace la bitmap de la barre d’outils standard par une autre bitmap.

{
   // Replace one toolbar bitmap with another.
   TBREPLACEBITMAP tbrb;
   tbrb.hInstOld = ::AfxGetInstanceHandle();
   tbrb.nIDOld = IDR_MAINFRAME;
   tbrb.hInstNew = ::AfxGetInstanceHandle();
   tbrb.nIDNew = IDR_MAINFRAME1;
   tbrb.nButtons = 8;
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   BOOL bRet = m_toolBarCtrl.ReplaceBitmap(&tbrb);
}

CToolBarCtrl::RestoreState

Restaure l’état du contrôle de barre d’outils à partir de l’emplacement dans le Registre spécifié par les paramètres.

void RestoreState(
    HKEY hKeyRoot,
    LPCTSTR lpszSubKey,
    LPCTSTR lpszValueName);

Paramètres

hKeyRoot
Identifie une clé actuellement ouverte dans le Registre ou l’une des valeurs de handle réservée prédéfinies suivantes :

• HKEY_CLASSES_ROOT

• HKEY_CURRENT_USER

• HKEY_LOCAL_MACHINE

• HKEY_USERS

lpszSubKey
Pointe vers une NULLchaîne -terminated contenant le nom de la sous-clé avec laquelle une valeur est associée. Ce paramètre peut être NULL ou un pointeur vers une chaîne vide. Si le paramètre est NULL, la valeur est ajoutée à la clé identifiée par le hKeyRoot paramètre.

lpszValueName
Pointe vers une chaîne contenant le nom de la valeur à récupérer. Si une valeur portant ce nom n’est pas déjà présente dans la clé, la fonction l’ajoute à la clé.

CToolBarCtrl::SaveState

Enregistre l’état du contrôle de barre d’outils à l’emplacement dans le Registre spécifié par les paramètres.

void SaveState(
    HKEY hKeyRoot,
    LPCTSTR lpszSubKey,
    LPCTSTR lpszValueName);

Paramètres

hKeyRoot
Identifie une clé actuellement ouverte dans le Registre ou l’une des valeurs de handle réservée prédéfinies suivantes :

• HKEY_CLASSES_ROOT

• HKEY_CURRENT_USER

• HKEY_LOCAL_MACHINE

• HKEY_USERS

lpszSubKey
Pointe vers une NULLchaîne -terminated contenant le nom de la sous-clé avec laquelle une valeur est associée. Ce paramètre peut être NULL ou un pointeur vers une chaîne vide. Si le paramètre est NULL, la valeur est ajoutée à la clé identifiée par le hKeyRoot paramètre.

lpszValueName
Pointe vers une chaîne contenant le nom de la valeur à définir. Si une valeur portant ce nom n’est pas déjà présente dans la clé, la fonction l’ajoute à la clé.

CToolBarCtrl::SetAnchorHighlight

Définit le paramètre de mise en surbrillance de l’ancrage pour une barre d’outils.

BOOL SetAnchorHighlight(BOOL fAnchor = TRUE);

Paramètres

fAnchor
[in] Spécifie si la mise en surbrillance de l’ancrage est activée ou désactivée. Si cette valeur n’est pas différente de zéro, la mise en surbrillance de l’ancrage est activée. Si cette valeur est égale à zéro, la mise en surbrillance de l’ancrage est désactivée

Valeur de retour

Paramètre d’ancrage précédent. Si la mise en surbrillance a été activée, cette valeur n’est pas nulle. Si la mise en surbrillance n’a pas été activée, cette valeur est égale à zéro.

Notes

Cette méthode implémente le comportement du message TB_SETANCHORHIGHLIGHTWin32, comme décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::SetBitmapSize

Définit la taille des images bitmap réelles à ajouter à un contrôle de barre d’outils.

BOOL SetBitmapSize(CSize size);

Paramètres

size
Largeur et hauteur, en pixels, des images bitmap.

Valeur de retour

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

Notes

Cette fonction doit être appelée uniquement avant d’ajouter des bitmaps à la barre d’outils. Si l’application ne définit pas explicitement la taille de bitmap, elle prend par défaut la valeur 16 par 15 pixels.

CToolBarCtrl::SetButtonInfo

Définit les informations d’un bouton existant dans une barre d’outils.

BOOL SetButtonInfo(
    int nID,
    TBBUTTONINFO* ptbbi);

Paramètres

nID
Identificateur du bouton.

ptbbi
Pointeur vers une TBBUTTONINFO structure qui reçoit les informations du bouton.

Valeur de retour

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

Notes

La fonction membre implémente le comportement du message TB_SETBUTTONINFOWin32, comme décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::SetButtonSize

Définit la taille des boutons dans le contrôle de barre d’outils.

BOOL SetButtonSize(CSize size);

Paramètres

size
Largeur et hauteur, en pixels, des boutons.

Valeur de retour

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

Notes

La taille du bouton doit toujours être au moins aussi grande que la taille bitmap qu’elle entoure. Cette fonction doit être appelée uniquement avant d’ajouter des bitmaps à la barre d’outils. Si l’application ne définit pas explicitement la taille du bouton, elle est par défaut de 24 à 22 pixels.

Exemple

Consultez l’exemple pour CToolBar::GetToolBarCtrl.

CToolBarCtrl::SetButtonStructSize

Spécifie la taille de la TBBUTTON structure.

void SetButtonStructSize(int nSize);

Paramètres

nSize
Taille, en octets, de la TBBUTTON structure.

Notes

Si vous souhaitez stocker des données supplémentaires dans la TBBUTTON structure, vous pouvez dériver une nouvelle structure, TBBUTTONajouter les membres dont vous avez besoin ou créer une structure qui contient une TBBUTTON structure en tant que premier membre. Vous appelez ensuite cette fonction pour indiquer à la barre d’outils la taille de la nouvelle structure.

Pour plus d’informations sur la structure, consultez CToolBarCtrl::AddButtons cette TBBUTTON rubrique.

CToolBarCtrl::SetButtonWidth

Définit la largeur minimale et maximale des boutons dans le contrôle de barre d’outils.

BOOL SetButtonWidth(
    int cxMin,
    int cxMax);

Paramètres

cxMin
Largeur minimale du bouton, en pixels. Les boutons de barre d’outils ne seront jamais plus étroits que cette valeur.

cxMax
Largeur maximale du bouton, en pixels. Si le texte du bouton est trop large, le contrôle l’affiche avec des points de suspension.

Valeur de retour

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

Notes

Cette fonction membre implémente le comportement du message TB_SETBUTTONWIDTH Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::SetCmdID

Définit l’identificateur de commande qui sera envoyé à la fenêtre propriétaire lorsque le bouton spécifié est enfoncé.

BOOL SetCmdID(
    int nIndex,
    UINT nID);

Paramètres

nIndex
Index de base zéro du bouton dont l’ID de commande doit être défini.

nID
ID de commande sur lequel définir le bouton sélectionné.

Valeur de retour

Retourne une valeur différente de zéro si elle réussit ; sinon zéro.

CToolBarCtrl::SetColorScheme

Définit le jeu de couleurs du contrôle de barre d’outils actuel.

void SetColorScheme(const COLORSCHEME* lpColorScheme);

Paramètres

lpColorScheme
[in] Pointeur vers une COLORSCHEME structure qui décrit la couleur de surbrillance et la couleur d’ombre du contrôle de barre d’outils.

Notes

Cette méthode n’a aucun effet si un thème visuel Windows Vista est défini.

Cette méthode envoie le TB_SETCOLORSCHEME message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

Exemple

L’exemple de code suivant définit le jeu de couleurs pour le contrôle de barre d’outils actuel. L’exemple de code rend les bords gauche et supérieur de chaque bouton outil rouge et les bords droit et inférieur bleu. Lorsque l’utilisateur appuie sur le bouton, les bords rouges du bouton tournent en bleu et ses bords bleus se transforment en rouge.

//Set color scheme for the current toolbar control.
//Make the left and top edges of the tool button red,
//and the right and bottom edges blue. The colors
//reverse when a button is pressed.
//This method has no effect if the Vista visual theme
//is set.
{
   COLORSCHEME cs;
   cs.dwSize = sizeof(COLORSCHEME);
   cs.clrBtnHighlight = RGB(255, 0, 0);
   cs.clrBtnShadow = RGB(0, 0, 255);
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   m_toolBarCtrl.SetColorScheme(&cs);
}

CToolBarCtrl::SetDisabledImageList

Définit la liste d’images que le contrôle de barre d’outils utilisera pour afficher les boutons désactivés.

CImageList* SetDisabledImageList(CImageList* pImageList);

Paramètres

pImageList
Pointeur vers un CImageList objet contenant les images à utiliser par le contrôle de barre d’outils pour afficher les images de bouton désactivées.

Valeur de retour

Pointeur vers un CImageList objet précédemment utilisé par le contrôle de barre d’outils pour afficher les images de bouton désactivées.

Notes

Cette fonction membre implémente le comportement du message TB_SETDISABLEDIMAGELIST Win32, comme décrit dans le SDK Windows. L’implémentation MFC d’utilisation SetDisabledImageList d’un CImageList objet contenant les images de bouton désactivées du contrôle de barre d’outils, plutôt qu’un handle vers une liste d’images.

CToolBarCtrl::SetDrawTextFlags

Définit les indicateurs dans la fonction DrawTextWin32, qui est utilisée pour dessiner le texte dans le rectangle spécifié, mis en forme en fonction de la façon dont les indicateurs sont définis.

DWORD SetDrawTextFlags(
    DWORD dwMask,
    DWORD dwDTFlags);

Paramètres

dwMask
Combinaison d’un ou plusieurs indicateurs, spécifiés dans la fonction DrawTextWin32, qui indique les bits dans dwDTFlags lesquels les bits seront utilisés lors du DT_ dessin du texte.

dwDTFlags
Combinaison d’un ou plusieurs indicateurs DT_ , spécifiés dans la fonction DrawTextWin32, qui indiquent la façon dont le texte du bouton sera dessiné. Cette valeur est transmise lorsque DrawText le texte du bouton est dessiné.

Valeur de retour

Contenant DWORD les indicateurs de dessin de texte précédents.

Notes

Cette fonction membre implémente le comportement du message TB_SETDRAWTEXTFLAGS Win32, comme décrit dans le SDK Windows. Cette fonction membre définit les indicateurs dans la fonction DrawTextWin32, qui dessine du texte dans le rectangle spécifié, mis en forme en fonction de la façon dont les indicateurs sont définis.

CToolBarCtrl::SetExtendedStyle

Définit les styles étendus d’un contrôle de barre d’outils.

DWORD SetExtendedStyle(DWORD dwExStyle);

Paramètres

dwExStyle
Valeur spécifiant les nouveaux styles étendus. Ce paramètre peut être une combinaison des styles étendus de la barre d’outils.

Valeur de retour

Qui DWORD représente les styles étendus précédents. Pour obtenir la liste des styles, consultez Styles étendus de la barre d’outils, dans le Kit de développement logiciel (SDK) Windows.

Notes

Cette fonction membre implémente le comportement du message TB_SETEXTENDEDSTYLE Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::SetHotImageList

Définit la liste d’images que le contrôle de barre d’outils utilisera pour afficher les boutons « chauds ».

CImageList* SetHotImageList(CImageList* pImageList);

Paramètres

pImageList
Pointeur vers un CImageList objet contenant les images à utiliser par le contrôle de barre d’outils pour afficher des images à bouton chaud.

Valeur de retour

Pointeur vers un CImageList objet précédemment utilisé par le contrôle de barre d’outils pour afficher des images de bouton chaud.

Notes

Cette fonction membre implémente le comportement du message TB_SETHOTIMAGELIST Win32, comme décrit dans le SDK Windows.

L’implémentation MFC d’utilise SetHotImageList un CImageList objet contenant les images de bouton chaud du contrôle de barre d’outils, plutôt qu’un handle vers une liste d’images. Un bouton chaud s’affiche en surbrillance lorsque le pointeur est au-dessus de celui-ci.

CToolBarCtrl::SetHotItem

Définit l’élément actif dans une barre d’outils.

int SetHotItem(int nHot);

Paramètres

nHot
Numéro d’index de base zéro de l’élément qui sera rendu actif. Si cette valeur est -1, aucun des éléments n’est chaud.

Valeur de retour

Index de l’élément chaud précédent, ou -1 s’il n’y avait pas d’élément chaud.

Notes

Cette fonction membre implémente le comportement du message TB_SETHOTITEM Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::SetImageList

Définit la liste d’images que la barre d’outils utilisera pour afficher les boutons qui sont dans leur état par défaut.

CImageList* SetImageList(CImageList* pImageList);

Paramètres

pImageList
Pointeur vers un CImageList objet contenant les images à utiliser par le contrôle de barre d’outils pour afficher les images de bouton dans leur état par défaut.

Valeur de retour

Pointeur vers un CImageList objet précédemment utilisé par le contrôle de barre d’outils pour afficher les images de bouton dans leur état par défaut.

Notes

Cette fonction membre implémente le comportement du message TB_SETIMAGELIST Win32, comme décrit dans le SDK Windows.

L’implémentation MFC d’utilise SetImageList un CImageList objet contenant les images de bouton du contrôle de barre d’outils, plutôt qu’un handle vers une liste d’images.

CToolBarCtrl::SetIndent

Définit la mise en retrait du premier bouton dans un contrôle de barre d’outils.

BOOL SetIndent(int iIndent);

Paramètres

iIndent
Valeur spécifiant la mise en retrait, en pixels.

Valeur de retour

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

CToolBarCtrl::SetInsertMark

Définit la marque d’insertion actuelle pour la barre d’outils.

void SetInsertMark(TBINSERTMARK* ptbim);

Paramètres

ptbim
Pointeur vers la TBINSERTMARK structure qui contient la marque d’insertion.

Notes

Cette fonction membre implémente le comportement du message TB_SETINSERTMARK Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::SetInsertMarkColor

Définit la couleur utilisée pour dessiner la marque d’insertion de la barre d’outils.

COLORREF SetInsertMarkColor(COLORREF clrNew);

Paramètres

clrNew
Valeur COLORREF qui contient la nouvelle couleur de marque d’insertion.

Valeur de retour

Valeur COLORREF qui contient la couleur de marque d’insertion précédente.

Notes

Cette fonction membre implémente le comportement du message TB_SETINSERTMARKCOLOR Win32, comme décrit dans le SDK Windows.

CToolBarCtrl::SetMaxTextRows

Définit le nombre maximal de lignes de texte affichées sur un bouton de barre d’outils.

BOOL SetMaxTextRows(int iMaxRows);

Paramètres

iMaxRows
Nombre maximal de lignes à définir.

Valeur de retour

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

CToolBarCtrl::SetMetrics

Définit les métriques de l’objet CToolBarCtrl .

void SetMetrics(LPTBMETRICS ptbm);

Paramètres

ptbm
Pointeur vers la TBMETRICS structure de l’objet CToolBarCtrl .

Notes

Cette fonction membre émule les fonctionnalités du TB_SETMETRICS message, comme décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::SetOwner

Définit la fenêtre propriétaire du contrôle de barre d’outils.

void SetOwner(CWnd* pWnd);

Paramètres

pWnd
Pointeur vers l’objet CWnd dérivé ou CWndqui sera la nouvelle fenêtre propriétaire du contrôle de barre d’outils.

Notes

La fenêtre propriétaire est la fenêtre qui reçoit des notifications de la barre d’outils.

CToolBarCtrl::SetPadding

Définit le remplissage horizontal et vertical du contrôle de barre d’outils actuel.

DWORD SetPadding(
    int nHorzPadding,
    int nVertPadding);

Paramètres

nHorzPadding
[in] Spécifie le remplissage horizontal du contrôle de barre d’outils, en pixels.

nVertPadding
[in] Spécifie le remplissage vertical du contrôle de barre d’outils, en pixels.

Valeur de retour

Dont DWORD le mot bas contient la valeur de remplissage horizontale précédente et dont le mot élevé contient la valeur de remplissage verticale précédente. Les valeurs de remplissage sont mesurées en pixels.

Notes

Cette méthode envoie le TB_SETPADDING message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

Exemple

L’exemple de code suivant définit le remplissage horizontal et vertical du contrôle de barre d’outils actuel sur 20 pixels.

{
   // Set the horizontal and vertical padding of the current
   // toolbar control.
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   m_toolBarCtrl.SetPadding(50, 50);
}

CToolBarCtrl::SetPressedImageList

Définit la liste d’images utilisée par le contrôle de barre d’outils actuel pour représenter les boutons dans l’état appuyé.

CImagelist* SetPressedImageList(
    int iImageID,
    CImageList* pImageList);

Paramètres

iImageID
[in] Index de base zéro de la liste d’images. Définissez ce paramètre sur zéro si vous utilisez une seule liste d’images.

pImageList
[in] Pointeur vers un CImageList qui contient la nouvelle liste d’images.

Valeur de retour

Pointeur vers un CImageList qui contient la liste d’images précédente pour le contrôle actif, ou NULL si aucune liste d’images n’a été définie.

Notes

Cette méthode envoie le TB_SETPRESSEDIMAGELIST message, qui est décrit dans le Kit de développement logiciel (SDK) Windows.

Exemple

L’exemple de code suivant définit la liste d’images enfoncée comme la liste d’images par défaut.

{
   // SetPressedImageList
   // Set the pressed image list to be the same as the
   // normal image list.
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   CImageList *pNormalCil = m_toolBarCtrl.GetImageList();
   CImageList *pPressedCil = m_toolBarCtrl.GetPressedImageList();
   m_toolBarCtrl.SetPressedImageList(0, pNormalCil);
}

CToolBarCtrl::SetRows

Demande au contrôle de barre d’outils de redimensionner lui-même le nombre demandé de lignes.

void SetRows(
    int nRows,
    BOOL bLarger,
    LPRECT lpRect);

Paramètres

nRows
Nombre demandé de lignes.

bLarger
Indique s’il faut utiliser plus de lignes ou moins de lignes si la barre d’outils ne peut pas être redimensionnée au nombre demandé de lignes.

lpRect
Pointe vers l’objet ou RECT la CRect structure qui recevra le nouveau rectangle englobant de la barre d’outils.

Notes

Si la barre d’outils ne peut pas se redimensionner sur le nombre ou les lignes demandés, elle se redimensionne à la taille supérieure ou suivante plus petite valide suivante, en fonction de la valeur de bLarger. Si bLarger c’est TRUEle cas, le nouveau nombre de lignes est supérieur au nombre demandé. Si bLarger c’est FALSEle cas, le nouveau nombre de lignes sera inférieur au nombre demandé.

Un nombre donné de lignes est valide pour la barre d’outils si les boutons peuvent être organisés de telle sorte que toutes les lignes aient le même nombre de boutons (sauf peut-être la dernière ligne). Par exemple, une barre d’outils qui contient quatre boutons n’a pas pu être dimensionnée à trois lignes, car les deux dernières lignes doivent être plus courtes. Si vous avez tenté de la dimensionner sur trois lignes, vous obtenez quatre lignes si bLarger elle était TRUE et deux lignes si elle bLarger était FALSE.

S’il existe des séparateurs dans la barre d’outils, les règles pour le moment où un nombre donné de lignes est valide sont plus complexes. La disposition est calculée de sorte que les groupes de boutons (boutons avec un séparateur avant le premier et le dernier bouton du groupe) ne sont jamais rompus sur plusieurs lignes, sauf si le groupe ne peut pas tenir sur une seule ligne.

Si un groupe ne s’adapte pas à une ligne, le groupe suivant démarre sur la ligne suivante, même s’il correspond à la ligne où le grand groupe s’est terminé. L’objectif de cette règle est de rendre la séparation entre les grands groupes plus visibles. Les séparateurs verticaux résultants sont comptabilisés comme des lignes.

Notez également que la SetRows fonction membre choisit toujours la disposition qui entraîne la plus petite taille de barre d’outils. La création d’une barre d’outils avec le TBSTYLE_WRAPABLE style, puis le redimensionnement du contrôle applique simplement la méthode décrite ci-dessus en fonction de la largeur du contrôle.

Cette fonction ne peut être appelée que pour les barres d’outils qui ont été créées avec le TBSTYLE_WRAPABLE style.

CToolBarCtrl::SetState

Définit l’état du bouton spécifié dans un contrôle de barre d’outils.

BOOL SetState(
    int nID,
    UINT nState);

Paramètres

nID
Identificateur de la commande du bouton.

nState
Indicateurs d’état. Il peut s’agir d’une combinaison des valeurs répertoriées pour les états de bouton dans CToolBarCtrl::AddButtons.

Valeur de retour

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

Notes

Cette fonction est particulièrement pratique si vous souhaitez définir plusieurs états de bouton. Pour définir un seul état, utilisez l’une des fonctions membres suivantes : EnableButton, , CheckButton, HideButton, Indeterminateou PressButton.

CToolBarCtrl::SetStyle

Définit les styles d’un contrôle de barre d’outils.

void SetStyle(DWORD dwStyle);

Paramètres

dwStyle
Contenant DWORD une combinaison de styles de contrôle de barre d’outils, comme décrit dans le Kit de développement logiciel (SDK) Windows.

CToolBarCtrl::SetToolTips

Associe un contrôle info-bulle à un contrôle de barre d’outils.

void SetToolTips(CToolTipCtrl* pTip);

Paramètres

pTip
Pointeur vers l’objet CToolTipCtrl .

CToolBarCtrl::SetWindowTheme

Définit le style visuel de l’objet CToolBarCtrl .

HRESULT SetWindowTheme(LPCWSTR pszSubAppName);

Paramètres

pszSubAppName
Pointeur vers une chaîne Unicode qui contient le style visuel de la barre d’outils à définir.

Valeur de retour

La valeur de retour n’est pas utilisée.

Notes

Cette fonction membre émule les fonctionnalités du TB_SETWINDOWTHEME message, comme décrit dans le Kit de développement logiciel (SDK) Windows.

Voir aussi

Exemple MFC CMNCTRL1
Exemple MFC MFCIE
CWnd Classe
Graphique hiérarchique
CToolBar Classe