Classe CMFCColorBar

A CMFCColorBar classe representa uma barra de controlo de acoplamento que pode selecionar cores num documento ou aplicação.

Sintaxe

class CMFCColorBar : public CMFCPopupMenuBar

Membros

Construtores Protegidos

Métodos Públicos

Métodos Protegidos

Membros de Dados Protegidos

Observações

Normalmente, não se cria um CMFCColorBar objeto diretamente. Em vez disso, a Classe CMFCColorMenuButton (usada em menus e barras de ferramentas) ou a Classe CMFCColorButton cria o CMFCColorBar objeto.

A CMFCColorBar classe oferece a seguinte funcionalidade:

• Ajusta automaticamente a lista de cores do documento.

• Guarda e restaura o seu estado, juntamente com o estado do documento.

• Gere o botão "automático".

• Utiliza o controlo CMFCColorPickerCtrl Class para selecionar uma cor personalizada.

• Suporta um estado "tear-off" (se for criado usando a classe CMFCColorMenuButton).

Para incorporar a CMFCColorBar funcionalidade na sua aplicação:

1. Cria um botão de menu normal e atribui-lhe um ID, por exemplo ID_CHAR_COLOR.

2. Na sua classe de janela de frame, substitua o método CFrameWndEx::OnShowPopupMenu e substitua o botão normal do menu por um objeto de classe CMFCColorMenuButton (chamando CMFCToolBar::ReplaceButton).

3. Defina todos os estilos e ative ou desative as funcionalidades do CMFCColorBar objeto durante a criação da classe CMFCColorMenuButton . O CMFCColorMenuButton objeto cria dinamicamente o CMFCColorBar objeto depois de o framework chamar o CreatePopupMenu método.

Quando o utilizador clica num botão de controlo da barra de cor, o framework usa a ON_COMMAND macro para notificar o pai do controlo da barra de cor. Na macro, o parâmetro ID de comando é o valor que atribuiste ao botão de controlo da barra de cor no passo 1 (ID_CHAR_COLOR neste exemplo). Para mais informações, consulte as classes CMFCColorMenuButton, CMFCColorButton Class, CMFCColorPickerCtrl,CFrameWndEx Class e CMFCToolBar.

Example

O exemplo seguinte demonstra como configurar uma barra de cor usando vários métodos na CMFCColorBar classe. Os métodos definem as margens horizontais e verticais, ativam o outro botão, criam uma janela de controlo da barra de cor e definem a cor atualmente selecionada. Este exemplo faz parte do exemplo 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));

Hierarquia de herança

CObject

CCmdTarget

CWnd

CBasePane

CPane

CMFCBaseToolBar

CMFCToolBar

CMFCPopupMenuBar

CMFCColorBar

Requerimentos

Cabeçalho: afxcolorbar.h

CMFCColorBar::AdjustLocations

Ajusta as posições dos botões de cor no controlo da barra de cor.

virtual void AdjustLocations();

Observações

Este método é chamado pelo framework durante o processamento de mensagens WM_SIZE.

CMFCColorBar::AllowChangeTextLabels

Indica se a etiqueta de texto dos botões de cor pode mudar.

virtual BOOL AllowChangeTextLabels() const;

Valor de retorno

Sempre FALSO.

Observações

Por defeito, este método devolve sempre FALSE, o que significa que as etiquetas de texto não podem ser modificadas. Substitua este método para permitir a modificação dos rótulos de texto.

CMFCColorBar::AllowShowOnList

Indica se o objeto de controlo da barra de cores pode aparecer numa lista da barra de ferramentas durante o processo de personalização.

virtual BOOL AllowShowOnList() const;

Valor de retorno

Sempre VERDADE.

Observações

Por defeito, este método devolve sempre TRUE, o que significa que o framework pode mostrar o controlo da barra de cor durante o processo de personalização. Anule este método para implementar um comportamento diferente.

CMFCColorBar::CalcSize

Chamado pelo framework como parte do processo de cálculo do layout.

virtual CSize CalcSize(BOOL bVertDock);

Parâmetros

bVertDock
[dentro] TRUE para especificar que o controlo da barra de cor está acoplado verticalmente; FALSE para especificar que o controlo da barra de cor está acoplado horizontalmente.

Valor de retorno

O tamanho da matriz de botões de cor num controlo de barra de cor.

CMFCColorBar::CMFCColorBar

Constrói um CMFCColorBar objeto.

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

Parâmetros

Cores
[dentro] Um array de cores que a estrutura mostra no controlo da barra de cores.

cor
[dentro] A cor inicialmente escolhida.

lpszAutoColor
[dentro] O rótulo de texto do botão automático (predefinido) de cor, ou NULL.

A etiqueta padrão para o botão automático é Automático.

lpszOtherColor
[dentro] O rótulo de texto do outro botão, que mostra mais escolhas de cor, ou NULL.

A etiqueta padrão para o outro botão é Mais Cores....

lpszDocColors
[dentro] A etiqueta de texto do botão de cores do documento. A paleta de cores do documento lista todas as cores que o documento utiliza atualmente.

lstDocColors
[dentro] Uma lista de cores que o documento utiliza atualmente.

nColunas
[dentro] O número de colunas que o array de cores tem.

nRowsDockHorz
[dentro] O número de linhas que a barra de cor tem quando está acoplada horizontalmente.

nColDockVert
[dentro] O número de colunas que a barra de cor tem quando está encaixada verticalmente.

colorAutomatic
[dentro] A cor padrão que a estrutura aplica quando clicas no botão automático.

nCommandID
[dentro] O ID do comando de controlo da barra de cores.

pParentBtn
[dentro] Um apontador para um botão parental.

src
[dentro] Um objeto existente CMFCColorBar a ser copiado para o novo CMFCColorBar objeto.

uiCommandID
[dentro] O ID do comando.

CMFCColorBar::ContextToSize

Calcula as margens verticais e horizontais necessárias para conter os botões no controlo da barra de cor e ajusta a localização desses botões.

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

Parâmetros

bSquareButtons
[dentro] TRUE para especificar que a forma dos botões num controlo de barra de cor é quadrada; caso contrário, FALSO. O valor padrão é VERDADEIRO.

bCenterButtons
[dentro] TRUE para especificar que o conteúdo na face de um botão de controlo da barra de cor está centrado; caso contrário, FALSO. O valor padrão é VERDADEIRO.

Observações

CMFCColorBar::Create

Cria uma janela de controlo de barra de cor e liga-a ao CMFCColorBar objeto.

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

Parâmetros

pParentWnd
[dentro] Aponta para a janela principal.

dwStyle
[dentro] Uma combinação bit a bit (OR) de estilos de janelas.

nID
[dentro] O ID do comando.

pPalette
[dentro] Aponta para uma paleta de cores. O padrão é NULL.

nColunas
[dentro] O número de colunas na barra de cor controla. O padrão é 0.

nRowsDockHorz
[dentro] O número de linhas na barra de cor controla quando está acoplada horizontalmente. O padrão é 0.

nColDockVert
[dentro] O número de colunas na barra de cor controla quando está acoplada verticalmente. O padrão é 0.

Valor de retorno

TRUE se este método for bem-sucedido; caso contrário, FALSO.

Observações

Para construir um CMFCColorBar objeto, chame o construtor de classes e depois este método. O Create método cria o controlo Windows e inicializa uma lista de cores.

CMFCColorBar::CreateControl

Cria uma janela de controlo na barra de cor, anexa-a ao CMFCColorBar objeto e redimensiona a janela de controlo para conter a paleta de cores especificada.

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

Parâmetros

pParentWnd
[dentro] Aponta para a janela principal. Não pode ser NULL.

retângulo
[dentro] Um retângulo delimitador que especifica onde desenhar o controlo da barra de cor.

nID
[dentro] O ID de controlo.

nColunas
[dentro] O número ideal de colunas na barra de cor controla. Este método modifica esse número para se ajustar à paleta de cores especificada. O padrão é -1, o que significa que este parâmetro não é especificado.

pPalette
[dentro] Apontar para uma paleta de cores, ou NULL. Se este parâmetro for NULL, este método calcula o tamanho do controlo da barra de cor como se fossem especificadas 20 cores. O padrão é NULL.

Valor de retorno

VERDADEIRO se este método tiver sucesso; caso contrário, FALSO.

Observações

Este método utiliza os parâmetros rect, nColumns e pPalette para calcular o número apropriado de linhas e colunas no controlo da barra de cor, e depois chama o método CMFCColorBar::Create .

CMFCColorBar::CreatePalette

Inicializa uma paleta com as cores num array especificado de cores.

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

Parâmetros

arColors
[dentro] Uma variedade de cores.

Paleta
[dentro] Uma paleta de cores.

Valor de retorno

TRUE se este método for bem-sucedido; caso contrário, FALSO.

CMFCColorBar::EnableAutomaticButton

Mostra ou esconde o botão automático.

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

Parâmetros

lpszLabel
[dentro] O rótulo de texto do botão automático (predefinido) de cor, ou NULL.

A etiqueta padrão para o botão automático é Automático.

colorAutomatic
[dentro] A cor padrão que a estrutura aplica quando clicas no botão automático.

bEnable
[dentro] TRUE para ativar o botão automático; FALSE para desativar o botão automático. O valor padrão é VERDADEIRO.

Observações

