CMFCColorBar-Klasse

  • Artikel
  • 16 Minuten Lesedauer

Die CMFCColorBar -Klasse stellt eine andockende Steuerleiste dar, die Farben in einem Dokument oder einer Anwendung auswählen kann.

Syntax

class CMFCColorBar : public CMFCPopupMenuBar

Member

Geschützte Konstruktoren

Name BESCHREIBUNG
CMFCColorBar::CMFCColorBar Erstellt ein CMFCColorBar-Objekt.

Öffentliche Methoden

name BESCHREIBUNG
CMFCColorBar::ContextToSize Berechnet die vertikalen und horizontalen Ränder, die erforderlich sind, um die Schaltflächen im Farbleisten-Steuerelement zu enthalten, und passt dann die Position dieser Schaltflächen an.
CMFCColorBar::CreateControl Erstellt ein Farbleisten-Steuerelementfenster, CMFCColorBar hängt es an das -Objekt an und legt die Größe des Steuerelements so um, dass es die angegebene Farbpalette enthält.
CMFCColorBar::Create Erstellt ein Farbleisten-Steuerelementfenster und hängt es an das -Objekt CMFCColorBar an.
CMFCColorBar::EnableAutomaticButton Zeigt die automatische Schaltfläche an oder blendet sie aus.
CMFCColorBar::EnableOtherButton Aktiviert oder deaktiviert die Anzeige eines Dialogfelds, in dem der Benutzer weitere Farben auswählen kann.
CMFCColorBar::GetColor Ruft die aktuell ausgewählte Farbe ab.
CMFCColorBar::GetCommandID Ruft die Befehls-ID des aktuellen Farbleisten-Steuerelements ab.
CMFCColorBar::GetHighlightedColor Ruft die Farbe ab, die andeutet, dass eine Farbschaltfläche den Fokus besitzt. Das heißt, die Schaltfläche ist heiß.
CMFCColorBar::GetHorzMargin Ruft den horizontalen Rand ab. Dabei handelt es sich um den Abstand zwischen der linken oder rechten Farbzelle und der Clientbereichsgrenze.
CMFCColorBar::GetVertMargin Ruft den vertikalen Rand ab, bei dem es sich um den Abstand zwischen der oberen oder unteren Farbzelle und der Clientbereichsgrenze handelt.
CMFCColorBar::IsTearOff Gibt an, ob die aktuelle Farbleiste andockbar ist.
CMFCColorBar::SetColor Legt die Farbe fest, die derzeit ausgewählt ist.
CMFCColorBar::SetColorName Legt einen neuen Namen für eine angegebene Farbe fest.
CMFCColorBar::SetCommandID Legt eine neue Befehls-ID für ein Farbleisten-Steuerelement fest.
CMFCColorBar::SetDocumentColors Legt die Liste der Farben fest, die im aktuellen Dokument verwendet werden.
CMFCColorBar::SetHorzMargin Legt den horizontalen Rand fest. Dies ist der Abstand zwischen der linken oder rechten Farbzelle und der Clientbereichsgrenze.
CMFCColorBar::SetVertMargin Legt den vertikalen Rand fest. Dies ist der Abstand zwischen der oberen oder unteren Farbzelle und der Clientbereichsgrenze.

Geschützte Methoden

Name BESCHREIBUNG
CMFCColorBar::AdjustLocations Passt die Positionen der Farbschaltflächen im Farbleisten-Steuerelement an.
CMFCColorBar::AllowChangeTextLabels Gibt an, ob sich die Textbezeichnung von Farbschaltflächen ändern kann.
CMFCColorBar::AllowShowOnList Gibt an, ob das Farbleisten-Steuerelementobjekt während des Anpassungsprozesses in einer Symbolleistenliste angezeigt werden kann.
CMFCColorBar::CalcSize Wird vom Framework als Teil des Layoutberechnungsprozesses aufgerufen.
CMFCColorBar::CreatePalette Initialisiert eine Palette mit den Farben in einem angegebenen Array von Farben.
CMFCColorBar::GetColorGridSize Berechnet die Anzahl der Zeilen und Spalten im Raster eines Farbleisten-Steuerelements.
CMFCColorBar::GetExtraHeight Berechnet die zusätzliche Höhe, die die aktuelle Farbleiste benötigt, um verschiedene Benutzeroberflächenelemente wie die Schaltfläche Andere, Dokumentfarben und so weiter anzuzeigen.
CMFCColorBar::InitColors Initialisiert ein Array von Farben mit den Farben in einer angegebenen Palette oder der Standardpalette des Systems.
CMFCColorBar::OnKey Wird vom Framework aufgerufen, wenn ein Benutzer eine Tastaturtaste drückt.
CMFCColorBar::OnSendCommand Wird vom Framework aufgerufen, um eine Hierarchie von Popupsteuerelementen zu schließen.
CMFCColorBar::OnUpdateCmdUI Wird vom Framework aufgerufen, um ein Benutzeroberflächenelement eines Farbleisten-Steuerelements zu aktivieren oder zu deaktivieren, bevor das Element angezeigt wird.
CMFCColorBar::OpenColorDialog Öffnet ein Farbdialogfeld.
CMFCColorBar::Rebuild Das Farbleisten-Steuerelement wird vollständig neu gedrammt.
CMFCColorBar::SelectPalette Legt die logische Palette des angegebenen Gerätekontexts auf die Palette der übergeordneten Schaltfläche des aktuellen Farbleisten-Steuerelements fest.
CMFCColorBar::SetPropList Legt den geschützten m_pWndPropList Daten member auf den angegebenen Zeiger auf ein Eigenschaftenraster-Steuerelement fest.
CMFCColorBar::ShowCommandMessageString Fordert das Rahmenfenster an, das das Farbleisten-Steuerelement besitzt, die Meldungszeile in der Statusleiste zu aktualisieren.

Geschützte Datenmember

Name BESCHREIBUNG
m_bInternal Ein boolesches Feld, das bestimmt, ob Mausereignisse verarbeitet werden. In der Regel werden Mausereignisse verarbeitet, wenn dieses Feld TRUE ist und der Anpassungsmodus FALSE ist.
m_bIsEnabled Ein boolescher Wert, der angibt, ob ein Steuerelement aktiviert ist.
m_bIsTearOff Ein boolescher Wert, der angibt, ob das Farbleisten-Steuerelement Andocken unterstützt.
m_BoxSize Ein CSize-Objekt , das die Größe einer Zelle in einem Farbleistenraster angibt.
m_bShowDocColorsWhenDocked Ein boolescher Wert, der angibt, ob Dokumentfarben angezeigt werden, wenn die Farbleiste angedockt wird. Weitere Informationen finden Sie unter CMFCColorBar::SetDocumentColors.
m_bStdColorDlg Ein boolescher Wert, der angibt, ob das Standarddialogfeld für die Systemfarbe oder das Dialogfeld CMFCColorDialog angezeigt werden soll. Weitere Informationen finden Sie unter CMFCColorBar::EnableOtherButton.
m_ColorAutomatic Ein COLORREF-Element , in dem die aktuelle automatische Farbe gespeichert wird. Weitere Informationen finden Sie unter CMFCColorBar::EnableOtherButton.
m_ColorNames Ein CMap-Objekt , das einen Satz von RGB-Farben mit ihren Namen verknüpft.
m_colors Ein CArray mitCOLORREF-Werten , das die Farben enthält, die im Farbleisten-Steuerelement angezeigt werden.
m_ColorSelected Ein COLORREF-Wert , der die Farbe ist, die der Benutzer derzeit aus dem Farbleisten-Steuerelement ausgewählt hat.
m_lstDocColors Eine CList mit COLORREF-Werten , die die Farben enthält, die derzeit in einem Dokument verwendet werden.
m_nCommandID Eine ganze Zahl ohne Vorzeichen, die die Befehls-ID einer Farbschaltfläche ist.
m_nHorzMargin Eine ganze Zahl, die den horizontalen Rand zwischen den Farbschaltflächen in einem Raster mit Farben angibt.
m_nHorzOffset Eine ganze Zahl, die den horizontalen Offset zur Mitte der Farbschaltfläche angibt. Dieser Wert ist wichtig, wenn die Schaltfläche zusätzlich zu einer Farbe Text oder ein Bild anzeigt.
m_nNumColumns Eine ganze Zahl, die die Anzahl der Spalten in einem Farbleisten-Steuerelementraster mit Farben angibt.
m_nNumColumnsVert Eine ganze Zahl, die die Anzahl der Spalten in einem vertikal ausgerichteten Farbraster ist.
m_nNumRowsHorz Eine ganze Zahl, die die Anzahl der Spalten in einem horizontal ausgerichteten Farbraster ist.
m_nRowHeight Eine ganze Zahl, die die Höhe einer Zeile mit Farbschaltflächen in einem Raster mit Farben ist.
m_nVertMargin Eine ganze Zahl, die den vertikalen Rand zwischen den Farbschaltflächen in einem Raster mit Farben angibt.
m_nVertOffset Eine ganze Zahl, die den vertikalen Offset zur Mitte der Farbschaltfläche angibt. Dieser Wert ist wichtig, wenn die Schaltfläche zusätzlich zu einer Farbe Text oder ein Bild anzeigt.
m_Palette Eine CPalette der Farben, die im Farbleistensteuerelement verwendet werden.
m_pParentBtn Ein Zeiger auf ein CMFCColorButton-Objekt , das das übergeordnete Element der aktuellen Schaltfläche ist. Dieser Wert ist wichtig, wenn sich die Farbschaltfläche in einer Hierarchie von Symbolleistensteuerelementen oder in einem Farbeigenschaftenraster-Steuerelement befindet.
m_pParentRibbonBtn Ein Zeiger auf ein CMFCRibbonColorButton-Objekt , das sich im Menüband befindet und die übergeordnete Schaltfläche der aktuellen Schaltfläche ist. Dieser Wert ist wichtig, wenn sich die Farbschaltfläche in einer Hierarchie von Symbolleistensteuerelementen oder in einem Farbeigenschaftenraster-Steuerelement befindet.
m_pWndPropList Ein Zeiger auf ein CMFCPropertyGridCtrl-Objekt .
m_strAutoColor Ein CString , bei dem es sich um den Text handelt, der auf der Schaltfläche Automatisch angezeigt wird. Weitere Informationen finden Sie unter CMFCColorBar::EnableAutomaticButton.
m_strDocColors Ein CString , bei dem es sich um den Text handelt, der auf der Schaltfläche "Dokumentfarben" angezeigt wird. Weitere Informationen finden Sie unter CMFCColorBar::SetDocumentColors.
m_strOtherColor Ein CString , bei dem es sich um den Text handelt, der auf der anderen Schaltfläche angezeigt wird. Weitere Informationen finden Sie unter CMFCColorBar::EnableOtherButton.

Hinweise

Normalerweise erstellen Sie kein CMFCColorBar -Objekt direkt. Stattdessen erstellt die CMFCColorMenuButton-Klasse (in Menüs und Symbolleisten verwendet) oder die CMFCColorButton-Klasse das CMFCColorBar -Objekt.

Die CMFCColorBar -Klasse bietet die folgenden Funktionen:

  • Passt die Liste der Dokumentfarben automatisch an.

  • Speichert und stellt seinen Zustand zusammen mit dem Dokumentzustand wieder her.

  • Verwaltet die Schaltfläche "automatisch".

  • Verwendet das CMFCColorPickerCtrl-Klassensteuerelement , um eine benutzerdefinierte Farbe auszuwählen.

  • Unterstützt einen "Tear-off"-Zustand (wenn er mit der CMFCColorMenuButton-Klasse erstellt wird).

So integrieren Sie die CMFCColorBar Funktionalität in Ihre Anwendung:

  1. Erstellen Sie eine reguläre Menüschaltfläche, und weisen Sie ihr eine ID zu, z. B. ID_CHAR_COLOR.

  2. Überschreiben Sie in der Framefensterklasse die CFrameWndEx::OnShowPopupMenu-Methode , und ersetzen Sie die reguläre Menüschaltfläche durch ein CMFCColorMenuButton-Klassenobjekt (durch Aufrufen von CMFCToolBar::ReplaceButton).

  3. Legen Sie alle Stile fest, und aktivieren oder deaktivieren Sie die Funktionen des Objekts während der Erstellung der CMFCColorBarCMFCColorMenuButton-Klasse . Das CMFCColorMenuButton -Objekt erstellt das CMFCColorBar -Objekt dynamisch, nachdem das Framework die - CreatePopupMenu Methode aufruft.

Wenn der Benutzer auf eine Schaltfläche für das Farbleisten-Steuerelement klickt, verwendet das Framework das ON_COMMAND Makro, um das übergeordnete Element des Farbleistensteuerelements zu benachrichtigen. Im Makro ist der Befehls-ID-Parameter der Wert, den Sie der Schaltfläche für das Farbleistensteuerelement in Schritt 1 zugewiesen haben (in diesem Beispiel ID_CHAR_COLOR). Weitere Informationen finden Sie in den Klassen CMFCColorMenuButton-Klasse, CMFCColorButton-Klasse, CMFCColorPickerCtrl-Klasse, CFrameWndEx-Klasse und CMFCToolBar-Klasse .

Beispiel

Im folgenden Beispiel wird veranschaulicht, wie eine Farbleiste mithilfe verschiedener Methoden in der CMFCColorBar -Klasse konfiguriert wird. Die Methoden legen die horizontalen und vertikalen Ränder fest, aktivieren die andere Schaltfläche, erstellen ein Farbleisten-Steuerelementfenster und legen die aktuell ausgewählte Farbe fest. Dieses Beispiel ist Teil des Beispiels Neue Steuerelemente.

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

Vererbungshierarchie

Cobject

CCmdTarget

CWnd

CBasePane

CPane

CMFCBaseToolBar

CMFCToolBar

CMFCPopupMenuBar

CMFCColorBar

Anforderungen

Header: afxcolorbar.h

CMFCColorBar::AdjustLocations

Passt die Positionen der Farbschaltflächen im Farbleisten-Steuerelement an.

virtual void AdjustLocations();

Hinweise

Diese Methode wird vom Framework während WM_SIZE Nachrichtenverarbeitung aufgerufen.

CMFCColorBar::AllowChangeTextLabels

Gibt an, ob sich die Textbezeichnung von Farbschaltflächen ändern kann.

virtual BOOL AllowChangeTextLabels() const;

Rückgabewert

Immer FALSE

Bemerkungen

Standardmäßig gibt diese Methode immer FALSE zurück, was bedeutet, dass Textbeschriftungen nicht geändert werden können. Überschreiben Sie diese Methode, um das Ändern von Textbezeichnungen zu ermöglichen.

CMFCColorBar::AllowShowOnList

Gibt an, ob das Farbleisten-Steuerelementobjekt während des Anpassungsprozesses in einer Symbolleistenliste angezeigt werden kann.

virtual BOOL AllowShowOnList() const;

Rückgabewert

Immer TRUE.

Bemerkungen

Standardmäßig gibt diese Methode immer TRUE zurück, was bedeutet, dass das Framework das Farbleistensteuerelement während des Anpassungsprozesses anzeigen kann. Überschreiben Sie diese Methode, um ein anderes Verhalten zu implementieren.

CMFCColorBar::CalcSize

Wird vom Framework als Teil des Layoutberechnungsprozesses aufgerufen.

virtual CSize CalcSize(BOOL bVertDock);

Parameter

bVertDock
[in] TRUE, um anzugeben, dass das Farbleisten-Steuerelement vertikal angedockt wird. FALSE, um anzugeben, dass das Farbleisten-Steuerelement horizontal angedockt wird.

Rückgabewert

Die Größe des Arrays von Farbschaltflächen in einem Farbleistensteuerelement.

CMFCColorBar::CMFCColorBar

Erstellt ein CMFCColorBar-Objekt.

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

Parameter

Farben
[in] Ein Array von Farben, das das Framework im Farbleistensteuerelement anzeigt.

color
[in] Die anfänglich ausgewählte Farbe.

lpszAutoColor
[in] Die Textbezeichnung der automatischen (Standard-)Farbschaltfläche oder NULL.

Die Standardbezeichnung für die automatische Schaltfläche ist Automatisch.

lpszOtherColor
[in] Die Textbezeichnung der anderen Schaltfläche, die mehr Farboptionen anzeigt, oder NULL.

Die Standardbezeichnung für die andere Schaltfläche ist Weitere Farben....

lpszDocColors
[in] Die Textbezeichnung der Dokumentfarbenschaltfläche. Die Dokumentfarbenpalette listet alle Farben auf, die das Dokument derzeit verwendet.

lstDocColors
[in] Eine Liste der Farben, die das Dokument derzeit verwendet.

nColumns
[in] Die Anzahl der Spalten, über die das Array von Farben verfügt.

nRowsDockHorz
[in] Die Anzahl der Zeilen, die die Farbleiste aufweist, wenn sie horizontal angedockt wird.

nColDockVert
[in] Die Anzahl der Spalten, die die Farbleiste aufweist, wenn sie vertikal angedockt wird.

colorAutomatic
[in] Die Standardfarbe, die das Framework anwendet, wenn Sie auf die Schaltfläche "Automatisch" klicken.

nCommandID
[in] Die Befehls-ID des Farbleistensteuerelements.

pParentBtn
[in] Ein Zeiger auf eine übergeordnete Schaltfläche.

src
[in] Ein vorhandenes CMFCColorBar Objekt, das in das neue CMFCColorBar Objekt kopiert werden soll.

uiCommandID
[in] Die Befehls-ID.

CMFCColorBar::ContextToSize

Berechnet die vertikalen und horizontalen Ränder, die erforderlich sind, um die Schaltflächen im Farbleisten-Steuerelement zu enthalten, und passt die Position dieser Schaltflächen an.

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

Parameter

bSquareButtons
[in] TRUE, um anzugeben, dass die Form der Schaltflächen in einem Farbleisten-Steuerelement quadratisch ist. andernfalls FALSE. Der Standardwert ist TRUE.

bCenterButtons
[in] TRUE, um anzugeben, dass der Inhalt auf dem Gesicht einer Farbleisten-Steuerelementschaltfläche zentriert ist. andernfalls FALSE. Der Standardwert ist TRUE.

Hinweise

CMFCColorBar::Create

Erstellt ein Farbleisten-Steuerelementfenster und fügt es an das CMFCColorBar -Objekt an.

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

Parameter

pParentWnd
[in] Zeiger auf das übergeordnete Fenster.

dwStyle
[in] Eine bitweise Kombination (OR) von Fensterstilen.

nID
[in] Die Befehls-ID.

pPalette
[in] Zeiger auf eine Palette von Farben. Die Standardeinstellung ist NULL.

nColumns
[in] Die Anzahl der Spalten im Farbleistensteuerelement. Die Standardeinstellung ist 0.

nRowsDockHorz
[in] Die Anzahl der Zeilen im Farbleistensteuerelement, wenn es horizontal angedockt wird. Die Standardeinstellung ist 0.

nColDockVert
[in] Die Anzahl der Spalten im Farbleistensteuerelement, wenn es vertikal angedockt wird. Die Standardeinstellung ist 0.

Rückgabewert

TRUE, wenn diese Methode erfolgreich ist; andernfalls FALSE.

Hinweise

Um ein CMFCColorBar -Objekt zu erstellen, rufen Sie den Klassenkonstruktor und dann diese Methode auf. Die Create -Methode erstellt das Windows-Steuerelement und initialisiert eine Liste von Farben.

CMFCColorBar::CreateControl

Erstellt ein Farbleisten-Steuerelementfenster, fügt es an das CMFCColorBar -Objekt an und legt die Größe des Steuerelementfensters so fest, dass es die angegebene Palette von Farben enthält.

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

Parameter

pParentWnd
[in] Zeiger auf das übergeordnete Fenster. Lässt keine NULL-Werte zu.

Rect
[in] Ein umgrenzendes Rechteck, das angibt, wo das Farbleistensteuerelement gezeichnet werden soll.

nID
[in] Die Steuerelement-ID.

nColumns
[in] Die ideale Anzahl von Spalten im Farbleisten-Steuerelement. Diese Methode ändert diese Zahl so, dass sie der angegebenen Palette von Farben entspricht. Der Standardwert ist -1. Dies bedeutet, dass dieser Parameter nicht angegeben ist.

pPalette
[in] Zeiger auf eine Palette von Farben oder NULL. Wenn dieser Parameter NULL ist, berechnet diese Methode die Größe des Farbleistensteuerelements so, als wären 20 Farben angegeben. Die Standardeinstellung ist NULL.

Rückgabewert

TRUE, wenn diese Methode erfolgreich ist; andernfalls FALSE.

Hinweise

Diese Methode verwendet die Parameter rect, nColumns und pPalette , um die entsprechende Anzahl oder Zeilen und Spalten im Farbleistensteuerelement zu berechnen, und ruft dann die CMFCColorBar::Create-Methode auf.

CMFCColorBar::CreatePalette

Initialisiert eine Palette mit den Farben in einem angegebenen Array von Farben.

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

Parameter

arColors
[in] Ein Array von Farben.

Palette
[in] Eine Palette von Farben.

Rückgabewert

TRUE, wenn diese Methode erfolgreich ist; andernfalls FALSE.

CMFCColorBar::EnableAutomaticButton

Zeigt die automatische Schaltfläche an oder blendet sie aus.

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

Parameter

lpszLabel
[in] Die Textbezeichnung der automatischen (Standard-)Farbschaltfläche oder NULL.

Die Standardbezeichnung für die automatische Schaltfläche ist Automatisch.

colorAutomatic
[in] Die Standardfarbe, die das Framework anwendet, wenn Sie auf die Schaltfläche "Automatisch" klicken.

bEnable
[in] TRUE, um die automatische Schaltfläche zu aktivieren. FALSE, um die automatische Schaltfläche zu deaktivieren. Der Standardwert ist TRUE.

Hinweise

Die Textbezeichnung der automatischen Schaltfläche wird gelöscht, wenn der lpszLabel-Parameter NULL oder der bEnable-Parameter FALSE ist.

CMFCColorBar::EnableOtherButton

Aktiviert oder deaktiviert die Anzeige eines Dialogfelds, in dem der Benutzer weitere Farben auswählen kann.

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

Parameter

lpszLabel
[in] Die Textbezeichnung der anderen Schaltfläche , die mehr Farboptionen anzeigt, oder NULL.

Die Standardbezeichnung für diese Schaltfläche ist Mehr Farben....

bAltColorDlg
[in] TRUE, um das Dialogfeld CMFCColorDialog anzuzeigen; FALSE, um das Standardmäßige Dialogfeld CColorDialog anzuzeigen. Der Standardwert ist TRUE.

bEnable
[in] TRUE, um die Schaltfläche zu aktivieren; FALSE, um die Schaltfläche zu deaktivieren. Der Standardwert ist TRUE.

CMFCColorBar::GetColor

Ruft die aktuell ausgewählte Farbe ab.

COLORREF GetColor() const;

Rückgabewert

Die aktuell ausgewählte Farbe.

CMFCColorBar::GetColorGridSize

Berechnet die Anzahl der Zeilen und Spalten im Raster eines Farbleisten-Steuerelements.

CSize GetColorGridSize(BOOL bVertDock) const;

Parameter

bVertDock
[in] TRUE, um die Berechnung für ein vertikal angedocktes Farbleisten-Steuerelement durchzuführen; Andernfalls führen Sie die Berechnung für ein horizontal angedocktes Steuerelement aus.

Rückgabewert

Ein CSize-Objekt , dessen cx Komponente die Anzahl der Spalten und deren cy Komponente die Anzahl der Zeilen enthält.

CMFCColorBar::GetCommandID

Ruft die Befehls-ID des aktuellen Farbleisten-Steuerelements ab.

UINT GetCommandID() const;

Rückgabewert

Eine Befehls-ID.

Hinweise

Wenn der Benutzer eine neue Farbe auswählt, sendet das Framework die Befehls-ID in WM_COMMAND Nachricht, um das übergeordnete Element des Objekts zu CMFCColorBar benachrichtigen.

CMFCColorBar::GetExtraHeight

Berechnet die zusätzliche Höhe, die die aktuelle Farbleiste benötigt, um verschiedene Benutzeroberflächenelemente anzuzeigen, z. B. die Schaltfläche Andere oder Dokumentfarben.

int GetExtraHeight(int nNumColumns) const;

Parameter

nNumColumns
[in] Wenn das Farbleisten-Steuerelement Dokumentfarben enthält, die Anzahl der Spalten, die im Raster der Dokumentfarben angezeigt werden sollen. Andernfalls wird dieser Wert nicht verwendet.

Rückgabewert

Die berechnete zusätzliche Höhe, die erforderlich ist.

CMFCColorBar::GetHighlightedColor

Ruft die Farbe ab, die andeutet, dass eine Farbschaltfläche den Fokus besitzt. Das heißt, die Schaltfläche ist heiß.

COLORREF GetHighlightedColor() const;

Rückgabewert

Ein RGB-Wert.

Hinweise

CMFCColorBar::GetHorzMargin

Ruft den horizontalen Rand ab. Dabei handelt es sich um den Abstand zwischen der linken oder rechten Farbzelle und der Clientbereichsgrenze.

int GetHorzMargin();

Rückgabewert

Der horizontale Rand.

CMFCColorBar::GetVertMargin

Ruft den vertikalen Rand ab, bei dem es sich um den Abstand zwischen der oberen oder unteren Farbzelle und der Clientbereichsgrenze handelt.

int GetVertMargin() const;

Rückgabewert

Der vertikale Rand.

CMFCColorBar::InitColors

Initialisiert ein Array von Farben mit den Farben in einer angegebenen Palette oder mit der Standardpalette des Systems.

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

Parameter

pPalette
[in] Ein Zeiger auf ein Palettenobjekt oder NULL. Wenn dieser Parameter NULL ist, verwendet diese Methode die Standardpalette des Betriebssystems.

arColors
[in] Ein Array von Farben.

Rückgabewert

Die Anzahl der Elemente im Array von Farben.

CMFCColorBar::IsTearOff

Gibt an, ob die aktuelle Farbleiste andockbar ist.

BOOL IsTearOff() const;

Rückgabewert

TRUE, wenn das aktuelle Farbleisten-Steuerelement andockbar ist; andernfalls FALSE.

Hinweise

Wenn das Farbleisten-Steuerelement andockbar ist, kann es von einer Steuerleiste ab- und an einer anderen Position angedockt werden.

CMFCColorBar::OnKey

Wird vom Framework aufgerufen, wenn ein Benutzer eine Tastaturtaste drückt.

virtual BOOL OnKey(UINT nChar);

Parameter

Nchar
[in] Der virtuelle Schlüsselcode für die Taste, die ein Benutzer gedrückt hat.

Rückgabewert

TRUE, wenn diese Methode den angegebenen Schlüssel verarbeitet; andernfalls FALSE.

CMFCColorBar::OnSendCommand

Wird vom Framework aufgerufen, um eine Hierarchie von Popupsteuerelementen zu schließen.

virtual BOOL OnSendCommand(const CMFCToolBarButton* pButton);

Parameter

pButton
[in] Zeiger auf ein Steuerelement, das sich auf einer Symbolleiste befindet.

Rückgabewert

TRUE, wenn diese Methode erfolgreich ist; andernfalls FALSE.

CMFCColorBar::OnUpdateCmdUI

Wird vom Framework aufgerufen, um ein Benutzeroberflächenelement eines Farbleisten-Steuerelements zu aktivieren oder zu deaktivieren, bevor das Element angezeigt wird.

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

Parameter

pTarget
[in] Zeiger auf ein Fenster, das ein zu aktualisierende Benutzeroberflächenelement enthält.

bDisableIfNoHndler
[in] TRUE, um das Benutzeroberflächenelement zu deaktivieren, wenn kein Handler in einer Meldungszuordnung definiert ist; andernfalls FALSE.

Hinweise

Wenn ein Benutzer Ihrer Anwendung auf ein Benutzeroberflächenelement klickt, muss das Element wissen, ob es als aktiviert oder deaktiviert angezeigt werden soll. Das Ziel der Befehlsmeldung stellt diese Informationen durch Implementieren eines ON_UPDATE_COMMAND_UI Befehlshandlers zur Verfügung. Verwenden Sie diese Methode, um den Befehl zu verarbeiten. Weitere Informationen finden Sie unter CCmdUI-Klasse.

CMFCColorBar::OpenColorDialog

Öffnet ein Farbdialogfeld.

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

Parameter

colorDefault
[in] Die Farbe, die standardmäßig ausgewählt wird, wenn das Farbdialogfeld geöffnet wird.

colorRes
[out] Die Farbe, die ein Benutzer ausgewählt hat.

Rückgabewert

TRUE, wenn der Benutzer eine Farbe ausgewählt hat; FALSE, wenn der Benutzer das Farbdialogfeld abgebrochen hat.

Hinweise

CMFCColorBar::Rebuild

Das Farbleisten-Steuerelement wird vollständig neu gedrammt.

virtual void Rebuild();

CMFCColorBar::SelectPalette

