CMFCRibbonCategory, classe
La CMFCRibbonCategory classe implémente un onglet de ruban qui contient un groupe de panneaux de ruban.
Syntaxe
class CMFCRibbonCategory : public CObject
Membres
Constructeurs protégés
| Nom | Description |
|---|---|
| CMFCRibbonCategory ::CMFCRibbonCategory | Constructeur . |
Méthodes publiques
Notes
En règle générale, vous créez une catégorie de ruban indirectement en appelant CMFCRibbonBar ::AddCategory, qui retourne un pointeur vers la catégorie de ruban nouvellement créée. Vous ajoutez des panneaux à la catégorie en appelant CMFCRibbonCategory ::AddPanel.
La CMFCRibbonTab classe dessine les catégories de ruban. Il est dérivé de CMFCRibbonBaseElement, classe.
Cet exemple suivant montre comment créer une catégorie de ruban et y ajouter un panneau.
// Create a new ribbon category and get a pointer to it`
CMFCRibbonCategory* pCategory = m_wndRibbonBar.AddCategory
(_T("&Write"), // Category name
IDB_WRITE, // Category small images (16 x 16)
IDB_WRITE_LARGE); // Category large images (32 x 32)
// Add a panel to the new category
CMFCRibbonPanel* pPanel = pCategory->AddPanel (
_T("Clipboard"), // Panel name
m_PanelIcons.ExtractIcon (0)); // Panel icon
Le diagramme suivant montre une figure de la catégorie Accueil de l’exemple d’application RibbonApp.
Hiérarchie d'héritage
CMFCRibbonCategory
Spécifications
En-tête : afxribboncategory.h
CMFCRibbonCategory ::AddHidden
Ajoute l’élément de ruban spécifié au tableau d’éléments du ruban affichés dans la boîte de dialogue de personnalisation.
void AddHidden(CMFCRibbonBaseElement* pElem);
Paramètres
pElem
[in] Pointeur vers un élément du ruban.
Notes
Les éléments du ruban de la boîte de dialogue de personnalisation sont les commandes que vous pouvez ajouter à la barre d’outils Accès rapide.
CMFCRibbonCategory ::AddPanel
Crée un panneau de ruban pour la catégorie de ruban.
CMFCRibbonPanel* AddPanel(
LPCTSTR lpszPanelName,
HICON hIcon = 0,
CRuntimeClass* pRTI = NULL);
Paramètres
lpszPanelName
[in] Pointeur vers le nom du nouveau panneau du ruban.
hIcon
[in] Gérez l’icône par défaut pour le nouveau panneau du ruban.
pRTI
[in] Pointeur vers les informations de classe runtime pour un panneau de ruban personnalisé.
Valeur de retour
Pointeur vers le nouveau panneau du ruban si la méthode a réussi ; sinon NULL si le panneau n’a pas été créé.
Notes
Si vous souhaitez créer un panneau de ruban personnalisé, vous devez spécifier ses informations de classe runtime dans pRTI. La classe de panneau de ruban personnalisé doit être dérivée de la CMFCRibbonPanel classe.
L’icône par défaut du panneau du ruban s’affiche lorsqu’il y a un espace insuffisant pour afficher les éléments du ruban.
Exemple
L’exemple suivant montre comment utiliser la AddPanel méthode dans la CMFCRibbonCategory classe.
// Create "Favorites" panel:
strTemp.LoadString(IDS_RIBBON_FAVORITES);
// CMFCRibbonCategory* pCategoryCustom
CMFCRibbonPanel *pPanelFavorites = pCategoryCustom->AddPanel(strTemp,
m_PanelImages.ExtractIcon(15));
CMFCRibbonCategory ::CMFCRibbonCategory
Construit et initialise un objet CMFCRibbonCategory .
CMFCRibbonCategory(
CMFCRibbonBar* pParenrRibbonBar,
LPCTSTR lpszName,
UINT uiSmallImagesResID,
UINT uiLargeImagesResID,
CSize sizeSmallImage = CSize(16,
16),
CSize sizeLargeImage = CSize(32,
32));
Paramètres
pParenrRibbonBar
[in] Pointeur vers la barre de ruban parente de la catégorie de ruban.
lpszName
[in] Nom de la catégorie de ruban.
uiSmallImagesResID
[in] ID de ressource de la liste d’images pour les petites images utilisées par les éléments du ruban dans la catégorie de ruban.
uiLargeImagesResID
[in] ID de ressource de la liste d’images pour les images volumineuses utilisées par les éléments du ruban dans la catégorie du ruban.
sizeSmallImage
[in] Taille par défaut des petites images pour les éléments du ruban dans la catégorie du ruban.
sizeLargeImage
[in] Taille par défaut des images volumineuses pour les éléments du ruban dans la catégorie du ruban.
CMFCRibbonCategory ::CopyFrom
Copie l’état du CMFCRibbonCategory spécifié dans l’objet CMFCRibbonCategory actuel.
virtual void CopyFrom(CMFCRibbonCategory& src);
Paramètres
src
[in] Objet source CMFCRibbonCategory .
Notes
CMFCRibbonCategory ::FindByData
Récupère l’élément du ruban associé aux données spécifiées.
CMFCRibbonBaseElement* FindByData(
DWORD_PTR dwData,
BOOL bVisibleOnly = TRUE) const;
Paramètres
dwData
[in] Données associées à un élément de ruban.
bVisibleOnly
[in] TRUE pour inclure des éléments de ruban d’accès rapide dans la recherche ; FALSE pour exclure les éléments du ruban d’accès rapide dans la recherche.
Valeur de retour
Pointeur vers un élément du ruban si la méthode a réussi ; sinon NULL.
Notes
CMFCRibbonCategory ::FindByID
Récupère l’élément du ruban associé à l’ID de commande spécifié.
CMFCRibbonBaseElement* FindByID(
UINT uiCmdID,
BOOL bVisibleOnly = TRUE) const;
Paramètres
uiCmdID
[in] ID de commande associé à un élément du ruban.
bVisibleOnly
[in] TRUE pour inclure des éléments de ruban d’accès rapide dans la recherche ; FALSE pour exclure les éléments du ruban d’accès rapide dans la recherche.
Valeur de retour
Pointeur vers un élément du ruban si la méthode a réussi ; sinon NULL.
Notes
CMFCRibbonCategory ::FindPanelWithElem
Récupère le panneau du ruban qui contient l’élément de ruban spécifié.
CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);
Paramètres
pElement
[in] Pointeur vers un élément du ruban.
Valeur de retour
Pointeur vers un panneau de ruban si la méthode a réussi ; sinon NULL.
Notes
CMFCRibbonCategory ::GetContextID
Récupère l’ID de contexte de la catégorie de ruban.
UINT GetContextID() const;
Valeur de retour
ID de contexte de la catégorie de ruban.
Notes
L’ID de contexte est 0 si la catégorie de ruban n’est pas une catégorie de ruban de contexte.
CMFCRibbonCategory ::GetData
Récupère les données définies par l’utilisateur associées à la catégorie de ruban.
DWORD_PTR GetData() const;
Valeur de retour
Données définies par l’utilisateur associées à la catégorie de ruban.
CMFCRibbonCategory ::GetDroppedDown
Récupère un pointeur vers l’élément du ruban dont le menu contextuel s’affiche actuellement.
CMFCRibbonBaseElement* GetDroppedDown();
Valeur de retour
Pointeur vers un élément du ruban si la méthode a réussi ; sinon NULL.
Notes
CMFCRibbonCategory ::GetElements
Récupère tous les éléments du ruban dans la catégorie du ruban.
void GetElements(
CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Paramètres
arElements
[in, out] Référence à un CArray d’éléments de ruban.
Notes
Les éléments du ruban conçus pour une utilisation dans la barre d’outils accès rapide sont inclus dans le tableau.
CMFCRibbonCategory ::GetElementsByID
Récupère tous les éléments du ruban associés à l’ID de commande spécifié.
void GetElementsByID(
UINT uiCmdID,
CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Paramètres
uiCmdID
[in] ID de commande associé à un élément du ruban.
arElements
[in, out] Référence à un CArray d’éléments de ruban.
Notes
Les éléments du ruban conçus pour une utilisation dans la barre d’outils accès rapide sont inclus dans le tableau.
CMFCRibbonCategory ::GetFirstVisibleElement
Récupère le premier élément visible qui appartient à la catégorie de ruban.
CMFCRibbonBaseElement* GetFirstVisibleElement() const;
Valeur de retour
Pointeur vers le premier élément visible ; peut être NULL si la catégorie n’a pas d’éléments visibles.
Notes
CMFCRibbonCategory ::GetFocused
Retourne un élément qui a le focus.
CMFCRibbonBaseElement* GetFocused();
Valeur de retour
Pointeur vers un élément prioritaire ou NULL.
Notes
CMFCRibbonCategory ::GetHighlighted
Retourne un élément mis en surbrillance.
CMFCRibbonBaseElement* GetHighlighted();
Valeur de retour
Pointeur vers un élément mis en surbrillance ou NULL si aucun élément n’est mis en surbrillance.
Notes
CMFCRibbonCategory ::GetImageCount
Récupère le nombre d’images dans la liste d’images spécifiée contenue dans la catégorie du ruban.
int GetImageCount(BOOL bIsLargeImage) const;
Paramètres
bIsLargeImage
[in] TRUE pour le nombre d’images dans la liste d’images volumineuses ; FALSE pour le nombre d’images dans la petite liste d’images.
Valeur de retour
Nombre d’images dans la liste d’images spécifiée.
Notes
CMFCRibbonCategory ::GetImageSize
Récupère la taille d’une image dans la liste d’images spécifiée contenue dans la catégorie de ruban.
CSize GetImageSize(BOOL bIsLargeImage) const;
Paramètres
bIsLargeImage
[in] TRUE pour la taille des images volumineuses ; FALSE pour la taille des petites images.
Valeur de retour
Taille d’une image dans la liste d’images spécifiée.
Notes
La taille récupérée inclut le facteur d’échelle d’image globale.
CMFCRibbonCategory ::GetItemIDsList
Récupère les ID de commande pour les éléments du ruban contenus dans la catégorie du ruban.
void GetItemIDsList(
CList<UINT, UINT>& lstItems,
BOOL bHiddenOnly = FALSE) const;
Paramètres
lstItems
[out] Liste des ID de commande pour les éléments du ruban dans la catégorie du ruban.
bHiddenOnly
[in] TRUE pour exclure les éléments du ruban affichés sur les panneaux du ruban de la catégorie de ruban ; FALSE pour inclure tous les éléments du ruban dans la catégorie du ruban.
Notes
CMFCRibbonCategory ::GetLargeImages
Récupère la liste des images volumineuses contenues dans la catégorie du ruban.
CMFCToolBarImages& GetLargeImages();
Valeur de retour
Liste des images volumineuses contenues dans la catégorie du ruban.
CMFCRibbonCategory ::GetLastVisibleElement
Récupère le dernier élément visible qui appartient à la catégorie de ruban.
CMFCRibbonBaseElement* GetLastVisibleElement() const;
Valeur de retour
Pointeur vers le dernier élément visible ; peut être NULL si la catégorie n’a aucun élément visible.
Notes
CMFCRibbonCategory ::GetMaxHeight
Récupère la hauteur maximale des panneaux du ruban contenus dans la catégorie du ruban.
int GetMaxHeight(CDC* pDC);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil pour les panneaux du ruban.
Valeur de retour
Hauteur maximale des panneaux du ruban contenus dans la catégorie du ruban.
Notes
La valeur récupérée inclut la hauteur des marges supérieures et inférieures des panneaux du ruban.
CMFCRibbonCategory ::GetName
Récupère le nom de la catégorie de ruban.
LPCTSTR GetName() const;
Valeur de retour
Nom de la catégorie de ruban.
Notes
CMFCRibbonCategory ::GetPanel
Retourne un pointeur vers le panneau du ruban situé à l’index spécifié.
CMFCRibbonPanel* GetPanel(int nIndex);
Paramètres
nIndex
[in] Index de base zéro d’un panneau de ruban.
Valeur de retour
Pointeur vers le panneau du ruban situé à l’index spécifié.
Notes
Une exception est levée si nIndex est hors limites.
CMFCRibbonCategory ::GetPanelCount
Retourne le nombre de panneaux de ruban dans la catégorie du ruban.
int GetPanelCount() const;
Valeur de retour
Nombre de panneaux de ruban dans la catégorie du ruban.
CMFCRibbonCategory ::GetPanelFromPoint
Récupère un pointeur vers un panneau de ruban si le point spécifié se trouve dans celui-ci.
CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;
Paramètres
point
[in] Coordonnées x et y du pointeur, par rapport au coin supérieur gauche de la fenêtre.
Valeur de retour
Pointeur vers un panneau de ruban si la méthode a réussi ; sinon NULL.
Notes
Seuls les panneaux de ruban contenus dans la catégorie de ruban sont testés.
CMFCRibbonCategory ::GetPanelIndex
Récupère l’index de base zéro du panneau de ruban spécifié.
int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;
Paramètres
pPanel
[in] Pointeur vers un panneau de ruban.
Valeur de retour
Index de base zéro du panneau de ruban spécifié si la méthode a réussi ; sinon -1.
Notes
Seuls les panneaux de ruban contenus dans la catégorie de ruban sont recherchés.
CMFCRibbonCategory ::GetParentButton
Récupère l’élément de ruban parent de la catégorie de ruban.
CMFCRibbonBaseElement* GetParentButton() const;
Valeur de retour
Retourne un pointeur vers l’élément du ruban parent, ou NULL s’il n’existe aucun élément parent.
Notes
CMFCRibbonCategory ::GetParentMenuBar
Retourne un pointeur vers la barre de menus parent de l’objet CMFCRibbonCategory .
CMFCRibbonPanelMenuBar* GetParentMenuBar() const;
Valeur de retour
Retourne le contenu du m_pParentMenuBar membre protégé.
Notes
CMFCRibbonCategory ::GetParentRibbonBar
Récupère la barre de ruban parente pour la catégorie de ruban.
CMFCRibbonBar* GetParentRibbonBar() const;
Valeur de retour
Pointeur vers la barre de ruban parente pour la catégorie de ruban.
Notes
CMFCRibbonCategory ::GetRect
Récupère le rectangle d’affichage de la catégorie de ruban.
CRect GetRect() const;
Valeur de retour
Rectangle d’affichage de la catégorie de ruban.
Notes
Le rectangle d’affichage de la catégorie de ruban n’inclut pas l’onglet Catégorie.
CMFCRibbonCategory ::GetSmallImages
Récupère la liste des petites images contenues dans la catégorie du ruban.
CMFCToolBarImages& GetSmallImages();
Valeur de retour
Liste des petites images contenues dans la catégorie du ruban.
CMFCRibbonCategory ::GetTabColor
Retourne la couleur actuelle de l’onglet catégorie de ruban.
AFX_RibbonCategoryColor GetTabColor() const;
Valeur de retour
Couleur actuelle de l’onglet catégorie du ruban.
Notes
La valeur retournée peut être l’une des valeurs énumérées suivantes :
AFX_CategoryColor_Red
AFX_CategoryColor_Orange
AFX_CategoryColor_Yellow
AFX_CategoryColor_Green
AFX_CategoryColor_Blue
AFX_CategoryColor_Indigo
AFX_CategoryColor_Violet
CMFCRibbonCategory ::GetTabRect
Récupère le rectangle d’affichage de l’onglet catégorie du ruban.
CRect GetTabRect() const;
Valeur de retour
Rectangle d’affichage de l’onglet Catégorie du ruban.
Notes
CMFCRibbonCategory ::GetTextTopLine
Récupère l’emplacement vertical du texte sur les boutons du ruban de la catégorie de ruban qui affichent des images volumineuses.
int GetTextTopLine() const;
Valeur de retour
Emplacement vertical du texte, en pixels, sur les boutons du ruban qui affichent de grandes images.
Notes
CMFCRibbonCategory ::GetVisibleElements
Récupère tous les éléments visibles appartenant à la catégorie de ruban.
void GetVisibleElements(
CArray <CMFCRibbonBaseElement*,
CMFCRibbonBaseElement*>& arElements);
Paramètres
arElements
Tableau de tous les éléments visibles.
Notes
CMFCRibbonCategory ::HighlightPanel
Met en surbrillance le panneau de ruban spécifié.
CMFCRibbonPanel* HighlightPanel(
CMFCRibbonPanel* pHLPanel,
CPoint point);
Paramètres
pHLPanel
[in] Pointeur vers le panneau du ruban pour mettre en surbrillance.
point
[in] Coordonnées x et y du pointeur, par rapport au coin supérieur gauche de la fenêtre.
Valeur de retour
Pointeur vers le panneau du ruban précédemment mis en surbrillance ; sinon, NULL si aucun panneau de ruban n’est mis en surbrillance lorsque cette méthode est appelée.
Notes
Pour plus d’informations sur la mise en surbrillance d’un panneau de ruban, consultez CMFCRibbonPanel ::Highlight.
CMFCRibbonCategory ::HitTest
Récupère un pointeur vers un élément de ruban si le point spécifié se trouve dans celui-ci.
CMFCRibbonBaseElement* HitTest(
CPoint point,
BOOL bCheckPanelCaption = FALSE) const;
Paramètres
point
[in] Coordonnées x et y du pointeur de la souris, par rapport au coin supérieur gauche de la fenêtre.
bCheckPanelCaption
[in] TRUE pour tester la légende du panneau du ruban ; FALSE pour exclure la légende du panneau du ruban.
Valeur de retour
Pointeur vers un élément du ruban si la méthode a réussi ; sinon NULL.
Notes
Seuls les éléments du ruban contenus dans la catégorie de ruban sont testés.
CMFCRibbonCategory ::HitTestEx
Récupère l’index de base zéro d’un élément de ruban si le point spécifié se trouve dans celui-ci.
int HitTestEx(CPoint point) const;
Paramètres
point
[in] Coordonnées x et y du pointeur de la souris, par rapport au coin supérieur gauche de la fenêtre.
Valeur de retour
Index de base zéro d’un élément de ruban si la méthode a réussi ; sinon -1.
Notes
Seuls les éléments du ruban contenus dans la catégorie de ruban sont testés.
CMFCRibbonCategory ::HitTestScrollButtons
Si un point se trouve dans le bouton de défilement gauche ou droit d’une catégorie de ruban, retourne un pointeur vers ce bouton.
CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;
Paramètres
point
[in] Point à tester.
Valeur de retour
Si le point se trouve dans le rectangle englobant du bouton de défilement gauche ou droit de la catégorie du ruban, retourne un pointeur vers ce bouton, ou sinon, retourne NULL.
Notes
CMFCRibbonCategory ::IsActive
Indique si la catégorie du ruban est la catégorie active dans la barre du ruban.
BOOL IsActive() const;
Valeur de retour
TRUE si la catégorie du ruban est la catégorie active ; sinon FALSE.
Notes
La catégorie de ruban active affiche ses panneaux de ruban.
CMFCRibbonCategory ::IsVisible
Indique si la catégorie du ruban est visible.
BOOL IsVisible() const;
Valeur de retour
TRUE si la catégorie du ruban est visible ; sinon FALSE.
Notes
Les catégories de ruban visibles affichent un onglet catégorie.
CMFCRibbonCategory ::IsWindows7Look
Indique si le ruban parent a l’apparence de Windows 7 (petit bouton d’application rectangulaire).
BOOL IsWindows7Look() const;
Valeur de retour
TRUE si le ruban parent a l’apparence de Windows 7 ; sinon FALSE.
Notes
CMFCRibbonCategory ::NotifyControlCommand
Remet un message de commande WM_NOTIFY à tous les CMFCRibbonPanel éléments du CMFCRibbonCategory message jusqu’à ce que le message soit géré.
virtual BOOL NotifyControlCommand(
BOOL bAccelerator,
int nNotifyCode,
WPARAM wParam,
LPARAM lParam);
Paramètres
bAccelerator
[in] TRUE si cette commande provient d’un accélérateur ou false sinon.
nNotifyCode
[in] Code de notification.
wParam
[in] Champ WPARAM du message.
lParam
[in] Champ LPARAM du message.
Valeur de retour
Retourne TRUE si le message a été géré, ou FALSE si ce n’est pas le cas.
Notes
CMFCRibbonCategory ::OnCancelMode
Appelle le mode d’annulation dans tous les CMFCRibbonPanel éléments du CMFCRibbonCategory.
virtual void OnCancelMode();
Notes
CMFCRibbonCategory ::OnDraw
Appelé par l’infrastructure pour dessiner la catégorie de ruban.
virtual void OnDraw(CDC* pDC);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil pour la catégorie de ruban.
Notes
CMFCRibbonCategory ::OnDrawImage
Appelé par l’infrastructure pour dessiner l’image spécifiée sur la catégorie de ruban.
virtual BOOL OnDrawImage(
CDC* pDC,
CRect rect,
CMFCRibbonBaseElement* pElement,
BOOL bIsLargeImage,
BOOL nImageIndex,
BOOL bCenter);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil pour l’image.
rect
[in] Afficher le rectangle de l’image.
pElement
[in] Pointeur vers l’élément du ruban qui contient l’image.
bIsLargeImage
[in] TRUE si l’image est de grande taille ; FALSE si l’image est la petite taille.
nImageIndex
[in] Index de base zéro de l’image dans le tableau d’images contenu dans la catégorie du ruban.
bCenter
[in] TRUE pour centrer l’image dans le rectangle d’affichage ; FALSE pour dessiner l’image dans le coin supérieur gauche du rectangle d’affichage.
Valeur de retour
TRUE si la méthode a réussi ; sinon FALSE.
Notes
CMFCRibbonCategory ::OnDrawMenuBorder
Appelé par l’infrastructure pour dessiner la bordure d’un menu contextuel.
virtual void OnDrawMenuBorder(
CDC* pDC,
CMFCRibbonPanelMenuBar* pMenuBar);
Paramètres
pDC
[in] Ce paramètre n’est pas utilisé.
pMenuBar
[in] Ce paramètre n’est pas utilisé.
Notes
Par défaut, cette méthode ne fait rien. Remplacez cette méthode pour dessiner la bordure d’un menu contextuel.
CMFCRibbonCategory ::OnKey
Appelé par l’infrastructure lorsqu’un utilisateur appuie sur un bouton clavier.
virtual BOOL OnKey(UINT nChar);
Paramètres
nChar
Code de clé virtuelle pour la touche qu’un utilisateur a appuyé.
Notes
CMFCRibbonCategory ::OnLButtonDown
Appelé par l’infrastructure pour récupérer l’élément du ruban sous le point spécifié lorsque l’utilisateur appuie sur le bouton gauche de la souris.
virtual CMFCRibbonBaseElement* OnLButtonDown(CPoint point);
Paramètres
point
[in] Coordonnées x et y du pointeur de la souris, par rapport au coin supérieur gauche de la fenêtre.
Valeur de retour
Pointeur vers un élément du ruban si la méthode a réussi ; sinon NULL.
Notes
CMFCRibbonCategory ::OnLButtonUp
Appelé par l’infrastructure lorsque l’utilisateur relâche le bouton gauche de la souris et que le pointeur se trouve sur la catégorie du ruban.
virtual void OnLButtonUp(CPoint point);
Paramètres
point
[in] Coordonnées x et y du pointeur, par rapport au coin supérieur gauche de la fenêtre.
Notes
CMFCRibbonCategory ::OnMouseMove
Appelé par l’infrastructure lorsque le pointeur se déplace sur la barre du ruban afin de mettre à jour l’affichage de la catégorie du ruban.
virtual void OnMouseMove(CPoint point);
Paramètres
point
[in] Coordonnées x et y du pointeur, par rapport au coin supérieur gauche de la fenêtre.
Notes
CMFCRibbonCategory ::OnRTLChanged
Appelé par l’infrastructure lorsque la disposition change de direction.
virtual void OnRTLChanged(BOOL bIsRTL);
Paramètres
bIsRTL
[in] TRUE si la disposition est de droite à gauche ; FALSE si la disposition est de gauche à droite.
Notes
Cette méthode ajuste la disposition de tous les panneaux de ruban et éléments du ruban contenus dans la catégorie du ruban.
CMFCRibbonCategory ::OnScrollHorz
Fait défiler la catégorie du ruban dans le sens horizontal.
virtual BOOL OnScrollHorz(
BOOL bScrollLeft,
int nScrollOffset = 0);
Paramètres
bScrollLeft
[in] TRUE pour faire défiler vers la gauche ; FALSE pour faire défiler vers la droite.
nScrollOffset
[in] Distance de défilement en pixels.
Valeur de retour
TRUE si la catégorie de ruban a été déplacée dans une direction horizontale ; sinon FALSE.
Notes
CMFCRibbonCategory ::OnUpdateCmdUI
Appelle la OnUpdateCmdUI fonction membre dans chacun des CMFCRibbonPanel éléments de l’élément CMFCRibbonCategory pour activer ou désactiver les éléments de l’interface utilisateur dans ces éléments.
virtual void OnUpdateCmdUI(
CMFCRibbonCmdUI* pCmdUI,
CFrameWnd* pTarget,
BOOL bDisableIfNoHndler);
Paramètres
pCmdUI
[in] Pointeur vers l’objet CMFCRibbonCmdUI qui spécifie les éléments d’interface utilisateur à activer et à désactiver.
pTarget
[in] Pointeur vers la fenêtre qui contrôle l’activation ou la désactivation des éléments de l’interface utilisateur.
bDisableIfNoHndler
[in] TRUE pour désactiver l’élément d’interface utilisateur si aucun gestionnaire n’est défini dans une carte de messages ; sinon, FALSE.
Notes
CMFCRibbonCategory ::RecalcLayout
Ajuste la disposition de tous les contrôles de la catégorie du ruban.
virtual void RecalcLayout(CDC* pDC);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil pour la catégorie de ruban.
Notes
CMFCRibbonCategory ::RemovePanel
Supprime un panneau de ruban de la catégorie de ruban.
BOOL RemovePanel(
int nIndex,
BOOL bDelete = TRUE);
Paramètres
nIndex
[in] Numéro d’index du panneau à supprimer. Obtenu en appelant la méthode CMFCRibbonCategory ::GetPanelIndex .
bDelete
[in] TRUE pour supprimer l’objet panneau de la mémoire ; FALSE pour supprimer l’objet panneau sans le supprimer.
Valeur de retour
TRUE si la méthode a réussi ; sinon, FALSE.
CMFCRibbonCategory ::ReposPanels
Ajuste la disposition de tous les contrôles des panneaux du ruban contenus dans la catégorie du ruban.
virtual void ReposPanels(CDC* pDC);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil pour les panneaux du ruban contenus dans la catégorie du ruban.
Notes
CMFCRibbonCategory ::SetCollapseOrder
Définit l’ordre dans lequel les panneaux du ruban de la catégorie de ruban sont réduits.
void SetCollapseOrder(const CArray<int,int>& arCollapseOrder);
Paramètres
arCollapseOrder
[in] Spécifie l’ordre de réduction. Le tableau contient des index de base zéro des panneaux de ruban.
Notes
La bibliothèque définit l’ordre de réduction. Toutefois, vous pouvez personnaliser ce comportement en fournissant la catégorie avec la liste des index qui spécifie l’ordre de réduction.
Lorsque la catégorie détecte qu’elle doit réduire un panneau de ruban, elle recherche l’élément suivant dans la liste spécifiée. Si la liste est vide ou si vous n’avez pas spécifié suffisamment d’éléments, la catégorie utilise l’algorithme interne.
Par exemple, la catégorie comporte trois panneaux de ruban et peut être réduite plusieurs fois jusqu’à ce que tous les panneaux soient à l’état entièrement réduit. Vous pouvez définir l’ordre de réduction suivant : 0, 0, 2, 2. Dans ce cas, la catégorie réduit le panneau 0 deux fois, le panneau 2 fois. Le panneau qui a l’index 1 reste noncollé.
Exemple
L’exemple suivant montre comment utiliser la SetCollapseOrder méthode dans la CMFCRibbonCategory classe. L’exemple montre comment construire un tableau pour l’ordre de réduction et comment définir l’ordre de réduction sur la catégorie du ruban.
CArray<int, int> arCollapseOrder;
arCollapseOrder.Add(0);
arCollapseOrder.Add(1);
arCollapseOrder.Add(2);
// CMFCRibbonCategory* pCategoryHome
pCategoryHome->SetCollapseOrder(arCollapseOrder);
CMFCRibbonCategory ::SetData
Définit les données définies par l’utilisateur à associer à la catégorie de ruban.
void SetData(DWORD_PTR dwData);
Paramètres
dwData
[in] Données définies par l’utilisateur.
CMFCRibbonCategory ::SetKeys
Affecte une info-bulle à la catégorie du ruban.
void SetKeys(LPCTSTR lpszKeys);
Paramètres
lpszKeys
[in] Texte de l’info-bulle.
Notes
Les touches sont affichées lorsque l’utilisateur appuie sur la touche Alt ou la touche F10.
CMFCRibbonCategory ::SetName
Affecte un nom et une info-bulle à la catégorie du ruban.
void SetName(LPCTSTR lpszName);
Paramètres
lpszName
[in] Nom et info-bulle de la catégorie de ruban.
Notes
Pour définir l’info-bulle de la catégorie de ruban, ajoutez une séquence d’échappement de ligne de ligne suivie des caractères d’info-bulle à lpszName.
CMFCRibbonCategory ::SetTabColor
Définit la couleur de la catégorie de ruban.
void SetTabColor(AFX_RibbonCategoryColor color);
Paramètres
color
[in] Spécifie la nouvelle couleur de la catégorie de ruban.
Notes
La couleur peut être l’une des valeurs suivantes :
AFX_CategoryColor_None
AFX_CategoryColor_Red
AFX_CategoryColor_Orange
AFX_CategoryColor_Yellow
AFX_CategoryColor_Green
AFX_CategoryColor_Blue
AFX_CategoryColor_Indigo
AFX_CategoryColor_Violet