Partager via

CMFCColorBar, classe

  • Article

La CMFCColorBar classe représente une barre de contrôle d’ancrage qui peut sélectionner des couleurs dans un document ou une application.

Syntaxe

class CMFCColorBar : public CMFCPopupMenuBar

Membres

Constructeurs protégés

Nom Description
CMFCColorBar ::CMFCColorBar Construit un objet CMFCColorBar.

Méthodes publiques

Nom Description
CMFCColorBar ::ContextToSize Calcule les marges verticales et horizontales requises pour contenir les boutons du contrôle de barre de couleurs, puis ajuste l’emplacement de ces boutons.
CMFCColorBar ::CreateControl Crée une fenêtre de contrôle de barre de couleurs, l’attache à l’objet CMFCColorBar et redimensionne le contrôle pour contenir la palette de couleurs spécifiée.
CMFCColorBar ::Create Crée une fenêtre de contrôle de barre de couleurs et l’attache à l’objet CMFCColorBar .
CMFCColorBar ::EnableAutomaticButton Affiche ou masque le bouton automatique.
CMFCColorBar ::EnableOtherButton Active ou désactive l’affichage d’une boîte de dialogue qui permet à l’utilisateur de sélectionner plus de couleurs.
CMFCColorBar ::GetColor Récupère la couleur actuellement sélectionnée.
CMFCColorBar ::GetCommandID Récupère l’ID de commande du contrôle de barre de couleurs actuel.
CMFCColorBar ::GetHighlightedColor Récupère la couleur qui signifie qu’un bouton de couleur a le focus ; c’est-à-dire que le bouton est chaud.
CMFCColorBar ::GetHorzMargin Récupère la marge horizontale, qui est l’espace entre la cellule de couleur gauche ou droite et la limite de la zone cliente.
CMFCColorBar ::GetVertMargin Récupère la marge verticale, qui est l’espace entre la cellule de couleur supérieure ou inférieure et la limite de la zone cliente.
CMFCColorBar ::IsTearOff Indique si la barre de couleurs actuelle est ancrée.
CMFCColorBar ::SetColor Définit la couleur actuellement sélectionnée.
CMFCColorBar ::SetColorName Définit un nouveau nom pour une couleur spécifiée.
CMFCColorBar ::SetCommandID Définit un nouvel ID de commande pour un contrôle de barre de couleurs.
CMFCColorBar ::SetDocumentColors Définit la liste des couleurs utilisées dans le document actif.
CMFCColorBar ::SetHorzMargin Définit la marge horizontale, qui est l’espace entre la cellule de couleur gauche ou droite et la limite de la zone cliente.
CMFCColorBar ::SetVertMargin Définit la marge verticale, qui est l’espace entre la cellule de couleur supérieure ou inférieure et la limite de la zone cliente.

Méthodes protégées

Nom Description
CMFCColorBar ::AdjustLocations Ajuste les positions des boutons de couleur sur le contrôle de barre de couleurs.
CMFCColorBar ::AllowChangeTextLabels Indique si l’étiquette de texte des boutons de couleur peut changer.
CMFCColorBar ::AllowShowOnList Indique si l’objet de contrôle de barre de couleurs peut apparaître dans une liste de barres d’outils pendant le processus de personnalisation.
CMFCColorBar ::CalcSize Appelé par l’infrastructure dans le cadre du processus de calcul de disposition.
CMFCColorBar ::CreatePalette Initialise une palette avec les couleurs dans un tableau de couleurs spécifié.
CMFCColorBar ::GetColorGridSize Calcule le nombre de lignes et de colonnes dans la grille d’un contrôle de barre de couleurs.
CMFCColorBar ::GetExtraHeight Calcule la hauteur supplémentaire requise par la barre de couleurs actuelle pour afficher divers éléments d’interface utilisateur tels que le bouton Other, les couleurs du document, etc.
CMFCColorBar ::InitColors Initialise un tableau de couleurs avec les couleurs d’une palette spécifiée ou de la palette système par défaut.
CMFCColorBar ::OnKey Appelé par l’infrastructure lorsqu’un utilisateur appuie sur un bouton clavier.
CMFCColorBar ::OnSendCommand Appelé par l’infrastructure pour fermer une hiérarchie de contrôles contextuels.
CMFCColorBar ::OnUpdateCmdUI Appelé par l’infrastructure pour activer ou désactiver un élément d’interface utilisateur d’un contrôle de barre de couleurs avant l’affichage de l’élément.
CMFCColorBar ::OpenColorDialog Ouvre une boîte de dialogue couleur.
CMFCColorBar ::Rebuild Redessine complètement le contrôle de barre de couleurs.
CMFCColorBar ::SelectPalette Définit la palette logique du contexte d’appareil spécifié sur la palette du bouton parent du contrôle de barre de couleurs actuelle.
CMFCColorBar ::SetPropList Définit le membre de données protégé sur m_pWndPropList le pointeur spécifié vers un contrôle de grille de propriétés.
CMFCColorBar ::ShowCommandMessageString Demande à la fenêtre frame qui possède le contrôle de barre de couleurs de mettre à jour la ligne de message dans la barre d’état.

Membres de données protégés

Nom Description
m_bInternal Champ booléen qui détermine si les événements de souris sont traités. En règle générale, les événements de souris sont traités lorsque ce champ a la valeur TRUE et que le mode de personnalisation est FALSE.
m_bIsEnabled Valeur booléenne qui indique si un contrôle est activé.
m_bIsTearOff Valeur booléenne qui indique si le contrôle de barre de couleurs prend en charge l’ancrage.
m_BoxSize Objet CSize qui spécifie la taille d’une cellule dans une grille de barres de couleurs.
m_bShowDocColorsWhenDocked Valeur booléenne qui indique s’il faut afficher les couleurs du document lorsque la barre de couleurs est ancrée. Pour plus d’informations, consultez CMFCColorBar ::SetDocumentColors.
m_bStdColorDlg Boolean qui indique s’il faut afficher la boîte de dialogue couleur système standard ou la boîte de dialogue CMFCColorDialog . Pour plus d’informations, consultez CMFCColorBar ::EnableOtherButton.
m_ColorAutomatic COLORREF qui stocke la couleur automatique actuelle. Pour plus d’informations, consultez CMFCColorBar ::EnableOtherButton.
m_ColorNames Objet CMap qui associe un ensemble de couleurs RVB à leurs noms.
m_colors CArray des valeurs COLORREF qui contient les couleurs affichées dans le contrôle de barre de couleurs.
m_ColorSelected Valeur COLORREF qui correspond à la couleur que l’utilisateur a actuellement sélectionnée dans le contrôle de barre de couleurs.
m_lstDocColors Liste de valeurs COLORREF qui contient les couleurs actuellement utilisées dans un document.
m_nCommandID Entier non signé qui est l’ID de commande d’un bouton de couleur.
m_nHorzMargin Entier qui correspond à la marge horizontale entre les boutons de couleur dans une grille de couleurs.
m_nHorzOffset Entier qui correspond au décalage horizontal au centre du bouton de couleur. Cette valeur est significative si le bouton affiche du texte ou une image en plus d’une couleur.
m_nNumColumns Entier qui correspond au nombre de colonnes d’une grille de contrôle de barre de couleurs de couleurs.
m_nNumColumnsVert Entier qui correspond au nombre de colonnes d’une grille verticale de couleurs.
m_nNumRowsHorz Entier qui correspond au nombre de colonnes d’une grille horizontale de couleurs.
m_nRowHeight Entier qui correspond à la hauteur d’une ligne de boutons de couleur dans une grille de couleurs.
m_nVertMargin Entier qui correspond à la marge verticale entre les boutons de couleur dans une grille de couleurs.
m_nVertOffset Entier qui correspond au décalage vertical au centre du bouton de couleur. Cette valeur est significative si le bouton affiche du texte ou une image en plus d’une couleur.
m_Palette Un CPalette des couleurs utilisées dans le contrôle de barre de couleurs.
m_pParentBtn Pointeur vers un objet CMFCColorButton qui est le parent du bouton actif. Cette valeur est significative si le bouton couleur se trouve dans une hiérarchie de contrôles de barre d’outils ou se trouve dans un contrôle de grille de propriétés de couleur.
m_pParentRibbonBtn Pointeur vers un objet CMFCRibbonColorButton qui se trouve sur le ruban et qui est le bouton parent du bouton actif. Cette valeur est significative si le bouton couleur se trouve dans une hiérarchie de contrôles de barre d’outils ou se trouve dans un contrôle de grille de propriétés de couleur.
m_pWndPropList Pointeur vers un objet CMFCPropertyGridCtrl .
m_strAutoColor CString qui est le texte affiché sur le bouton Automatique. Pour plus d’informations, consultez CMFCColorBar ::EnableAutomaticButton.
m_strDocColors CString qui est le texte affiché sur le bouton couleurs du document. Pour plus d’informations, consultez CMFCColorBar ::SetDocumentColors.
m_strOtherColor CString qui est le texte affiché sur l’autre bouton. Pour plus d’informations, consultez CMFCColorBar ::EnableOtherButton.

