CMFCToolBarButton, classe

  • Article

Fournit des fonctionnalités de bouton aux barres d’outils.

Syntaxe

class CMFCToolBarButton : public CObject

Membres

Constructeurs publics

Nom Description
CMFCToolBarButton ::CMFCToolBarButton Construit et initialise un objet CMFCToolBarButton.
CMFCToolBarButton::~CMFCToolBarButton Destructeur.

Méthodes publiques

Nom Description
CMFCToolBarButton ::CanBeDropped Spécifie si un utilisateur peut positionner un bouton sur une barre d’outils ou un menu pendant la personnalisation.
CMFCToolBarButton ::CanBeStored Spécifie si le bouton peut être stocké.
CMFCToolBarButton ::CanBeStretched Spécifie si un utilisateur peut étirer le bouton pendant la personnalisation.
CMFCToolBarButton ::CompareWith Compare cette instance à l’objet fourni CMFCToolBarButton .
CMFCToolBarButton ::CopyFrom Copie les propriétés d’un autre bouton de barre d’outils vers le bouton actif.
CMFCToolBarButton ::CreateFromOleData Crée un CMFCToolBarButton objet à partir de l’objet fourni COleDataObject .
CMFCToolBarButton::CreateObject Utilisé par l'infrastructure pour créer une instance dynamique de ce type de classe.
CMFCToolBarButton ::EnableWindow Active ou désactive les entrées de souris et de clavier.
CMFCToolBarButton ::ExportToMenuButton Copie du texte du bouton de la barre d’outils dans un menu.
CMFCToolBarButton ::GetClipboardFormat Récupère le format global du Presse-papiers pour l’application.
CMFCToolBarButton ::GetHwnd Récupère le handle de fenêtre associé au bouton de barre d’outils.
CMFCToolBarButton ::GetImage Récupère l’index d’image du bouton.
CMFCToolBarButton ::GetInvalidateRect Récupère la région de la zone cliente du bouton qui doit être redessinée.
CMFCToolBarButton ::GetParentWnd Récupère la fenêtre parente du bouton.
CMFCToolBarButton ::GetProtectedCommands Récupère la liste des commandes que l’utilisateur ne peut pas personnaliser.
CMFCToolBarButton ::GetTextSize Récupère la taille du texte du bouton.
CMFCToolBarButton ::HasFocus Détermine si le bouton a le focus d’entrée actuel.
CMFCToolBarButton ::HaveHotBorder Détermine si une bordure du bouton s’affiche lorsqu’un utilisateur sélectionne le bouton.
CMFCToolBarButton ::IsDrawImage Détermine si une image est affichée sur le bouton.
CMFCToolBarButton ::IsDrawText Détermine si une étiquette de texte est affichée sur le bouton.
CMFCToolBarButton ::IsDroppedDown Détermine si le bouton affiche un sous-menu.
CMFCToolBarButton ::IsEditable Détermine si le bouton peut être personnalisé.
CMFCToolBarButton ::IsExtrasize Détermine si le bouton peut être affiché avec une bordure étendue.
CMFCToolBarButton ::IsFirstInGroup Détermine si le bouton est à la première position dans son groupe de boutons.
CMFCToolBarButton ::IsHidden Détermine si le bouton est masqué.
CMFCToolBarButton ::IsHorizontal Détermine si le bouton se trouve dans une barre d’outils horizontale.
CMFCToolBarButton ::IsLastInGroup Spécifie si le bouton se trouve à la dernière position dans son groupe de boutons.
CMFCToolBarButton ::IsLocked Détermine si le bouton se trouve dans une barre d’outils verrouillée (non personnalisable).
CMFCToolBarButton ::IsOwnerOf Détermine si le bouton est le propriétaire du handle de fenêtre fourni.
CMFCToolBarButton ::IsVisible Détermine si le bouton de barre d’outils est visible.
CMFCToolBarButton ::IsWindowVisible Détermine si le handle de fenêtre sous-jacent du bouton est visible.
CMFCToolBarButton ::NotifyCommand Spécifie si le bouton traite le message WM_COMMAND .
CMFCToolBarButton ::OnAddToCustomizePage Appelé par l’infrastructure lorsque le bouton est ajouté à une boîte de dialogue Personnaliser .
CMFCToolBarButton ::OnBeforeDrag Spécifie si le bouton peut être déplacé.
CMFCToolBarButton ::OnBeforeDrop Spécifie si un utilisateur peut supprimer le bouton dans la barre d’outils cible.
CMFCToolBarButton ::OnCalculateSize Appelé par l’infrastructure pour calculer la taille du bouton pour le contexte de l’appareil spécifié et l’état d’ancrage.
CMFCToolBarButton ::OnCancelMode Appelé par l’infrastructure pour gérer le message WM_CANCELMODE .
CMFCToolBarButton ::OnChangeParentWnd Appelé par l’infrastructure lorsque le bouton est inséré dans une nouvelle barre d’outils.
CMFCToolBarButton ::OnClick Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton de la souris.
CMFCToolBarButton ::OnClickUp Appelé par l’infrastructure lorsque l’utilisateur relâche le bouton de la souris.
CMFCToolBarButton ::OnContextHelp Appelé par l’infrastructure lorsque la barre d’outils parent gère un message WM_HELPHITTEST.
CMFCToolBarButton ::OnCtlColor Appelé par l’infrastructure lorsque la barre d’outils parent gère un message WM_CTLCOLOR.
CMFCToolBarButton ::OnCustomizeMenu Permet au bouton de modifier le menu fourni lorsque l’application affiche un menu contextuel dans la barre d’outils parente.
CMFCToolBarButton ::OnDblClk Appelé par l’infrastructure lorsque la barre d’outils parent gère un message WM_LBUTTONDBLCLK .
CMFCToolBarButton ::OnDraw Appelé par l’infrastructure pour dessiner le bouton à l’aide des styles et options spécifiés.
CMFCToolBarButton ::OnDrawOnCustomizeList Appelé par l’infrastructure pour dessiner le bouton dans le volet Commandes de la boîte de dialogue Personnaliser .
CMFCToolBarButton ::OnGetCustomToolTipText Appelé par l’infrastructure pour récupérer le texte d’info-bulle personnalisé du bouton.
CMFCToolBarButton ::OnGlobalFontsChanged Appelé par l’infrastructure lorsque la police globale a changé.
CMFCToolBarButton ::OnMove Appelé par l’infrastructure lorsque la barre d’outils parente se déplace.
CMFCToolBarButton ::OnShow Appelé par l’infrastructure lorsque le bouton devient visible ou invisible.
CMFCToolBarButton ::OnSize Appelé par l’infrastructure lorsque la barre d’outils parente modifie sa taille ou sa position et que cette modification nécessite que le bouton change de taille.
CMFCToolBarButton ::OnToolHitTest Appelé par l’infrastructure lorsque la barre d’outils parente doit déterminer si un point se trouve dans le rectangle englobant du bouton.
CMFCToolBarButton ::OnUpdateToolTip Appelé par l’infrastructure lorsque la barre d’outils parent met à jour son texte d’info-bulle.
CMFCToolBarButton ::P repareDrag Appelé par l’infrastructure lorsque le bouton est sur le point d’effectuer une opération de glisser-déplacer.
CMFCToolBarButton ::Rect Récupère le rectangle englobant du bouton.
CMFCToolBarButton ::ResetImageToDefault Définit la valeur par défaut de l’image associée au bouton.
CMFCToolBarButton ::SaveBarState Enregistre l’état du bouton de barre d’outils.
CMFCToolBarButton ::Serialize Lit cet objet à partir d’une archive ou l’écrit dans une archive. (Substitue CObject::Serialize.)
CMFCToolBarButton ::SetACCData Remplit l’objet fourni CAccessibilityData avec des données d’accessibilité à partir du bouton de barre d’outils.
CMFCToolBarButton ::SetClipboardFormatName Renomme le format global du Presse-papiers.
CMFCToolBarButton ::SetImage Définit l’index d’image du bouton.
CMFCToolBarButton ::SetProtectedCommands Définit la liste des commandes que l’utilisateur ne peut pas personnaliser.
CMFCToolBarButton ::SetRadio Appelé par l’infrastructure lorsqu’un bouton change son état vérifié.
CMFCToolBarButton ::SetRect Définit le rectangle englobant du bouton.
CMFCToolBarButton ::SetStyle Définit le style du bouton.
CMFCToolBarButton ::SetVisible Spécifie si le bouton est visible.
CMFCToolBarButton ::Show Affiche ou masque le bouton.

Données membres

Nom Description
CMFCToolBarButton ::m_bImage Spécifie si une image est affichée sur le bouton.
CMFCToolBarButton ::m_bText Spécifie si une étiquette de texte est affichée sur le bouton.
CMFCToolBarButton ::m_bTextBelow Spécifie si l’étiquette de texte est affichée sous l’image sur le bouton.
CMFCToolBarButton ::m_bUserButton Spécifie si le bouton a une image définie par l’utilisateur.
CMFCToolBarButton ::m_bWholeText Spécifie si le bouton affiche son étiquette de texte intégral même s’il ne tient pas dans le rectangle englobant.
CMFCToolBarButton ::m_bWrap Spécifie si le bouton en regard d’un séparateur sera placé sur la ligne suivante.
CMFCToolBarButton ::m_bWrapText Spécifie si les étiquettes de texte à plusieurs lignes sont activées.
CMFCToolBarButton ::m_nID ID de commande du bouton.
CMFCToolBarButton ::m_nStyle Style du bouton.
CMFCToolBarButton ::m_strText Étiquette de texte du bouton.

Notes

Un CMFCToolbarButton objet est un contrôle qui réside dans une barre d’outils. Son comportement ressemble à celui d’un bouton ordinaire. Vous pouvez affecter une image et une étiquette de texte à cet objet. Un bouton de barre d’outils peut également avoir un ID de commande. Lorsque l’utilisateur clique sur le bouton de la barre d’outils, l’infrastructure exécute la commande spécifiée par cet ID.

En règle générale, les boutons de barre d’outils peuvent être personnalisés : l’utilisateur peut faire glisser des boutons d’une barre d’outils vers une autre, puis copier, coller, supprimer et modifier des étiquettes de texte et des images. Pour empêcher l’utilisateur de personnaliser la barre d’outils, vous pouvez verrouiller la barre d’outils de deux façons. Définissez l’indicateur bLocked sur TRUE lorsque vous appelez CMFCToolBar ::LoadToolBar, ou ajoutez l’ID de commande d’un bouton individuel à la liste globale des commandes protégées à l’aide de la méthode CMFCToolBarButton ::SetProtectedCommands .

CMFCToolBarButton les objets affichent des images à partir des collections globales d’images de barre d’outils dans l’application. Ces collections sont conservées par la barre d’outils parente, cmFCToolBar, classe. Pour plus d’informations, consultez CMFCToolBarImages, classe.

Lorsque l’utilisateur clique sur un bouton de barre d’outils, sa barre d’outils parent traite le message de la souris et communique les actions appropriées au bouton. Si le bouton a un ID de commande valide, la barre d’outils parente envoie le message WM_COMMAND au cadre parent.

La CMFCToolBarButton classe est la classe de base pour d’autres classes de bouton de barre d’outils, telles que CMFCToolBarMenuButton, CMFCToolBarEditBoxButton, classe et CLASSE CMFCToolBarComboBoxButton.

Exemple

L’exemple suivant montre comment configurer un CMFCToolBarButton objet à l’aide de différentes méthodes dans la CMFCToolBarButton classe. L’exemple montre comment activer l’entrée de la souris et du clavier, définir l’index de l’image du bouton, définir le rectangle englobant du bouton et rendre le bouton visible. Cet extrait de code fait partie de l’exemple de contrôle Tab.

CMFCToolBarButton *pOffice2007 = NULL;
int nIndex = -1;

for (UINT uiCmd = ID_VIEW_APPLOOK_2007_1; uiCmd <= ID_VIEW_APPLOOK_2007_4; uiCmd++)
{
   // CMFCToolBar m_wndToolBarTheme
   nIndex = m_wndToolBarTheme.CommandToIndex(uiCmd);

   CMFCToolBarButton *pButton = m_wndToolBarTheme.GetButton(nIndex);

   if (pButton != NULL)
   {
      pOffice2007 = pButton;
      break;
   }
}

pOffice2007->EnableWindow();
pOffice2007->SetImage(1);
pOffice2007->SetRect(CRect(1, 1, 1, 1));
pOffice2007->SetVisible();
pOffice2007->Show(true);

Hiérarchie d'héritage

CObject

CMFCToolBarButton

Spécifications

En-tête : afxtoolbarbutton.h

CMFCToolBarButton ::CanBeDropped

Spécifie si un utilisateur peut positionner un bouton sur une barre d’outils ou un menu pendant la personnalisation.

virtual BOOL CanBeDropped(CMFCToolBar* pToolbar);

Paramètres

pToolbar
[in] Inutilisé.

Valeur de retour

Cette méthode retourne TRUE.

Notes

Par défaut, un bouton de barre d’outils peut être supprimé sur chaque barre d’outils personnalisable (autrement dit, non verrouillée).

L’implémentation par défaut de cette méthode retourne TRUE. Remplacez cette méthode et retournez FALSE si vous souhaitez empêcher l’utilisateur de repositionner le bouton.

CMFCToolBarButton ::CanBeStored

Détermine si le bouton peut être stocké.

virtual BOOL CanBeStored() const;

Valeur de retour

Cette méthode retourne TRUE.

Notes

L’infrastructure utilise cette méthode pour déterminer si le bouton peut participer à une opération de glisser-déplacer.

L’implémentation par défaut retourne TRUE. Remplacez cette méthode si votre bouton ne peut pas être stocké dans le cadre d’une opération de glisser-déplacer. Pour plus d’informations sur les opérations de glisser-déplacer, consultez ole glisser-déplacer.

CMFCToolBarButton ::CanBeStretched

Spécifie si un utilisateur peut étirer le bouton pendant la personnalisation.

virtual BOOL CanBeStretched() const;

Valeur de retour

Cette méthode retourne FALSE.

Notes

Cette méthode est utilisée par l’infrastructure pour déterminer si le bouton peut être étendu en mode de personnalisation.

L’implémentation par défaut de cette méthode retourne FALSE. Remplacez cette méthode pour retourner TRUE pour un contrôle de largeur variable, tel qu’une zone de liste modifiable ou un curseur.

Pour plus d’informations sur le mode de personnalisation, consultez CMFCToolBar ::SetCustomizeMode.

CMFCToolBarButton ::CMFCToolBarButton

Construit et initialise un objet CMFCToolBarButton.

