CMFCRibbonGallery, classe
Implémente les galeries de ruban de style Office 2007. Pour plus d’informations, consultez le code source situé dans le dossier VC\atlmfc\src\mfc de votre installation de Visual Studio.
Syntaxe
class CMFCRibbonGallery : public CMFCRibbonButton
Membres
Constructeurs publics
| Nom | Description |
|---|---|
| CMFCRibbonGallery ::CMFCRibbonGallery | Construit et initialise un objet CMFCRibbonGallery. |
Méthodes publiques
| Nom | Description |
|---|---|
| CMFCRibbonGallery ::AddGroup | Ajoute un nouveau groupe à la galerie. |
| CMFCRibbonGallery ::AddSubItem | Ajoute un nouvel élément de menu au menu déroulant. |
| CMFCRibbonGallery ::Clear | Efface le contenu de la galerie. |
| CMFCRibbonGallery ::EnableMenuResize | Active ou désactive le redimensionnement du panneau de menus. |
| CMFCRibbonGallery ::EnableMenuSideBar | Active ou désactive la barre latérale à gauche du menu contextuel. |
| CMFCRibbonGallery ::GetCompactSize | (Remplacements CMFCRibbonButton ::GetCompactSize.) |
| CMFCRibbonGallery ::GetDroppedDown | (Remplacements CMFCRibbonBaseElement ::GetDroppedDown.) |
| CMFCRibbonGallery ::GetGroupName | Retourne le nom du groupe situé à l’index spécifié. |
| CMFCRibbonGallery ::GetGroupOffset | |
| CMFCRibbonGallery ::GetIconsInRow | Retourne le nombre d’éléments d’une ligne de la galerie de rubans. |
| CMFCRibbonGallery ::GetItemToolTip | Retourne le texte d’info-bulle associé à un élément de la galerie. |
| CMFCRibbonGallery ::GetLastSelectedItem | Retourne l’index du dernier élément de la galerie que l’utilisateur a sélectionné. |
| CMFCRibbonGallery ::GetPaletteID | Retourne l’ID de commande de la galerie active. |
| CMFCRibbonGallery ::GetRegularSize | (Remplacements CMFCRibbonButton ::GetRegularSize.) |
| CMFCRibbonGallery ::GetSelectedItem | |
| CMFCRibbonGallery ::HasMenu | (Remplacements CMFCRibbonButton ::HasMenu.) |
| CMFCRibbonGallery ::IsButtonMode | Spécifie si la galerie est contenue dans un bouton de galerie. |
| CMFCRibbonGallery ::IsMenuResizeEnabled | Spécifie si le redimensionnement du menu est activé ou désactivé. |
| CMFCRibbonGallery ::IsMenuResizeVertical | |
| CMFCRibbonGallery ::IsMenuSideBar | Spécifie si la barre latérale est activée ou désactivée. |
| CMFCRibbonGallery ::OnAfterChangeRect | (Substitue CMFCRibbonButton::OnAfterChangeRect.) |
| CMFCRibbonGallery ::OnDraw | (Remplacements CMFCRibbonButton ::OnDraw.) |
| CMFCRibbonGallery ::OnEnable | (Substitue CMFCRibbonBaseElement::OnEnable.) |
| CMFCRibbonGallery ::OnRTLChanged | (Remplacements CMFCRibbonBaseElement ::OnRTLChanged.) |
| CMFCRibbonGallery ::RedrawIcons | Redessine la galerie. |
| CMFCRibbonGallery ::RemoveItemTool Astuces | Supprime les info-bulles de tous les éléments de la galerie. |
| CMFCRibbonGallery ::SelectItem | |
| CMFCRibbonGallery ::SetACCData | (Remplacements CMFCRibbonButton ::SetACCData.) |
| CMFCRibbonGallery ::SetButtonMode | Spécifie s’il faut afficher la galerie de rubans en tant que bouton déroulant ou en tant que palette directement sur le ruban. |
| CMFCRibbonGallery ::SetGroupName | Définit le nom d’un groupe. |
| CMFCRibbonGallery ::SetIconsInRow | Définit le nombre d’éléments par ligne dans la galerie. |
| CMFCRibbonGallery ::SetItemToolTip | Définit le texte d’info-bulle d’un élément dans la galerie. |
| CMFCRibbonGallery ::SetPalette | Attache une palette à une galerie de rubans. |
| CMFCRibbonGallery ::SetPaletteID | Définit l’ID de commande envoyé dans le message WM_COMMAND lorsqu’un élément de galerie a été sélectionné. |
Méthodes protégées
| Nom | Description |
|---|---|
| CMFCRibbonGallery ::OnDrawPaletteIcon | Appelé par l’infrastructure lorsqu’une icône de galerie est dessinée. |
Notes
Un bouton de galerie se comporte comme un bouton de menu normal, sauf qu’il affiche une galerie lorsqu’un utilisateur l’ouvre. Lorsque vous sélectionnez un élément dans une galerie, l’infrastructure envoie le message WM_COMMAND avec l’ID de commande du bouton. Lorsque vous gérez le message, vous devez appeler CMFCRibbonGallery ::GetLastSelectedItem pour déterminer l’élément sélectionné dans la galerie.
Exemple
L’exemple suivant montre comment utiliser différentes méthodes dans la CMFCRibbonGallery classe pour configurer un CMFCRibbonGallery objet. L’exemple montre comment spécifier le nombre d’éléments par ligne dans la galerie, activer le redimensionnement du panneau de menus, activer la barre latérale à gauche du menu contextuel et afficher la galerie de ruban en tant que palette directement sur la barre du ruban. Cet extrait de code fait partie de l’ exemple Draw Client.
CMFCRibbonGallery *pBtnStyles = new CMFCRibbonGallery(ID_OBJECT_STYLES, _T("Styles\nk"), 0, 0, IDB_STYLES, 40);
pBtnStyles->SetIconsInRow(7);
pBtnStyles->EnableMenuResize(TRUE, TRUE);
pBtnStyles->EnableMenuSideBar();
pBtnStyles->SetButtonMode(false);
pBtnStyles->RedrawIcons();
Hiérarchie d'héritage
CObject
└ CMFCRibbonBaseElement
└ CMFCRibbonButton
└ CMFCRibbonGallery
Spécifications
En-tête : afxRibbonPaletteGallery.h
CMFCRibbonGallery ::AddGroup
Ajoute un nouveau groupe à la galerie.
void AddGroup(
LPCTSTR lpszGroupName,
UINT uiImagesPaletteResID,
int cxPaletteImage);
void AddGroup(
LPCTSTR lpszGroupName,
CMFCToolBarImages& imagesGroup);
void AddGroup(
LPCTSTR lpszGroupName,
int nIconsNum);
Paramètres
lpszGroupName
[in] Spécifie le nom du groupe.
uiImagesPaletteResID
[in] Spécifie l’ID de ressource de la liste d’images qui contient les images du groupe.
cxPaletteImage
[in] Spécifie la largeur en pixels d’une image.
imagesGroup
[in] Référence à la liste d’images qui contient des images de groupe.
nIconsNum
[in] Spécifie le nombre d’icônes dans le groupe. Ce paramètre doit être spécifié uniquement pour les groupes personnalisés (propriétaires dessinés).
Notes
Vous pouvez diviser les éléments d’une galerie de rubans en plusieurs groupes en appelant cette méthode. Chaque groupe peut avoir un légende.
CMFCRibbonGallery ::AddSubItem
Ajoute un nouvel élément de menu au menu déroulant.
void AddSubItem(
CMFCRibbonBaseElement* pSubItem,
int nIndex=-1,
BOOL bOnTop=FALSE);
Paramètres
pSubItem
[in] Pointeur vers l’élément à ajouter au menu.
nIndex
[in] Spécifie l’index de base zéro d’un emplacement où insérer l’élément.
bOnTop
[in] TRUE pour spécifier que l’élément doit être inséré avant la galerie de rubans ; sinon, FALSE.
Notes
Vous pouvez combiner des galeries contextuelles avec des éléments de menu contextuel en appelant cette méthode. Les éléments de menu peuvent être placés avant ou après la galerie.
Pour insérer l’élément avant la galerie, définissez bOnTop sur TRUE. Définissez bOnTop sur FALSE pour insérer l’élément sous la galerie.
Remarque
Le paramètre nIndex spécifie l’index d’insertion en haut de la galerie et en bas de la galerie. Par exemple, si vous devez insérer un élément à une position avant la galerie, définissez nIndex sur 1 et bOnTop sur TRUE. De même, si vous devez insérer un élément en dessous de la galerie, définissez nIndex sur 1 et bOnTop sur FALSE.
CMFCRibbonGallery ::Clear
Efface le contenu de la galerie.
virtual void Clear();
Notes
Appelez cette méthode pour supprimer tout le contenu de la galerie de rubans. Cette opération doit être effectuée avant d’attacher une nouvelle galerie de rubans ou un ensemble de groupes à la galerie de rubans.
CMFCRibbonGallery ::CMFCRibbonGallery
Construit et initialise un objet CMFCRibbonGallery .
CMFCRibbonGallery (
UINT nID,
LPCTSTR lpszText,
int nSmallImageIndex,
int nLargeImageIndex,
CMFCToolBarImages& imagesPalette);
CMFCRibbonGallery (
UINT nID,
LPCTSTR lpszText,
int nSmallImageIndex,
int nLargeImageIndex,
UINT uiImagesPaletteResID=0,
int cxPaletteImage=0);
CMFCRibbonGallery (
UINT nID,
LPCTSTR lpszText,
int nSmallImageIndex,
int nLargeImageIndex,
CSize sizeIcon,
int nIconsNum,
BOOL bDefaultButtonStyle=TRUE);
Paramètres
nID
Spécifie l’ID de commande de la commande à exécuter lorsqu’un utilisateur clique sur le bouton.
lpszText
Spécifie le texte à afficher sur le bouton.
nSmallImageIndex
Index de base zéro de la petite image à afficher sur le bouton.
nLargeImageIndex
Index de base zéro de l’image volumineuse à afficher sur le bouton.
imagesPalette
Référence à l’objet CMFCToolBarImages qui contient les images à afficher dans la galerie.
uiImagesPaletteResID
ID de ressource de la liste des images à afficher dans la galerie.
cxPaletteImage
Spécifie la largeur, en pixels, de l’image sur la galerie.
sizeIcon
Spécifie la taille, en pixels, de l’image de la galerie.
nIconsNum
Spécifie le nombre d’icônes dans la galerie.
bDefaultButtonStyle
Spécifie s’il faut utiliser le style de bouton par défaut ou dessiné par le propriétaire.
Notes
CMFCRibbonGallery ::EnableMenuResize
Active ou désactive le redimensionnement du panneau de menus.
void EnableMenuResize(
BOOL bEnable = TRUE,
BOOL bVertcalOnly = FALSE);
Paramètres
bEnable
[in] TRUE pour activer le redimensionnement du menu ; sinon, FALSE.
bVertcalOnly
[in] TRUE pour spécifier que la galerie ne peut être redimensionnée que verticalement ; FALSE pour spécifier que la galerie peut être redimensionnée verticalement et horizontalement.
Notes
Utilisez cette méthode pour activer ou désactiver le redimensionnement de la galerie de rubans. Lorsque le redimensionnement est activé, la galerie de rubans affiche un gripper qu’un utilisateur peut utiliser pour le redimensionner.
CMFCRibbonGallery ::EnableMenuSideBar
Active ou désactive la barre latérale à gauche du menu contextuel.
void EnablMenuSideBar(BOOL bEnable=TRUE);
Paramètres
bEnable
[in] TRUE pour spécifier que la barre latérale est activée ; sinon, FALSE.
Notes
Appelez cette méthode pour activer ou désactiver la barre latérale de style XP Bureau à gauche du menu.
CMFCRibbonGallery ::GetCompactSize
virtual CSize GetCompactSize(CDC* pDC);
Paramètres
[in] Pdc
Valeur de retour
Notes
CMFCRibbonGallery ::GetDroppedDown
virtual CMFCRibbonBaseElement* GetDroppedDown();
Valeur de retour
Notes
CMFCRibbonGallery ::GetGroupName
Retourne le nom du groupe situé à l’index spécifié.
LPCTSTR GetGroupName(int nGroupIndex) const;
Paramètres
nGroupIndex
[in] Spécifie l’index de base zéro pour le groupe dont vous souhaitez récupérer le nom.
Valeur de retour
Nom du groupe situé à l’index spécifié. Le passage d’un index non valide entraîne une assertion ayant échoué.
Notes
CMFCRibbonGallery ::GetGroupOffset
virtual int GetGroupOffset() const;
Valeur de retour
Notes
CMFCRibbonGallery ::GetIconsInRow
Retourne le nombre d’éléments d’une ligne de la galerie de rubans.
int GetIconsInRow() const;
Valeur de retour
Nombre d’éléments d’une ligne.
Notes
CMFCRibbonGallery ::GetItemToolTip
Retourne le texte d’info-bulle associé à un élément de la galerie.
LPCTSTR GetItemToolTip(int nItemIndex) const;
Paramètres
nItemIndex
[in] Spécifie l’index de base zéro de l’élément pour lequel récupérer le texte de l’info-bulle.
Valeur de retour
Pointeur vers la chaîne d’info-bulle affectée à un élément dans la galerie de rubans. Elle peut être NULL si aucune info-bulle n’est affectée à cet élément.
Notes
CMFCRibbonGallery ::GetLastSelectedItem
Retourne l’index du dernier élément de la galerie de ruban que l’utilisateur a sélectionné.
static int GetLastSelectedItem(UINT uiCmdID);
Paramètres
uiCmdID
[in] Spécifie l’ID de commande de l’élément de menu qui a ouvert la galerie de rubans.
Valeur de retour
Lorsque l’utilisateur sélectionne un élément dans la galerie de rubans, la bibliothèque envoie le message WM_COMMAND ainsi que l’ID de commande du bouton de menu qui a ouvert la galerie de rubans.
Notes
CMFCRibbonGallery ::GetPaletteID
Retourne l’ID de commande de la palette active.
int GetPaletteID() const;
Valeur de retour
ID de commande de la palette actuellement sélectionnée.
Notes
CMFCRibbonGallery ::GetRegularSize
virtual CSize GetRegularSize(CDC* pDC);
Paramètres
[in] Pdc
Valeur de retour
Notes
CMFCRibbonGallery ::GetSelectedItem
int GetSelectedItem() const;
Valeur de retour
Notes
CMFCRibbonGallery ::HasMenu
virtual BOOL HasMenu() const;
Valeur de retour
Notes
CMFCRibbonGallery ::IsButtonMode
Spécifie si la palette est contenue dans un bouton de galerie.
BOOL IsButtonMode() const;
Valeur de retour
TRUE si la palette est affichée sous la forme d’un bouton de menu déroulant ; FALSE si la palette est affichée directement sur le ruban.
Notes
CMFCRibbonGallery ::IsMenuResizeEnabled
Spécifie si le redimensionnement du menu est activé.
BOOL IsMenuResizeEnabled() const;
Valeur de retour
TRUE si le redimensionnement du menu a été activé ; sinon, FALSE.
Notes
CMFCRibbonGallery ::IsMenuResizeVertical
BOOL IsMenuResizeVertical() const;
Valeur de retour
Notes
CMFCRibbonGallery ::IsMenuSideBar
Spécifie si la barre latérale est activée ou désactivée.
BOOL IsMenuSideBar() const;
Valeur de retour
TRUE si la barre latérale de style XP Bureau est dessinée à gauche du menu contextuel ; sinon, FALSE.
Notes
CMFCRibbonGallery ::OnAfterChangeRect
virtual void OnAfterChangeRect(CDC* pDC);
Paramètres
[in] Pdc
Notes
CMFCRibbonGallery ::OnDraw
virtual void OnDraw(CDC* pDC);
Paramètres
[in] Pdc
Notes
CMFCRibbonGallery ::OnDrawPaletteIcon
Appelé par l’infrastructure lorsqu’une icône de galerie est dessinée.
virtual void OnDrawPaletteIcon(
CDC* pDC,
CRect rectIcon,
int nIconIndex,
CMFCRibbonGalleryIcon* pIcon,
COLORREF clrText);
Paramètres
pDC
[in] Pointeur vers le contexte de l’appareil utilisé pour le dessin.
rectIcon
[in] Spécifie le rectangle englobant de l’icône à dessiner.
nIconIndex
[in] Spécifie l’index de base zéro dans la liste d’images des icônes de galerie de l’icône à dessiner.
Picon
[in] Pointeur vers l’icône dessinée.
clrText
[in] Spécifie la couleur du texte de l’élément à dessiner.
Notes
Vous pouvez remplacer cette méthode dans une classe dérivée pour personnaliser l’apparence d’une galerie de rubans.
CMFCRibbonGallery ::OnEnable
virtual void OnEnable(BOOL bEnable);
Paramètres
[in] bEnable
Notes
CMFCRibbonGallery ::OnRTLChanged
virtual void OnRTLChanged(BOOL bIsRTL);
Paramètres
[in] bIsRTL
Notes
CMFCRibbonGallery ::RedrawIcons
Redessine la galerie.
void RedrawIcons();
Notes
Appelez cette fonction pour redessiner la galerie. Vous devez appeler cette méthode si vous avez modifié le contenu de la galerie au moment de l’exécution.
CMFCRibbonGallery ::RemoveItemTool Astuces
Supprime les info-bulles de tous les éléments de la galerie.
void RemoveItemToolTips();
Notes
CMFCRibbonGallery ::SelectItem
void SelectItem(int nItemIndex);
Paramètres
[in] nItemIndex
Notes
CMFCRibbonGallery ::SetACCData
Remplit l’objet CAccessibilityData spécifié avec des données d’accessibilité à partir de la galerie du ruban.
virtual BOOL SetACCData(
CWnd* pParent,
CAccessibilityData& data);
Paramètres
pParent
[in] Fenêtre parente de la fenêtre de la galerie de rubans.
data
[out] Objet CAccessibilityData qui reçoit les données d’accessibilité de la galerie de rubans.
Valeur de retour
Notes
TRUE si la méthode réussit ; sinon, FALSE.
CMFCRibbonGallery ::SetButtonMode
Détermine s’il faut afficher la galerie de rubans en tant que bouton déroulant ou en tant que palette directement sur le ruban.
void SetButtonMode(BOOL bSet=TRUE);
Paramètres
bSet
[in] TRUE pour afficher la galerie de rubans sous la forme d’un bouton de menu déroulant ; FALSE pour afficher le contenu de la galerie de rubans directement sur le ruban.
Notes
CMFCRibbonGallery ::SetGroupName
Définit le nom d’un groupe.
void SetGroupName(
int nGroupIndex,
LPCTSTR lpszGroupName);
Paramètres
nGroupIndex
[in] Spécifie l’index de base zéro pour le groupe pour lequel le nom est modifié.
lpszGroupName
[in] Spécifie le nouveau nom du groupe.
Notes
Le groupe dont le nom est modifié doit avoir été ajouté à l’aide de la méthode CMFCRibbonGallery ::AddGroup .
CMFCRibbonGallery ::SetIconsInRow
Spécifie le nombre d’éléments par ligne dans la galerie.
void SetIconsInRow(int nIconsInRow);
Paramètres
nIconsInRow
[in] Spécifie le nombre d’éléments à afficher dans chaque ligne de la galerie.
Notes
Utilisez cette méthode pour spécifier la largeur de la galerie de rubans.
CMFCRibbonGallery ::SetItemToolTip
Définit le texte d’info-bulle d’un élément dans la galerie.
void SetItemToolTip(
int nItemIndex,
LPCTSTR lpszToolTip);
Paramètres
nItemIndex
[in] Index de base zéro de l’élément de palette auquel associer l’info-bulle.
lpszToolTip
[in] Texte à afficher sur l’info-bulle.
Notes
CMFCRibbonGallery ::SetPalette
Attache une palette à une galerie de rubans.
void SetPalette(CMFCToolBarImages& imagesPalette);
void SetPalette(
UINT uiImagesPaletteResID,
int cxPaletteImage);
Paramètres
imagesPalette
[in] Spécifie la liste d’images qui contient les icônes à afficher dans la galerie.
uiImagesPaletteResID
[in] Spécifie l’ID de ressource de la liste d’images qui contient les icônes à afficher dans la galerie.
cxPaletteImage
[in] Spécifie la largeur, en pixels, d’une image sur la galerie.
Notes
CMFCRibbonGallery ::SetPaletteID
Définit l’ID de commande envoyé dans le message WM_COMMAND lorsqu’un utilisateur sélectionne un élément de galerie.
void SetPaletteID(UINT nID);
Paramètres
nID
[in] Spécifie l’ID de commande envoyé dans le message WM_COMMAND lorsqu’un utilisateur sélectionne un élément de galerie.
Notes
Pour déterminer l’élément spécifique sélectionné par un utilisateur dans la galerie, appelez la méthode statique CMFCRibbonGallery ::GetLastSelectedItem .
Voir aussi
Graphique hiérarchique
Classes
CMFCRibbonButton, classe
CMFCRibbonGalleryMenuButton, classe
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour