Classe de CMFCRibbonBaseElement

Article
03/04/2013

La classe d' CMFCRibbonBaseElement est la classe de base pour tous les éléments que vous pouvez ajouter à barre de ruban.Les exemples des éléments du ruban sont des boutons de ruban, des cases à cocher de ruban, et les zones de liste déroulante du ruban.

class CMFCRibbonBaseElement : public CObject

Membres

Constructeurs publics

Nom	Description
CMFCRibbonBaseElement	Construit un objet CMFCRibbonBaseElement.

Méthodes publiques

Nom	Description
CMFCRibbonBaseElement::AddToKeyList	Ajoute un keytip pour l'élément ruban à un tableau de keytips.
CMFCRibbonBaseElement::AddToListBox	Ajoute un élément ruban à la zone de liste spécifiée de commandes de ruban.
CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar	Indique si l'élément ruban peut être ajouté à la barre d'outils d'accès rapide.
CMFCRibbonBaseElement::CanBeCompacted	Indique si la taille de l'élément ruban peut être compacte.
CMFCRibbonBaseElement::CanBeStretched	Indique si la hauteur de l'élément ruban peut grimper verticalement jusqu'à la hauteur d'une ligne de ruban.
CMFCRibbonBaseElement::CanBeStretchedHorizontally	Indique si la largeur de l'élément ruban peut changer.
CMFCRibbonBaseElement::CleanUpSizes	Nettoie les paramètres de dimension pour l'élément ruban.
CMFCRibbonBaseElement::ClosePopupMenu	Ferme le menu popup pour l'élément ruban.
CMFCRibbonBaseElement::CopyFrom	Copie l'état d' CMFCRibbonBaseElement spécifié à l'objet actuel.
CMFCRibbonBaseElement::DestroyCtrl	Détruit l'élément ruban.
CMFCRibbonBaseElement::DrawImage	Dessine l'image pour l'élément ruban.
CMFCRibbonBaseElement::Find	Retourne le pointeur spécifié à l'élément ruban s'il indique l'objet actuel.
CMFCRibbonBaseElement::FindByData	Extrait un pointeur vers l'élément ruban s'il contient les données spécifiées.
CMFCRibbonBaseElement::FindByID	Extrait un pointeur vers l'élément ruban si cet élément est identifié par l'ID de commande spécifiée
CMFCRibbonBaseElement::FindByOriginal	Extrait un pointeur vers l'élément ruban si son élément ruban d'origine correspond à l'élément spécifié de ruban.
CMFCRibbonBaseElement::GetCompactSize	Retourne la taille compacte de l'élément ruban.
CMFCRibbonBaseElement::GetData	Récupère des données définies par l'utilisateur associées à l'élément ruban.
CMFCRibbonBaseElement::GetDescription	Retourne la description de l'élément ruban.
CMFCRibbonBaseElement::GetDroppedDown	Extrait un pointeur vers l'élément ruban si son menu contextuel est déplacé vers le bas.
CMFCRibbonBaseElement::GetElements	Ajoute l'élément actuel de ruban au tableau spécifiée.
CMFCRibbonBaseElement::GetElementsByID	Ajoute l'élément actuel de ruban au tableau spécifié si l'élément actuel de ruban contient l'ID de commande spécifiée
CMFCRibbonBaseElement::GetHighlighted	Extrait un pointeur vers l'élément ruban s'il est mis en surbrillance.
CMFCRibbonBaseElement::GetID	Retourne l'ID de commande de l'élément ruban.
CMFCRibbonBaseElement::GetImageSize	Retourne la taille de l'image de l'élément ruban.
CMFCRibbonBaseElement::GetIntermediateSize	Retourne la taille de l'élément ruban dans son état intermédiaire.
CMFCRibbonBaseElement::GetKeys	Retourne le keytip associé à l'élément ruban.
CMFCRibbonBaseElement::GetKeyTipRect	Récupère le rectangle de limite de keytip pour l'élément ruban.
CMFCRibbonBaseElement::GetKeyTipSize	Extrait la taille du texte de keytip.
CMFCRibbonBaseElement::GetLocationInGroup	Indique l'emplacement d'affichage de l'élément ruban à un groupe de ruban.
CMFCRibbonBaseElement::GetMenuKeys	Retourne les keytips associés à un bouton.
CMFCRibbonBaseElement::GetNotifyID	Extrait l'ID de commande de notification pour l'élément ruban.
CMFCRibbonBaseElement::GetOriginal	Récupère l'élément d'origine du ruban.
CMFCRibbonBaseElement::GetParentCategory	Extrait la catégorie ruban pour l'élément ruban.
CMFCRibbonBaseElement::GetParentPanel	Récupère le panneau de ruban qui contient l'élément ruban.
CMFCRibbonBaseElement::GetParentRibbonBar	Extrait la barre parente de ruban pour l'élément ruban.
CMFCRibbonBaseElement::GetParentWnd	Extrait la fenêtre parente pour l'élément ruban.
CMFCRibbonBaseElement::GetPressed	Extrait un pointeur vers l'élément ruban si l'utilisateur appuie actuel.
CMFCRibbonBaseElement::GetQuickAccessToolBarID	Extrait l'ID de commande de l'élément ruban lorsqu'il se trouve dans la barre d'outils d'accès rapide.
CMFCRibbonBaseElement::GetRect	Retourne le rectangle englobant de l'élément ruban.
CMFCRibbonBaseElement::GetRegularSize	Retourne la taille normale de l'élément ruban.
CMFCRibbonBaseElement::GetSize	Retourne la taille actuelle de l'élément ruban.
CMFCRibbonBaseElement::GetText	Retourne le texte associé à l'élément ruban.
CMFCRibbonBaseElement::GetToolTipText	Texte d'info-bulle de la valeur de l'élément ruban.
CMFCRibbonBaseElement::GetTopLevelRibbonBar	Extrait la barre de ruban de niveau supérieur pour l'élément ruban.
CMFCRibbonBaseElement::HasCompactMode	Spécifie si l'élément ruban a un état compact.
CMFCRibbonBaseElement::HasFocus	Indique si l'élément parent a le focus clavier.
CMFCRibbonBaseElement::HasIntermediateMode	Spécifie si l'élément ruban a un état intermédiaire.
CMFCRibbonBaseElement::HasLargeMode	Spécifie si l'élément ruban possède un grand mode.
CMFCRibbonBaseElement::HasMenu	Indique si l'élément ruban possède un menu.
CMFCRibbonBaseElement::HitTest	Extrait un pointeur vers l'élément ruban si le point spécifié est placé dans celui-ci.
CMFCRibbonBaseElement::IsAlignByColumn	Indique si l'élément ruban est aligné verticalement avec d'autres éléments du ruban.
CMFCRibbonBaseElement::IsAlwaysLargeImage	Indique si la taille de l'image de l'élément ruban est toujours grande.
CMFCRibbonBaseElement::IsAutoRepeatMode	Indique si l'élément ruban est en mode automatique à répétition.
CMFCRibbonBaseElement::IsChecked	Spécifie si l'élément ruban est activée.
CMFCRibbonBaseElement::IsCompactMode	Spécifie si l'élément ruban est dans un état compact.
CMFCRibbonBaseElement::IsDefaultMenuLook
CMFCRibbonBaseElement::IsDisabled	Spécifie si l'élément ruban est désactivé.
CMFCRibbonBaseElement::IsDroppedDown	Détermine si l'élément ruban affiche un menu contextuel et est déplacé vers le bas.
CMFCRibbonBaseElement::IsFocused	Spécifie si l'élément ruban a le focus.
CMFCRibbonBaseElement::IsGalleryIcon	Indique si l'élément ruban est contenu dans une galerie de ruban.
CMFCRibbonBaseElement::IsHighlighted	Spécifie si l'élément ruban est mis en surbrillance.
CMFCRibbonBaseElement::IsIntermediateMode	Indique si l'image actuelle pour l'élément ruban est taille intermédiaire.
CMFCRibbonBaseElement::IsLargeMode	Indique si l'image actuelle pour l'élément ruban est volumineuse.
CMFCRibbonBaseElement::IsMenuMode	Indique si l'élément ruban est contenu dans un menu.
CMFCRibbonBaseElement::IsPressed	Indique si l'utilisateur a cliqué l'élément ruban.
CMFCRibbonBaseElement::IsQATMode	Indique si l'élément ruban est contenu dans la barre d'outils d'accès rapide.
CMFCRibbonBaseElement::IsSeparator	Indique si l'élément ruban est un séparateur d'affichage.
CMFCRibbonBaseElement::IsShowGroupBorder	Indique si l'élément ruban est contenu à un groupe qui affiche une bordure commune.
CMFCRibbonBaseElement::IsShowTooltipOnBottom	Indique si l'info-bulle s'affiche sous l'élément ruban.
CMFCRibbonBaseElement::IsTabStop	Indique si l'élément ruban peut être sélectionné à l'aide de le clavier.
CMFCRibbonBaseElement::IsTextAlwaysOnRight	Indique si le texte de l'élément ruban s'affiche à droite.
CMFCRibbonBaseElement::IsVisible	Indique si l'élément ruban est actuellement affiché.
CMFCRibbonBaseElement::IsWholeRowHeight	Indique si le heigth d'affichage de l'élément ruban est identique à la hauteur d'affichage du panneau de ruban qui le contient.
CMFCRibbonBaseElement::NotifyCommand	Envoie une notification de commande à la fenêtre parente de l'élément ruban.
CMFCRibbonBaseElement::NotifyHighlightListItem	Notifie la fenêtre parente de la barre de ruban lorsqu'un utilisateur met en surbrillance un élément ruban qui est défini dans une liste.
CMFCRibbonBaseElement::OnAddToQAToolbar	Ajoute l'élément ruban à la barre d'outils d'accès rapide spécifiée.
CMFCRibbonBaseElement::OnAfterChangeRect	Met à jour l'info-bulle pour l'élément ruban.
CMFCRibbonBaseElement::OnAutoRepeat	Met à jour l'élément ruban en réponse à l'entrée d'utilisateur stockée.
CMFCRibbonBaseElement::OnCalcTextSize	Calcule la taille du texte pour l'élément ruban.
CMFCRibbonBaseElement::OnChangeMenuHighlight	Appelé par l'infrastructure lorsque la mise en surbrillance change pour un élément ruban qui est défini dans un menu.
CMFCRibbonBaseElement::OnDraw	Appelé par l'infrastructure pour dessiner l'élément ruban.
CMFCRibbonBaseElement::OnDrawKeyTip	Appelé par l'infrastructure pour dessiner le keytip pour l'élément ruban.
CMFCRibbonBaseElement::OnDrawMenuImage	Appelé par l'infrastructure lorsque l'image de menu pour l'élément ruban est dessinée.
CMFCRibbonBaseElement::OnDrawOnList	Appelé par l'infrastructure pour dessiner l'élément ruban dans une zone de liste de commandes.
CMFCRibbonBaseElement::OnKey	Appelé par l'infrastructure lorsque l'utilisateur appuie sur un keytip et l'élément ruban a le focus.
CMFCRibbonBaseElement::OnMenuKey
CMFCRibbonBaseElement::OnRTLChanged	Appelé par l'infrastructure lorsque la disposition change la direction.
CMFCRibbonBaseElement::OnShow	Appelé par l'infrastructure pour afficher ou masquer l'élément ruban.
CMFCRibbonBaseElement::OnShowPopupMenu	Appelé par l'infrastructure lorsque l'élément ruban devient afficher un menu contextuel.
CMFCRibbonBaseElement::PostMenuCommand
CMFCRibbonBaseElement::Redraw	Met à jour l'affichage pour l'élément ruban.
CMFCRibbonBaseElement::SetACCData	Définit les données d'accessibilité pour l'élément ruban.
CMFCRibbonBaseElement::SetCompactMode	Définit la taille d'affichage pour l'élément ruban.
CMFCRibbonBaseElement::SetData	Associe un élément de données avec l'élément ruban.
CMFCRibbonBaseElement::SetDefaultMenuLook
CMFCRibbonBaseElement::SetDescription	Définit la description de l'élément ruban.
CMFCRibbonBaseElement::SetID	Définit l'ID de commande de l'élément ruban.
CMFCRibbonBaseElement::SetInitialMode	Définit la taille d'affichage initial pour l'élément ruban.
CMFCRibbonBaseElement::SetKeys	Définit un keytip pour l'élément ruban.
CMFCRibbonBaseElement::SetOriginal	Définit l'élément d'origine de ruban pour l'élément ruban.
CMFCRibbonBaseElement::SetParentCategory	Définit la catégorie parente pour l'élément ruban.
CMFCRibbonBaseElement::SetParentMenu	Définit le conteneur parent de menu pour l'élément ruban.
CMFCRibbonBaseElement::SetParentRibbonBar	Définit la barre parente de ruban pour l'élément ruban.
CMFCRibbonBaseElement::SetRect	Définit les dimensions Franco Camion qu'il affichent le rectangle pour l'élément ruban.
CMFCRibbonBaseElement::SetText	Définit le texte de l'élément ruban.
CMFCRibbonBaseElement::SetTextAlwaysOnRight	Définit le texte de l'élément ruban à afficher sur la droite.
CMFCRibbonBaseElement::SetToolTipText	Définit le texte d'info-bulle pour l'élément ruban.
CMFCRibbonBaseElement::SetVisible	Définit l'état de visibilité de l'élément ruban.
CMFCRibbonBaseElement::StretchHorizontally	Étire la largeur de l'élément ruban.
CMFCRibbonBaseElement::StretchToWholeRow	Modifie la hauteur d'affichage de l'élément ruban en hauteur de ligne spécifiée.
CMFCRibbonBaseElement::UpdateTooltipInfo	Met à jour le texte d'info-bulle à l'aide de la ressource de commande pour l'élément 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 ruban accepte ou perd le focus d'entrée.

Notes

La classe d' CMFCRibbonBaseElement 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 peut être le focus, en surbrillance, enfoncé, désactivé, vérifié, ou supprimé vers le bas).

La taille de l'image d'un élément ruban est définie par le membre d' RibbonImageType , qui peut être l'une des valeurs suivantes :

RibbonImageLarge
RibbonImageSmall

Selon sa taille, un élément ruban affiche une petite ou grande image.

Exemple

L'exemple suivant montre comment utiliser différentes méthodes dans la classe d' CMFCRibbonBaseElement .L'exemple montre comment obtenir un objet d' CMFCRibbonBaseElement d'une classe d' CMFCRibbonStatusBar , définir la description de l'élément ruban, définir le texte, définir un keytip, et définir le texte d'info-bulle pour l'élément ruban.Cet extrait de code fait partie d' Exemple de client de dessin.

    // 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"));