CMFCToolBarButton(
    UINT uiID,
    int iImage,
    LPCTSTR lpszText=NULL,
    BOOL bUserButton=FALSE,
    BOOL bLocked=FALSE);

Paramètres

uiID
[in] ID de commande du bouton.

iImage
[in] Index d’image du bouton dans la collection d’images.

lpszText
[in] Étiquette de texte du bouton. Sa valeur peut être NULL.

bUserButton
[in] Valeur booléenne qui détermine si le bouton est défini par l’utilisateur. Si ce paramètre a la valeur TRUE, le bouton est défini par l’utilisateur. Sinon, l’image de bouton est chargée à partir d’une ressource.

bloqué
[in] Valeur booléenne qui détermine si le bouton peut être personnalisé. Si ce paramètre a la valeur TRUE, le bouton ne peut pas être personnalisé. Sinon, le bouton peut être personnalisé.

CMFCToolBarButton ::CompareWith

Compare cette instance à l’objet fourni CMFCToolBarButton .

virtual BOOL CompareWith(const CMFCToolBarButton& other) const;

Paramètres

other
[in] Référence à l’objet à comparer à cette instance.

Valeur de retour

Différent de zéro si l’objet fourni est égal à la valeur de cette instance ; sinon, 0.

Notes

L’implémentation par défaut détermine si l’ID de commande de l’objet fourni est égal à l’ID de commande de cette instance. Remplacez cette méthode si vous devez effectuer un traitement supplémentaire pour déterminer si deux CMFCToolBarButton objets sont égaux.

CMFCToolBarButton ::CopyFrom

Copie les propriétés d’un autre bouton de barre d’outils vers le bouton actif.

virtual void CopyFrom(const CMFCToolBarButton& src);

Paramètres

src
[in] Référence au bouton source à partir duquel copier.

Notes

Appelez cette méthode pour copier un autre bouton de barre d’outils vers ce bouton de barre d’outils.

CMFCToolBarButton ::CreateFromOleData

Crée un CMFCToolBarButton objet à partir de l’objet fourni COleDataObject .

static CMFCToolBarButton* __stdcall CreateFromOleData(COleDataObject* pDataObject);

Paramètres

pDataObject
[in] Objet de données OLE source.

Valeur de retour

Objet CMFCToolBarButton créé.

Notes

Cette méthode est utilisée par l’infrastructure pour effectuer le transfert de données dans différents formats. Par exemple, la CMFCOutlookBarPane::OnDragOver méthode utilise cette méthode pour effectuer des opérations de glisser-déplacer.

CMFCToolBarButton ::EnableWindow

Active ou désactive les entrées de souris et de clavier.

virtual void EnableWindow(BOOL bEnable = TRUE);

Paramètres

bEnable
[in] Définissez ce paramètre sur TRUE pour activer l’entrée, ou sur FALSE pour désactiver l’entrée.

Notes

Cette méthode appelle la EnableWindow fonction pour activer ou désactiver l’entrée. Pour plus d’informations, consultez EnableWindow dans le Kit de développement logiciel (SDK) Windows.

CMFCToolBarButton ::ExportToMenuButton

Copie du texte du bouton de la barre d’outils dans un menu.

virtual BOOL ExportToMenuButton(CMFCToolBarMenuButton& menuButton) const;

Paramètres

menuButton
[in] Référence au bouton du menu cible.

Valeur de retour

Cette méthode retourne TRUE.

Notes

L’infrastructure appelle cette méthode pour copier le texte d’un bouton de barre d’outils vers un bouton de menu. L’implémentation par défaut copie l’étiquette de texte du bouton. Si l’étiquette de texte est vide, cette méthode copie le texte d’info-bulle du bouton.

L’implémentation par défaut de cette méthode retourne TRUE. Remplacez cette méthode si vous souhaitez effectuer des actions supplémentaires lorsque l’infrastructure convertit un objet dérivé de CMFCToolbarButton en un bouton de menu.

CMFCToolBarButton ::GetClipboardFormat

Récupère le format global du Presse-papiers pour l’application.

static CLIPFORMAT __stdcall GetClipboardFormat();

Valeur de retour

Valeur CLIPFORMAT globale pour l’application.

Notes

L’infrastructure appelle cette méthode pour récupérer le format du Presse-papiers pour les opérations de transfert de données OLE. Par exemple, la méthode CMFCToolBarButton ::CreateFromOleData utilise cette méthode pour copier des données à partir d’un objet de données OLE source.

Cette méthode définit la valeur CLIPFORMAT globale la première fois que cette méthode est appelée. Tous les appels suivants à cette méthode retournent cette valeur.

Pour autoriser les opérations de glisser-déplacer entre les applications, appelez la méthode CMFCToolBarButton ::SetClipboardFormatName .

Pour plus d’informations sur les Presse-papiers dans MFC, consultez Presse-papiers.

CMFCToolBarButton ::GetHwnd

Récupère le handle de fenêtre associé au bouton de barre d’outils.

virtual HWND GetHwnd();

Valeur de retour

Handle de fenêtre associé au bouton de barre d’outils ou NULL si le bouton de barre d’outils n’a pas de handle de fenêtre associé.

Notes

L’implémentation par défaut de cette méthode retourne NULL. Remplacez cette méthode pour retourner le handle de fenêtre de votre contrôle spécifique.

CMFCToolBarButton ::GetImage

Récupère l’index d’image du bouton.

int GetImage() const;

Valeur de retour

Index de l’image associée à ce bouton.

Notes

Si le bouton a une image définie par l’utilisateur (autrement dit, si bUserButton était TRUE dans le constructeur), l’index retourné spécifie une image dans la collection d’images définies par l’utilisateur (voir CMFCToolBar ::GetUserImages). Sinon, l’index spécifie une image dans la collection d’images chargées à partir d’un fichier de ressources (voir CMFCToolBar ::GetImages). Pour plus d’informations sur les fichiers de ressources, consultez Utilisation des fichiers de ressources.

CMFCToolBarButton ::GetInvalidateRect

Récupère la région de la zone cliente du bouton qui doit être redessinée.

virtual const CRect GetInvalidateRect() const;

Valeur de retour

Objet CRect qui spécifie la région qui doit être redessinée.

Notes

L’implémentation par défaut de cette méthode retourne l’ensemble de la zone cliente. Remplacez cette méthode si vous souhaitez qu’une zone différente soit redessinée.

CMFCToolBarButton ::GetParentWnd

Récupère la fenêtre parente du bouton.

CWnd* GetParentWnd() const;

Valeur de retour

Fenêtre parente du bouton.

CMFCToolBarButton ::GetProtectedCommands

Récupère la liste des commandes que l’utilisateur ne peut pas personnaliser.

static const CList<UINT,UINT>& GetProtectedCommands();

Valeur de retour

Liste des commandes protégées.

Notes

En mode de personnalisation, l’infrastructure désactive les commandes de bouton de barre d’outils protégées. L’utilisateur ne peut pas effectuer d’opérations de glisser-déplacer et de modification sur les boutons de barre d’outils désactivés.

Utilisez la méthode CMFCToolBarButton ::SetProtectedCommands pour définir la liste des commandes protégées.

CMFCToolBarButton ::GetTextSize

Récupère la taille du texte du bouton.

SIZE GetTextSize() const;

Valeur de retour

Objet SIZE qui contient la taille, en pixels, du texte du bouton.

CMFCToolBarButton ::HasFocus

Détermine si le bouton a le focus d’entrée actuel.

virtual BOOL HasFocus() const;

Valeur de retour

Différent de zéro si le bouton a le focus d’entrée ; sinon 0.

Notes

L’implémentation par défaut de cette méthode retourne une valeur différente de zéro si le bouton a le focus d’entrée ou est une fenêtre enfant ou descendante de la fenêtre qui a le focus d’entrée. Vous pouvez remplacer cette fonction pour personnaliser ce comportement.

CMFCToolBarButton ::HaveHotBorder

Détermine si une bordure du bouton s’affiche lorsqu’un utilisateur sélectionne le bouton.

virtual BOOL HaveHotBorder() const;

Valeur de retour

Cette méthode retourne TRUE.

Notes

L’infrastructure appelle cette méthode pour déterminer si le bouton de barre d’outils doit afficher sa bordure lorsqu’un utilisateur le sélectionne.

L’implémentation par défaut retourne TRUE. Vous pouvez remplacer cette méthode pour personnaliser ce comportement.

CMFCToolBarButton ::IsDrawImage

Détermine si une image est affichée sur le bouton.

BOOL IsDrawImage() const;

Valeur de retour

Différent de zéro si une image est affichée sur le bouton ; sinon 0.

Notes

Cette méthode retourne FALSE si le bouton de la barre d’outils n’a aucune image associée ( CMFCToolBarButton ::GetImage renvoie -1) ou si CMFCToolBarButton ::m_bImage a la valeur FALSE.

CMFCToolBarButton ::IsDrawText

Détermine si une étiquette de texte est affichée sur le bouton.

BOOL IsDrawText() const;

Valeur de retour

Différent de zéro si une étiquette de texte est affichée ; sinon 0.

Notes

Cette méthode retourne FALSE si le bouton de la barre d’outils n’a pas d’étiquette de texte associée ( CMFCToolBarButton ::m_strText est vide) ou si CMFCToolBarButton ::m_bText a la valeur FALSE.

CMFCToolBarButton ::IsDroppedDown

Détermine si le bouton affiche un sous-menu.

virtual BOOL IsDroppedDown() const;

Valeur de retour

Cette méthode retourne FALSE.

Notes

L’implémentation par défaut de cette méthode retourne FALSE. Remplacez cette méthode pour retourner TRUE si votre contrôle affiche un sous-menu.

CMFCToolBarButton ::IsEditable

Détermine si le bouton peut être personnalisé.

virtual BOOL IsEditable() const;

Valeur de retour

Différent de zéro si un bouton peut être personnalisé par l’utilisateur ; sinon 0.

Notes

L’infrastructure appelle cette méthode pour déterminer si l’utilisateur peut personnaliser le bouton de barre d’outils à l’aide des opérations de glisser-déplacer ou de modification.

L’implémentation par défaut retourne FALSE si l’ID de commande du bouton est une commande standard (vous pouvez le déterminer en appelant la IsStandardCommand fonction) ou si l’ID de commande se trouve dans la liste des commandes protégées. Pour plus d’informations sur les commandes protégées, consultez CMFCToolBarButton ::GetProtectedCommands et CMFCToolBarButton ::SetProtectedCommands.

Remplacez cette méthode pour personnaliser son comportement.

CMFCToolBarButton ::IsExtrasize

Détermine si le bouton peut être affiché avec une bordure étendue.

virtual BOOL IsExtraSize() const;

Valeur de retour

Différent de zéro si le bouton de barre d’outils peut être affiché avec une bordure étendue ; sinon 0.

Notes

Plusieurs apparences utilisent une taille supplémentaire pour les bordures des boutons de barre d’outils (par exemple, des boutons arrondis).

Si l’utilisateur déplace ce bouton d’une barre d’outils vers une autre, l’infrastructure appelle la méthode CMFCToolBarButton ::OnChangeParentWnd . La méthode CMFCToolBarButton ::OnChangeParentWnd définit l’indicateur de taille supplémentaire sur celle de la nouvelle barre d’outils parente (pour plus d’informations, consultez CMFCToolBar ::IsButtonExtraSizeAvailable).

CMFCToolBarButton ::IsFirstInGroup

Détermine si le bouton est à la première position dans son groupe de boutons.

virtual BOOL IsFirstInGroup() const;

Valeur de retour

TRUE si le bouton est le premier bouton de son groupe de boutons ; sinon FALSE.

Notes

Cette méthode définit un groupe de boutons comme un ensemble voisin de boutons positionnés sur la même ligne et limités par des séparateurs ou la bordure de la barre d’outils. Cette méthode retourne FALSE si le bouton de barre d’outils fait référence au bouton Personnaliser . Pour plus d’informations sur le bouton Personnaliser , consultez CMFCToolBar ::GetCustomizeButton.

Appelez la méthode CMFCToolBarButton ::IsLastInGroup pour déterminer si le bouton se trouve à la dernière position dans son groupe de boutons.

CMFCToolBarButton ::IsHidden

Détermine si le bouton est masqué.

BOOL IsHidden() const;

Valeur de retour

Différent de zéro si le bouton est masqué (invisible) ; sinon 0.

Notes

L’infrastructure appelle cette méthode lorsque la barre d’outils parente est étirée pour déterminer si le bouton de barre d’outils est visible.

Si vous définissez le bouton comme invisible à l’aide de la méthode CMFCToolBarButton ::SetVisible , utilisez CMFCToolBarButton ::IsVisible pour déterminer si le bouton de barre d’outils est visible.

Par défaut, tous les boutons de barre d’outils sont visibles. Utilisez la méthode CMFCToolBarButton ::Show pour masquer ou afficher les boutons de barre d’outils.

CMFCToolBarButton ::IsHorizontal

Détermine si le bouton se trouve dans une barre d’outils horizontale.

BOOL IsHorizontal() const;

Valeur de retour

Différent de zéro si un bouton de barre d’outils se trouve sur une barre d’outils horizontale ; sinon 0.

Notes

L’infrastructure appelle cette méthode pour déterminer la disposition des boutons de barre d’outils.

Cette méthode retourne le membre de m_bHorz données. La valeur par défaut du m_bHorz membre de données est TRUE ; elle est réinitialisée à chaque appel à la méthode CMFCToolBarButton ::OnDraw .

CMFCToolBarButton ::IsLastInGroup

Spécifie si le bouton se trouve à la dernière position dans son groupe de boutons.

virtual BOOL IsLastInGroup() const;

Valeur de retour

TRUE si le bouton est le dernier bouton de son groupe de boutons ; sinon FALSE.

Notes

Cette méthode définit un groupe de boutons comme un ensemble voisin de boutons positionnés sur la même ligne et qui sont limités par des séparateurs ou la bordure de la barre d’outils Cette méthode retourne FALSE si le bouton de barre d’outils n’a aucune barre d’outils parente ou que le bouton de barre d’outils fait référence au bouton Personnaliser . Pour plus d’informations sur le bouton Personnaliser , consultez CMFCToolBar ::GetCustomizeButton.

Appelez la méthode CMFCToolBarButton ::IsFirstInGroup pour déterminer si le bouton est en première position dans son groupe de boutons.

CMFCToolBarButton ::IsLocked

Détermine si le bouton se trouve dans une barre d’outils verrouillée (non personnalisable).

BOOL IsLocked() const;

Valeur de retour

Différent de zéro si le bouton se trouve sur une barre d’outils verrouillée ; sinon 0.

Notes

