Classe CMFCToolBarButton

Fornece funcionalidade de botões às barras de ferramentas.

Sintaxe

class CMFCToolBarButton : public CObject

Membros

Construtores Públicos

Métodos Públicos

Membros de Dados

Observações

Um CMFCToolbarButton objeto é um controlo que reside numa barra de ferramentas. O seu comportamento assemelha-se ao de um botão comum. Pode atribuir uma imagem e um rótulo de texto a este objeto. Um botão de barra de ferramentas também pode ter um ID de comando. Quando o utilizador clica no botão da barra de ferramentas, o framework executa o comando que este ID especifica.

Normalmente, os botões da barra de ferramentas podem ser personalizados: o utilizador pode arrastar botões de uma barra de ferramentas para outra, e copiar, colar, eliminar e editar etiquetas de texto e imagens. Para impedir que o utilizador personalize a barra de ferramentas, pode bloqueá-la de duas formas. Ou define a bLocked flag para TRUE quando chamas o CMFCToolBar::LoadToolBar, ou adiciona o ID do comando de um botão individual à lista global de comandos protegidos usando o método CMFCToolBarButton::SetProtectedCommands .

CMFCToolBarButton Os objetos exibem imagens das coleções globais de imagens da barra de ferramentas na aplicação. Estas coleções são mantidas pela barra de ferramentas principal, CMFCToolBar Class. Para mais informações, consulte a Classe CMFCToolBarImages.

Quando o utilizador clica num botão da barra de ferramentas, a sua barra de ferramentas principal processa a mensagem do rato e comunica as ações apropriadas ao botão. Se o botão tiver um ID de comando válido, a barra de ferramentas pai envia a mensagem WM_COMMAND para o frame pai.

A CMFCToolBarButton classe é a base para outras classes de botões de barra de ferramentas, como CMFCToolBarMenuButton Class, CMFCToolBarEditBoxButton Class e CMFCToolBarComboBoxButton Class.

Example

O exemplo seguinte demonstra como configurar um CMFCToolBarButton objeto usando vários métodos na CMFCToolBarButton classe. O exemplo ilustra como ativar a entrada do rato e teclado, definir o índice da imagem do botão, definir o retângulo delimitador do botão e tornar o botão visível. Este excerto de código faz parte do exemplo Tab Control.

CMFCToolBarButton *pOffice2007 = NULL;
int nIndex = -1;

for (UINT uiCmd = ID_VIEW_APPLOOK_2007_1; uiCmd <= ID_VIEW_APPLOOK_2007_4; uiCmd++)
{
   // CMFCToolBar m_wndToolBarTheme
   nIndex = m_wndToolBarTheme.CommandToIndex(uiCmd);

   CMFCToolBarButton *pButton = m_wndToolBarTheme.GetButton(nIndex);

   if (pButton != NULL)
   {
      pOffice2007 = pButton;
      break;
   }
}

pOffice2007->EnableWindow();
pOffice2007->SetImage(1);
pOffice2007->SetRect(CRect(1, 1, 1, 1));
pOffice2007->SetVisible();
pOffice2007->Show(true);

Hierarquia de herança

CObject

CMFCToolBarButton

Requerimentos

Cabeçalho: afxtoolbarbutton.h

CMFCToolBarButton::PodeSer Dropado

Especifica se o utilizador pode posicionar um botão numa barra de ferramentas ou menu durante a personalização.

virtual BOOL CanBeDropped(CMFCToolBar* pToolbar);

Parâmetros

pToolbar
[dentro] Sem uso.

Valor de retorno

Este método devolve VERDADEIRO.

Observações

Por defeito, um botão da barra de ferramentas pode ser colocado em todas as barras de ferramentas personalizáveis (ou seja, não bloqueadas).

A implementação padrão deste método devolve TRUE. Substitua este método e retorne FALSE se quiser impedir o utilizador de reposicionar o botão.

CMFCToolBarButton::CanBeStored

Determina se o botão pode ser armazenado.

virtual BOOL CanBeStored() const;

Valor de retorno

Este método devolve VERDADEIRO.

Observações

A estrutura utiliza este método para determinar se o botão pode participar numa operação de arrastar e largar.

A implementação padrão devolve TRUE. Anule este método se o seu botão não puder ser armazenado como parte de uma operação de arrastar e largar. Para mais informações sobre operações de arrastar e largar, consulte OLE arrastar e largar.

CMFCToolBarButton::PodeSerEsticado

Especifica se o utilizador pode esticar o botão durante a personalização.

virtual BOOL CanBeStretched() const;

Valor de retorno

Este método devolve FALSE.

Observações

Este método é usado pela estrutura para determinar se o botão pode ser esticado em modo de personalização.

A implementação padrão deste método devolve FALSE. Substitua este método para devolver TRUE para um controlo de largura variável, como uma caixa combo ou um slider.

Para mais informações sobre o modo de personalização, consulte CMFCToolBar::SetCustomizeMode.

CMFCToolBarButton::CMFCToolBarButton

Constrói e inicializa um CMFCToolBarButton objeto.

CMFCToolBarButton(
    UINT uiID,
    int iImage,
    LPCTSTR lpszText=NULL,
    BOOL bUserButton=FALSE,
    BOOL bLocked=FALSE);

Parâmetros

uiID
[dentro] O ID do comando do botão.

iImage
[dentro] O índice da imagem do botão na coleção de imagens.

lpszText
[dentro] O rótulo de texto do botão. Pode ser NULL.

bUserButton
[dentro] Um valor booleano que determina se o botão é definido pelo utilizador. Se este parâmetro for VERDADEIRO, o botão é definido pelo utilizador. Caso contrário, a imagem do botão é carregada a partir de um recurso.

bLocked
[dentro] Um valor booleano que determina se o botão pode ser personalizado. Se este parâmetro for VERDADEIRO, o botão não pode ser personalizado. Caso contrário, o botão pode ser personalizado.