Notes

En règle générale, vous ne créez pas d’objet CMFCColorBar directement. Au lieu de cela, la classe CMFCColorMenuButton (utilisée dans les menus et les barres d’outils) ou la classe CMFCColorButton crée l’objet CMFCColorBar .

La CMFCColorBar classe fournit les fonctionnalités suivantes :

  • Ajuste automatiquement la liste des couleurs du document.

  • Enregistre et restaure son état, ainsi que l’état du document.

  • Gère le bouton « automatique ».

  • Utilise le contrôle CMFCColorPickerCtrl, classe pour sélectionner une couleur personnalisée.

  • Prend en charge un état de « déchirure » (s’il est créé à l’aide de la classe CMFCColorMenuButton).

Pour incorporer les CMFCColorBar fonctionnalités dans votre application :

  1. Créez un bouton de menu standard et affectez-le à un ID, par exemple ID_CHAR_COLOR.

  2. Dans votre classe de fenêtre frame, remplacez la méthode CFrameWndEx ::OnShowPopupMenu et remplacez le bouton de menu standard par un objet CMFCColorMenuButton Class (en appelant CMFCToolBar ::ReplaceButton).

  3. Définissez tous les styles et activez ou désactivez les fonctionnalités de l’objet lors de la création de la CMFCColorBar classe CMFCColorMenuButton. L’objet CMFCColorMenuButton crée dynamiquement l’objet CMFCColorBar après que l’infrastructure appelle la CreatePopupMenu méthode.

Lorsque l’utilisateur clique sur un bouton de contrôle de barre de couleurs, l’infrastructure utilise la ON_COMMAND macro pour notifier le parent du contrôle de barre de couleurs. Dans la macro, le paramètre ID de commande est la valeur que vous avez affectée au bouton de contrôle de barre de couleurs à l’étape 1 (ID_CHAR_COLOR dans cet exemple). Pour plus d’informations, consultez la classe CMFCColorMenuButton, la classe CMFCColorButton, la classe CMFCColorPickerCtrl, la classe CFrameWndEx et les classes CMFCToolBar Class.

Exemple

L’exemple suivant montre comment configurer une barre de couleurs à l’aide de différentes méthodes dans la CMFCColorBar classe. Les méthodes définissent les marges horizontales et verticales, activez l’autre bouton, créez une fenêtre de contrôle de barre de couleurs et définissez la couleur actuellement sélectionnée. Cet exemple fait partie de l’exemple New Controls.

CMFCColorBar m_wndColorBar;

// set the margins
m_wndColorBar.SetHorzMargin(0);
m_wndColorBar.SetVertMargin(0);
// enable the display of a dialog box that
// lets the user select more colors
m_wndColorBar.EnableOtherButton(_T("Other..."));
// create a color bar control window
m_wndColorBar.CreateControl(this, rectColorBar, IDC_COLORBAR, 5 /* columns */);
// set the currently selected color
m_wndColorBar.SetColor(RGB(255, 0, 0));