L’infrastructure appelle cette méthode pour déterminer si l’utilisateur peut personnaliser le bouton de barre d’outils à l’aide des opérations de glisser-déplacer ou de modification. Définissez l’attribut verrouillé dans la barre d’outils parente à l’aide de la méthode CMFCToolBar ::LoadToolBar . L’infrastructure transmet la valeur de cet attribut au constructeur de chaque bouton de barre d’outils ( CMFCToolbarButton) qu’il insère dans la barre d’outils parente.

CMFCToolBarButton ::IsOwnerOf

Détermine si le bouton est le propriétaire du handle de fenêtre fourni.

virtual BOOL IsOwnerOf(HWND hwnd);

Paramètres

hwnd
[in] Handle de fenêtre.

Valeur de retour

Différent de zéro si le bouton est le propriétaire de la poignée de fenêtre fournie ; sinon 0.

Notes

Cette méthode retourne une valeur différente de zéro si hwnd fait référence à la poignée de fenêtre directe ou est un enfant de la poignée de fenêtre associée au bouton. Cette méthode retourne 0 si hwnd a la valeur NULL.

CMFCToolBarButton ::IsVisible

Détermine si le bouton de barre d’outils est visible.

BOOL IsVisible() const;

Valeur de retour

Différent de zéro si le bouton de la barre d’outils est visible ; sinon 0.

Notes

Vous pouvez afficher ou masquer le bouton de barre d’outils à l’aide de la méthode CMFCToolBarButton ::SetVisible . Appelez la méthode CPane ::AdjustSizeImmediate dans la barre d’outils parente après avoir appelé CMFCToolBarButton ::SetVisible pour recalculer la disposition d’une barre d’outils parente.

CMFCToolBarButton ::IsWindowVisible

Détermine si le handle de fenêtre sous-jacent du bouton est visible.

virtual BOOL IsWindowVisible();

Valeur de retour

Différent de zéro si la poignée de fenêtre sous-jacente du bouton est visible ; sinon 0.

Notes

Cette méthode retourne une valeur différente de zéro si l’attribut styles du handle de fenêtre sous-jacent contient le style WS_VISIBLE. Cette méthode retourne FALSE si le handle de fenêtre sous-jacent du bouton est NULL.

CMFCToolBarButton ::m_bImage

Spécifie si une image est affichée sur le bouton.

BOOL m_bImage;

Notes

Si ce membre de données a la valeur TRUE, l’infrastructure affiche l’image associée au bouton de barre d’outils ; sinon, l’infrastructure n’affiche pas l’image. Ce membre affecte la valeur de retour de la méthode CMFCToolBarButton ::m_bImage .

CMFCToolBarButton ::m_bText

Spécifie si une étiquette de texte est affichée sur le bouton.

BOOL m_bText;

Notes

Si ce membre de données a la valeur TRUE, l’infrastructure affiche l’étiquette de texte du bouton de barre d’outils ; sinon, l’infrastructure n’affiche pas l’étiquette de texte. Ce membre affecte la valeur de retour de la méthode CMFCToolBarButton ::m_bText .

CMFCToolBarButton ::m_bTextBelow

Spécifie si l’étiquette de texte est affichée sous l’image sur le bouton.

BOOL m_bTextBelow;

Notes

Si cette variable membre a la valeur TRUE, l’infrastructure affiche le texte du bouton sous l’image. La valeur par défaut de ce membre est FALSE.

CMFCToolBarButton ::m_bUserButton

Spécifie si le bouton a une image définie par l’utilisateur

BOOL m_bUserButton;

Notes

Ce membre de données a la valeur TRUE lorsque le bouton a une image définie par l’utilisateur associée.

CMFCToolBarButton ::m_bWholeText

Spécifie si le bouton affiche son étiquette de texte intégral même s’il ne tient pas dans le rectangle englobant.

BOOL m_bWholeText;

Notes

Si ce membre de données a la valeur TRUE, l’infrastructure affiche l’étiquette de texte intégral en agrandissant le bouton. Sinon, le framework tronque et ajoute un ellipse ( ...) à l’étiquette de texte.

CMFCToolBarButton ::m_bWrap

Spécifie si le bouton en regard d’un séparateur sera placé sur la ligne suivante.

BOOL m_bWrap;

Notes

L’infrastructure définit ce membre de données sur TRUE lorsque le bouton de barre d’outils ne correspond pas à la ligne active ou lorsque vous spécifiez une disposition (par exemple, un nombre spécifique de boutons de barre d’outils par ligne).

L’infrastructure place ce bouton sur la ligne suivante si ce membre de données a la valeur TRUE et que la barre d’outils est ancrée horizontalement ou flottante.

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

CMFCToolBarButton ::m_bWrapText

Spécifie si les étiquettes de texte à plusieurs lignes sont activées.

AFX_IMPORT_DATA static BOOL m_bWrapText;

Notes

Si cette variable membre statique a la valeur TRUE, l’infrastructure permet à toutes les barres d’outils d’afficher des étiquettes de texte multilignes sur les boutons de barre d’outils.

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

CMFCToolBarButton ::m_nID

ID de commande du bouton.

UINT m_nID;

Notes

Un ID de commande de -1 indique que le bouton est un séparateur. Tous les séparateurs de boutons ont le style TBBS_SEPARATOR. Pour plus d’informations sur les styles de bouton, consultez CMFCToolBarButton ::m_nStyle .

CMFCToolBarButton ::m_nStyle

Style du bouton.

UINT m_nStyle;

Notes

Consultez Les styles de contrôle ToolBar pour obtenir la liste des styles de bouton de barre d’outils disponibles.

CMFCToolBarButton ::m_strText

Étiquette de texte du bouton.

CString m_strText;

Notes

Ce membre de données contient l’étiquette de texte du bouton. L’étiquette de texte peut être vide.

CMFCToolBarButton ::NotifyCommand

Spécifie si le bouton traite le message WM_COMMAND .

virtual BOOL NotifyCommand(int iNotifyCode);

Paramètres

iNotifyCode
[in] Message de notification associé à la commande.

Valeur de retour

Cette méthode retourne FALSE.

Notes

L’infrastructure appelle cette méthode lorsqu’il est sur le point d’envoyer un message WM_COMMAND à la fenêtre parente.

Par défaut, cette méthode retourne FALSE. Remplacez cette méthode pour retourner TRUE si vous souhaitez traiter le message WM_COMMAND ou FALSE pour indiquer que la barre d’outils parente doit gérer le message.

CMFCToolBarButton ::OnAddToCustomizePage

Appelé par l’infrastructure lorsque le bouton est ajouté à une boîte de dialogue Personnaliser .

virtual void OnAddToCustomizePage();

Notes

L’implémentation par défaut de cette méthode ne fait rien. Remplacez cette méthode si vous souhaitez effectuer une action lorsque le bouton est ajouté à une boîte de dialogue Personnaliser .

CMFCToolBarButton ::OnBeforeDrag

Spécifie si le bouton peut être déplacé.

virtual BOOL OnBeforeDrag() const;

Valeur de retour

TRUE si le bouton peut être déplacé ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode avant que l’utilisateur commence à faire glisser le bouton.

L’implémentation par défaut de cette méthode retourne TRUE. Remplacez cette méthode pour retourner FALSE pour désactiver le glissement du bouton.

CMFCToolBarButton ::OnBeforeDrop

Spécifie si un utilisateur peut supprimer le bouton dans la barre d’outils cible.

virtual BOOL OnBeforeDrop(CMFCToolBar* pTarget);

Paramètres

pTarget
[in] Cible de l’opération de glisser-déplacer.