Legt die logische Palette des angegebenen Gerätekontexts auf die Palette der übergeordneten Schaltfläche des aktuellen Farbleisten-Steuerelements fest.

CPalette* SelectPalette(CDC* pDC);

Parameter

Pdc
[in] Zeiger auf den Gerätekontext der übergeordneten Schaltfläche des aktuellen Farbleisten-Steuerelements.

Rückgabewert

Zeiger auf die Palette, die durch die Palette der übergeordneten Schaltfläche des aktuellen Farbleisten-Steuerelements ersetzt wird.

CMFCColorBar::SetColor

Legt die Farbe fest, die derzeit ausgewählt ist.

void SetColor(COLORREF color);

Parameter

color
[in] Ein RGB-Farbwert.

CMFCColorBar::SetColorName

Legt einen neuen Namen für eine angegebene Farbe fest.

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

Parameter

color
[in] Der RGB-Wert einer Farbe.

strName
[in] Der neue Name für die angegebene Farbe.

Hinweise

Diese Methode ändert den Namen der angegebenen Farbe in allen CMFCColorBar Objekten in Ihrer Anwendung.

CMFCColorBar::SetCommandID

Legt eine neue Befehls-ID für ein Farbleisten-Steuerelement fest.

void SetCommandID(UINT nCommandID);

Parameter

nCommandID
[in] Eine Befehls-ID.

Hinweise

Rufen Sie diese Methode auf, um die Befehls-ID eines Farbleisten-Steuerelements zu ändern und das übergeordnete Fenster des Steuerelements zu benachrichtigen, dass sich die ID geändert hat.

CMFCColorBar::SetDocumentColors

Legt die Liste der Farben fest, die im aktuellen Dokument verwendet werden.

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

Parameter

lpszCaption
[in] Eine Beschriftung, die angezeigt wird, wenn das Farbleisten-Steuerelement nicht angedockt ist.

lstDocColors
[in] Eine Liste von Farben, die die aktuellen Dokumentfarben ersetzen.

bShowWhenDocked
[in] TRUE, um Dokumentfarben beim Andocken des Farbleisten-Steuerelements zu zeigen; andernfalls FALSE. Der Standardwert ist FALSE.

Hinweise

Dokumentfarben sind die Farben, die derzeit in einem Dokument verwendet werden. Das Framework verwaltet automatisch eine Liste von Dokumentfarben, aber Sie können diese Methode verwenden, um die Liste zu ändern.

CMFCColorBar::SetHorzMargin

Legt den horizontalen Rand fest. Dies ist der Abstand zwischen der linken oder rechten Farbzelle und der Begrenzung des Clientbereichs.

void SetHorzMargin(int nHorzMargin);

Parameter

nHorzMargin
[in] Der horizontale Rand in Pixel.

Hinweise

Standardmäßig legt der CMFCColorBar::CMFCColorBar-Konstruktor den horizontalen Rand auf 4 Pixel fest.

CMFCColorBar::SetPropList

Legt den geschützten m_pWndPropList Daten member auf den angegebenen Zeiger auf ein Eigenschaftenraster-Steuerelement fest.

void SetPropList(CMFCPropertyGridCtrl* pWndList);

Parameter

pWndList
[in] Zeiger auf das Eigenschaftenraster-Steuerelementobjekt.

CMFCColorBar::SetVertMargin

Legt den vertikalen Rand fest. Dies ist der Abstand zwischen der oberen oder unteren Farbzelle und der Clientbereichsgrenze.

void SetVertMargin(int nVertMargin);

Parameter

nVertMargin
[in] Der vertikale Rand in Pixel.

Hinweise

Standardmäßig legt der CMFCColorBar::CMFCColorBar-Konstruktor den vertikalen Rand auf 4 Pixel fest.

CMFCColorBar::ShowCommandMessageString

Fordert das Rahmenfenster an, das das Farbleisten-Steuerelement besitzt, die Meldungszeile in der Statusleiste zu aktualisieren.

virtual void ShowCommandMessageString(UINT uiCmdId);

Parameter

uiCmdId
[in] Eine Befehls-ID. (Dieser Parameter wird ignoriert.)

Hinweise

Diese Methode sendet die WM_SETMESSAGESTRING an den Besitzer des Farbleisten-Steuerelements.

Weitere Informationen

Hierarchiediagramm
Klassen