Hiérarchie d'héritage

CObject

CCmdTarget

CWnd

CBasePane

CPane

CMFCBaseToolBar

CMFCToolBar

CMFCPopupMenuBar

CMFCColorBar

Spécifications

En-tête : afxcolorbar.h

CMFCColorBar ::AdjustLocations

Ajuste les positions des boutons de couleur sur le contrôle de barre de couleurs.

virtual void AdjustLocations();

Notes

Cette méthode est appelée par l’infrastructure pendant WM_SIZE traitement des messages.

CMFCColorBar ::AllowChangeTextLabels

Indique si l’étiquette de texte des boutons de couleur peut changer.

virtual BOOL AllowChangeTextLabels() const;

Valeur de retour

Toujours FALSE.

Notes

Par défaut, cette méthode retourne toujours FALSE, ce qui signifie que les étiquettes de texte ne peuvent pas être modifiées. Remplacez cette méthode pour activer la modification des étiquettes de texte.

CMFCColorBar ::AllowShowOnList

Indique si l’objet de contrôle de barre de couleurs peut apparaître dans une liste de barres d’outils pendant le processus de personnalisation.

virtual BOOL AllowShowOnList() const;

Valeur de retour

Toujours TRUE.

Notes

Par défaut, cette méthode retourne toujours TRUE, ce qui signifie que l’infrastructure peut afficher le contrôle de barre de couleurs pendant le processus de personnalisation. Remplacez cette méthode pour implémenter un comportement différent.

CMFCColorBar ::CalcSize

Appelé par l’infrastructure dans le cadre du processus de calcul de disposition.

virtual CSize CalcSize(BOOL bVertDock);

Paramètres

bVertDock
[in] TRUE pour spécifier que le contrôle de barre de couleurs est ancré verticalement ; FALSE pour spécifier que le contrôle de barre de couleurs est ancré horizontalement.

Valeur de retour

Taille du tableau de boutons de couleur dans un contrôle de barre de couleurs.

CMFCColorBar ::CMFCColorBar

Construit un objet CMFCColorBar.

CMFCColorBar(
    const CArray<COLORREF,COLORREF>& colors,
    COLORREF color,
    LPCTSTR lpszAutoColor,
    LPCTSTR lpszOtherColor,
    LPCTSTR lpszDocColors,
    CList<COLORREF,COLORREF>& lstDocColors,
    int nColumns,
    int nRowsDockHorz,
    int nColDockVert,
    COLORREF colorAutomatic,
    UINT nCommandID,
    CMFCColorButton* pParentBtn);

CMFCColorBar(
    const CArray<COLORREF,COLORREF>& colors,
    COLORREF color,
    LPCTSTR lpszAutoColor,
    LPCTSTR lpszOtherColor,
    LPCTSTR lpszDocColors,
    CList<COLORREF,COLORREF>& lstDocColors,
    int nColumns,
    COLORREF colorAutomatic,
    UINT nCommandID,
    CMFCRibbonColorButton* pParentRibbonBtn);

CMFCColorBar(
    CMFCColorBar& src,
    UINT uiCommandID);

Paramètres

Couleurs
[in] Tableau de couleurs affichées par l’infrastructure sur le contrôle de barre de couleurs.

color
[in] Couleur initialement sélectionnée.

lpszAutoColor
[in] Étiquette de texte du bouton de couleur automatique (par défaut) ou NULL.

L’étiquette standard du bouton automatique est Automatique.

lpszOtherColor
[in] Étiquette de texte de l’autre bouton, qui affiche plus de choix de couleurs ou NULL.

L’étiquette standard de l’autre bouton est Plus de couleurs....

lpszDocColors
[in] Étiquette de texte du bouton Couleurs du document. La palette de couleurs du document répertorie toutes les couleurs utilisées par le document.

lstDocColors
[in] Liste des couleurs utilisées actuellement par le document.

