Partilhar via


Classe CMFCRibbonColorButton

Observação

A biblioteca Microsoft Foundation Classes (MFC) continua a ser suportada. No entanto, já não estamos a adicionar funcionalidades nem a atualizar a documentação.

A CMFCRibbonColorButton classe implementa um botão de cor que podes adicionar a uma barra de fita. O botão de cor da fita apresenta um menu suspenso que contém uma ou mais paletas de cores.

Sintaxe

class CMFCRibbonColorButton : public CMFCRibbonGallery

Membros

Construtores Públicos

Nome Description
CMFCRibbonColorButton::CMFCRibbonColorButton.

Métodos Públicos

Nome Description
CMFCRibbonColorButton::AddColorsGroup Adiciona um grupo de cores à área de cor normal.
CMFCRibbonColorButton::EnableAutomaticButton Especifica se o botão Automático está ativado.
CMFCRibbonColorButton::EnableOtherButton Ativa o botão Outro .
CMFCRibbonColorButton::GetAutomaticColor
CMFCRibbonColorButton::GetColor Devolve a cor atualmente selecionada.
CMFCRibbonColorButton::GetColorBoxSize Devolve o tamanho dos elementos de cor que aparecem na barra de cores.
CMFCRibbonColorButton::GetColumns
CMFCRibbonColorButton::GetHighedColor Devolve a cor do elemento atualmente selecionado na paleta de cores pop-up.
CMFCRibbonColorButton::RemoveAllColorGroups Remove todos os grupos de cores da área de cor normal.
CMFCRibbonColorButton::SetColor Seleciona uma cor da área de cor normal.
CMFCRibbonColorButton::SetColorBoxSize Define o tamanho de todos os elementos de cor que aparecem na barra de cores.
CMFCRibbonColorButton::SetColorName
CMFCRibbonColorButton::SetColumns
CMFCRibbonColorButton::SetDocumentColors Especifica uma lista de valores RGB para mostrar na área de cor do documento.
CMFCRibbonColorButton::SetPalette
CMFCRibbonColorButton::UpdateColor

Observações

O botão de cor da fita exibe uma barra de cor quando o utilizador o pressiona. Por defeito, esta barra de cores contém uma paleta de seleção de cores chamada área de cor regular. Opcionalmente, a barra de cores pode mostrar um botão Automático , que permite ao utilizador selecionar uma cor predefinida, e um botão Outros , que mostra uma paleta de cores pop-up com cores adicionais.

Example

O exemplo seguinte demonstra como usar vários métodos na CMFCRibbonColorButton aula. O exemplo mostra como construir um CMFCRibbonColorButton objeto, definir a imagem grande, ativar o botão Automático , ativar o botão Outro , definir o número de colunas, definir o tamanho de todos os elementos de cor que aparecem na barra de cores, adicionar um grupo de cores à área de cor normal e especificar uma lista de valores RGB para mostrar na área de cor do documento. Este excerto de código faz parte do exemplo 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);

Hierarquia de herança

CObject

CMFCRibbonBaseElement

CMFCRibbonButton

CMFCRibbonGaleria

CMFCRibbonColorButton

Requerimentos

Cabeçalho: afxribboncolorbutton.h

CMFCRibbonColorButton::AddColorsGroup

Adiciona um grupo de cores à área de cor normal.

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

Parâmetros

lpszName
[dentro] O nome do grupo.

lstColors
[dentro] A lista de cores.

bColunas Contíguas
[dentro] Controla como os itens coloridos são apresentados no grupo. Se for VERDADEIRO, os itens coloridos são desenhados sem espaçamento vertical. Se FALSE, os itens de cor são desenhados com espaçamento vertical.

Observações

Use esta função para fazer com que o pop-up de cores mostre vários grupos de cores. Podes controlar como as cores são apresentadas em grupo.

CMFCRibbonColorButton::CMFCRibbonColorButton.

Constrói um CMFCRibbonColorButton objeto.

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

Parâmetros

nID
[dentro] Especifica o ID do comando a executar quando o utilizador clica no botão.

lpszText
[dentro] Especifica o texto a aparecer no botão.

nSmallImageIndex
[dentro] O índice em base zero da imagem pequena aparecerá no botão.

cor
[dentro] A cor do botão (preto por defeito).

bSimpleButtonLook
[dentro] Se TRUE, o botão é desenhado como um simples retângulo.

nLargeImageIndex
[dentro] O índice em base zero da imagem grande deve aparecer no botão.

Valor de retorno

Observações

CMFCRibbonColorButton::EnableAutomaticButton

Especifica se o botão Automático está ativado.

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

Parâmetros

lpszLabel
[dentro] A etiqueta para o botão Automático .

colorAutomatic
[dentro] Um valor RGB que especifica a cor padrão do botão Automático .

bEnable
[dentro] TRUE se o botão Automático estiver ativado; FALSE se estiver desativado.

lpszToolTip
[dentro] A dica do botão Automático .

bOnTop
[dentro] Especifica se o botão Automático está no topo, antes da paleta de cores.

bDrawBorder
[dentro] VERDADE se a aplicação desenhar uma borda à volta da barra de cor no botão de cor da fita. A barra de cores mostra a cor atualmente selecionada. FALSE se a aplicação não desenhar uma fronteira

CMFCRibbonColorButton::EnableOtherButton

Ativa o botão Outro .

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

Parâmetros

lpszLabel
A etiqueta do botão.

lpszToolTip
O texto da tooltip para o botão Outro .

Observações

O botão Outro é o botão que aparece abaixo do grupo de cores. Quando o utilizador clica no botão Outro , aparece um diálogo a cores.

CMFCRibbonColorButton::GetAutomaticColor

Recupera a cor atual do botão automático.

COLORREF GetAutomaticColor() const;

Valor de retorno

Um valor de cor RGB que representa a cor atual do botão automático.

Observações

A cor do botão automático é definida pelo colorAutomatic parâmetro passado ao CMFCRibbonColorButton::EnableAutomaticButton método.

CMFCRibbonColorButton::GetColor

Devolve a cor atualmente selecionada.

COLORREF GetColor() const;

Valor de retorno

A cor selecionada clicando no botão.

CMFCRibbonColorButton::GetColorBoxSize

Devolve o tamanho dos elementos de cor que aparecem na barra de cores.

CSize GetColorBoxSize() const;

Valor de retorno

O tamanho dos botões de cor na paleta de cores suspensa.

CMFCRibbonColorButton::GetColumns

Obtém o número de itens numa linha da galeria do botão de cor da fita.

int GetColumns() const;

Valor de retorno

Devolve o número de ícones em cada linha.

Observações

CMFCRibbonColorButton::GetHighedColor

Devolve a cor do elemento atualmente selecionado na paleta de cores pop-up.

COLORREF GetHighlightedColor() const;

Valor de retorno

A cor do elemento atualmente selecionado na paleta de cores pop-up.

CMFCRibbonColorButton::RemoveAllColorGroups

Remove todos os grupos de cores da área de cor normal.

void RemoveAllColorGroups();

CMFCRibbonColorButton::SetColor

Seleciona uma cor da área de cor normal.

void SetColor(COLORREF color);

Parâmetros

cor
[dentro] Uma cor para fixar.

CMFCRibbonColorButton::SetColorBoxSize

Define o tamanho de todos os elementos de cor que aparecem na barra de cores.

void SetColorBoxSize(CSize sizeBox);

Parâmetros

sizeBox
[dentro] O novo tamanho dos botões de cor na paleta de cores.

CMFCRibbonColorButton::SetColorName

Define um novo nome para uma cor especificada.

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

Parâmetros

cor
[dentro] O valor RGB de uma cor.

strName
[dentro] O novo nome para a cor especificada.

Observações

Como chama CMFCColorBar::SetColorName, este método altera o nome da cor especificada em todos CMFCColorBar os objetos da sua aplicação.

CMFCRibbonColorButton::SetColumns

Define o número de colunas apresentadas na tabela de cores que é apresentada ao utilizador durante o processo de seleção de cores.

void SetColumns(int nColumns);

Parâmetros

nColunas
[dentro] O número de ícones de cor a mostrar em cada linha.

Observações

CMFCRibbonColorButton::SetDocumentColors

Especifica uma lista de valores RGB para mostrar na área de cor do documento.

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

Parâmetros

lpszLabel
[dentro] O texto a ser exibido com as cores do documento.

lstColors
[dentro] Uma referência a uma lista de valores RGB.

CMFCRibbonColorButton::SetPalette

Especifica as cores padrão a mostrar na tabela de cores que o botão de cores apresenta.

void SetPalette(CPalette* pPalette);

Parâmetros

pPalette
[dentro] Um apontador para uma paleta de cores.

Observações

CMFCRibbonColorButton::UpdateColor

É chamado pelo framework quando o utilizador seleciona uma cor da tabela de cores exibida ao clicar no botão de cor.

void UpdateColor(COLORREF color);

Parâmetros

cor
[dentro] Uma cor selecionada pelo utilizador.

Observações

O CMFCRibbonColorButton::UpdateColor método altera a cor do botão atualmente selecionado e notifica o seu pai enviando uma mensagem WM_COMMAND com uma notificação BN_CLICKED padrão. Use o método CMFCRibbonColorButton::GetColor para recuperar a cor selecionada.

Consulte também

Gráfico de Hierarquia
Classes
Classe CMFCRibbonGaleria