CMFCToolBarButton::CompareWith

Compara esta instância com o objeto fornecido CMFCToolBarButton .

virtual BOOL CompareWith(const CMFCToolBarButton& other) const;

Parâmetros

Outros
[dentro] Referência ao objeto para comparar com esta instância.

Valor de retorno

Não nulo se o objeto fornecido for igual ao valor desta instância; caso contrário, 0.

Observações

A implementação por defeito determina se o ID de comando do objeto fornecido é igual ao ID de comando desta instância. Substitua este método se tiver de realizar processamento adicional para determinar se dois CMFCToolBarButton objetos são iguais.

CMFCToolBarButton::CopyFrom

Copia as propriedades de outro botão da barra de ferramentas para o botão atual.

virtual void CopyFrom(const CMFCToolBarButton& src);

Parâmetros

src
[dentro] Uma referência ao botão de origem de onde copiar.

Observações

Chame este método para copiar outro botão da barra de ferramentas para este botão da barra de ferramentas.

CMFCToolBarButton::CreateFromOleData

Cria um CMFCToolBarButton objeto a partir do objeto fornecido COleDataObject .

static CMFCToolBarButton* __stdcall CreateFromOleData(COleDataObject* pDataObject);

Parâmetros

pDataObject
[dentro] O objeto de dados OLE de origem.

Valor de retorno

O objeto criado CMFCToolBarButton .

Observações

Este método é utilizado pelo framework para realizar transferência de dados em vários formatos. Por exemplo, o CMFCOutlookBarPane::OnDragOver método utiliza este método para realizar operações de arrastar e largar.

CMFCToolBarButton::EnableWindow

Ativa ou desativa a entrada de rato e teclado.

virtual void EnableWindow(BOOL bEnable = TRUE);

Parâmetros

bEnable
[dentro] Defina este parâmetro para TRUE para permitir a entrada, ou para FALSE para desativar a entrada.

Observações

Este método chama a EnableWindow função para ativar ou desativar a entrada. Para mais informações, consulte EnableWindow no SDK do Windows.

CMFCToolBarButton::ExportToMenuButton

Copia texto do botão da barra de ferramentas para um menu.

virtual BOOL ExportToMenuButton(CMFCToolBarMenuButton& menuButton) const;

Parâmetros

menuButton
[dentro] Uma referência ao botão do menu alvo.

Valor de retorno

Este método devolve VERDADEIRO.

Observações

A framework chama este método para copiar o texto de um botão da barra de ferramentas para um botão de menu. A implementação padrão copia o rótulo de texto do botão. Se a etiqueta do texto estiver vazia, este método copia o texto da tooltip do botão.

A implementação padrão deste método devolve TRUE. Anule este método se quiser tomar ações adicionais quando o framework converter um objeto derivado do CMFCToolbarButton num botão de menu.

CMFCToolBarButton::GetClipboardFormat

Recupera o formato global da prancheta para a aplicação.

static CLIPFORMAT __stdcall GetClipboardFormat();

Valor de retorno

O valor global CLIPFORMAT para a aplicação.

Observações

A estrutura chama este método para recuperar o formato da prancheta para operações de transferência de dados OLE. Por exemplo, o método CMFCToolBarButton::CreateFromOleData usa este método para copiar dados de um objeto de dados OLE de origem.

Este método define o valor global CLIPFORMAT na primeira vez que este método é chamado. Todas as chamadas subsequentes a este método retornam este valor.

Para permitir que ocorram operações de arrastar e largar entre aplicações, chame o método CMFCToolBarButton::SetClipboardFormatName .

Para mais informações sobre pranchetas de notas no MFC, consulte Prancheta.

CMFCToolBarButton::GetHwnd

Recupera a alça da janela associada ao botão da barra de ferramentas.

virtual HWND GetHwnd();

Valor de retorno

O handle da janela associado ao botão da barra de ferramentas ou NULL se o botão da barra não tiver um handle de janela associado.

Observações

A implementação padrão deste método devolve NULL. Ultrapasse este método para devolver a maçaneta da janela do seu controlo específico.

CMFCToolBarButton::GetImage

Recupera o índice da imagem do botão.

int GetImage() const;

Valor de retorno

O índice da imagem associada a este botão.

Observações

Se o botão tiver uma imagem definida pelo utilizador (isto é, se bUserButton fosse TRUE no construtor), o índice devolvido especifica uma imagem na coleção de imagens definidas pelo utilizador (ver CMFCToolBar::GetUserImages). Caso contrário, o índice especifica uma imagem na coleção de imagens que são carregadas a partir de um ficheiro de recurso (ver CMFCToolBar::GetImages). Para mais informações sobre ficheiros de recursos, consulte Trabalhar com Ficheiros de Recursos.

CMFCToolBarButton::GetInvalidateRect

Recupera a região da área do cliente do botão que deve ser redesenhada.

virtual const CRect GetInvalidateRect() const;

Valor de retorno

Um CRect objeto que especifica a região que deve ser redesenhada.

Observações

A implementação padrão deste método devolve toda a área do cliente. Anule este método se quiser que uma área diferente seja redesenhada.

CMFCToolBarButton::GetParentWnd

Recupera a janela principal do botão.

CWnd* GetParentWnd() const;

Valor de retorno

A janela principal do botão.

CMFCToolBarButton::GetProtectedCommands

Recupera a lista de comandos que o utilizador não pode personalizar.

static const CList<UINT,UINT>& GetProtectedCommands();

Valor de retorno

A lista de comandos protegidos.

Observações

No modo de personalização, o framework desativa os comandos de botão da barra de ferramentas que estão protegidos. O utilizador não pode realizar operações de arrastar e largar e editar botões desativados da barra de ferramentas.

Use o método CMFCToolBarButton::SetProtectedCommands para definir a lista de comandos protegidos.