nColumns
[in] Nombre de colonnes dont dispose le tableau de couleurs.

nRowsDockHorz
[in] Nombre de lignes qu’a la barre de couleurs lorsqu’elle est ancrée horizontalement.

nColDockVert
[in] Nombre de colonnes dont dispose la barre de couleurs lorsqu’elle est ancrée verticalement.

colorAutomatic
[in] Couleur par défaut appliquée par l’infrastructure lorsque vous cliquez sur le bouton automatique.

nCommandID
[in] ID de commande de contrôle de la barre de couleurs.

pParentBtn
[in] Pointeur vers un bouton parent.

src
[in] Objet existant CMFCColorBar à copier dans le nouvel CMFCColorBar objet.

uiCommandID
[in] ID de commande.

CMFCColorBar ::ContextToSize

Calcule les marges verticales et horizontales requises pour contenir les boutons du contrôle de barre de couleurs et ajuste l’emplacement de ces boutons.

void ContextToSize(
    BOOL bSquareButtons = TRUE,
    BOOL bCenterButtons = TRUE);

Paramètres

bSquareButtons
[in] TRUE pour spécifier que la forme des boutons d’un contrôle de barre de couleurs est carrée ; sinon, FALSE. La valeur par défaut est TRUE.

bCenterButtons
[in] TRUE pour spécifier que le contenu sur le visage d’un bouton de contrôle de barre de couleurs est centré ; sinon, FALSE. La valeur par défaut est TRUE.

Notes

CMFCColorBar ::Create

Crée une fenêtre de contrôle de barre de couleurs et l’attache à l’objet CMFCColorBar .

virtual BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle,
    UINT nID,
    CPalette* pPalette=NULL,
    int nColumns=0,
    int nRowsDockHorz=0,
    int nColDockVert=0);

Paramètres

pParentWnd
[in] Pointeur vers la fenêtre parente.

dwStyle
[in] Combinaison au niveau du bit (OR) des styles de fenêtre.

nID
[in] ID de commande.

pPalette
[in] Pointeur vers une palette de couleurs. Le par défaut est NULL.

nColumns
[in] Nombre de colonnes dans le contrôle de barre de couleurs. La valeur par défaut est 0.

nRowsDockHorz
[in] Nombre de lignes dans le contrôle de barre de couleurs lorsqu’elle est ancrée horizontalement. La valeur par défaut est 0.

nColDockVert
[in] Nombre de colonnes dans le contrôle de barre de couleurs lorsqu’elle est ancrée verticalement. La valeur par défaut est 0.

Valeur de retour

TRUE si cette méthode réussit ; sinon, FALSE.

Notes

Pour construire un CMFCColorBar objet, appelez le constructeur de classe, puis cette méthode. La Create méthode crée le contrôle Windows et initialise une liste de couleurs.

CMFCColorBar ::CreateControl

Crée une fenêtre de contrôle de barre de couleurs, l’attache à l’objet CMFCColorBar et redimensionne la fenêtre de contrôle pour contenir la palette de couleurs spécifiée.

virtual BOOL CreateControl(
    CWnd* pParentWnd,
    const CRect& rect,
    UINT nID,
    int nColumns=-1,
    CPalette* pPalette=NULL);

Paramètres

pParentWnd
[in] Pointeur vers la fenêtre parente. Ne peut pas avoir la valeur NULL.

rect
[in] Rectangle englobant qui spécifie où dessiner le contrôle de barre de couleurs.

nID
[in] ID de contrôle.

nColumns
[in] Nombre idéal de colonnes dans le contrôle de barre de couleurs. Cette méthode modifie ce nombre pour qu’il corresponde à la palette de couleurs spécifiée. La valeur par défaut est -1, ce qui signifie que ce paramètre n’est pas spécifié.

pPalette
[in] Pointeur vers une palette de couleurs ou NULL. Si ce paramètre est NULL, cette méthode calcule la taille du contrôle de barre de couleurs comme si 20 couleurs ont été spécifiées. Le par défaut est NULL.

Valeur de retour

TRUE si cette méthode réussit ; sinon FALSE.

Notes

Cette méthode utilise les paramètres rect, nColumns et pPalette pour calculer le nombre ou les lignes et colonnes appropriés dans le contrôle de barre de couleurs, puis appelle la méthode CMFCColorBar ::Create .

CMFCColorBar ::CreatePalette

Initialise une palette avec les couleurs dans un tableau de couleurs spécifié.

static BOOL CreatePalette(
    const CArray<COLORREF, COLORREF>& arColors,
    CPalette& palette);

Paramètres

arColors
[in] Tableau de couleurs.

palette
[in] Palette de couleurs.

Valeur de retour

TRUE si cette méthode réussit ; sinon, FALSE.

CMFCColorBar ::EnableAutomaticButton

Affiche ou masque le bouton automatique.

void EnableAutomaticButton(
    LPCTSTR lpszLabel,
    COLORREF colorAutomatic,
    BOOL bEnable=TRUE);

Paramètres

lpszLabel
[in] Étiquette de texte du bouton de couleur automatique (par défaut) ou NULL.

L’étiquette standard du bouton automatique est Automatique.

colorAutomatic
[in] Couleur par défaut appliquée par l’infrastructure lorsque vous cliquez sur le bouton automatique.

bEnable
[in] TRUE pour activer le bouton automatique ; FALSE pour désactiver le bouton automatique. La valeur par défaut est TRUE.

Notes

L’étiquette de texte du bouton automatique est supprimée si le paramètre lpszLabel a la valeur NULL ou si le paramètre bEnable a la valeur FALSE.

CMFCColorBar ::EnableOtherButton

Active ou désactive l’affichage d’une boîte de dialogue qui permet à l’utilisateur de sélectionner plus de couleurs.

void EnableOtherButton(
    LPCTSTR lpszLabel,
    BOOL bAltColorDlg=TRUE,
    BOOL bEnable=TRUE);

Paramètres

lpszLabel
[in] Étiquette de texte de l’autre bouton, qui affiche plus de choix de couleurs ou NULL.

L’étiquette standard pour ce bouton est Plus de couleurs....

bAltColorDlg
[in] TRUE pour afficher la boîte de dialogue CMFCColorDialog ; FALSE pour afficher la boîte de dialogue CColorDialog standard. La valeur par défaut est TRUE.

bEnable
[in] TRUE pour activer le bouton ; FALSE pour désactiver le bouton. La valeur par défaut est TRUE.

CMFCColorBar ::GetColor

Récupère la couleur actuellement sélectionnée.

COLORREF GetColor() const;

Valeur de retour

Couleur actuellement sélectionnée.

CMFCColorBar ::GetColorGridSize

Calcule le nombre de lignes et de colonnes dans la grille d’un contrôle de barre de couleurs.

CSize GetColorGridSize(BOOL bVertDock) const;

Paramètres

bVertDock
[in] TRUE pour effectuer le calcul d’un contrôle de barre de couleurs ancrée verticalement ; sinon, effectuez le calcul d’un contrôle ancré horizontalement.

Valeur de retour

Objet CSize dont cx le composant contient le nombre de colonnes et dont cy le composant contient le nombre de lignes.

CMFCColorBar ::GetCommandID

Récupère l’ID de commande du contrôle de barre de couleurs actuel.

UINT GetCommandID() const;

Valeur de retour

ID de commande.

Notes

Lorsque l’utilisateur sélectionne une nouvelle couleur, l’infrastructure envoie l’ID de commande dans un message WM_COMMAND pour notifier le parent de l’objet CMFCColorBar .

CMFCColorBar ::GetExtraHeight

Calcule la hauteur supplémentaire requise par la barre de couleurs actuelle pour afficher divers éléments d’interface utilisateur, tels que les autres couleurs du bouton ou du document.

int GetExtraHeight(int nNumColumns) const;

Paramètres

nNumColumns
[in] Si le contrôle de barre de couleurs contient des couleurs de document, le nombre de colonnes à afficher dans la grille des couleurs du document. Sinon, cette valeur n’est pas utilisée.

Valeur de retour

Hauteur supplémentaire calculée requise.

CMFCColorBar ::GetHighlightedColor

Récupère la couleur qui signifie qu’un bouton de couleur a le focus ; c’est-à-dire que le bouton est chaud.

COLORREF GetHighlightedColor() const;

Valeur de retour

Valeur RVB.

Notes

CMFCColorBar ::GetHorzMargin

Récupère la marge horizontale, qui est l’espace entre la cellule de couleur gauche ou droite et la limite de la zone cliente.

int GetHorzMargin();

Valeur de retour

Marge horizontale.

CMFCColorBar ::GetVertMargin

Récupère la marge verticale, qui est l’espace entre la cellule de couleur supérieure ou inférieure et la limite de la zone cliente.

int GetVertMargin() const;

Valeur de retour

Marge verticale.

CMFCColorBar ::InitColors

Initialise un tableau de couleurs avec les couleurs d’une palette spécifiée ou avec la palette par défaut système.

static int InitColors(
    CPalette* pPalette,
    CArray<COLORREF, COLORREF>& arColors);

Paramètres

pPalette
[in] Pointeur vers un objet palette ou NULL. Si ce paramètre est NULL, cette méthode utilise la palette par défaut du système d’exploitation.

arColors
[in] Tableau de couleurs.

Valeur de retour

Nombre d’éléments dans le tableau de couleurs.

CMFCColorBar ::IsTearOff

Indique si la barre de couleurs actuelle est ancrée.

BOOL IsTearOff() const;

Valeur de retour

TRUE si le contrôle de barre de couleurs actuelle est ancré ; sinon, FALSE.

Notes

Si le contrôle de barre de couleurs peut être ancré, il peut être déchiré d’une barre de contrôle et ancré à un autre emplacement.

CMFCColorBar ::OnKey

Appelé par l’infrastructure lorsqu’un utilisateur appuie sur un bouton clavier.

virtual BOOL OnKey(UINT nChar);

Paramètres

nChar
[in] Code de touche virtuelle pour la touche qu’un utilisateur a appuyé.

Valeur de retour

TRUE si cette méthode traite la clé spécifiée ; sinon, FALSE.

CMFCColorBar ::OnSendCommand

Appelé par l’infrastructure pour fermer une hiérarchie de contrôles contextuels.

virtual BOOL OnSendCommand(const CMFCToolBarButton* pButton);

Paramètres

pButton
[in] Pointeur vers un contrôle qui réside dans une barre d’outils.

Valeur de retour

TRUE si cette méthode réussit ; sinon, FALSE.

CMFCColorBar ::OnUpdateCmdUI

Appelé par l’infrastructure pour activer ou désactiver un élément d’interface utilisateur d’un contrôle de barre de couleurs avant l’affichage de l’élément.

virtual void OnUpdateCmdUI(
    CFrameWnd* pTarget,
    BOOL bDisableIfNoHndler);

Paramètres

pTarget
[in] Pointeur vers une fenêtre qui contient un élément d’interface utilisateur à mettre à jour.

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

Lorsqu’un utilisateur de votre application clique sur un élément d’interface utilisateur, l’élément doit savoir s’il doit être affiché comme activé ou désactivé. La cible du message de commande fournit ces informations en implémentant un gestionnaire de commandes ON_UPDATE_COMMAND_UI. Utilisez cette méthode pour aider à traiter la commande. Pour plus d’informations, consultez la classe CCmdUI.

CMFCColorBar ::OpenColorDialog

Ouvre une boîte de dialogue couleur.

virtual BOOL OpenColorDialog(
    const COLORREF colorDefault,
    COLORREF& colorRes);

Paramètres

colorDefault
[in] Couleur sélectionnée par défaut lorsque la boîte de dialogue couleur s’ouvre.

colorRes
[out] Couleur sélectionnée par un utilisateur.

Valeur de retour

TRUE si l’utilisateur a sélectionné une couleur ; FALSE si l’utilisateur a annulé la boîte de dialogue couleur.

Notes

CMFCColorBar ::Rebuild

Redessine complètement le contrôle de barre de couleurs.

virtual void Rebuild();

CMFCColorBar ::SelectPalette

Définit la palette logique du contexte d’appareil spécifié sur la palette du bouton parent du contrôle de barre de couleurs actuelle.

CPalette* SelectPalette(CDC* pDC);

Paramètres

pDC
[in] Pointeur vers le contexte de l’appareil du bouton parent du contrôle de barre de couleurs actuelle.

Valeur de retour

Pointeur vers la palette remplacée par la palette du bouton parent du contrôle de barre de couleurs actuelle.

CMFCColorBar ::SetColor

Définit la couleur actuellement sélectionnée.

void SetColor(COLORREF color);

Paramètres

color
[in] Valeur de couleur RVB.

CMFCColorBar ::SetColorName

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

static void 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

Cette méthode modifie le nom de la couleur spécifiée dans tous les CMFCColorBar objets de votre application.

CMFCColorBar ::SetCommandID

Définit un nouvel ID de commande pour un contrôle de barre de couleurs.

void SetCommandID(UINT nCommandID);

Paramètres

nCommandID
[in] ID de commande.

Notes

Appelez cette méthode pour modifier l’ID de commande d’un contrôle de barre de couleurs et informer la fenêtre parente du contrôle que l’ID a changé.

CMFCColorBar ::SetDocumentColors

Définit la liste des couleurs utilisées dans le document actif.

void SetDocumentColors(
    LPCTSTR lpszCaption,
    CList<COLORREF,COLORREF>& lstDocColors,
    BOOL bShowWhenDocked=FALSE);

Paramètres

lpszCaption
[in] Légende affichée lorsque le contrôle de barre de couleurs n’est pas ancré.

lstDocColors
[in] Liste des couleurs qui remplacent les couleurs actuelles du document.

bShowWhenDocked
[in] TRUE pour afficher les couleurs du document lorsque le contrôle de barre de couleurs est ancré ; sinon, FALSE. La valeur par défaut est FALSE.

Notes

Les couleurs du document sont les couleurs actuellement utilisées dans un document. L’infrastructure gère automatiquement une liste de couleurs de document, mais vous pouvez utiliser cette méthode pour modifier la liste.

CMFCColorBar ::SetHorzMargin

Définit la marge horizontale, qui est l’espace entre la cellule de couleur gauche ou droite et la limite de la zone cliente.

void SetHorzMargin(int nHorzMargin);

Paramètres

nHorzMargin
[in] Marge horizontale, en pixels.

Notes

Par défaut, le constructeur CMFCColorBar ::CMFCColorBar définit la marge horizontale sur 4 pixels.

CMFCColorBar ::SetPropList

Définit le membre de données protégé sur m_pWndPropList le pointeur spécifié vers un contrôle de grille de propriétés.

void SetPropList(CMFCPropertyGridCtrl* pWndList);

Paramètres

pWndList
[in] Pointeur vers l’objet de contrôle de grille de propriétés.

CMFCColorBar ::SetVertMargin

Définit la marge verticale, qui est l’espace entre la cellule de couleur supérieure ou inférieure et la limite de la zone cliente.

void SetVertMargin(int nVertMargin);

Paramètres

nVertMargin
[in] Marge verticale, en pixels.

Notes

Par défaut, le constructeur CMFCColorBar ::CMFCColorBar définit la marge verticale sur 4 pixels.

CMFCColorBar ::ShowCommandMessageString

Demande à la fenêtre frame qui possède le contrôle de barre de couleurs de mettre à jour la ligne de message dans la barre d’état.

virtual void ShowCommandMessageString(UINT uiCmdId);

Paramètres

uiCmdId
[in] ID de commande. (Ce paramètre est ignoré.)

Notes

Cette méthode envoie le message WM_SETMESSAGESTRING au propriétaire du contrôle de barre de couleurs.

Voir aussi

Graphique hiérarchique
Classes