Valeur de retour

TRUE si le bouton peut être supprimé dans la barre d’outils cible fournie ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode avant la suppression du bouton dans une barre d’outils.

L’implémentation par défaut de cette méthode retourne TRUE. Remplacez cette méthode pour retourner FALSE pour désactiver l’opération de suppression sur la cible spécifiée.

CMFCToolBarButton ::OnCalculateSize

Appelé par l’infrastructure pour calculer la taille du bouton pour le contexte de l’appareil spécifié et l’état d’ancrage.

virtual SIZE OnCalculateSize(
    CDC* pDC,
    const CSize& sizeDefault,
    BOOL bHorz);

Paramètres

pDC
[in] Contexte de l’appareil qui affiche le bouton.

sizeDefault
[in] Taille par défaut du bouton.

bHorz
[in] État d’ancrage de la barre d’outils parente. Ce paramètre a la valeur TRUE si la barre d’outils est ancrée horizontalement ou flottante, ou FALSE si la barre d’outils est ancrée verticalement.

Valeur de retour

Structure SIZE qui contient les dimensions du bouton, en pixels.

Notes

L’infrastructure appelle cette méthode pour déterminer la taille du bouton de barre d’outils pour le contexte de l’appareil et l’état d’ancrage spécifiés.

L’implémentation par défaut prend en compte les tailles de texte et d’image (si elles sont affichées), le texte et les positions d’image (le texte ci-dessous ou à droite de l’image) et l’état d’ancrage de la barre d’outils.

Remplacez cette méthode si vous souhaitez fournir la taille d’un bouton non standard (par exemple, un bouton de zone d’édition).

CMFCToolBarButton ::OnCancelMode

Appelé par l’infrastructure pour gérer le message WM_CANCELMODE .

virtual void OnCancelMode();

Notes

L’implémentation par défaut de cette méthode ne fait rien. Remplacez cette méthode si vous souhaitez gérer le message WM_CANCELMODE .

CMFCToolBarButton ::OnChangeParentWnd

Appelé par l’infrastructure lorsque le bouton est inséré dans une nouvelle barre d’outils.

virtual void OnChangeParentWnd(CWnd* pWndParent);

Paramètres

pWndParent
[in] Nouvelle fenêtre parente.

Notes

Le bouton est inséré dans une barre d’outils, par exemple, lorsque l’utilisateur le fait glisser d’une barre d’outils vers une autre barre d’outils.

L’implémentation par défaut de cette méthode ne fait rien.

CMFCToolBarButton ::OnClick

Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton de la souris.

virtual BOOL OnClick(
    CWnd* pWnd,
    BOOL bDelay=TRUE);

Paramètres

pWnd
[in] Fenêtre parente du bouton de barre d’outils.

bDelay
[in] TRUE si le message doit être géré avec un délai.

Valeur de retour

Cette méthode retourne FALSE.

Notes

L’infrastructure appelle cette méthode lorsque l’utilisateur clique sur le bouton de barre d’outils.

L’implémentation par défaut ne fait rien et retourne FALSE. Remplacez cette méthode pour retourner une valeur différente de zéro si le bouton traite le message de clic.

CMFCToolBarButton ::OnClickUp

Appelé par l’infrastructure lorsque l’utilisateur relâche le bouton de la souris.

virtual BOOL OnClickUp();

Valeur de retour

Cette méthode retourne FALSE.

Notes

L’infrastructure appelle cette méthode lorsque l’utilisateur libère le bouton de barre d’outils.

L’implémentation par défaut ne fait rien et retourne FALSE. Remplacez cette méthode pour retourner une valeur différente de zéro si le bouton traite le message de clic.

CMFCToolBarButton ::OnContextHelp

Appelé par l’infrastructure lorsque la barre d’outils parent gère un message WM_HELPHITTEST.

virtual BOOL OnContextHelp(CWnd* pWnd);

Paramètres

pWnd
[in] Fenêtre parente du bouton de barre d’outils.

Valeur de retour

Cette méthode retourne FALSE.

Notes

L’implémentation par défaut de cette méthode ne fait rien et retourne FALSE. Remplacez cette méthode pour retourner une valeur différente de zéro si le bouton traite le message d’aide.

Pour plus d’informations sur le message WM_HELPHITTEST, consultez TN028 : Prise en charge de l’aide contextuelle.

CMFCToolBarButton ::OnCtlColor

Appelé par l’infrastructure lorsque la barre d’outils parent gère un message WM_CTLCOLOR.

virtual HBRUSH OnCtlColor(
    CDC* pDC,
    UINT nCtlColor);

Paramètres

pDC
[in] Contexte de l’appareil qui affiche le bouton.

nCtlColor
[in] Notification de couleur spécifique.

Valeur de retour

Poignée de l’objet pinceau que l’infrastructure utilise pour peindre l’arrière-plan du bouton.

Notes

L’infrastructure appelle cette méthode lorsque la barre d’outils parent traite le message WM_CTLCOLOR pour un bouton de barre d’outils qui contient un contrôle Windows. L’infrastructure n’appelle pas cette méthode si le bouton de barre d’outils est sans fenêtre.

L’infrastructure appelle cette méthode lorsque l’infrastructure de barre d’outils est en mode de personnalisation et que le bouton de barre d’outils est déverrouillé. Pour plus d’informations sur le mode de personnalisation, consultez CMFCToolBar ::SetCustomizeMode. Pour plus d’informations sur le verrouillage des boutons de barre d’outils, consultez CMFCToolBarButton ::IsLocked.

L’implémentation par défaut ne fait rien et retourne NULL.

CMFCToolBarButton ::OnCustomizeMenu

Permet au bouton de modifier le menu fourni lorsque l’application affiche un menu contextuel dans la barre d’outils parente.

virtual BOOL OnCustomizeMenu(CMenu* pMenu);

Paramètres

pMenu
[in] Menu à personnaliser.

Valeur de retour

Cette méthode retourne FALSE.

Notes

L’implémentation par défaut ne fait rien et retourne FALSE. Remplacez cette méthode et retournez une valeur différente de zéro si vous souhaitez modifier le contenu du menu fourni.

CMFCToolBarButton ::OnDblClk

Appelé par l’infrastructure lorsque la barre d’outils parent gère un message WM_LBUTTONDBLCLK .

virtual void OnDblClk(CWnd* pWnd);

Paramètres

pWnd
[in] : fenêtre parente du bouton.

Notes

Cette méthode est appelée par la méthode lorsque la CMFCToolBar::OnLButtonDblClk barre d’outils parent gère un message WM_LBUTTONDBLCLK .

L’implémentation par défaut de cette méthode ne fait rien.

CMFCToolBarButton ::OnDraw

Appelé par l’infrastructure pour dessiner le bouton à l’aide des styles et options spécifiés.

virtual void OnDraw(
    CDC* pDC,
    const CRect& rect,
    CMFCToolBarImages* pImages,
    BOOL bHorz=TRUE,
    BOOL bCustomizeMode=FALSE,
    BOOL bHighlight=FALSE,
    BOOL bDrawBorder=TRUE,
    BOOL bGrayDisabledButtons=TRUE);

Paramètres

pDC
[in] Contexte de l’appareil qui affiche le bouton.

rect
[in] Rectangle englobant du bouton.

pImages
[in] Collection d’images de barre d’outils associées au bouton.

bHorz
[in] État d’ancrage de la barre d’outils parente. Ce paramètre est TRUE lorsque le bouton est ancré horizontalement et FALSE lorsque le bouton est ancré verticalement.

bCustomizeMode
[in] Spécifie si la barre d’outils est en mode de personnalisation. Ce paramètre a la valeur TRUE lorsque la barre d’outils est en mode de personnalisation et FALSE lorsque la barre d’outils n’est pas en mode de personnalisation.

bHighlight
[in] Spécifie si le bouton est mis en surbrillance. Ce paramètre a la valeur TRUE lorsque le bouton est mis en surbrillance et FALSE lorsque le bouton n’est pas mis en surbrillance.

bDrawBorder
[in] Spécifie si le bouton doit afficher sa bordure. Ce paramètre a la valeur TRUE lorsque le bouton doit afficher sa bordure et FALSE lorsque le bouton ne doit pas afficher sa bordure.

bGrayDisabledButtons
[in] Spécifie s’il faut ombrer les boutons désactivés ou utiliser la collection d’images désactivées. Ce paramètre a la valeur TRUE lorsque les boutons désactivés doivent être ombrés et FALSE lorsque cette méthode doit utiliser la collection d’images désactivées.

Notes

Remplacez cette méthode pour personnaliser le dessin du bouton de barre d’outils.

CMFCToolBarButton ::OnDrawOnCustomizeList

Appelé par l’infrastructure pour dessiner le bouton dans le volet Commandes de la boîte de dialogue Personnaliser .

virtual int OnDrawOnCustomizeList(
    CDC* pDC,
    const CRect& rect,
    BOOL bSelected);

Paramètres

pDC
[in] Contexte de l’appareil qui affiche le bouton.

rect
[in] Rectangle englobant du bouton.

bSelected
[in] Spécifie si le bouton est sélectionné. Si ce paramètre a la valeur TRUE, le bouton est sélectionné. Si ce paramètre a la valeur FALSE, le bouton n’est pas sélectionné.

Valeur de retour

Largeur, en pixels, du bouton sur le contexte d’appareil spécifié.

Notes

Cette méthode est appelée par la boîte de dialogue de personnalisation ( onglet Commandes ) lorsque le bouton est sur le point de s’afficher sur la zone de liste de dessin du propriétaire.

L’implémentation par défaut de cette méthode affiche l’image et l’étiquette de texte du bouton s’ils sont disponibles. Si l’étiquette de texte du bouton n’est pas disponible, la méthode affiche le texte de l’info-bulle.

Remplacez cette méthode pour effectuer un dessin personnalisé.

CMFCToolBarButton ::OnGetCustomToolTipText

Appelé par l’infrastructure pour récupérer le texte d’info-bulle personnalisé du bouton.

virtual BOOL OnGetCustomToolTipText(CString& strToolTip);

Paramètres

strToolTip
[out] Objet CString qui reçoit le texte d’info-bulle personnalisé.

Valeur de retour

Cette méthode retourne FALSE.

Notes

L’infrastructure appelle cette méthode lorsqu’elle affiche l’info-bulle du bouton de barre d’outils. Si cette méthode retourne FALSE, l’infrastructure utilise une info-bulle par défaut.

L’implémentation par défaut ne fait rien et retourne FALSE. Remplacez cette méthode et retournez une valeur différente de zéro pour fournir un texte d’info-bulle personnalisé pour le bouton de barre d’outils.

CMFCToolBarButton ::OnGlobalFontsChanged

Appelé par l’infrastructure lorsque la police globale a changé.

virtual void OnGlobalFontsChanged();

Notes

L’implémentation par défaut de cette méthode ne fait rien. Remplacez cette méthode pour mettre à jour la police utilisée pour afficher le texte du bouton.

CMFCToolBarButton ::OnMove

Appelé par l’infrastructure lorsque la barre d’outils parente se déplace.

virtual void OnMove();

Notes

L’implémentation par défaut de cette méthode ne fait rien. Remplacez cette méthode pour repositionner le bouton lorsque la barre d’outils parente se déplace.

CMFCToolBarButton ::OnShow

Appelé par l’infrastructure lorsque le bouton devient visible ou invisible.

virtual void OnShow(BOOL bShow);

Paramètres

bShow
[in] Spécifie si le bouton est visible. Si ce paramètre a la valeur TRUE, le bouton est visible. Sinon, le bouton n’est pas visible.

Notes

L’implémentation par défaut de cette méthode ne fait rien. Remplacez cette méthode pour mettre à jour la visibilité du bouton.

CMFCToolBarButton ::OnSize

Appelé par l’infrastructure lorsque la barre d’outils parente modifie sa taille ou sa position et que cette modification entraîne la modification de la taille du bouton.

virtual void OnSize(int iSize);

Paramètres

iSize
[in] Nouvelle largeur du bouton.

Notes

L’implémentation par défaut de cette méthode ne fait rien. Remplacez cette méthode pour redimensionner le bouton lorsque la taille ou la position de la barre d’outils parente change.

CMFCToolBarButton ::OnToolHitTest

Appelé par l’infrastructure lorsque la barre d’outils parente doit déterminer si un point se trouve dans le rectangle englobant du bouton.

virtual BOOL OnToolHitTest(
    const CWnd* pWnd,
    TOOLINFO* pTI);

Paramètres

pWnd
[in] Fenêtre parente du bouton. Sa valeur peut être NULL.

Pti
[in] Structure TOOLINFO qui contient des informations sur un outil dans un contrôle d’info-bulle.

Valeur de retour

Résultat de OnMenuButtonToolHitTest si le bouton peut récupérer un pointeur vers la fenêtre de cadre parent ; sinon FALSE.

Notes

Cette méthode appelle l’une des méthodes suivantes si elle peut convertir la fenêtre parente en objet frame valide :

CMFCToolBarButton ::OnUpdateToolTip

Appelé par l’infrastructure lorsque la barre d’outils parent met à jour son texte d’info-bulle.

virtual BOOL OnUpdateToolTip(
    CWnd* pWndParent,
    int iButtonIndex,
    CToolTipCtrl& wndToolTip,
    CString& str);

Paramètres

pWndParent
[in] Fenêtre parente.

iButtonIndex
[in] Index de base zéro du bouton dans la collection de boutons parent.

wndToolTip
[in] Contrôle qui affiche le texte de l’info-bulle.

str
[out] Objet CString qui reçoit le texte d’info-bulle mis à jour.

Valeur de retour

Cette méthode retourne FALSE.

Notes

L’implémentation par défaut de cette méthode ne fait rien et retourne FALSE. Remplacez cette méthode pour retourner une valeur différente de zéro si vous fournissez une chaîne de texte d’info-bulle.

CMFCToolBarButton ::P repareDrag

Appelé par l’infrastructure lorsque le bouton est sur le point d’effectuer une opération de glisser-déplacer.

virtual BOOL PrepareDrag(COleDataSource& srcItem);

Paramètres

srcItem
[in] Objet COleDataSource qui stocke les informations d’état sur l’opération de glisser-déplacer.

Valeur de retour

TRUE si l’opération réussit ; sinon FALSE.

Notes

L’infrastructure appelle cette méthode pour préparer le bouton de barre d’outils pour stocker son état dans l’objet fourni COleDataSource . Cette méthode stocke son état en sérialisant lui-même dans un fichier partagé, puis en passant ce fichier à la méthode COleDataSource ::CacheGlobalData . Pour plus d’informations sur la sérialisation des boutons de barre d’outils, consultez CMFCToolBarButton ::Serialize.