CMFCToolBarButton::GetTextSize

Recupera o tamanho do texto do botão.

SIZE GetTextSize() const;

Valor de retorno

Um objeto SIZE que contém o tamanho, em pixels, do texto do botão.

CMFCToolBarButton::HasFocus

Determina se o botão tem o foco de entrada atual.

virtual BOOL HasFocus() const;

Valor de retorno

Diferente de zero se o botão tiver o foco de entrada; caso contrário, 0.

Observações

A implementação padrão deste método retorna diferente de zero se o botão tiver o foco de entrada ou for uma janela filha ou descendente da janela que tem o foco de entrada. Pode sobrescrever esta função para personalizar este comportamento.

CMFCToolBarButton::HaveHotBorder

Determina se uma borda do botão é exibida quando o utilizador seleciona o botão.

virtual BOOL HaveHotBorder() const;

Valor de retorno

Este método devolve VERDADEIRO.

Observações

A estrutura chama este método para determinar se o botão da barra de ferramentas deve mostrar a sua borda quando o utilizador o seleciona.

A implementação padrão devolve TRUE. Pode sobrescrever este método para personalizar este comportamento.

CMFCToolBarButton::IsDrawImage

Determina se uma imagem é exibida no botão.

BOOL IsDrawImage() const;

Valor de retorno

Diferente de zero se uma imagem for exibida no botão; caso contrário, 0.

Observações

Este método retorna FALSE se o botão da barra de ferramentas não tiver imagem associada ( CMFCToolBarButton::GetImage retorna -1) ou se o CMFCToolBarButton::m_bImage estiver definido como FALSE.

CMFCToolBarButton::IsDrawText

Determina se uma etiqueta de texto é exibida no botão.

BOOL IsDrawText() const;

Valor de retorno

Diferente de zero se for exibida uma etiqueta de texto; caso contrário, 0.

Observações

Este método devolve FALSE se o botão da barra de ferramentas não tiver etiqueta de texto associada ( CMFCToolBarButton::m_strText estiver vazio) ou se o CMFCToolBarButton::m_bText estiver definido como FALSE.

CMFCToolBarButton::IsDroppedDown

Determina se o botão mostra um submenu.

virtual BOOL IsDroppedDown() const;

Valor de retorno

Este método devolve FALSE.

Observações

A implementação padrão deste método devolve FALSE. Anule este método para devolver TRUE se o seu controlo mostrar um submenu.

CMFCToolBarButton::IsEditable

Determina se o botão pode ser personalizado.

virtual BOOL IsEditable() const;

Valor de retorno

Diferente de zero se um botão puder ser personalizado pelo utilizador; caso contrário, 0.

Observações

O framework chama este método para determinar se o utilizador pode personalizar o botão da barra de ferramentas usando operações de arrastar e largar ou editar.

A implementação padrão devolve FALSE se o ID do comando do botão for um comando padrão (pode determinar isto chamando a IsStandardCommand função) ou se o ID do comando estiver na lista de comandos protegidos. Para mais informações sobre comandos protegidos, consulte CMFCToolBarButton::GetProtectedCommands e CMFCToolBarButton::SetProtectedCommands.

Substitua este método para personalizar o seu comportamento.

CMFCToolBarButton::IsExtraSize

Determina se o botão pode ser exibido com uma borda estendida.

virtual BOOL IsExtraSize() const;

Valor de retorno

Diferente de zero se o botão da barra de ferramentas puder ser exibido com uma borda alargada; caso contrário, 0.

Observações

Várias skins usam tamanho extra para as bordas dos botões da barra de ferramentas (por exemplo, botões redondos).

Se o utilizador mover este botão de uma barra de ferramentas para outra, o framework chama o método CMFCToolBarButton::OnChangeParentWnd . O método CMFCToolBarButton::OnChangeParentWnd define a flag de tamanho extra para a nova barra de ferramentas pai (para mais informações, veja CMFCToolBar::IsButtonExtraSizeAvailable).

CMFCToolBarButton::IsFirstInGroup

Determina se o botão está na primeira posição do seu grupo de botões.

virtual BOOL IsFirstInGroup() const;

Valor de retorno

TRUE se o botão for o primeiro botão do seu grupo de botões; caso contrário, FALSO.

Observações

Este método define um grupo de botões como um conjunto vizinho de botões posicionados na mesma linha e delimitados por separadores ou pela borda da barra de ferramentas. Este método devolve FALSE se o botão da barra de ferramentas se referir ao botão Personalizar . Para mais informações sobre o botão Personalizar , consulte CMFCToolBar::GetCustomizeButton.

Chame o método CMFCToolBarButton::IsLastInGroup para determinar se o botão está na última posição do seu grupo de botões.

CMFCToolBarButton::IsHidden

Determina se o botão está escondido.

BOOL IsHidden() const;

Valor de retorno

Diferente de zero se o botão estiver oculto (invisível); caso contrário, 0.

Observações

A estrutura chama este método quando a barra de ferramentas principal é esticada para determinar se o botão da barra de ferramentas é visível.

Se definires o botão como invisível usando o método CMFCToolBarButton::SetVisible , usa CMFCToolBarButton::IsVisible para determinar se o botão da barra de ferramentas é visível.

Por defeito, todos os botões da barra de ferramentas são visíveis. Use o método CMFCToolBarButton::Show para esconder ou mostrar botões da barra de ferramentas.

CMFCToolBarButton::IsHorizontal

Determina se o botão está localizado numa barra de ferramentas horizontal.

BOOL IsHorizontal() const;

Valor de retorno

Diferente de zero se um botão da barra de ferramentas estiver localizado numa barra de ferramentas horizontal; caso contrário, 0.

Observações

A estrutura chama este método para determinar a disposição dos botões da barra de ferramentas.

Este método devolve o m_bHorz elemento de dados. O valor padrão do m_bHorz membro de dados é TRUE; é reiniciado em cada chamada para o método CMFCToolBarButton::OnDraw .

CMFCToolBarButton::IsLastInGroup

Especifica se o botão está na última posição do seu grupo de botões.

virtual BOOL IsLastInGroup() const;

Valor de retorno

TRUE se o botão for o último botão do seu grupo de botões; caso contrário, FALSO.

Observações

Este método define um grupo de botões como um conjunto vizinho de botões que estão posicionados na mesma linha e são limitados por separadores ou pela borda da barra de ferramentas. Este método retorna FALSE se o botão da barra de ferramentas não tiver barra de ferramentas pai ou se o botão da barra de ferramentas se referir ao botão Personalizar . Para mais informações sobre o botão Personalizar , consulte CMFCToolBar::GetCustomizeButton.

Chame o método CMFCToolBarButton::IsFirstInGroup para determinar se o botão está na primeira posição do seu grupo de botões.

CMFCToolBarButton::IsLocked

Determina se o botão está numa barra de ferramentas bloqueada (não personalizável).

BOOL IsLocked() const;

Valor de retorno

Diferente de zero se o botão estiver numa barra de ferramentas bloqueada; caso contrário, 0.

Observações

O framework chama este método para determinar se o utilizador pode personalizar o botão da barra de ferramentas usando operações de arrastar e largar ou editar. Defina o atributo bloqueado na barra de ferramentas principal usando o método CMFCToolBar::LoadToolBar . A estrutura passa o valor deste atributo ao construtor de cada botão da barra de ferramentas ( CMFCToolbarButton) que insere na barra de ferramentas principal.

CMFCToolBarButton::IsOwnerOf

Determina se o botão é o proprietário da maçaneta da janela fornecida.

virtual BOOL IsOwnerOf(HWND hwnd);

Parâmetros

hwnd
[dentro] Uma maçaneta de janela.

Valor de retorno

Diferente de zero se o botão for o proprietário da maçaneta da janela fornecida; caso contrário, 0.

Observações

Este método devolve não nulo se hwnd se referir à manivela direta da janela ou for filho da alavanca da janela associada ao botão. Este método devolve 0 se hwnd for NULL.

CMFCToolBarButton::IsVisible

Determina se o botão da barra de ferramentas é visível.

BOOL IsVisible() const;

Valor de retorno

Diferente de zero se o botão da barra de ferramentas for visível; caso contrário, 0.

Observações

Pode mostrar ou esconder o botão da barra de ferramentas usando o método CMFCToolBarButton::SetVisible . Chame o método CPane::AdjustSizeImmediate na barra de ferramentas pai depois de chamar CMFCToolBarButton::SetVisible para recalcular o layout de uma barra de ferramentas parental.

CMFCToolBarButton::IsWindowVisible

Determina se a manivela da janela subjacente do botão é visível.

virtual BOOL IsWindowVisible();

Valor de retorno

Não nulo se a manivela subjacente do botão for visível; caso contrário, 0.

Observações

Este método retorna não nulo se o atributo styles do handle da janela subjacente contiver o estilo WS_VISIBLE. Este método devolve FALSE se a alavanca da janela subjacente do botão for NULL.

CMFCToolBarButton::m_bImage

Especifica se uma imagem é exibida no botão.

BOOL m_bImage;

Observações

Se este elemento de dados estiver definido como TRUE, a estrutura apresenta a imagem associada ao botão da barra de ferramentas; caso contrário, a estrutura não exibe a imagem. Este membro afeta o valor de retorno do método CMFCToolBarButton::m_bImage .

CMFCToolBarButton::m_bText

Especifica se uma etiqueta de texto é exibida no botão.

BOOL m_bText;

Observações

Se este elemento de dados estiver definido como TRUE, a estrutura mostra o rótulo de texto do botão da barra de ferramentas; caso contrário, a estrutura não exibe a etiqueta do texto. Este membro afeta o valor de retorno do método CMFCToolBarButton::m_bText .

CMFCToolBarButton::m_bTextBelow

Especifica se a etiqueta de texto é exibida por baixo da imagem no botão.

BOOL m_bTextBelow;

Observações

Se esta variável membro estiver definida como TRUE, a estrutura mostra o texto do botão por baixo da imagem. O valor padrão deste membro é FALSO.

CMFCToolBarButton::m_bUserButton

Especifica se o botão tem uma imagem definida pelo utilizador

BOOL m_bUserButton;

Observações

Este membro de dados é definido como TRUE quando o botão tem uma imagem definida pelo utilizador associada.

CMFCToolBarButton::m_bWholeText

Especifica se o botão exibe a sua etiqueta de texto completo mesmo que não se ajuste no retângulo delimitador.

BOOL m_bWholeText;

Observações

Se este elemento de dados estiver definido como TRUE, o framework exibe o rótulo de texto completo ao aumentar o botão. Caso contrário, a estrutura trunca e acrescenta uma elipse ( ...) ao rótulo do texto.

CMFCToolBarButton::m_bWrap

Especifica se o botão ao lado de um separador será colocado na linha seguinte.

BOOL m_bWrap;

Observações

O framework define este elemento de dados para TRUE quando o botão da barra de ferramentas não cabe na linha atual ou quando especifica um layout (por exemplo, um número específico de botões da barra de ferramentas por linha).

A estrutura coloca este botão na linha seguinte se este elemento de dados estiver definido como TRUE e a barra de ferramentas estiver acoplada horizontalmente ou flutuante.

O valor padrão deste membro de dados é FALSE.

CMFCToolBarButton::m_bWrapText

Especifica se as etiquetas de texto multilinha estão ativadas.

AFX_IMPORT_DATA static BOOL m_bWrapText;

Observações

Se esta variável estática for TRUE, o framework permite que todas as barras de ferramentas mostrem etiquetas de texto de várias linhas nos botões da barra de ferramentas.

O valor padrão deste membro de dados é FALSE.

CMFCToolBarButton::m_nID

O ID do comando do botão.

UINT m_nID;

Observações

Um ID de comando de -1 indica que o botão é um separador. Todos os separadores de botões têm o estilo TBBS_SEPARATOR. Consulte CMFCToolBarButton::m_nStyle para mais informações sobre estilos de botões.

CMFCToolBarButton::m_nStyle

O estilo do botão.

UINT m_nStyle;

Observações

Consulte os Estilos de Controlo da Barra de Ferramentas para a lista de estilos de botões disponíveis na barra de ferramentas.

CMFCToolBarButton::m_strText

O rótulo de texto do botão.

CString m_strText;

Observações

Este membro de dados contém o rótulo de texto do botão. O rótulo do texto pode estar vazio.

CMFCToolBarButton::NotifyCommand

Especifica se o botão processa a mensagem WM_COMMAND .

virtual BOOL NotifyCommand(int iNotifyCode);

Parâmetros

iNotifyCode
[dentro] A mensagem de notificação associada ao comando.

Valor de retorno

Este método devolve FALSE.

Observações

O framework chama este método quando está prestes a enviar uma mensagem WM_COMMAND para a janela principal.

Por defeito, este método devolve FALSE. Substitua este método para devolver TRUE se quiser processar a mensagem WM_COMMAND ou FALSE para indicar que a barra de ferramentas pai deve tratar da mensagem.

CMFCToolBarButton::OnAddToCustomizePage

É chamado pela framework quando o botão é adicionado a uma caixa de diálogo Personalizar .

virtual void OnAddToCustomizePage();

Observações

A implementação padrão deste método não faz nada. Anule este método se quiser realizar alguma ação quando o botão for adicionado a uma caixa de diálogo Personalizar .

CMFCToolBarButton::OnBeforeDrag

Especifica se o botão pode ser arrastado.

virtual BOOL OnBeforeDrag() const;

Valor de retorno

TRUE se o botão puder ser arrastado; caso contrário, FALSO.

Observações

O framework chama este método antes do utilizador começar a arrastar o botão.

A implementação padrão deste método devolve TRUE. Substitua este método para devolver FALSE e desativar o arrastar do botão.

CMFCToolBarButton::OnBeforeDrop

Especifica se o utilizador pode colocar o botão na barra de ferramentas de destino.

virtual BOOL OnBeforeDrop(CMFCToolBar* pTarget);

Parâmetros

pTarget
[dentro] O alvo da operação de arrastar e largar.

Valor de retorno

TRUE se o botão puder ser colocado na barra de ferramentas alvo fornecida; caso contrário, FALSO.

Observações

A framework chama este método antes de o botão ser colocado numa barra de ferramentas.

A implementação padrão deste método devolve TRUE. Sobrescrita este método para devolver FALSE e assim desativar a operação de drop no alvo especificado.

CMFCToolBarButton::OnCalculateSize

Chamado pelo framework para calcular o tamanho do botão para o contexto do dispositivo especificado e para o estado de acoplamento.

virtual SIZE OnCalculateSize(
    CDC* pDC,
    const CSize& sizeDefault,
    BOOL bHorz);

Parâmetros

pDC
[dentro] O contexto do dispositivo que mostra o botão.

tamanhoPadrão
[dentro] O tamanho padrão do botão.

bHorz
[dentro] O estado da dock da barra de ferramentas dos pais. Este parâmetro é VERDADEIRO se a barra de ferramentas estiver acoplada horizontalmente ou flutuante, ou FALSE se a barra estiver acoplada verticalmente.

Valor de retorno

Uma SIZE estrutura que contém as dimensões do botão, em pixels.

Observações

A estrutura chama este método para determinar o tamanho do botão da barra de ferramentas para o contexto do dispositivo especificado e para o estado da dock.

A implementação padrão considera os tamanhos do texto e da imagem (se forem exibidos), as posições do texto e da imagem (o texto abaixo ou no lado direito da imagem) e o estado da dock da barra de ferramentas.

Anule este método se quiser fornecer o tamanho de um botão não padrão (por exemplo, um botão de caixa de edição).

CMFCToolBarButton::OnCancelMode

Chamado pelo framework para tratar da mensagem WM_CANCELMODE .

virtual void OnCancelMode();

Observações

A implementação padrão deste método não faz nada. Anule este método se quiser tratar da WM_CANCELMODE mensagem.

CMFCToolBarButton::OnChangeParentWnd

Chamada pela framework quando o botão é inserido numa nova barra de ferramentas.

virtual void OnChangeParentWnd(CWnd* pWndParent);

Parâmetros

pWndParent
[dentro] A nova janela parental.

Observações

O botão é inserido numa barra de ferramentas, por exemplo, quando o utilizador o arrasta de uma barra de ferramentas para outra.

A implementação padrão deste método não faz nada.

CMFCToolBarButton::OnClick

É chamado pela framework quando o utilizador clica no botão do rato.

virtual BOOL OnClick(
    CWnd* pWnd,
    BOOL bDelay=TRUE);

Parâmetros

pWnd
[dentro] A janela principal do botão da barra de ferramentas.

bDelay
[dentro] VERDADE se a mensagem deve ser tratada com atraso.

Valor de retorno

Este método devolve FALSE.

Observações

A framework chama este método quando o utilizador clica no botão da barra de ferramentas.

A implementação padrão não faz nada e devolve FALSE. Substitua este método para devolver um valor diferente de zero se o botão processar a mensagem de clique.

CMFCToolBarButton::OnClickUp

Chamado pelo framework quando o utilizador solta o botão do rato.

virtual BOOL OnClickUp();

Valor de retorno

Este método devolve FALSE.

Observações

A framework chama este método quando o utilizador solta o botão da barra de ferramentas.