O rótulo de texto do botão automático é eliminado se o parâmetro lpszLabel for NULL ou se o parâmetro bEnable for FALSE.

CMFCColorBar::EnableOtherButton

Ativa ou desativa a visualização de uma caixa de diálogo que permite ao utilizador selecionar mais cores.

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

Parâmetros

lpszLabel
[dentro] O rótulo de texto do outro botão, que mostra mais escolhas de cor, ou NULL.

A etiqueta padrão para este botão é Mais Cores....

bAltColorDlg
[dentro] TRUE para mostrar a caixa de diálogo CMFCColorDialog ; FALSE para mostrar a caixa de diálogo padrão CColorDialog . O valor padrão é VERDADEIRO.

bEnable
[dentro] TRUE para ativar o botão; FALSE para desativar o botão. O valor padrão é VERDADEIRO.

CMFCColorBar::GetColor

Recupera a cor atualmente selecionada.

COLORREF GetColor() const;

Valor de retorno

A cor atualmente selecionada.

CMFCColorBar::GetColorGridSizeGrid

Calcula o número de linhas e colunas na grelha de um controlo de barra de cor.

CSize GetColorGridSize(BOOL bVertDock) const;

Parâmetros

bVertDock
[dentro] TRUE para realizar o cálculo de um controlo de barra de cor acoplada verticalmente; caso contrário, realizar o cálculo para um controlo acoplado horizontalmente.

Valor de retorno

Um objeto CSize cujo cx componente contém o número de colunas e cujo cy componente contém o número de linhas.

CMFCColorBar::GetCommandID

Recupera o ID de comando do controlo atual da barra de cor.

UINT GetCommandID() const;

Valor de retorno

Um ID de comando.

Observações

Quando o utilizador seleciona uma nova cor, o framework envia o ID do comando numa mensagem WM_COMMAND para notificar o pai do CMFCColorBar objeto.

CMFCColorBar::GetExtraHeight

Calcula a altura adicional que a barra de cor atual requer para exibir elementos diversos da interface do utilizador, como o botão Outro ou as cores do documento.

int GetExtraHeight(int nNumColumns) const;

Parâmetros

nNumColumns
[dentro] Se o controlo da barra de cor contiver cores do documento, o número de colunas a mostrar na grelha de cores do documento. Caso contrário, este valor não é utilizado.

Valor de retorno

A altura extra calculada que é necessária.

CMFCColorBar::GetHighedColor

Recupera a cor que indica que um botão de cor tem o foco; Ou seja, o botão está quente.

COLORREF GetHighlightedColor() const;

Valor de retorno

Um valor RGB.

Observações

CMFCColorBar::GetHorzMargin

Recupera a margem horizontal, que é o espaço entre a célula de cor esquerda ou direita e a fronteira da área do cliente.

int GetHorzMargin();

Valor de retorno

A margem horizontal.

CMFCColorBar::GetVertMargin

Recupera a margem vertical, que é o espaço entre a célula de cor superior ou inferior e o limite da área do cliente.

int GetVertMargin() const;

Valor de retorno

A margem vertical.

CMFCColorBar::InitColors

Inicializa um array de cores com as cores numa paleta especificada, ou com a paleta padrão do sistema.

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

Parâmetros

pPalette
[dentro] Um apontador para um objeto paleta, ou NULL. Se este parâmetro for NULL, este método utiliza a paleta padrão do sistema operativo.

arColors
[dentro] Uma variedade de cores.

Valor de retorno

O número de elementos na matriz de cores.

CMFCColorBar::IsTearOff

Indica se a barra de cor atual é acoplável.

BOOL IsTearOff() const;

Valor de retorno

TRUE se o controlo atual da barra de cor for acoplável; caso contrário, FALSO.

Observações

Se o controlo da barra de cor for acoplável, pode ser arrancado de uma barra de controlo e acoplado noutro local.

CMFCColorBar::OnKey

É chamado pelo framework quando um utilizador pressiona um botão do teclado.

virtual BOOL OnKey(UINT nChar);

Parâmetros

nChar
[dentro] O código da chave virtual para a tecla que um utilizador pressionou.

Valor de retorno

TRUE se este método processar a chave especificada; caso contrário, FALSO.

CMFCColorBar::OnSendCommand

Chamado pelo framework para fechar uma hierarquia de controlos pop-up.

virtual BOOL OnSendCommand(const CMFCToolBarButton* pButton);

Parâmetros

pButton
[dentro] Apontar para um controlo que reside numa barra de ferramentas.

Valor de retorno

TRUE se este método for bem-sucedido; caso contrário, FALSO.

CMFCColorBar::OnUpdateCmdUI

É chamado pela framework para ativar ou desativar um item de interface de utilizador de um controlo de barra de cor antes de o item ser exibido.

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

