Classe CMFCRibbonColorButton
A classe CMFCRibbonColorButton implementa um botão de cores que você pode adicionar a uma barra de faixa de opções. O botão de cor da faixa de opções exibe um menu suspenso que contém uma ou mais paletas de cores.
Sintaxe
class CMFCRibbonColorButton : public CMFCRibbonGallery
Membros
Construtores públicos
| Nome | Descrição |
|---|---|
| CMFCRibbonColorButton::CMFCRibbonColorButton |
Métodos públicos
| Nome | Descrição |
|---|---|
| CMFCRibbonColorButton::AddColorsGroup | Adiciona um grupo de cores à área de cores regular. |
| CMFCRibbonColorButton::EnableAutomaticButton | Especifica se o botão Automático está habilitado. |
| CMFCRibbonColorButton::EnableOtherButton | Habilita o botão Outra. |
| CMFCRibbonColorButton::GetAutomaticColor | |
| CMFCRibbonColorButton::GetColor | Retorna a cor atualmente selecionada. |
| CMFCRibbonColorButton::GetColorBoxSize | Retorna o tamanho dos elementos de cor que aparecem na barra de cores. |
| CMFCRibbonColorButton::GetColumns | |
| CMFCRibbonColorButton::GetHighlightedColor | Retorna a cor do elemento atualmente selecionado na paleta pop-up de cores. |
| CMFCRibbonColorButton::RemoveAllColorGroups | Remove todos os grupos de cores da área de cores regular. |
| CMFCRibbonColorButton::SetColor | Seleciona uma cor na área de cores regular. |
| 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 a serem exibidos na área de cores do documento. |
| CMFCRibbonColorButton::SetPalette | |
| CMFCRibbonColorButton::UpdateColor |
Comentários
O botão de cor da faixa de opções exibe uma barra de cores quando um usuário a pressiona. Por padrão, essa barra de cores contém uma paleta de seleção de cores chamada área de cores regular. Opcionalmente, a barra de cores pode exibir um botão Automático, que permite que o usuário selecione uma cor padrão e um botão Outra, que exibe uma paleta pop-up contendo cores adicionais.
Exemplo
O exemplo a seguir demonstra como usar vários métodos na classe CMFCRibbonColorButton. O exemplo mostra como construir um objeto CMFCRibbonColorButton, definir a imagem grande, habilitar o botão Automático, habilitar o botão Outra, 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 cores regular e especificar uma lista de valores RGB a serem exibidos na área de cores do documento. Esse snippet de código faz parte do exemplo Desenhar Cliente.
// 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
Requisitos
Cabeçalho: afxribboncolorbutton.h
CMFCRibbonColorButton::AddColorsGroup
Adiciona um grupo de cores à área de cores regular.
void AddColorsGroup(
LPCTSTR lpszName,
const CList<COLORREF,COLORREF>& lstColors,
BOOL bContiguousColumns=FALSE);
Parâmetros
lpszName
[in] O nome do grupo.
lstColors
[in] A lista de cores.
bContiguousColumns
[in] Controla como os itens de cor são exibidos no grupo. Se TRUE, os itens de cor serão desenhados sem um espaçamento vertical. Se FALSE, os itens de cor serão desenhados com um espaçamento vertical.
Comentários
Use essa função para fazer com que o pop-up de cores exiba vários grupos de cores. Você pode controlar como as cores são exibidas em grupo.
CMFCRibbonColorButton::CMFCRibbonColorButton
Constrói um objeto 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));
Parâmetros
Nid
[in] Especifica a ID de comando do comando a ser executado quando um usuário clica no botão.
lpszTexto
[in] Especifica o texto a ser exibido no botão.
nSmallImageIndex
[in] O índice de base zero da imagem pequena a ser exibida no botão.
color
[in] A cor do botão (o padrão é preto).
bSimpleButtonLook
[in] Se TRUE, o botão será desenhado como um retângulo simples.
nLargeImageIndex
[in] O índice de base zero da imagem grande a ser exibida no botão.
Valor de retorno
Comentários
CMFCRibbonColorButton::EnableAutomaticButton
Especifica se o botão Automático está habilitado.
void EnableAutomaticButton(
LPCTSTR lpszLabel,
COLORREF colorAutomatic,
BOOL bEnable=TRUE,
LPCTSTR lpszToolTip=NULL,
BOOL bOnTop=TRUE,
BOOL bDrawBorder=FALSE);
Parâmetros
lpszLabel
[in] O rótulo do botão Automático.
colorAutomatic
[in] Um valor RGB que especifica a cor padrão do botão Automático.
bEnable
[in] TRUE se o botão Automático estiver habilitado; FALSE se estiver desabilitado.
lpszToolTip
[in] A dica de ferramenta do botão Automático.
bOnTop
[in] Especifica se o botão Automático está na parte superior, antes da paleta de cores.
bDrawBorder
[in] TRUE se o aplicativo desenhar uma borda ao redor da barra de cores no botão de cor da faixa de opções. A barra de cores exibe a cor atualmente selecionada. FALSE se o aplicativo não desenhar uma borda
CMFCRibbonColorButton::EnableOtherButton
Habilita o botão Outra.
void EnableOtherButton(
LPCTSTR lpszLabel,
LPCTSTR lpszToolTip=NULL);
Parâmetros
lpszLabel
O rótulo do botão.
lpszToolTip
O texto da dica de ferramenta para o botão Outra.
Comentários
O botão Outra é o botão exibido abaixo do grupo de cores. Quando o usuário clica no botão Outra, ele exibe uma caixa de diálogo de 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.
Comentários
A cor do botão automático é definida pelo parâmetro colorAutomatic passado para o método CMFCRibbonColorButton::EnableAutomaticButton.
CMFCRibbonColorButton::GetColor
Retorna a cor atualmente selecionada.
COLORREF GetColor() const;
Valor de retorno
A cor selecionada ao clicar o botão.
CMFCRibbonColorButton::GetColorBoxSize
Retorna 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 em uma linha da exibição da galeria do botão de cor da faixa de opções.
int GetColumns() const;
Valor de retorno
Retorna o número de ícones em cada linha.
Comentários
CMFCRibbonColorButton::GetHighlightedColor
Retorna a cor do elemento atualmente selecionado na paleta pop-up de cores.
COLORREF GetHighlightedColor() const;
Valor de retorno
A cor do elemento atualmente selecionado na paleta pop-up de cores.
CMFCRibbonColorButton::RemoveAllColorGroups
Remove todos os grupos de cores da área de cores regular.
void RemoveAllColorGroups();
CMFCRibbonColorButton::SetColor
Seleciona uma cor na área de cores regular.
void SetColor(COLORREF color);
Parâmetros
color
[in] Uma cor a ser definida.
CMFCRibbonColorButton::SetColorBoxSize
Define o tamanho de todos os elementos de cor que aparecem na barra de cores.
void SetColorBoxSize(CSize sizeBox);
Parâmetros
sizeBox
[in] 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
color
[in] O valor RGB de uma cor.
strName
[in] O novo nome da cor especificada.
Comentários
Como ele chama CMFCColorBar::SetColorName, esse método altera o nome da cor especificada em todos os objetos CMFCColorBar em seu aplicativo.
CMFCRibbonColorButton::SetColumns
Define o número de colunas exibidas na tabela de cores que é apresentada ao usuário durante o processo de seleção de cores do usuário.
void SetColumns(int nColumns);
Parâmetros
nColunas
[in] O número de ícones de cor a serem exibidos em cada linha.
Comentários
CMFCRibbonColorButton::SetDocumentColors
Especifica uma lista de valores RGB a serem exibidos na área de cores do documento.
void SetDocumentColors(
LPCTSTR lpszLabel,
CList<COLORREF,COLORREF>& lstColors);
Parâmetros
lpszLabel
[in] O texto a ser exibido com as cores do documento.
lstColors
[in] Uma referência a uma lista de valores RGB.
CMFCRibbonColorButton::SetPalette
Especifica as cores padrão a serem exibidas na tabela de cores exibida pelo botão de cores.
void SetPalette(CPalette* pPalette);
Parâmetros
pPalette
[in] Um ponteiro para uma paleta de cores.
Comentários
CMFCRibbonColorButton::UpdateColor
Chamado pela estrutura quando o usuário seleciona uma cor da tabela de cores exibida quando o usuário clica no botão de cor.
void UpdateColor(COLORREF color);
Parâmetros
color
[in] Uma cor selecionada pelo usuário.
Comentários
O método CMFCRibbonColorButton::UpdateColor altera a cor do botão atualmente selecionada e notifica seu pai enviando uma mensagem WM_COMMAND com uma notificação padrão BN_CLICKED. Use o método CMFCRibbonColorButton::GetColor para recuperar a cor selecionada.