A implementação padrão não faz nada e devolve FALSE. Substitua este método para devolver um valor diferente de zero se o botão processar a mensagem de clique.

CMFCToolBarButton::OnContextHelp

É chamado pelo framework quando a barra de ferramentas pai trata uma mensagem WM_HELPHITTEST.

virtual BOOL OnContextHelp(CWnd* pWnd);

Parâmetros

pWnd
[dentro] A janela principal do botão da barra de ferramentas.

Valor de retorno

Este método devolve FALSE.

Observações

A implementação padrão deste método não faz nada e devolve FALSE. Substitua este método para devolver um valor diferente de zero se o botão processar a mensagem de ajuda.

Para mais informações sobre a mensagem WM_HELPHITTEST, consulte TN028: Context-Sensitive Apoio de Ajuda.

CMFCToolBarButton::OnCtlColor

Chamada pela framework quando a barra de ferramentas pai trata uma mensagem WM_CTLCOLOR.

virtual HBRUSH OnCtlColor(
    CDC* pDC,
    UINT nCtlColor);

Parâmetros

pDC
[dentro] O contexto do dispositivo que mostra o botão.

nCtlColor
[dentro] A notificação de cor específica.

Valor de retorno

Uma pega para o objeto pincel que a estrutura usa para pintar o fundo do botão.

Observações

A framework chama este método quando a barra de ferramentas pai processa a mensagem WM_CTLCOLOR para um botão da barra de ferramentas que contém um controlo do Windows. A framework não chama este método se o botão da barra de ferramentas estiver sem janelas.

A estrutura chama este método quando a estrutura da barra de ferramentas está em modo de personalização e o botão da barra de ferramentas está desbloqueado. Para mais informações sobre o modo de personalização, consulte CMFCToolBar::SetCustomizeMode. Para mais informações sobre bloqueio dos botões da barra de ferramentas, veja CMFCToolBarButton::IsLocked.

A implementação padrão não faz nada e devolve NULL.

CMFCToolBarButton::OnCustomizeMenu

Permite que o botão modifique o menu fornecido quando a aplicação apresenta um menu de atalho na barra de ferramentas dos pais.

virtual BOOL OnCustomizeMenu(CMenu* pMenu);

Parâmetros

pMenu
[dentro] O menu para personalizar.

Valor de retorno

Este método devolve FALSE.

Observações

A implementação padrão não faz nada e devolve FALSE. Substitua este método e devolve um valor diferente de zero se quiser modificar o conteúdo do menu fornecido.

CMFCToolBarButton::OnDblClk

É chamado pelo framework quando a barra de ferramentas pai trata uma mensagem WM_LBUTTONDBLCLK .

virtual void OnDblClk(CWnd* pWnd);

Parâmetros

pWnd
[em] - A janela principal do botão.

Observações

Este método é chamado pelo CMFCToolBar::OnLButtonDblClk método quando a barra de ferramentas pai trata uma mensagem WM_LBUTTONDBLCLK .

A implementação padrão deste método não faz nada.

CMFCToolBarButton::OnDraw

É chamado pela framework para desenhar o botão usando os estilos e opções especificados.

virtual void OnDraw(
    CDC* pDC,
    const CRect& rect,
    CMFCToolBarImages* pImages,
    BOOL bHorz=TRUE,
    BOOL bCustomizeMode=FALSE,
    BOOL bHighlight=FALSE,
    BOOL bDrawBorder=TRUE,
    BOOL bGrayDisabledButtons=TRUE);

Parâmetros

pDC
[dentro] O contexto do dispositivo que mostra o botão.

retângulo
[dentro] O retângulo delimitador do botão.

pImagens
[dentro] A coleção de imagens da barra de ferramentas associada ao botão.

bHorz
[dentro] O estado da dock da barra de ferramentas dos pais. Este parâmetro é VERDADEIRO quando o botão está acoplado horizontalmente e FALSE quando o botão está acoplado verticalmente.

bCustomizeMode
[dentro] Especifica se a barra de ferramentas está em modo de personalização. Este parâmetro é VERDADEIRO quando a barra de ferramentas está em modo de personalização e FALSE quando a barra de ferramentas não está em modo de personalização.

bDestaques
[dentro] Especifica se o botão está destacado. Este parâmetro é VERDADEIRO quando o botão está destacado e FALSO quando o botão não está destacado.

bDrawBorder
[dentro] Especifica se o botão deve mostrar a sua borda. Este parâmetro é VERDADEIRO quando o botão deve mostrar a sua borda e FALSE quando o botão não deve mostrar a sua borda.

bGrayDisabledButtons
[dentro] Especifica se deve sombrear botões desativados ou usar a coleção de imagens desativadas. Este parâmetro é VERDADEIRO quando os botões desativados devem estar sombreados e FALSE quando este método deve usar a coleção de imagens desativadas.

Observações

Substitua este método para personalizar o desenho de botões da barra de ferramentas.

CMFCToolBarButton::OnDrawOnCustomizeList

Chamado pelo framework para desenhar o botão no painel de Comandos da caixa de diálogo Personalizar .

virtual int OnDrawOnCustomizeList(
    CDC* pDC,
    const CRect& rect,
    BOOL bSelected);

Parâmetros

pDC
[dentro] O contexto do dispositivo que mostra o botão.

retângulo
[dentro] O retângulo delimitador do botão.

bSelecionado
[dentro] Especifica se o botão está selecionado. Se este parâmetro for VERDADEIRO, o botão é selecionado. Se este parâmetro for FALSO, o botão não é selecionado.

Valor de retorno

A largura, em pixels, do botão no contexto do dispositivo especificado.

Observações

Este método é chamado pela caixa de diálogo de personalização (aba Comandos ) quando o botão está prestes a aparecer na caixa da lista de sorteio do proprietário.

A implementação padrão deste método mostra a imagem e o texto do botão, caso estejam disponíveis. Se o rótulo de texto do botão não estiver disponível, o método apresenta o texto da dica de ferramenta.

Anule este método para realizar desenhos personalizados.

CMFCToolBarButton::OnGetCustomToolTipText

Chamado pela framework para recuperar o texto da tooltip personalizado para o botão.

virtual BOOL OnGetCustomToolTipText(CString& strToolTip);

Parâmetros

strToolTip
[fora] Um CString objeto que recebe o texto da dica de ferramenta personalizada.

Valor de retorno

Este método devolve FALSE.

Observações

A framework chama este método quando apresenta a dica de ferramenta para o botão da barra de ferramentas. Se este método devolver FALSE, o framework usa uma tooltip por defeito.

A implementação padrão não faz nada e devolve FALSE. Substitua este método e devolve um valor diferente de zero para fornecer texto de tooltip personalizado para o botão da barra de ferramentas.

CMFCToolBarButton::OnGlobalFontsChanged

Chamada pelo framework quando a fonte global mudou.

virtual void OnGlobalFontsChanged();

Observações

A implementação padrão deste método não faz nada. Substitua este método para atualizar a fonte usada para mostrar o texto do botão.

CMFCToolBarButton::OnMove

É chamada pela framework quando a barra de ferramentas dos pais se move.

virtual void OnMove();

Observações

A implementação padrão deste método não faz nada. Substitua este método para reposicionar o botão quando a barra de ferramentas principal se mover.

CMFCToolBarButton::OnShow

É chamado pela estrutura quando o botão se torna visível ou invisível.

virtual void OnShow(BOOL bShow);

Parâmetros

bShow
[dentro] Especifica se o botão é visível. Se este parâmetro for VERDADEIRO, o botão é visível. Caso contrário, o botão não é visível.

Observações

A implementação padrão deste método não faz nada. Substitua este método para atualizar a visibilidade do botão.

CMFCToolBarButton::OnSize

É chamada pela framework quando a barra de ferramentas pai muda de tamanho ou posição e esta alteração faz com que o botão mude de tamanho.

virtual void OnSize(int iSize);

Parâmetros

iSize
[dentro] A nova largura do botão.

Observações

A implementação padrão deste método não faz nada. Substitua este método para redimensionar o botão quando o tamanho ou a posição da barra de ferramentas pai mudar.

CMFCToolBarButton::OnToolHitTest

Chamado pela estrutura quando a barra de ferramentas pai tem de determinar se um ponto está no retângulo delimitador do botão.

virtual BOOL OnToolHitTest(
    const CWnd* pWnd,
    TOOLINFO* pTI);

Parâmetros

pWnd
[dentro] A janela principal do botão. Pode ser NULL.

pTI
[dentro] Uma TOOLINFO estrutura que contém informação sobre uma ferramenta num controlo tooltip.

Valor de retorno

O resultado de OnMenuButtonToolHitTest se o botão consegue recuperar um ponteiro para a janela do frame pai; caso contrário, FALSE.

Observações

Este método chama um dos seguintes métodos se conseguir converter a janela pai num objeto frame válido:

• CMDIFrameWndEx::OnMenuButtonToolHitTest

• CFrameWndEx::OnMenuButtonToolHitTest

• COleIPFrameWndEx::OnMenuButtonToolHitTest

CMFCToolBarButton::OnUpdateToolTip

Chamado pelo framework quando a barra de ferramentas dos pais atualiza o texto da tooltip.

virtual BOOL OnUpdateToolTip(
    CWnd* pWndParent,
    int iButtonIndex,
    CToolTipCtrl& wndToolTip,
    CString& str);

Parâmetros

pWndParent
[dentro] A janela dos pais.

iButtonIndex
[dentro] O índice em base zero do botão na coleção de botões pais.

wndToolTip
[dentro] O controlo que mostra o texto da tooltip.

STR
[fora] Um objeto que recebe o texto atualizado da CString tooltip.

Valor de retorno

Este método devolve FALSE.

Observações

A implementação padrão deste método não faz nada e devolve FALSE. Substitua este método para devolver um valor diferente de zero se fornecer uma cadeia de texto tooltip.

CMFCToolBarButton::P repareDrag

Chamada pela framework quando o botão está prestes a realizar uma operação de arrastar e largar.

virtual BOOL PrepareDrag(COleDataSource& srcItem);

Parâmetros

srcItem
[dentro] Um COleDataSource objeto que armazena informação de estado sobre a operação de arrastar e largar.

Valor de retorno

TRUE se a operação for bem-sucedida; caso contrário, FALSO.

Observações

O framework chama este método para preparar o botão da barra de ferramentas para armazenar o seu estado no objeto fornecido COleDataSource . Este método armazena o seu estado serializando-se para um ficheiro partilhado e depois passando esse ficheiro para o método COleDataSource::CacheGlobalData . Para mais informações sobre serialização de botões em barras de ferramentas, consulte CMFCToolBarButton::Serialize.

Este método não faz nada e devolve TRUE se o botão não puder ser armazenado (o método CMFCToolBarButton::CanBeStored devolve FALSE). Devolve FALSE se ocorrer uma exceção durante a serialização do objeto.

Para mais informações sobre operações OLE arrastar e largar, veja OLE arrastar e largar.

CMFCToolBarButton::Rect

Recupera o retângulo delimitador do botão.

const CRect& Rect() const;

Valor de retorno

Um CRect objeto que contém o retângulo delimitador de um botão.

CMFCToolBarButton::ResetImageToDefault

Define como valor padrão a imagem associada ao botão.

virtual void ResetImageToDefault();

Observações

Este método recupera a imagem padrão da sua barra de ferramentas principal usando o método CMFCToolBar::GetDefaultImage . Se o botão não tiver uma imagem padrão associada, este método define o rótulo de texto do botão de acordo com o seu recurso de string usando o método CStringT::LoadString . Para mais informações sobre recursos de cadeias de caracteres, consulte Trabalhar com Ficheiros de Recursos.