Parâmetros

pTarget
[dentro] Apontar para uma janela que contém um item de interface de utilizador para atualizar.

bDisableSeNoHndler
[dentro] TRUE para desativar o elemento da interface de utilizador se não houver um handler definido num mapa de mensagens; caso contrário, FALSO.

Observações

Quando um utilizador da sua aplicação clica num item da interface de utilizador, o item deve saber se deve ser apresentado como ativado ou desativado. O alvo da mensagem de comando fornece esta informação ao implementar um manipulador de comandos ON_UPDATE_COMMAND_UI. Use este método para ajudar a processar o comando. Para mais informações, consulte a Classe CCmdUI.

CMFCColorBar::OpenColorDialog

Abre uma caixa de diálogo a cores.

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

Parâmetros

colorDefault
[dentro] A cor que é selecionada por defeito quando a caixa de diálogo de cor se abre.

colorRes
[fora] A cor que o utilizador selecionou.

Valor de retorno

TRUE se o utilizador escolheu uma cor; FALSE se o utilizador cancelou a caixa de diálogo a cores.

Observações

CMFCColorBar::Reconstruir

Redesenha completamente o controlo da barra de cores.

virtual void Rebuild();

CMFCColorBar::SelectPalette

Define a paleta lógica do contexto do dispositivo especificado para a paleta do botão pai do controlo atual da barra de cor.

CPalette* SelectPalette(CDC* pDC);

Parâmetros

pDC
[dentro] Apontar para o contexto do dispositivo do botão pai do controlo atual da barra de cor.

Valor de retorno

Apontador para a paleta que é substituído pela paleta do botão pai do controlo atual da barra de cor.

CMFCColorBar::SetColor

Define a cor que está atualmente selecionada.

void SetColor(COLORREF color);

Parâmetros

cor
[dentro] Um valor de cor RGB.

CMFCColorBar::SetColorName

Define um novo nome para uma cor especificada.

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

Este método altera o nome da cor especificada em todos CMFCColorBar os objetos da sua aplicação.

CMFCColorBar::SetCommandID

Define um novo ID de comando para um controlo de barra de cor.

void SetCommandID(UINT nCommandID);

Parâmetros

nCommandID
[dentro] Um ID de comando.

Observações

Chame este método para modificar o ID de comando de um controlo de barra de cor e para notificar a janela principal do controlo que o ID mudou.

CMFCColorBar::SetDocumentColors

Define a lista de cores usadas no documento atual.

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

Parâmetros

lpszLegenda
[dentro] Uma legenda que é mostrada quando o controlo da barra de cor não está acoplado.

lstDocColors
[dentro] Uma lista de cores que substitui as cores atuais do documento.

bMostrarQuandoAcoplado
[dentro] TRUE para mostrar as cores do documento quando o controlo da barra de cor está acoplado; caso contrário, FALSO. O valor padrão é FALSE.

Observações

As cores dos documentos são as cores atualmente usadas num documento. O framework mantém automaticamente uma lista de cores do documento, mas pode usar este método para modificar a lista.

CMFCColorBar::SetHorzMargin

Define a margem horizontal, que é o espaço entre a célula de cor esquerda ou direita e o limite da área do cliente.

void SetHorzMargin(int nHorzMargin);

Parâmetros

nHorzMargin
[dentro] A margem horizontal, em pixels.

Observações

Por defeito, o construtor CMFCColorBar::CMFCColorBar define a margem horizontal para 4 píxeis.

CMFCColorBar::SetPropList

Define o m_pWndPropList elemento de dados protegidos para o ponteiro especificado para um controlo de grelha de propriedade.

void SetPropList(CMFCPropertyGridCtrl* pWndList);

Parâmetros

pWndList
[dentro] Apontador para o objeto de controlo da grelha de propriedades.

CMFCColorBar::SetVertMargin

Define a margem vertical, que é o espaço entre a célula de cor superior ou inferior e a fronteira da área do cliente.

void SetVertMargin(int nVertMargin);

Parâmetros

nVertMargin
[dentro] A margem vertical, em pixels.

Observações

Por defeito, o construtor CMFCColorBar::CMFCColorBar define a margem vertical para 4 píxeis.

CMFCColorBar::ShowCommandMessageString

Solicita à janela de frame que detém o controlo da barra de cor para atualizar a linha da mensagem na barra de estado.

virtual void ShowCommandMessageString(UINT uiCmdId);

Parâmetros

uiCmdId
[dentro] Um ID de comando. (Este parâmetro é ignorado.)

Observações

Este método envia a mensagem WM_SETMESSAGESTRING ao proprietário do controlo da barra de cor.

Consulte também

Gráfico de Hierarquia
Classes