CMFCRibbonColorButton, classe

La classe CMFCRibbonColorButton implémente un bouton de couleur que vous pouvez ajouter à une barre de ruban. Le bouton de couleur du ruban affiche un menu déroulant qui contient une ou plusieurs palettes de couleurs.

Syntaxe

class CMFCRibbonColorButton : public CMFCRibbonGallery

Membres

Constructeurs publics

Méthodes publiques

Notes

Le bouton de couleur du ruban affiche une barre de couleurs quand un utilisateur clique dessus. Par défaut, cette barre de couleurs contient une palette de sélection de couleurs appelée zone de couleur normale. Si vous le souhaitez, la barre de couleurs peut afficher un bouton Automatique , qui permet à l’utilisateur de sélectionner une couleur par défaut, et un bouton Autres qui affiche une palette de couleurs contextuelle qui contient des couleurs supplémentaires.

Exemple

L’exemple suivant montre comment utiliser différentes méthodes de la classe CMFCRibbonColorButton . L’exemple montre comment construire un objet CMFCRibbonColorButton , définir l’image de grande taille, activez le bouton Automatique , activer le bouton Autres , définir le nombre de colonnes, définir la taille de tous les éléments de couleur qui apparaissent sur la barre de couleurs, ajouter un groupe de couleurs à la zone de couleur normale et spécifier une liste de valeurs RVB à afficher dans la zone de couleur du document. Cet extrait de code fait partie de l’ exemple Draw Client.

// Create the "Paper Color" button
CMFCRibbonColorButton *pBtnPaperColor = new CMFCRibbonColorButton(ID_VIEW_PAPERCOLOR, _T("Paper Color\ng"), TRUE, 13, 1);
pBtnPaperColor->SetAlwaysLargeImage();
pBtnPaperColor->EnableAutomaticButton(_T("&Automatic"), RGB(255, 255, 255));
pBtnPaperColor->EnableOtherButton(_T("&More Colors..."), _T("More Colors"));
pBtnPaperColor->SetColumns(10);
pBtnPaperColor->SetColorBoxSize(CSize(17, 17));
// CList<COLORREF,COLORREF> m_lstMainColors
pBtnPaperColor->AddColorsGroup(_T("Theme Colors"), m_lstMainColors, TRUE);
// CList<COLORREF,COLORREF> m_lstAdditionalColors
pBtnPaperColor->AddColorsGroup(_T(""), m_lstAdditionalColors, FALSE);
// CList<COLORREF,COLORREF> m_lstStandardColors
pBtnPaperColor->AddColorsGroup(_T("Standard Colors"), m_lstStandardColors, TRUE);
CList<COLORREF, COLORREF> lstColors;
lstColors.AddTail(RGB(255, 0, 0));
lstColors.AddTail(RGB(0, 255, 0));
lstColors.AddTail(RGB(0, 0, 255));
pBtnPaperColor->SetDocumentColors(_T("Document Colors"), lstColors);

Hiérarchie d'héritage

CObject

CMFCRibbonBaseElement

CMFCRibbonButton

CMFCRibbonGallery

CMFCRibbonColorButton

Spécifications

En-tête : afxribboncolorbutton.h

CMFCRibbonColorButton ::AddColorsGroup

Ajoute un groupe de couleurs dans la zone de couleur normale.

void AddColorsGroup(
    LPCTSTR lpszName,
    const CList<COLORREF,COLORREF>& lstColors,
    BOOL bContiguousColumns=FALSE);

Paramètres

lpszName
[in] Nom du groupe.

lstColors
[in] Liste des couleurs.

bContiguousColumns
[in] Contrôle la façon dont les éléments de couleur sont affichés dans le groupe. Si la valeur est TRUE, les éléments de couleur sont dessinés sans espacement vertical. Si la valeur est FALSE, les éléments de couleur sont dessinés avec un espacement vertical.

Notes

Utilisez cette fonction pour faire en sorte que la fenêtre contextuelle de couleur affiche plusieurs groupes de couleurs. Vous pouvez contrôler la façon dont les couleurs sont affichées dans le groupe.

CMFCRibbonColorButton ::CMFCRibbonColorButton

Construit un objet CMFCRibbonColorButton.

CMFCRibbonColorButton();

CMFCRibbonColorButton(
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    COLORREF color = RGB(0, 0, 0));

CMFCRibbonColorButton(
    UINT nID,
    LPCTSTR lpszText,
    BOOL bSimpleButtonLook,
    int nSmallImageIndex,
    int nLargeImageIndex,
    COLORREF color = RGB(0, 0, 0));

Paramètres

nID
[in] Spécifie l’ID de commande de la commande à exécuter lorsqu’un utilisateur clique sur le bouton.

lpszText
[in] Spécifie le texte à afficher sur le bouton.

nSmallImageIndex
[in] Index de base zéro de la petite image à afficher sur le bouton.

color
[in] Couleur du bouton (par défaut en noir).

bSimpleButtonLook
[in] Si la valeur est TRUE, le bouton est dessiné sous la forme d’un rectangle simple.

nLargeImageIndex
[in] Index de base zéro de l’image volumineuse à afficher sur le bouton.

Valeur de retour

Notes

CMFCRibbonColorButton ::EnableAutomaticButton

Spécifie si le bouton Automatique est activé.

void EnableAutomaticButton(
    LPCTSTR lpszLabel,
    COLORREF colorAutomatic,
    BOOL bEnable=TRUE,
    LPCTSTR lpszToolTip=NULL,
    BOOL bOnTop=TRUE,
    BOOL bDrawBorder=FALSE);

Paramètres

