CMFCRibbonBaseElement, classe
La CMFCRibbonBaseElement classe est la classe de base pour tous les éléments que vous pouvez ajouter à une barre de ruban. Parmi les exemples d'éléments de ruban figurent les boutons de ruban, les cases à cocher de ruban et les zones de listes déroulantes de ruban.
Syntaxe
class CMFCRibbonBaseElement : public CObject
Membres
Constructeurs publics
| Nom | Description |
|---|---|
CMFCRibbonBaseElement |
Construit un objet CMFCRibbonBaseElement. |
Méthodes publiques
| Nom | Description |
|---|---|
| CMFCRibbonBaseElement ::AddToKeyList | Ajoute une info-bulle pour l’élément du ruban à un tableau d’info-bulles. |
| CMFCRibbonBaseElement ::AddToListBox | Ajoute un élément de ruban à la zone de liste des commandes de ruban spécifiées. |
| CMFCRibbonBaseElement ::CanBeAddedToQuickAccessToolBar | Indique si l’élément du ruban peut être ajouté à la barre d’outils accès rapide. |
| CMFCRibbonBaseElement ::CanBeCompacted | Indique si la taille de l’élément de ruban peut être compacte. |
| CMFCRibbonBaseElement ::CanBeStretched | Indique si la hauteur de l’élément de ruban peut augmenter verticalement à la hauteur d’une ligne de ruban. |
| CMFCRibbonBaseElement ::CanBeStretchedHorizontally | Indique si la largeur de l’élément du ruban peut changer. |
| CMFCRibbonBaseElement ::CleanUpSizes | Nettoie les paramètres de dimension de l’élément du ruban. |
| CMFCRibbonBaseElement ::ClosePopupMenu | Ferme le menu contextuel de l’élément du ruban. |
| CMFCRibbonBaseElement ::CopyFrom | Copie l’état de l’objet spécifié CMFCRibbonBaseElement dans l’objet actif. |
| CMFCRibbonBaseElement ::D estroyCtrl | Détruit l’élément du ruban. |
| CMFCRibbonBaseElement ::D rawImage | Dessine l’image de l’élément du ruban. |
| CMFCRibbonBaseElement ::Find | Retourne le pointeur spécifié vers l’élément du ruban s’il pointe vers l’objet actif. |
| CMFCRibbonBaseElement ::FindByData | Récupère un pointeur vers l’élément du ruban s’il contient les données spécifiées. |
| CMFCRibbonBaseElement ::FindByID | Récupère un pointeur vers l’élément du ruban si cet élément est identifié par l’ID de commande spécifié. |
| CMFCRibbonBaseElement ::FindByOriginal | Récupère un pointeur vers l’élément du ruban si son élément de ruban d’origine correspond à l’élément de ruban spécifié. |
| CMFCRibbonBaseElement ::GetCompactSize | Retourne la taille réduite de l'élément de ruban. |
| CMFCRibbonBaseElement ::GetData | Récupère les données définies par l’utilisateur associées à l’élément du ruban. |
| CMFCRibbonBaseElement ::GetDescription | Retourne la description de l’élément du ruban. |
| CMFCRibbonBaseElement ::GetDroppedDown | Récupère un pointeur vers l’élément du ruban si son menu contextuel est supprimé. |
| CMFCRibbonBaseElement ::GetElements | Ajoute l’élément de ruban actuel au tableau spécifié. |
| CMFCRibbonBaseElement ::GetElementsByID | Ajoute l’élément de ruban actuel au tableau spécifié si l’élément de ruban actuel contient l’ID de commande spécifié. |
| CMFCRibbonBaseElement ::GetHighlighted | Récupère un pointeur vers l’élément du ruban s’il est mis en surbrillance. |
| CMFCRibbonBaseElement ::GetID | Retourne l’ID de commande de l’élément du ruban. |
| CMFCRibbonBaseElement ::GetImageSize | Retourne la taille d'image de l'élément de ruban. |
| CMFCRibbonBaseElement ::GetIntermediateSize | Retourne la taille de l'élément de ruban dans son état intermédiaire. |
| CMFCRibbonBaseElement ::GetKeys | Retourne l’info-bulle associée à l’élément du ruban. |
| CMFCRibbonBaseElement ::GetKeyTipRect | Récupère le rectangle de limite d’info-bulle pour l’élément du ruban. |
| CMFCRibbonBaseElement ::GetKeyTipSize | Récupère la taille du texte de l’info-clé. |
| CMFCRibbonBaseElement ::GetLocationInGroup | Indique l’emplacement d’affichage de l’élément du ruban dans un groupe de rubans. |
| CMFCRibbonBaseElement ::GetMenuKeys | Retourne les info-bulles associées à un bouton. |
| CMFCRibbonBaseElement ::GetNotifyID | Récupère l’ID de commande de notification de l’élément du ruban. |
| CMFCRibbonBaseElement ::GetOriginal | Récupère l’élément de ruban d’origine. |
| CMFCRibbonBaseElement ::GetParentCategory | Récupère la catégorie de ruban pour l’élément du ruban. |
| CMFCRibbonBaseElement ::GetParentPanel | Récupère le panneau du ruban qui contient l’élément du ruban. |
| CMFCRibbonBaseElement ::GetParentRibbonBar | Récupère la barre de ruban parente de l’élément du ruban. |
| CMFCRibbonBaseElement ::GetParentWnd | Récupère la fenêtre parente de l’élément du ruban. |
| CMFCRibbonBaseElement ::GetPressed | Récupère un pointeur vers l’élément du ruban si l’utilisateur appuie actuellement dessus. |
| CMFCRibbonBaseElement ::GetQuickAccessToolBarID | Récupère l’ID de commande de l’élément du ruban lorsqu’il se trouve dans la barre d’outils accès rapide. |
| CMFCRibbonBaseElement ::GetRect | Retourne le rectangle englobant de l’élément du ruban. |
| CMFCRibbonBaseElement ::GetRegularSize | Retourne la taille normale de l'élément de ruban. |
| CMFCRibbonBaseElement ::GetSize | Retourne la taille actuelle de l’élément du ruban. |
| CMFCRibbonBaseElement ::GetText | Retourne le texte associé à l’élément du ruban. |
| CMFCRibbonBaseElement ::GetToolTipText | Retourne le texte d'info-bulle de l'élément de ruban. |
| CMFCRibbonBaseElement ::GetTopLevelRibbonBar | Récupère la barre de ruban de niveau supérieur pour l’élément du ruban. |
| CMFCRibbonBaseElement ::HasCompactMode | Précise si l'élément de ruban a un mode réduit. |
| CMFCRibbonBaseElement ::HasFocus | Indique si l’élément parent a le focus clavier. |
| CMFCRibbonBaseElement ::HasIntermediateMode | Précise si l'élément de ruban a un mode intermédiaire. |
| CMFCRibbonBaseElement ::HasLargeMode | Spécifie si l’élément du ruban a un mode volumineux. |
| CMFCRibbonBaseElement ::HasMenu | Indique si l’élément du ruban a un menu. |
| CMFCRibbonBaseElement ::HitTest | Récupère un pointeur vers l’élément du ruban si le point spécifié se trouve dans celui-ci. |
| CMFCRibbonBaseElement ::IsAlignByColumn | Indique si l’élément du ruban est aligné verticalement avec d’autres éléments du ruban. |
| CMFCRibbonBaseElement ::IsAlwaysLargeImage | Indique si la taille de l’image de l’élément du ruban est toujours grande. |
| CMFCRibbonBaseElement ::IsAutoRepeatMode | Indique si l’élément du ruban est en mode de répétition automatique. |
| CMFCRibbonBaseElement ::IsChecked | Spécifie si l’élément du ruban est activé. |
| CMFCRibbonBaseElement ::IsCompactMode | Spécifie si l’élément du ruban est en mode compact. |
| CMFCRibbonBaseElement ::IsDefaultMenuLook | |
| CMFCRibbonBaseElement ::IsDisabled | Spécifie si l’élément du ruban est désactivé. |
| CMFCRibbonBaseElement ::IsDroppedDown | Détermine si l’élément du ruban affiche un menu contextuel et est supprimé. |
| CMFCRibbonBaseElement ::IsFocused | Spécifie si l’élément du ruban a le focus. |
| CMFCRibbonBaseElement ::IsGalleryIcon | Indique si l’élément du ruban est contenu dans une galerie de rubans. |
| CMFCRibbonBaseElement ::IsHighlighted | Spécifie si l’élément du ruban est mis en surbrillance. |
| CMFCRibbonBaseElement ::IsIntermediateMode | Indique si l’image actuelle de l’élément de ruban est de taille intermédiaire. |
| CMFCRibbonBaseElement ::IsLargeMode | Indique si l’image actuelle de l’élément de ruban est de grande taille. |
| CMFCRibbonBaseElement ::IsMenuMode | Indique si l’élément du ruban est contenu dans un menu. |
| CMFCRibbonBaseElement ::IsPressed | Indique si l’utilisateur a cliqué sur l’élément du ruban. |
| CMFCRibbonBaseElement ::IsQATMode | Indique si l’élément du ruban est contenu dans la barre d’outils Accès rapide. |
| CMFCRibbonBaseElement ::IsSeparator | Indique si l’élément du ruban est un séparateur d’affichage. |
| CMFCRibbonBaseElement ::IsShowGroupBorder | Indique si l’élément du ruban est contenu dans un groupe qui affiche une bordure commune. |
| CMFCRibbonBaseElement ::IsshowTooltipOnBottom | Indique si l’info-bulle s’affiche sous l’élément du ruban. |
| CMFCRibbonBaseElement ::IsTabstop | Indique si l’élément du ruban peut être sélectionné avec le clavier. |
| CMFCRibbonBaseElement ::IsTextAlwaysOnRight | Indique si le texte de l’élément du ruban est affiché à droite. |
| CMFCRibbonBaseElement ::IsVisible | Indique si l’élément du ruban est actuellement affiché. |
| CMFCRibbonBaseElement ::IsWholeRowHeight | Indique si l’heigth d’affichage de l’élément de ruban est identique à la hauteur d’affichage du panneau du ruban qui le contient. |
| CMFCRibbonBaseElement ::NotifyCommand | Envoie une notification de commande à la fenêtre parente de l’élément du ruban. |
| CMFCRibbonBaseElement ::NotifyHighlightListItem | Avertit la fenêtre parente de la barre de ruban lorsqu’un utilisateur met en surbrillance un élément de ruban situé dans une liste. |
| CMFCRibbonBaseElement ::OnAddToQAToolbar | Ajoute l’élément du ruban à la barre d’outils d’accès rapide spécifiée. |
| CMFCRibbonBaseElement ::OnAfterChangeRect | Met à jour l’info-bulle de l’élément du ruban. |
| CMFCRibbonBaseElement ::OnAutoRepeat | Met à jour l’élément du ruban en réponse à une entrée utilisateur soutenue. |
| CMFCRibbonBaseElement ::OnCalcTextsize | Calcule la taille du texte de l’élément du ruban. |
| CMFCRibbonBaseElement ::OnChangeMenuHighlight | Appelé par l’infrastructure lorsque la mise en surbrillance change pour un élément de ruban situé dans un menu. |
| CMFCRibbonBaseElement ::OnDraw | Appelé par l'infrastructure pour dessiner l'élément de ruban. |
| CMFCRibbonBaseElement ::OnDrawKeyTip | Appelé par l’infrastructure pour dessiner l’info-bulle pour l’élément du ruban. |
| CMFCRibbonBaseElement ::OnDrawMenuImage | Appelé par l’infrastructure lorsque l’image de menu de l’élément du ruban est dessinée. |
| CMFCRibbonBaseElement ::OnDrawOnList | Appelé par l’infrastructure pour dessiner l’élément du ruban dans une zone de liste de commandes. |
| CMFCRibbonBaseElement ::OnKey | Appelé par l’infrastructure lorsque l’utilisateur appuie sur une touche d’info-bulle et que l’élément du ruban a le focus. |
| CMFCRibbonBaseElement ::OnMenuKey | |
| CMFCRibbonBaseElement ::OnRTLChanged | Appelé par l’infrastructure lorsque la disposition change de direction. |
| CMFCRibbonBaseElement ::OnShow | Appelé par l’infrastructure pour afficher ou masquer l’élément du ruban. |
| CMFCRibbonBaseElement ::OnShowPopupMenu | Appelé par l’infrastructure lorsque l’élément du ruban va afficher un menu contextuel. |
| CMFCRibbonBaseElement ::P ostMenuCommand | |
| CMFCRibbonBaseElement ::Redraw | Met à jour l’affichage de l’élément du ruban. |
| CMFCRibbonBaseElement ::SetACCData | Définit les données d’accessibilité de l’élément ruban. |
| CMFCRibbonBaseElement ::SetCompactMode | Définit la taille d’affichage de l’élément du ruban. |
| CMFCRibbonBaseElement ::SetData | Associe un élément de données à l’élément du ruban. |
| CMFCRibbonBaseElement ::SetDefaultMenuLook | |
| CMFCRibbonBaseElement ::SetDescription | Définit la description de l'élément de ruban. |
| CMFCRibbonBaseElement ::SetID | Définit l’ID de commande de l’élément du ruban. |
| CMFCRibbonBaseElement ::SetInitialMode | Définit la taille d’affichage initiale de l’élément du ruban. |
| CMFCRibbonBaseElement ::SetKeys | Définit une info-bulle pour l’élément du ruban. |
| CMFCRibbonBaseElement ::SetOriginal | Définit l’élément de ruban d’origine pour l’élément du ruban. |
| CMFCRibbonBaseElement ::SetParentCategory | Définit la catégorie parente de l’élément du ruban. |
| CMFCRibbonBaseElement ::SetParentMenu | Définit le conteneur de menu parent de l’élément du ruban. |
| CMFCRibbonBaseElement ::SetParentRibbonBar | Définit la barre de ruban parente de l’élément du ruban. |
| CMFCRibbonBaseElement ::SetRect | Définit les dimensions qu’il affiche le rectangle pour l’élément du ruban. |
| CMFCRibbonBaseElement ::SetText | Définit le texte de l'élément de ruban. |
| CMFCRibbonBaseElement ::SetTextAlwaysOnRight | Définit le texte de l’élément du ruban à afficher à droite. |
| CMFCRibbonBaseElement ::SetToolTipText | Définit le texte de l’info-bulle pour l’élément du ruban. |
| CMFCRibbonBaseElement ::SetVisible | Définit l’état de visibilité de l’élément du ruban. |
| CMFCRibbonBaseElement ::StretchHorizontally | Étire la largeur de l’élément du ruban. |
| CMFCRibbonBaseElement ::StretchToWholeRow | Remplace la hauteur d’affichage de l’élément du ruban par la hauteur de ligne spécifiée. |
| CMFCRibbonBaseElement ::UpdateTooltipInfo | Met à jour le texte de l’info-bulle à l’aide de la ressource de commande pour l’élément du ruban. |
Méthodes protégées
| Nom | Description |
|---|---|
| CMFCRibbonBaseElement ::OnProcessKey | Appelé par l’infrastructure lorsque l’utilisateur appuie sur une touche de raccourci. |
| CMFCRibbonBaseElement ::OnSetFocus | Appelé par l’infrastructure lorsqu’un élément de ruban reçoit ou perd le focus d’entrée. |
Notes
La CMFCRibbonBaseElement classe définit les propriétés communes à tous les éléments du ruban qui incluent l’ID de commande, l’étiquette de texte, le texte d’info-bulle, la description de l’élément et l’état (qui peuvent être prioritaires, mis en surbrillance, appuyés, désactivés, activés ou supprimés).
La taille de l’image d’un élément de ruban est définie par le RibbonImageType membre, qui peut être l’une des valeurs suivantes :
RibbonImageLargeRibbonImageSmall
Selon sa taille, un élément de ruban affiche une petite ou grande image.
Exemple
L’exemple suivant montre comment utiliser différentes méthodes de la classe CMFCRibbonBaseElement . L’exemple montre comment obtenir un CMFCRibbonBaseElement objet à partir d’une CMFCRibbonStatusBar classe, définir la description de l’élément du ruban, définir le texte, définir une info-bulle et définir le texte de l’info-bulle pour l’élément du ruban. Cet extrait de code fait partie de l’ exemple Draw Client.
// CMFCRibbonStatusBar m_wndStatusBar
CMFCRibbonBaseElement *pPane = m_wndStatusBar.FindByID(nID);
pPane->SetDescription(_T("a pane"));
// CString strText
pPane->SetText(strText);
pPane->SetKeys(_T("p"));
pPane->SetToolTipText(_T("this is a pane"));
Hiérarchie d'héritage
Spécifications
En-tête : afxbaseribbonelement.h
CMFCRibbonBaseElement ::AddToKeyList
Ajoute une info-bulle pour l’élément du ruban à un tableau d’info-bulles.
virtual void AddToKeyList(
CArray<CMFCRibbonKeyTip*, CMFCRibbonKeyTip*>& arElems);
Paramètres
arElems
[in] Référence à un CArray des info-clés.
Notes
Lorsque la fonctionnalité d’info-clés du ruban est activée, l’infrastructure affiche les info-bulles du ruban lorsque l’utilisateur appuie sur la touche Alt ou la touche F10.
CMFCRibbonBaseElement ::AddToListBox
Ajoute un élément de ruban à la zone de liste des commandes de ruban spécifiées.
virtual int AddToListBox(
CMFCRibbonCommandsListBox* pWndListBox,
BOOL bDeep);
Paramètres
pWndListBox
[in] Pointeur vers une zone de liste de commandes.
bDeep
[in] Ce paramètre n’est pas utilisé.
Valeur de retour
Index de base zéro de l’élément de ruban ajouté.
Notes
L’infrastructure ajoute des éléments de ruban à une zone de liste de commandes pour permettre à l’utilisateur de personnaliser l’interface utilisateur.
CMFCRibbonBaseElement ::CanBeAddedToQuickAccessToolBar
Indique si l’élément du ruban peut être ajouté à la barre d’outils accès rapide.
virtual BOOL CanBeAddedToQuickAccessToolBar() const;
Valeur de retour
TRUE si l’élément peut être ajouté ; sinon, FALSE.
Notes
CMFCRibbonBaseElement ::CanBeCompacted
Indique si la taille de l’élément de ruban peut être compacte.
virtual BOOL CanBeCompacted() const;
Valeur de retour
TRUE si la taille de l’élément de ruban peut être compacte ; sinon, FALSE.
Notes
La taille d’un élément de ruban peut être compacte, intermédiaire ou grande.
CMFCRibbonBaseElement ::CanBeStretched
Indique si la hauteur de l’élément de ruban peut augmenter verticalement à la hauteur d’une ligne de ruban.
virtual BOOL CanBeStretched();
Valeur de retour
Retourne toujours TRUE.
Notes
Par défaut, cette méthode retourne toujours TRUE. Remplacez cette méthode pour indiquer si la hauteur de l’élément de ruban peut augmenter verticalement à la hauteur d’une ligne de ruban.
CMFCRibbonBaseElement ::CanBeStretchedHorizontally
Indique si la largeur de l’élément du ruban peut changer.
virtual BOOL CanBeStretchedHorizontally();
Valeur de retour
Retourne toujours FALSE.
Notes
Par défaut, cette méthode retourne toujours FALSE. Remplacez cette méthode pour indiquer si la largeur de l’élément du ruban peut changer.
CMFCRibbonBaseElement ::CleanUpSizes
Nettoie les paramètres de dimension de l’élément du ruban.
virtual void CleanUpSizes();
Notes
Par défaut, cette méthode ne fait rien. Remplacez cette méthode dans une classe dérivée pour réinitialiser les paramètres de dimension de l’élément du ruban.
CMFCRibbonBaseElement ::ClosePopupMenu
Ferme le menu contextuel de l’élément du ruban.
virtual void ClosePopupMenu();
Notes
CMFCRibbonBaseElement ::CopyFrom
Copie l’état du CMFCRibbonBaseElement spécifié dans l’objet actif.
virtual void CopyFrom(const CMFCRibbonBaseElement& src);
Paramètres
src
[in] Objet CMFCRibbonBaseElement source.
Notes
CMFCRibbonBaseElement ::D estroyCtrl
Détruit l’élément du ruban.
virtual void DestroyCtrl();
Notes
Par défaut, cette méthode ne fait rien. Remplacez cette méthode dans une classe dérivée pour détruire l’élément du ruban.
CMFCRibbonBaseElement ::D rawImage
Dessine l’image de l’élément du ruban.
virtual void DrawImage(
CDC* pDC,
RibbonImageType type,
CRect rectImage);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
type
[in] Valeur énumérée d’un type d’image. Consultez la section Remarques pour obtenir la liste des valeurs possibles.
rectImage
[in] Rectangle d’image.
Notes
Par défaut, cette méthode ne fait rien. Remplacez cette méthode dans une classe dérivée pour dessiner l’image de l’élément du ruban.
Le tableau suivant répertorie les valeurs possibles pour le paramètre de type :
| Valeur | Description |
|---|---|
RibbonImageLarge |
Grande taille d’image de 32 x 32 pixels. |
RibbonImageSmall |
Petite taille d’image de 16 x 16 pixels. |
CMFCRibbonBaseElement ::Find
Retourne le pointeur spécifié s’il pointe vers l’objet actuel.
virtual CMFCRibbonBaseElement* Find(const CMFCRibbonBaseElement* pElement);
Paramètres
pElement
[in] Pointeur vers un élément du ruban.
Valeur de retour
Pointeur vers l’élément du ruban si pElement pointe vers l’objet actuel ; sinon NULL.
Notes
CMFCRibbonBaseElement ::FindByData
Récupère un pointeur vers l’élément du ruban s’il contient les données spécifiées.
virtual CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData);
Paramètres
dwData
[in] Données associées à un élément de ruban.
Valeur de retour
Pointeur vers l’élément du ruban s’il contient les données spécifiées ; sinon NULL.
Notes
CMFCRibbonBaseElement ::FindByID
Récupère un pointeur vers l’élément du ruban si cet élément est identifié par l’ID de commande spécifié.
virtual CMFCRibbonBaseElement* FindByID(UINT uiCmdID);
Paramètres
uiCmdID
[in] ID de commande d’un élément de ruban.
Valeur de retour
Pointeur vers l’élément du ruban si cet élément est identifié par l’ID de commande spécifié ; sinon NULL.
Notes
CMFCRibbonBaseElement ::FindByOriginal
Récupère un pointeur vers l’élément de ruban actuel si son élément de ruban d’origine correspond à l’élément de ruban spécifié.
virtual CMFCRibbonBaseElement* FindByOriginal(CMFCRibbonBaseElement* pOriginal);
Paramètres
pOriginal
[in] Pointeur vers un élément du ruban.
Valeur de retour
Pointeur vers l’élément du ruban si son élément de ruban d’origine correspond à l’élément de ruban spécifié ; sinon NULL.
Notes
Les éléments du ruban copiés dans un autre conteneur conservent un pointeur vers l’élément de ruban d’origine.
CMFCRibbonBaseElement ::GetCompactSize
Retourne la taille réduite de l'élément de ruban.
virtual CSize GetCompactSize(CDC* pDC);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
Valeur de retour
Taille compacte d’un élément de ruban.
Remarque
La taille compacte signifie que l’élément du ruban est tronqué (il affiche une petite image ou une image sans texte).
CMFCRibbonBaseElement ::GetData
Récupère les données définies par l’utilisateur associées à l’élément du ruban.
DWORD_PTR GetData() const;
Valeur de retour
Données définies par l’utilisateur associées à l’élément du ruban.
CMFCRibbonBaseElement ::GetDescription
Retourne la description de l’élément du ruban.
virtual CString GetDescription() const;
Valeur de retour
Description de l’élément du ruban. La description s’affiche dans la barre d’état ou dans une info-bulle, ou sous le bouton de menu si l’élément du ruban se trouve sur la classe CMFCRibbonMainPanel.
CMFCRibbonBaseElement ::GetDroppedDown
Récupère un pointeur vers l’élément du ruban si son menu contextuel est supprimé.
virtual CMFCRibbonBaseElement* GetDroppedDown();
Valeur de retour
Pointeur vers l’élément du ruban si son menu contextuel est supprimé ; sinon NULL.
Notes
CMFCRibbonBaseElement ::GetElements
Ajoute l’élément de ruban actuel au tableau spécifié.
virtual void GetElements(
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Paramètres
arElements
[in, out] Tableau d’éléments du ruban.
Notes
CMFCRibbonBaseElement ::GetElementsByID
Ajoute l’élément de ruban actuel au tableau spécifié si l’élément de ruban actuel contient l’ID de commande spécifié.
virtual void GetElementsByID(
UINT uiCmdID,
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Paramètres
uiCmdID
[in] ID de commande d’un élément de ruban.
arElements
[in] Tableau d’éléments du ruban.
Notes
CMFCRibbonBaseElement ::GetHighlighted
Récupère un pointeur vers l’élément du ruban s’il est mis en surbrillance.
virtual CMFCRibbonBaseElement* GetHighlighted();
Valeur de retour
Pointeur vers l’élément du ruban s’il est mis en surbrillance ; sinon NULL.
Notes
CMFCRibbonBaseElement ::GetID
Retourne l’ID de commande de l’élément du ruban.
UINT GetID() const;
Valeur de retour
ID de commande de l’élément du ruban.
CMFCRibbonBaseElement ::GetImageSize
Retourne la taille d'image de l'élément de ruban.
virtual CSize GetImageSize(RibbonImageType R) const;
Valeur de retour
Taille de l’image de l’élément du ruban.
CMFCRibbonBaseElement ::GetIntermediateSize
Retourne la taille de l'élément de ruban dans son état intermédiaire.
virtual CSize GetIntermediateSize(CDC* pDC);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
Valeur de retour
Taille de l’élément de ruban dans son état intermédiaire.
CMFCRibbonBaseElement ::GetKeys
Retourne l’info-bulle associée à l’élément du ruban.
LPCTSTR GetKeys() const;
Valeur de retour
Info-bulle associée à l’élément du ruban.
CMFCRibbonBaseElement ::GetKeyTipRect
Récupère le rectangle de limite d’info-bulle pour l’élément du ruban.
virtual CRect GetKeyTipRect(
CDC* pDC,
BOOL bIsMenu);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
bIsMenu
[in] TRUE si l’élément du ruban affiche un menu contextuel ; sinon FALSE.
Valeur de retour
Retourne toujours un rectangle avec 0 valeurs.
Notes
Remplacez cette méthode dans une classe dérivée pour retourner le rectangle de limite d’info-bulle.
CMFCRibbonBaseElement ::GetKeyTipSize
Récupère la taille du texte de l’info-clé.
virtual CSize GetKeyTipSize(CDC* pDC);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
Valeur de retour
Taille du texte d’info-clé.
Notes
CMFCRibbonBaseElement ::GetLocationInGroup
Indique l’emplacement d’affichage de l’élément du ruban dans un groupe de rubans.
RibbonElementLocation GetLocationInGroup() const;
Valeur de retour
Une valeur RibbonElementLocation énumérée. Le tableau suivant répertorie les valeurs possibles.
| Valeur | Description |
|---|---|
RibbonElementNotInGroup |
L’élément du ruban n’est pas contenu dans un groupe de rubans. |
RibbonElementSingleInGroup |
L’élément du ruban s’affiche comme seul élément d’un groupe de ruban. |
RibbonElementFirstInGroup |
L’élément du ruban s’affiche à gauche d’un groupe de rubans. |
RibbonElementLastInGroup |
L’élément de ruban s’affiche à droite d’un groupe de rubans. |
RibbonElementMiddleInGroup |
L’élément du ruban n’est pas affiché à l’une ou l’autre extrémité d’un groupe de rubans. |
Notes
Les groupes d’éléments du ruban sont alignés horizontalement uniquement.
CMFCRibbonBaseElement ::GetMenuKeys
Retourne l’info-bulle de menu pour l’élément du ruban.
LPCTSTR GetMenuKeys() const;
Valeur de retour
Info-bulle de menu associée à l’élément du ruban.
Notes
Lorsqu’elle est appelée, une info-bulle de menu affiche un menu contextuel.
CMFCRibbonBaseElement ::GetNotifyID
Récupère l’ID de commande de notification de l’élément du ruban.
virtual UINT GetNotifyID();
Valeur de retour
ID de commande de notification.
Notes
CMFCRibbonBaseElement ::GetOriginal
Récupère l’élément de ruban d’origine.
CMFCRibbonBaseElement* GetOriginal() const;
Valeur de retour
Pointeur vers l’élément de ruban d’origine.
Notes
Les éléments du ruban copiés dans un autre conteneur conservent un pointeur vers l’élément de ruban d’origine.
CMFCRibbonBaseElement ::GetParentCategory
Récupère la catégorie de ruban pour l’élément du ruban.
CMFCRibbonCategory* GetParentCategory() const;
Valeur de retour
Pointeur vers la catégorie du ruban.
Notes
CMFCRibbonBaseElement ::GetParentPanel
Récupère le panneau du ruban qui contient l’élément du ruban.
virtual CMFCRibbonPanel* GetParentPanel() const;
Valeur de retour
Pointeur vers le panneau du ruban qui contient l’élément du ruban.
Notes
CMFCRibbonBaseElement ::GetParentRibbonBar
Récupère la barre de ruban parente de l’élément du ruban.
CMFCRibbonBar* GetParentRibbonBar() const;
Valeur de retour
Pointeur vers la barre de ruban parente de l’élément du ruban.
Notes
CMFCRibbonBaseElement ::GetParentWnd
Récupère la fenêtre parente de l’élément du ruban.
virtual CWnd* GetParentWnd() const;
Valeur de retour
Pointeur vers la fenêtre parente de l’élément du ruban si la méthode a réussi ; sinon, NULL.
Notes
La fenêtre parente d’un élément de ruban est une classe CMFCRibbonBar ou cmFCRibbonPanelMenuBar.
CMFCRibbonBaseElement ::GetPressed
Récupère un pointeur vers l’élément du ruban si l’utilisateur appuie actuellement dessus.
virtual CMFCRibbonBaseElement* GetPressed();
Valeur de retour
Pointeur vers l’élément du ruban si l’utilisateur l’appuie actuellement ; sinon, NULL.
Notes
CMFCRibbonBaseElement ::GetQuickAccessToolBarID
Récupère l’ID de commande de l’élément du ruban lorsqu’il se trouve dans la barre d’outils accès rapide.
virtual UINT GetQuickAccessToolBarID() const;
Valeur de retour
ID de commande de l’élément du ruban lorsqu’il se trouve dans la barre d’outils accès rapide.
Notes
CMFCRibbonBaseElement ::GetRect
Retourne le rectangle englobant de l’élément du ruban.
CRect GetRect() const;
Valeur de retour
Rectangle englobant de l’élément du ruban. La position du rectangle se trouve dans les coordonnées du contrôle ruban parent.
CMFCRibbonBaseElement ::GetRegularSize
Retourne la taille normale de l'élément de ruban.
virtual CSize GetRegularSize(CDC* pDC) = 0;
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
Valeur de retour
Taille normale de l’élément du ruban.
Notes
Remarque
La taille normale est la taille maximale possible de l’élément du ruban.
CMFCRibbonBaseElement ::GetSize
Retourne la taille actuelle de l’élément du ruban.
virtual CSize GetSize(CDC* pDC);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
Valeur de retour
Taille actuelle de l’élément du ruban.
CMFCRibbonBaseElement ::GetText
Retourne le texte associé à l’élément du ruban.
LPCTSTR GetText() const;
Valeur de retour
Texte associé à l’élément du ruban.
CMFCRibbonBaseElement ::GetToolTipText
Retourne le texte d'info-bulle de l'élément de ruban.
virtual CString GetToolTipText() const;
Valeur de retour
Texte d’info-bulle de l’élément du ruban.
CMFCRibbonBaseElement ::GetTopLevelRibbonBar
Récupère la barre de ruban de niveau supérieur pour l’élément du ruban.
CMFCRibbonBar* GetTopLevelRibbonBar() const;
Valeur de retour
Pointeur vers la barre de ruban de niveau supérieur pour l’élément du ruban si la méthode a réussi ; sinon, NULL.
Notes
CMFCRibbonBaseElement ::HasCompactMode
Précise si l'élément de ruban a un mode réduit.
virtual BOOL HasCompactMode() const;
Valeur de retour
TRUE si l’élément du ruban a un mode compact. FALSE dans le cas contraire.
Notes
Remarque
En mode compact, un élément affiche une petite image uniquement.
CMFCRibbonBaseElement ::HasIntermediateMode
Précise si l'élément de ruban a un mode intermédiaire.
virtual BOOL HasIntermediateMode() const;
Valeur de retour
TRUE si l’élément du ruban a un mode intermédiaire, FALSE sinon. En mode intermédiaire, un élément affiche une petite image et du texte à droite de l’image.
Notes
CMFCRibbonBaseElement ::HasLargeMode
Détermine si l'élément de ruban a un mode grand.
virtual BOOL HasLargeMode() const;
Valeur de retour
TRUE si l’élément du ruban a un mode volumineux. FALSE dans le cas contraire.
Notes
En mode grand, un élément peut prendre la hauteur totale du panneau parent.
CMFCRibbonBaseElement ::HasMenu
Indique si l’élément du ruban a un menu.
virtual BOOL HasMenu() const;
Valeur de retour
Retourne toujours FALSE.
Notes
Par défaut, cette méthode retourne toujours FALSE. Remplacez cette méthode dans une classe dérivée pour indiquer si l’élément du ruban a un menu.
CMFCRibbonBaseElement ::HitTest
Récupère un pointeur vers l’élément du ruban si le point spécifié se trouve dans celui-ci.
virtual CMFCRibbonBaseElement* HitTest(CPoint point);
Paramètres
point
[in] Ce paramètre n’est pas utilisé.
Valeur de retour
Pointeur vers l’élément du ruban s’il existe ; sinon FALSE.
Notes
Par défaut, cette méthode retourne toujours un pointeur valide vers l’élément du ruban lorsqu’elle existe. Remplacez cette méthode pour indiquer si le point réside dans l’élément du ruban.
CMFCRibbonBaseElement ::IsAlignByColumn
Indique si l’élément du ruban est aligné verticalement avec d’autres éléments du ruban.
virtual BOOL IsAlignByColumn() const;
Valeur de retour
Retourne toujours TRUE.
Notes
Par défaut, cette méthode retourne toujours TRUE. Remplacez cette méthode dans une classe dérivée pour indiquer si l’élément de ruban dérivé est aligné verticalement avec d’autres éléments du ruban.
CMFCRibbonBaseElement ::IsAlwaysLargeImage
Indique si la taille de l’image de l’élément du ruban est toujours grande.
virtual BOOL IsAlwaysLargeImage() const;
Valeur de retour
TRUE si la taille de l’image de l’élément du ruban est toujours grande ; sinon FALSE.
Notes
La grande taille de l’image est de 32 x 32 pixels.
CMFCRibbonBaseElement ::IsAutoRepeatMode
Indique si l’élément du ruban est en mode de répétition automatique.
virtual BOOL IsAutoRepeatMode(int& nDelay) const;
Paramètres
nDelay
[in] Ce paramètre n’est pas utilisé.
Valeur de retour
Retourne toujours FALSE.
Notes
Par défaut, cette méthode retourne toujours FALSE. Remplacez cette méthode pour indiquer si l’élément du ruban est en mode de répétition automatique.
En mode répétition automatique, l’élément du ruban répond à un intervalle défini, mesuré en millisecondes, à une entrée utilisateur soutenue.
CMFCRibbonBaseElement ::IsChecked
Spécifie si l’élément du ruban est activé.
virtual BOOL IsChecked() const;
Valeur de retour
TRUE si l’élément du ruban est activé ; sinon FALSE.
CMFCRibbonBaseElement ::IsCompactMode
Spécifie si l’élément du ruban est en mode compact.
BOOL IsCompactMode() const;
Valeur de retour
TRUE si l’élément du ruban est en mode compact ; sinon FALSE.
CMFCRibbonBaseElement ::IsDefaultMenuLook
Indique si l’élément du ruban est défini pour apparaître sous la forme d’une commande contextuelle.
BOOL IsDefaultMenuLook() const;
Valeur de retour
TRUE si l’élément du ruban est défini pour apparaître en tant que commande contextuelle ; sinon FALSE.
Notes
CMFCRibbonBaseElement ::IsDisabled
Spécifie si l’élément du ruban est désactivé.
virtual BOOL IsDisabled() const;
Valeur de retour
TRUE si l’élément du ruban est désactivé ; sinon FALSE.
CMFCRibbonBaseElement ::IsDroppedDown
Spécifie si l’élément du ruban affiche un menu contextuel et est supprimé.
virtual BOOL IsDroppedDown() const;
Valeur de retour
TRUE si l’élément du ruban est supprimé et affiche un menu contextuel ; sinon FALSE.
CMFCRibbonBaseElement ::IsFocused
Spécifie si l’élément du ruban a le focus.
virtual BOOL IsFocused() const;
Valeur de retour
TRUE si l’élément du ruban a le focus ; sinon FALSE.
CMFCRibbonBaseElement ::IsGalleryIcon
Indique si l’élément du ruban est contenu dans une galerie de rubans.
virtual BOOL IsGalleryIcon() const;
Valeur de retour
Retourne toujours FALSE.
Notes
Par défaut, cette méthode retourne toujours FALSE. Remplacez cette méthode dans une classe dérivée pour indiquer si l’élément du ruban est contenu dans une galerie de rubans.
CMFCRibbonBaseElement ::IsHighlighted
Spécifie si l’élément du ruban est mis en surbrillance.
virtual BOOL IsHighlighted() const;
Valeur de retour
TRUE si l’élément du ruban est mis en surbrillance ; sinon FALSE.
Notes
CMFCRibbonBaseElement ::IsIntermediateMode
Indique si l’image actuelle de l’élément de ruban est de taille intermédiaire.
BOOL IsIntermediateMode() const;
Valeur de retour
TRUE si l’image de l’élément du ruban est de taille intermédiaire ; sinon FALSE.
Notes
La taille de l’image intermédiaire est de 16 x 16 pixels.
CMFCRibbonBaseElement ::IsLargeMode
Indique si l’image actuelle de l’élément de ruban est de grande taille.
BOOL IsLargeMode() const;
Valeur de retour
TRUE si l’image de l’élément du ruban est de grande taille ; sinon FALSE.
Notes
La grande taille de l’image est de 32 x 32 pixels.
CMFCRibbonBaseElement ::IsMenuMode
Indique si l’élément du ruban est contenu dans un menu.
BOOL IsMenuMode() const;
Valeur de retour
TRUE si l’élément du ruban est contenu dans un menu ; sinon, FALSE.
Notes
CMFCRibbonBaseElement ::IsPressed
Indique si l’utilisateur a cliqué sur l’élément du ruban.
virtual BOOL IsPressed() const;
Valeur de retour
TRUE si l’utilisateur a cliqué sur l’élément du ruban ; sinon FALSE.
CMFCRibbonBaseElement ::IsQATMode
Indique si l’élément du ruban est contenu dans la barre d’outils Accès rapide.
BOOL IsQATMode() const;
Valeur de retour
TRUE si l’élément du ruban est contenu dans la barre d’outils accès rapide ; sinon, FALSE.
Notes
CMFCRibbonBaseElement ::IsSeparator
Indique si l’élément du ruban est un séparateur d’affichage.
virtual BOOL IsSeparator() const;
Valeur de retour
TRUE si l’élément du ruban est un séparateur d’affichage ; sinon FALSE.
Notes
CMFCRibbonBaseElement ::IsShowGroupBorder
Indique si l’élément du ruban est contenu dans un groupe qui affiche une bordure commune.
BOOL IsShowGroupBorder() const;
Valeur de retour
TRUE si l’élément du ruban est contenu dans un groupe qui affiche une bordure commune ; sinon, FALSE.
Notes
CMFCRibbonBaseElement ::IsshowTooltipOnBottom
Indique si l’info-bulle s’affiche sous l’élément du ruban.
virtual BOOL IsShowTooltipOnBottom() const;
Valeur de retour
TRUE si l’info-bulle s’affiche sous l’élément du ruban ; FALSE si l’info-bulle s’affiche près du pointeur.
Notes
CMFCRibbonBaseElement ::IsTabstop
Indique si l’élément du ruban peut être sélectionné avec le clavier.
virtual BOOL IsTabStop() const;
Valeur de retour
Retourne toujours TRUE.
Notes
Par défaut, cette méthode retourne toujours TRUE. Remplacez cette méthode pour indiquer si l’élément du ruban peut être sélectionné avec le clavier.
CMFCRibbonBaseElement ::IsTextAlwaysOnRight
Indique si le texte de l’élément du ruban est affiché à droite.
BOOL IsTextAlwaysOnRight() const;
Valeur de retour
TRUE si le texte de l’élément du ruban est affiché à droite ; sinon, FALSE.
Notes
CMFCRibbonBaseElement ::IsVisible
Indique si l’élément du ruban est actuellement affiché.
BOOL IsVisible() const;
Valeur de retour
TRUE si l’élément du ruban est actuellement affiché ; sinon, FALSE.
Notes
CMFCRibbonBaseElement ::IsWholeRowHeight
Indique si la hauteur d’affichage de l’élément de ruban est identique à la hauteur d’affichage du panneau du ruban qui le contient.
virtual BOOL IsWholeRowHeight() const;
Valeur de retour
Retourne toujours FALSE.
Notes
Par défaut, cette méthode retourne toujours FALSE. Remplacez cette méthode pour indiquer si la hauteur d’affichage de l’élément de ruban est identique à la hauteur d’affichage du panneau du ruban qui le contient.
CMFCRibbonBaseElement ::NotifyCommand
Envoie une notification de commande à la fenêtre parente de l’élément du ruban.
BOOL NotifyCommand(BOOL bWithDelay = FALSE);
Paramètres
bWithDelay
[in] TRUE pour ajouter la notification de commande à la file d’attente des messages de la fenêtre parente ; FALSE pour envoyer le message immédiatement à la fenêtre parente.
Valeur de retour
TRUE si le message a été envoyé ; sinon, FALSE.
Notes
CMFCRibbonBaseElement ::NotifyHighlightListItem
Avertit la fenêtre parente de la barre de ruban lorsqu’un utilisateur met en surbrillance un élément de ruban situé dans une liste.
virtual void NotifyHighlightListItem(int nIndex);
Paramètres
nIndex
[in] Index de l’élément du ruban dans la liste.
Notes
CMFCRibbonBaseElement ::OnAddToQAToolbar
Ajoute l’élément du ruban à la barre d’outils d’accès rapide spécifiée.
virtual BOOL OnAddToQAToolbar(CMFCRibbonQuickAccessToolBar& qat);
Paramètres
qat
[in] Barre d’outils accès rapide.
Valeur de retour
Retourne toujours TRUE indiquant que l’élément du ruban a été ajouté à la barre d’outils accès rapide.
Notes
CMFCRibbonBaseElement ::OnAfterChangeRect
Met à jour l’info-bulle de l’élément du ruban.
virtual void OnAfterChangeRect(CDC* pDC);
Paramètres
pDC
[in] Ce paramètre n’est pas utilisé.
Notes
Par défaut, cette méthode met à jour l’info-bulle de l’élément du ruban. Remplacez cette méthode pour mettre à jour l’élément du ruban une fois que son rectangle d’affichage a changé.
CMFCRibbonBaseElement ::OnAutoRepeat
Met à jour l’élément du ruban en réponse à une entrée utilisateur soutenue.
virtual BOOL OnAutoRepeat();
Valeur de retour
Retourne toujours FALSE.
Notes
Par défaut, cette méthode retourne toujours FALSE. Remplacez cette méthode pour traiter l’entrée utilisateur soutenue.
CMFCRibbonBaseElement ::OnCalcTextsize
Calcule la taille du texte de l’élément du ruban.
virtual void OnCalcTextSize(CDC* pDC);
Paramètres
pDC
[in] Ce paramètre n’est pas utilisé.
Notes
Par défaut, cette méthode ne fait rien. Remplacez cette méthode pour calculer la taille du texte de l’élément du ruban.
CMFCRibbonBaseElement ::OnChangeMenuHighlight
Appelé par l’infrastructure lorsque la mise en surbrillance change pour un élément de ruban situé dans un menu.
virtual void OnChangeMenuHighlight(CMFCRibbonPanelMenuBar* pPanelMenuBar
CMFCRibbonBaseElement* pHot);
Paramètres
pPanelMenuBar
[in] Ce paramètre n’est pas utilisé.
Phot
[in] Ce paramètre n’est pas utilisé.
Notes
Par défaut, cette méthode ne fait rien. Remplacez cette méthode pour mettre à jour un élément de ruban situé dans un menu lorsque la mise en surbrillance change.
CMFCRibbonBaseElement ::OnDraw
Appelé par l'infrastructure pour dessiner l'élément de ruban.
virtual void OnDraw(CDC* pDC) = 0;
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
Notes
Remplacez cette méthode dans une classe dérivée si vous souhaitez personnaliser le dessin d’un élément de ruban spécifique.
CMFCRibbonBaseElement ::OnDrawKeyTip
Appelé par l’infrastructure pour dessiner l’info-bulle pour l’élément du ruban.
virtual void OnDrawKeyTip(
CDC* pDC,
const CRect& rect,
BOOL bIsMenu);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
rect
[in] Rectangle de limite pour l’info-bulle.
bIsMenu
[in] TRUE si l’info-bulle concerne un bouton de menu contextuel ; sinon, FALSE.
Notes
CMFCRibbonBaseElement ::OnDrawMenuImage
Appelé par l’infrastructure lorsque l’image de menu de l’élément du ruban est dessinée.
virtual BOOL OnDrawMenuImage(
CDC* pDC,
CRect rect);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
rect
[in] Rectangle d’image de menu.
Valeur de retour
Retourne toujours TRUE pour indiquer que l’image a été dessinée.
Notes
CMFCRibbonBaseElement ::OnDrawOnList
Appelé par l’infrastructure pour dessiner l’élément du ruban dans une zone de liste de commandes.
virtual void OnDrawOnList(
CDC* pDC,
CString strText,
int nTextOffset,
CRect rect,
BOOL bIsSelected,
BOOL bHighlighted);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil pour l’élément du ruban.
strText
[in] Texte d’affichage.
nTextOffset
[in] Distance, en pixels, du côté gauche de la zone de liste au texte d’affichage.
rect
[in] Rectangle d’affichage de l’élément du ruban.
bIsSelected
[in] Ce paramètre n’est pas utilisé.
bHighlighted
[in] Ce paramètre n’est pas utilisé.
Notes
La zone de liste des commandes affiche les éléments du ruban pour permettre aux utilisateurs de personnaliser la barre d’outils accès rapide.
CMFCRibbonBaseElement ::OnKey
Appelé par l’infrastructure lorsque l’utilisateur appuie sur une touche d’info-bulle et que l’élément du ruban a le focus.
virtual BOOL OnKey(BOOL bIsMenuKey);
Paramètres
bIsMenuKey
[in] TRUE si l’info-bulle affiche un menu contextuel ; sinon, FALSE.
Valeur de retour
TRUE si l’événement a été géré ; sinon FALSE.
Notes
CMFCRibbonBaseElement ::OnMenuKey
Appelé par l’infrastructure lorsque l’utilisateur appuie sur une touche de menu dans le panneau principal.
virtual BOOL OnMenuKey(UINT nUpperChar);
Paramètres
nUpperChar
[in] Ce paramètre n’est pas utilisé.
Valeur de retour
Retourne toujours FALSE.
Notes
Par défaut, cette méthode retourne toujours FALSE. Remplacez cette méthode pour répondre lorsqu’un utilisateur appuie sur une touche de menu dans le panneau principal.
CMFCRibbonBaseElement ::OnProcessKey
Appelé par l’infrastructure lorsque l’utilisateur appuie sur une touche de raccourci.
virtual BOOL OnProcessKey(UINT nChar);
Paramètres
nChar
[in] Ce paramètre n’est pas utilisé.
Valeur de retour
Retourne toujours FALSE.
Notes
Remplacez cette méthode si vous souhaitez que l’élément du ruban traite une touche de raccourci.
CMFCRibbonBaseElement ::OnRTLChanged
Appelé par l’infrastructure lorsque la disposition change de direction.
virtual void OnRTLChanged(BOOL bIsRTL);
Paramètres
bIsRTL
[in] Ce paramètre n’est pas utilisé.
Notes
Par défaut, cette méthode ne fait rien. Remplacez cette méthode pour ajuster l’élément du ruban lorsque la disposition change de direction. La direction de disposition par défaut est de gauche à droite.
CMFCRibbonBaseElement ::OnSetFocus
Appelé par l’infrastructure lorsqu’un élément de ruban reçoit ou perd le focus d’entrée.
virtual void OnSetFocus(BOOL B);
Notes
Remplacez cette méthode dans une classe dérivée si vous souhaitez que votre application gère une modification dans le focus d’un élément de ruban.
CMFCRibbonBaseElement ::OnShow
Appelé par l’infrastructure pour afficher ou masquer l’élément du ruban.
virtual void OnShow(BOOL bShow);
Paramètres
bShow
[in] Ce paramètre n’est pas utilisé.
Notes
Par défaut, cette méthode ne fait rien. Remplacez cette méthode pour afficher ou masquer l’élément du ruban.
CMFCRibbonBaseElement ::OnShowPopupMenu
Appelé par l’infrastructure avant que l’élément du ruban affiche un menu contextuel.
virtual void OnShowPopupMenu();
Notes
Cette méthode informe la fenêtre parente de la barre de ruban que l’élément du ruban affiche un menu contextuel.
CMFCRibbonBaseElement ::P ostMenuCommand
Ferme le menu contextuel de l’élément du ruban et envoie un message proche au menu parent.
void PostMenuCommand(UINT uiCmdId);
Paramètres
uiCmdId
[in] Le paramètre n’est pas utilisé.
Notes
Le message de fermeture est envoyé uniquement si l’élément du ruban se trouve dans un menu contextuel.
CMFCRibbonBaseElement ::Redraw
Met à jour l’affichage de l’élément du ruban.
virtual void Redraw();
Notes
Cette méthode redessine le rectangle d’affichage de l’élément du ruban en appelant CWnd ::RedrawWindow avec les indicateurs RDW_INVALIDATE, RDW_ERASE et RDW_UPDATENOW définis.
CMFCRibbonBaseElement ::SetACCData
Définit les données d’accessibilité de l’élément ruban.
virtual BOOL SetACCData(
CWnd* pParent,
CAccessibilityData& data);
Paramètres
pParent
La fenêtre parente de l’élément ruban.
data
Les données d’accessibilité de l’élément ruban.
Valeur de retour
Retourne toujours TRUE.
Notes
Par défaut, cette méthode définit les données d’accessibilité pour l’élément du ruban et retourne toujours TRUE. Remplacez cette méthode pour définir l’accessibilité des données et retourner une valeur qui indique la réussite ou l’échec.
CMFCRibbonBaseElement ::SetCompactMode
Définit la taille d’affichage de l’élément du ruban.
virtual void SetCompactMode(BOOL bCompactMode = TRUE);
Paramètres
bCompactMode
[in] TRUE pour réduire la taille d’affichage de l’élément du ruban ; FALSE pour augmenter la taille d’affichage de l’élément du ruban.
Notes
Le tableau suivant récapitule la logique de cette méthode.
| bCompactMode | Taille de l’élément du ruban actuel | Nouvelle taille d’élément du ruban |
|---|---|---|
| VRAI | Compact | Aucune modification. |
| VRAI | Intermédiaire | Compacter s’il est possible. |
| VRAI | grand | Intermédiaire s’il est possible. |
| FAUX | Compact | Intermédiaire s’il est possible ; sinon grand. |
CMFCRibbonBaseElement ::SetData
Associe un élément de données à l’élément du ruban.
void SetData(DWORD_PTR dwData);
Paramètres
dwData
[in] Valeur des données.
CMFCRibbonBaseElement ::SetDefaultMenuLook
Définit l’élément du ruban à afficher sous la forme d’une commande contextuelle.
void SetDefaultMenuLook(BOOL bIsDefaultMenuLook = TRUE);
Paramètres
bIsDefaultMenuLook
[in] TRUE pour définir l’élément du ruban à afficher sous la forme d’une commande contextuelle ; sinon FALSE.
Notes
CMFCRibbonBaseElement ::SetDescription
Définit la description de l'élément de ruban.
virtual void SetDescription(LPCTSTR lpszText);
Paramètres
lpszText
[in] Description de l’élément du ruban.
Notes
L’infrastructure affiche la nouvelle description dans la barre d’état, ou dans l’info-bulle, ou sous le bouton de menu.
CMFCRibbonBaseElement ::SetID
Définit l’ID de commande de l’élément du ruban.
virtual void SetID(UINT nID);
Paramètres
nID
[in] ID de commande.
CMFCRibbonBaseElement ::SetInitialMode
Définit la taille d’affichage initiale de l’élément du ruban.
virtual void SetInitialMode(BOOL bOneRow = FALSE);
Paramètres
bOneRow
[in] TRUE pour limiter la taille d’affichage de l’élément du ruban à compacter ou intermédiaire ; sinon, FALSE.
Notes
La taille d’affichage des éléments du ruban peut être compacte, intermédiaire ou grande.
CMFCRibbonBaseElement ::SetKeys
Définit les touches d’accès pour l’élément du ruban.
virtual void SetKeys(
LPCTSTR lpszKeys,
LPCTSTR lpszMenuKeys=NULL);
Paramètres
lpszKeys
[in] Info-bulle pour l’élément du ruban.
lpszMenuKeys
[in] Info-bulle pour le menu contextuel de l’élément du ruban.
CMFCRibbonBaseElement ::SetOriginal
Définit l’élément de ruban d’origine pour l’élément du ruban.
virtual void SetOriginal(CMFCRibbonBaseElement* pOriginal);
Paramètres
pOriginal
[in] Pointeur vers un élément du ruban.
Notes
Les éléments du ruban copiés dans un autre conteneur conservent un pointeur vers l’élément de ruban d’origine.
CMFCRibbonBaseElement ::SetParentCategory
Définit la catégorie parente de l’élément du ruban.
virtual void SetParentCategory(CMFCRibbonCategory* pParent);
Paramètres
pParent
[in] Pointeur vers une catégorie de ruban.
Notes
Les groupes à onglets dans les contrôles du ruban sont appelés catégories.
CMFCRibbonBaseElement ::SetParentMenu
Définit le conteneur de menu parent de l’élément du ruban.
virtual void SetParentMenu(CMFCRibbonPanelMenuBar* pMenuBar);
Paramètres
pMenuBar
[in] Menu parent.
Notes
CMFCRibbonBaseElement ::SetParentRibbonBar
Définit la barre de ruban parente de l’élément du ruban.
virtual void SetParentRibbonBar(CMFCRibbonBar* pRibbonBar);
Paramètres
pRibbonBar
[in] Pointeur vers la barre du ruban parent.
Notes
CMFCRibbonBaseElement ::SetRect
Définit les dimensions du rectangle d’affichage de l’élément du ruban.
void SetRect(CRect rect);
Paramètres
rect
[in] Dimensions du rectangle.
Notes
CMFCRibbonBaseElement ::SetText
Définit le texte et l’info-bulle pour l’élément du ruban.
virtual void SetText(LPCTSTR lpszText);
Paramètres
lpszText
[in] Texte et info-bulle pour l’élément du ruban.
Notes
Pour définir l’info-bulle pour l’élément du ruban, ajoutez la séquence d’échappement newline suivie des caractères d’info-bulle à lpszText.
Exemple
//Set the text for the ribbon element
SetText(_T("Margins"))
//Set the text and a single-letter keytip
SetText(_T("Margins\nm"))
//Set the text and a multiple-letter keytip
SetText(_T("Line Numbers\nln"))
CMFCRibbonBaseElement ::SetTextAlwaysOnRight
Définit le texte de l’élément du ruban à afficher à droite.
virtual void SetTextAlwaysOnRight(BOOL bSet = TRUE);
Paramètres
bSet
[in] TRUE pour afficher le texte à droite ; sinon FALSE.
Notes
CMFCRibbonBaseElement ::SetToolTipText
Définit le texte de l’info-bulle pour l’élément du ruban.
virtual void SetToolTipText(LPCTSTR lpszText);
Paramètres
lpszText
[in] Texte de l’info-bulle.
CMFCRibbonBaseElement ::SetVisible
Définit la visibilité de l’élément du ruban.
void SetVisible(BOOL bIsVisible);
Paramètres
bIsVisible
[in] TRUE pour afficher l’élément du ruban ; FALSE pour masquer l’élément du ruban.
Notes
CMFCRibbonBaseElement ::StretchHorizontally
Étire la largeur de l’élément du ruban.
virtual void StretchHorizontally();
Notes
Par défaut, cette méthode génère un échec d’assertion dans les builds de débogage et ne doit donc pas être appelée. Remplacez cette méthode pour étirer la largeur de l’élément du ruban.
CMFCRibbonBaseElement ::StretchToWholeRow
Remplace la hauteur d’affichage de l’élément du ruban par la hauteur de ligne spécifiée.
virtual BOOL StretchToWholeRow(
CDC* pDC,
int nHeight);
Paramètres
pDC
[in] Ce paramètre n’est pas utilisé.
nHeight
[in] Hauteur de la ligne.
Valeur de retour
TRUE si la hauteur d’affichage a été définie ; sinon, FALSE.
Notes
Remplacez cette méthode pour modifier la hauteur d’affichage de l’élément du ruban en la hauteur de ligne spécifiée.
CMFCRibbonBaseElement ::UpdateTooltipInfo
Met à jour le texte de l’info-bulle à l’aide de la ressource de commande pour l’élément du ruban.
virtual void UpdateTooltipInfo();
Notes
CMFCRibbonBaseElement ::HasFocus
Indique si l’élément parent a le focus clavier.
virtual BOOL HasFocus() const;
Valeur de retour
TRUE si l’élément du ruban est concentré ; sinon FALSE.