Este método não faz nada se o botão tiver uma imagem definida pelo utilizador.

CMFCToolBarButton::SaveBarState

Guarda o estado do botão da barra de ferramentas.

virtual void SaveBarState();

Observações

A estrutura chama este método quando cria um CMFCToolBarButton objeto como resultado de uma operação de arrastar e largar.

A implementação padrão deste método não faz nada. Substitua este método para guardar o estado do botão da barra de ferramentas numa fonte de dados externa.

CMFCToolBarButton::Serializar

Lê este objeto de um arquivo ou escreve-o num arquivo.

virtual void Serialize(CArchive& ar);

Parâmetros

ar
[dentro] O CArchive objeto a partir do qual ou para o qual serializar.

Observações

Este método suporta processos de transferência de dados como operações de transferência ou arrastar e largar. Lê ou escreve propriedades do botão, como o ID, etiqueta de texto e ID da imagem, a partir ou para o objeto fornecido.CArchive

Para exemplos de serialização, veja Serialização: Serializar um Objeto.

CMFCToolBarButton::SetACCData

Preenche o objeto fornecido CAccessibilityData com dados de acessibilidade a partir do botão da barra de ferramentas.

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

Parâmetros

pParent
[dentro] A janela principal do botão da barra de ferramentas.

Dados
[dentro] Um CAccessibilityData objeto que é preenchido com os dados de acessibilidade do botão da barra de ferramentas.

Valor de retorno

Este método devolve VERDADEIRO.

Observações

Substitua este método para devolver FALSE se o botão da barra de ferramentas não fornecer dados de acessibilidade.

CMFCToolBarButton::SetClipboardFormatName

Renomeia o formato global da prancheta.

static void __stdcall SetClipboardFormatName(LPCTSTR lpszName);

Parâmetros

lpszName
[dentro] O novo nome do formato global de prancheta. Não pode ser NULL.

Observações

Este método permite que operações de arrastar e largar ocorram entre múltiplas aplicações. Cada candidatura deve fornecer o mesmo nome de formato de prancheta.

Deve chamar este método antes de o framework chamar CMFCToolBarButton::GetClipboardFormat.

CMFCToolBarButton::SetImage

Define o índice da imagem do botão.

virtual void SetImage(int iImage);

Parâmetros

iImage
[dentro] O índice da imagem na coleção de imagens da barra de ferramentas.

Observações

Se o botão da barra de ferramentas for um separador, iImage refere-se à nova largura do botão separador.

Se o iImage for inferior a zero, este método desativa o desenho da imagem e permite o desenho do rótulo de texto do botão.

CMFCToolBarButton::SetProtectedCommands

Define a lista de comandos que o utilizador não pode personalizar.

static void SetProtectedCommands(const CList<UINT,UINT>& lstCmds);

Parâmetros

lstCmds
[dentro] A lista de comandos protegidos.

Observações

No modo de personalização, o framework desativa os comandos de botão da barra de ferramentas que estão protegidos. O utilizador não pode realizar operações de arrastar e largar e editar botões desativados da barra de ferramentas.

Use o método CMFCToolBarButton::GetProtectedCommands para recuperar a lista de comandos protegidos.

CMFCToolBarButton::SetRadio

É chamada pela framework quando um botão muda o seu estado verificado.

virtual void SetRadio();

Observações

A implementação padrão deste método não faz nada. Substitua este método para realizar uma ação personalizada quando o botão mudar o estado verificado.

CMFCToolBarButton::SetRect

Define o retângulo delimitador do botão.

void SetRect(const CRect rect);

Parâmetros

retângulo
[dentro] O novo retângulo delimitado do botão.

Observações

Este método chama o método CMFCToolBarButton::OnMove depois de definir o novo retângulo delimitador.

CMFCToolBarButton::SetStyle

Define o estilo do botão.

virtual void SetStyle(UINT nStyle);

Parâmetros

nStyle
[dentro] O novo estilo do botão.

Observações

A implementação padrão define o membro de dados CMFCToolBarButton::m_nStyle para nStyle. Anule este método se quiser realizar processamento adicional para lidar com a mudança de estilo. Consulte ToolBar Control Styles para uma lista de flags de estilo válidos.

CMFCToolBarButton::SetVisible

Especifica se o botão é visível.

void SetVisible(BOOL bShow=TRUE);

Parâmetros

bShow
[dentro] Um valor booleano que especifica se deve mostrar ou ocultar o botão. Se este parâmetro for VERDADEIRO, o botão é mostrado. Se o parâmetro for FALSO, o botão fica oculto.

Observações

Use esta função para esconder ou mostrar um botão específico da barra de ferramentas. Chame o método CPane::AdjustSizeImmediate depois de chamar este método.

CMFCToolBarButton::Show

Mostra ou oculta o botão.

void Show(BOOL bShow);

Parâmetros

bShow
[dentro] Um valor booleano que especifica se deve mostrar ou ocultar o botão. Se este parâmetro for VERDADEIRO, o botão é mostrado. Se o parâmetro for FALSO, o botão fica oculto.

Observações

O framework chama este método para atualizar a visibilidade dos botões da barra de ferramentas quando a barra de ferramentas principal é redimensionada. A framework chama este método com o bShow definido para FALSE quando o botão já não cabe dentro dos limites da barra de ferramentas. A estrutura chama este método com o bShow definido para TRUE quando, após redimensionar, o botão volta a encaixar nos limites da barra de ferramentas.

Use o método CMFCToolBarButton::SetVisible para definir a visibilidade geral do botão.

Este método chama o método CMFCToolBarButton::OnShow depois de atualizar o estado de visibilidade do botão.

Consulte também

Gráfico de Hierarquia
Classes
Classe CMFCToolBar
Classe CMFCToolBarImages