Cette méthode ne renvoie rien et retourne TRUE si le bouton ne peut pas être stocké (la méthode CMFCToolBarButton ::CanBeStored retourne FALSE). Elle retourne FALSE si une exception se produit pendant la sérialisation d’objets.

Pour plus d’informations sur les opérations de glisser-déplacer OLE, consultez glisser-déplacer OLE.

CMFCToolBarButton ::Rect

Récupère le rectangle englobant du bouton.

const CRect& Rect() const;

Valeur de retour

Objet CRect qui contient le rectangle englobant d’un bouton.

CMFCToolBarButton ::ResetImageToDefault

Définit la valeur par défaut de l’image associée au bouton.

virtual void ResetImageToDefault();

Notes

Cette méthode récupère l’image par défaut de sa barre d’outils parente à l’aide de la méthode CMFCToolBar ::GetDefaultImage . Si le bouton n’a pas d’image par défaut associée, cette méthode définit l’étiquette de texte du bouton en fonction de sa ressource de chaîne à l’aide de la méthode CStringT ::LoadString . Pour plus d’informations sur les ressources de chaîne, consultez Utilisation des fichiers de ressources.

Cette méthode ne fait rien si le bouton a une image définie par l’utilisateur.

CMFCToolBarButton ::SaveBarState

Enregistre l’état du bouton de barre d’outils.

virtual void SaveBarState();

Notes

L’infrastructure appelle cette méthode lorsqu’elle crée un CMFCToolBarButton objet à la suite d’une opération de glisser-déplacer.

L’implémentation par défaut de cette méthode ne fait rien. Remplacez cette méthode pour enregistrer l’état du bouton de barre d’outils dans une source de données externe.

CMFCToolBarButton ::Serialize

Lit cet objet à partir d’une archive ou l’écrit dans une archive.

virtual void Serialize(CArchive& ar);

Paramètres

Ar
[in] Objet CArchive à partir duquel ou vers lequel sérialiser.

Notes

Cette méthode prend en charge les processus de transfert de données tels que le Presse-papiers ou les opérations de glisser-déplacer. Il lit ou écrit des propriétés du bouton, telles que l’ID, l’étiquette de texte et l’ID d’image depuis ou vers l’objet fourni CArchive .

Pour obtenir des exemples de sérialisation, consultez Sérialisation : Sérialisation d’un objet.

CMFCToolBarButton ::SetACCData

Remplit l’objet fourni CAccessibilityData avec des données d’accessibilité à partir du bouton de barre d’outils.

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

Paramètres

pParent
[in] Fenêtre parente du bouton de barre d’outils.

data
[in] Objet CAccessibilityData rempli avec les données d’accessibilité du bouton de barre d’outils.

Valeur de retour

Cette méthode retourne TRUE.

Notes

Remplacez cette méthode pour retourner FALSE si votre bouton de barre d’outils ne fournit pas de données d’accessibilité.

CMFCToolBarButton ::SetClipboardFormatName

Renomme le format global du Presse-papiers.

static void __stdcall SetClipboardFormatName(LPCTSTR lpszName);

Paramètres

lpszName
[in] Nouveau nom du format global du Presse-papiers. Ne peut pas avoir la valeur NULL.

Notes

Cette méthode permet d’effectuer des opérations de glisser-déplacer entre plusieurs applications. Chaque application doit fournir le même nom de format presse-papiers.

Vous devez appeler cette méthode avant que l’infrastructure appelle CMFCToolBarButton ::GetClipboardFormat.

CMFCToolBarButton ::SetImage

Définit l’index d’image du bouton.

virtual void SetImage(int iImage);

Paramètres

iImage
[in] Index de l’image dans la collection d’images de barre d’outils.

Notes

Si le bouton de barre d’outils est un séparateur, iImage fait référence à la nouvelle largeur du bouton séparateur.

Si iImage est inférieur à zéro, cette méthode désactive le dessin de l’image et active le dessin de l’étiquette de texte du bouton.

CMFCToolBarButton ::SetProtectedCommands

Définit la liste des commandes que l’utilisateur ne peut pas personnaliser.

static void SetProtectedCommands(const CList<UINT,UINT>& lstCmds);

Paramètres

lstCmds
[in] Liste des commandes protégées.

Notes

En mode de personnalisation, l’infrastructure désactive les commandes de bouton de barre d’outils protégées. L’utilisateur ne peut pas effectuer d’opérations de glisser-déplacer et de modification sur les boutons de barre d’outils désactivés.

Utilisez la méthode CMFCToolBarButton ::GetProtectedCommands pour récupérer la liste des commandes protégées.

CMFCToolBarButton ::SetRadio

Appelé par l’infrastructure lorsqu’un bouton change son état vérifié.

virtual void SetRadio();

Notes

L’implémentation par défaut de cette méthode ne fait rien. Remplacez cette méthode pour effectuer une action personnalisée lorsque le bouton modifie son état vérifié.

CMFCToolBarButton ::SetRect

Définit le rectangle englobant du bouton.

void SetRect(const CRect rect);

Paramètres

rect
[in] Nouveau rectangle englobant du bouton.

Notes

Cette méthode appelle la méthode CMFCToolBarButton ::OnMove après avoir défini le nouveau rectangle englobant.

CMFCToolBarButton ::SetStyle

Définit le style du bouton.

virtual void SetStyle(UINT nStyle);

Paramètres

nStyle
[in] Nouveau style du bouton.

Notes

L’implémentation par défaut définit le membre de données CMFCToolBarButton ::m_nStyle sur nStyle. Remplacez cette méthode si vous souhaitez effectuer un traitement supplémentaire pour gérer le changement de style. Consultez Les styles de contrôle ToolBar pour obtenir la liste des indicateurs de style valides.

CMFCToolBarButton ::SetVisible

Spécifie si le bouton est visible.

void SetVisible(BOOL bShow=TRUE);

Paramètres

bShow
[in] Valeur booléenne qui spécifie s’il faut afficher ou masquer le bouton. Si ce paramètre a la valeur TRUE, le bouton s’affiche. Si le paramètre a la valeur FALSE, le bouton est masqué.

Notes

Utilisez cette fonction pour masquer ou afficher un bouton de barre d’outils particulier. Appelez la méthode CPane ::AdjustSizeImmediate après avoir appelé cette méthode.

CMFCToolBarButton ::Show

Affiche ou masque le bouton.

void Show(BOOL bShow);

Paramètres

bShow
[in] Valeur booléenne qui spécifie s’il faut afficher ou masquer le bouton. Si ce paramètre a la valeur TRUE, le bouton s’affiche. Si le paramètre a la valeur FALSE, le bouton est masqué.

Notes

L’infrastructure appelle cette méthode pour mettre à jour la visibilité des boutons de barre d’outils lorsque la barre d’outils parente est redimensionnée. L’infrastructure appelle cette méthode avec bShow défini sur FALSE lorsque le bouton ne correspond plus aux limites de la barre d’outils. L’infrastructure appelle cette méthode avec bShow défini sur TRUE lorsqu’après le redimensionnement du bouton s’adapte à nouveau aux limites de la barre d’outils.

Utilisez la méthode CMFCToolBarButton ::SetVisible pour définir la visibilité générale du bouton.

Cette méthode appelle la méthode CMFCToolBarButton ::OnShow après avoir mis à jour l’état de visibilité du bouton.

Voir aussi

Graphique hiérarchique
Classes
CMFCToolBar, classe
CMFCToolBarImages, classe