lpszLabel
[in] Étiquette du bouton Automatique .

colorAutomatic
[in] Valeur RVB qui spécifie la couleur par défaut du bouton Automatique .

bEnable
[in] TRUE si le bouton Automatique est activé ; FALSE s’il est désactivé.

lpszToolTip
[in] Info-bulle du bouton Automatique .

bOnTop
[in] Spécifie si le bouton Automatique se trouve en haut, avant la palette de couleurs.

bDrawBorder
[in] TRUE si l’application dessine une bordure autour de la barre de couleurs sur le bouton couleur du ruban. La barre de couleurs affiche la couleur actuellement sélectionnée. FALSE si l’application ne dessine pas de bordure

CMFCRibbonColorButton ::EnableOtherButton

Active le bouton Autres .

void EnableOtherButton(
    LPCTSTR lpszLabel,
    LPCTSTR lpszToolTip=NULL);

Paramètres

lpszLabel
Étiquette du bouton.

lpszToolTip
Texte de l’info-bulle pour le bouton Autre .

Notes

Le bouton Autre est le bouton affiché sous le groupe de couleurs. Lorsque l’utilisateur clique sur le bouton Autre , il affiche une boîte de dialogue de couleur.

CMFCRibbonColorButton ::GetAutomaticColor

Récupère la couleur de bouton automatique actuelle.

COLORREF GetAutomaticColor() const;

Valeur de retour

Valeur de couleur RVB qui représente la couleur de bouton automatique actuelle.

Notes

La couleur de bouton automatique est définie par le colorAutomatic paramètre passé à la CMFCRibbonColorButton::EnableAutomaticButton méthode.

CMFCRibbonColorButton ::GetColor

Retourne la couleur actuellement sélectionnée.

COLORREF GetColor() const;

Valeur de retour

Couleur sélectionnée en cliquant sur le bouton.

CMFCRibbonColorButton ::GetColorBoxSize

Retourne la taille des éléments de couleur qui apparaissent dans la barre de couleurs.

CSize GetColorBoxSize() const;

Valeur de retour

Taille des boutons de couleur dans la palette de couleurs déroulantes.

CMFCRibbonColorButton ::GetColumns

Obtient le nombre d’éléments d’une ligne de l’affichage de la galerie du bouton de couleur du ruban.

int GetColumns() const;

Valeur de retour

Retourne le nombre d’icônes dans chaque ligne.

Notes

CMFCRibbonColorButton ::GetHighlightedColor

Retourne la couleur de l’élément actuellement sélectionné dans la palette de couleurs contextuelle.

COLORREF GetHighlightedColor() const;

Valeur de retour

Couleur de l’élément actuellement sélectionné dans la palette de couleurs contextuelle.

CMFCRibbonColorButton ::RemoveAllColorGroups

Supprime tous les groupes de couleurs de la zone de couleur normale.

void RemoveAllColorGroups();

CMFCRibbonColorButton ::SetColor

Sélectionne une couleur dans la zone de couleur normale.

void SetColor(COLORREF color);

Paramètres

color
[in] Couleur à définir.

CMFCRibbonColorButton ::SetColorBoxSize

Définit la taille de tous les éléments de couleur qui apparaissent dans la barre de couleurs.

void SetColorBoxSize(CSize sizeBox);

Paramètres

sizeBox
[in] Nouvelle taille des boutons de couleur dans la palette de couleurs.

CMFCRibbonColorButton ::SetColorName

Définit un nouveau nom pour une couleur spécifiée.

static void __stdcall SetColorName(
    COLORREF color,
    const CString& strName);

Paramètres

color
[in] Valeur RVB d’une couleur.

strName
[in] Nouveau nom pour la couleur spécifiée.

Notes

Comme elle appelle CMFCColorBar::SetColorName, cette méthode modifie le nom de la couleur spécifiée dans tous les CMFCColorBar objets de votre application.

CMFCRibbonColorButton ::SetColumns

Définit le nombre de colonnes affichées dans le tableau des couleurs présentées à l’utilisateur pendant le processus de sélection des couleurs de l’utilisateur.

void SetColumns(int nColumns);

Paramètres

nColumns
[in] Nombre d’icônes de couleur à afficher dans chaque ligne.

Notes

CMFCRibbonColorButton ::SetDocumentColors

Spécifie une liste de valeurs RVB à afficher dans la zone de couleur du document.

void SetDocumentColors(
    LPCTSTR lpszLabel,
    CList<COLORREF,COLORREF>& lstColors);

Paramètres

lpszLabel
[in] Texte à afficher avec les couleurs du document.

lstColors
[in] Référence à une liste de valeurs RVB.

CMFCRibbonColorButton ::SetPalette

Spécifie les couleurs standard à afficher dans le tableau de couleurs que le bouton couleur affiche.

void SetPalette(CPalette* pPalette);

Paramètres

pPalette
[in] Pointeur vers une palette de couleurs.

Notes

CMFCRibbonColorButton ::UpdateColor

Appelé par l’infrastructure lorsque l’utilisateur sélectionne une couleur dans la table de couleurs affichée lorsque l’utilisateur clique sur le bouton couleur.

void UpdateColor(COLORREF color);

Paramètres

color
[in] Couleur sélectionnée par l’utilisateur.

Notes

La CMFCRibbonColorButton::UpdateColor méthode modifie la couleur du bouton sélectionné et avertit son parent en envoyant un message WM_COMMAND avec une notification standard BN_CLICKED. Utilisez la méthode CMFCRibbonColorButton ::GetColor pour récupérer la couleur sélectionnée.

Voir aussi

Graphique hiérarchique
Classes
CMFCRibbonGallery, classe