Classe CMFCToolBarMenuButton

Um botão de barra de ferramentas que contém um menu pop-up. Para mais detalhes, consulte o código-fonte localizado na pasta VC\atlmfc\src\mfc da sua instalação no Visual Studio.

Sintaxe

class CMFCToolBarMenuButton : public CMFCToolBarButton

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Membros de Dados

Observações

A CMFCToolBarMenuButton pode aparecer como um menu, um item de menu que tem um submenu, um botão que executa um comando ou mostra um menu, ou um botão que mostra apenas um menu. Determina o comportamento e a aparência do botão do menu especificando parâmetros como a imagem, texto, identificador do menu e ID de comando associados ao botão no construtor CMFCToolbarMenuButton::CMFCToolbarMenuButton.

Uma classe personalizada derivada da CMFCToolbarMenuButton classe deve usar a macro DECLARE_SERIAL . A macro DECLARE_DYNCREATE gera um erro quando a aplicação fecha.

Example

O exemplo seguinte demonstra como configurar um CMFCToolBarMenuButton objeto. O código ilustra como especificar que o menu suspenso está em modo de paleta e especificar o ID para a barra de remoção criada quando o utilizador arrasta o botão do menu para fora de uma barra de menus. Este excerto de código faz parte do exemplo do Word Pad.

pBorderType->SetMenuPaletteMode(TRUE, 2 /* Rows number */);
pBorderType->SetTearOff(ID_BORDER_TEAROFF);

Hierarquia de herança

CObject

CMFCToolBarButton

CMFCToolBarMenuButton

Requerimentos

Cabeçalho: afxtoolbarmenubutton.h

CMFCToolBarMenuButton::CMFCToolBarMenuButton

Constrói um CMFCToolBarMenuButton objeto.

CMFCToolBarMenuButton();
CMFCToolBarMenuButton(const CMFCToolBarMenuButton& src);

CMFCToolBarMenuButton(
    UINT uiID,
    HMENU hMenu,
    int iImage,
    LPCTSTR lpszText=NULL,
    BOOL bUserButton=FALSE);

Parâmetros

src
[dentro] Um objeto existente CMFCToolBarMenuButton a ser copiado para este CMFCToolBarMenuButton objeto.

uiID
[dentro] O ID do comando a executar quando um utilizador clica no botão; ou (UINT)-1 para um botão de menu que não executa diretamente um comando.

hMenu
[dentro] Um puxador para um menu; ou NULL se o botão não tiver menu.

iImage
[dentro] Índice da imagem do botão; ou -1 se este botão não tiver um ícone ou usar o ícone para o comando especificado pelo uiID. O índice é o mesmo para cada CMFCToolBarImages objeto na tua aplicação.

lpszText
[dentro] O texto do botão do menu da barra de ferramentas.

bUserButton
[dentro] TRUE se o botão mostrar uma imagem definida pelo utilizador; FALSE se o botão mostrar uma imagem pré-definida associada ao comando especificado pelo uiID.

Observações

Se o uiID for um ID de comando válido, o botão executa esse comando quando o utilizador clica nele. Se hMenu for um handle válido, o botão fornece um menu suspenso quando aparece numa barra de ferramentas ou um submenu quando aparece num menu. Se tanto uiID como hMenu forem válidos, o botão é um botão dividido com uma parte que executa o comando quando o utilizador clica nela e outra com uma seta para baixo que abre um menu quando o utilizador clica. No entanto, se o hMenu for válido, o utilizador não poderá clicar no botão para executar um comando quando o botão for inserido num menu.

Example

O exemplo seguinte demonstra como construir um objeto da CMFCToolBarMenuButton classe. Este excerto de código faz parte do exemplo do Word Pad.

CMFCToolBarMenuButton *pBorderType = new CMFCToolBarMenuButton(ID_BORDER_1, pPopup->GetSafeHmenu(),
                                                               GetCmdMgr()->GetCmdImage(ID_BORDER_1, FALSE),
                                                               _T("Borders"));

CMFCToolBarMenuButton::CompareWith

virtual BOOL CompareWith(const CMFCToolBarButton& other) const;

Parâmetros

[dentro] Outros

Valor de retorno

Observações

CMFCToolBarMenuButton::CopyFrom

virtual void CopyFrom(const CMFCToolBarButton& src);

Parâmetros

[dentro] src

Observações

CMFCToolBarMenuButton::CreateFromMenu

Inicializa o menu da barra de ferramentas a partir de um handle do menu do Windows.

virtual void CreateFromMenu(HMENU hMenu);

Parâmetros

hMenu
[dentro] Uma pega para um menu.

Observações

Um botão do menu da barra de ferramentas pode mostrar um submenu suspenso.

O framework chama este método para inicializar os comandos no submenu a partir de um menu.

CMFCToolBarMenuButton::CreateMenu

Cria um menu que consiste nos comandos no menu da barra de ferramentas. Devolve uma alavanca ao menu.

virtual HMENU CreateMenu() const;

Valor de retorno

Um exemplo para o menu se houver sucesso. NULL se a lista de comandos associada ao botão do menu da barra de ferramentas estiver vazia.

Observações

Podes sobrescrever este método numa classe derivada para personalizar a forma como o menu é gerado.

CMFCToolBarMenuButton::CriarMenuPopupMenu

Cria um CMFCPopupMenu objeto para mostrar o menu da barra de ferramentas.

virtual CMFCPopupMenu* CreatePopupMenu();

Valor de retorno

Um apontador para um CMFCPopupMenu objeto que mostra o menu suspenso associado ao botão do menu da barra de ferramentas.

Observações

Este método é chamado pelo framework para preparar a visualização do menu suspenso associado ao botão.

A implementação padrão apenas constrói e devolve um novo CMFCPopupMenu objeto. Substitua este método se quiser usar um tipo derivado de CMFCPopupMenu Class ou realizar uma inicialização adicional.

CMFCToolBarMenuButton::D rawDocumentIcon

Desenha um ícone de documento no botão do menu.

void DrawDocumentIcon(
    CDC* pDC,
    const CRect& rectImage,
    HICON hIcon);

Parâmetros

pDC
[dentro] Um apontador para o contexto do dispositivo.

rectImage
[dentro] Coordenadas do retângulo delimitador da imagem.

hIcon
[dentro] Uma pega para o ícone.

Observações

Este método pega num ícone de documento e desenha-o no botão do menu, centrado na área especificada por rectImage.

CMFCToolBarMenuButton::EnableQuickCustomize

void EnableQuickCustomize();

Observações

CMFCToolBarMenuButton::HasButton

virtual BOOL HasButton() const;

Valor de retorno

Observações

CMFCToolBarMenuButton::HaveHotBorder

virtual BOOL HaveHotBorder() const;

Valor de retorno

Observações

CMFCToolBarMenuButton::IsBorder

virtual BOOL IsBorder() const;

Valor de retorno

Observações

CMFCToolBarMenuButton::ÉClicadoNoMenu

BOOL IsClickedOnMenu() const;

Valor de retorno

Observações

CMFCToolBarMenuButton::IsQuickMode

BOOL IsQuickMode();

Valor de retorno

Observações

CMFCToolBarMenuButton::GetCommands

Dá acesso apenas de leitura à lista de comandos no menu da barra de ferramentas.

const CObList& GetCommands() const;

Valor de retorno

Uma referência const a um objeto CobList Class , que contém uma coleção de objetos CMFCToolBarButton Class .

Observações

Um botão do menu da barra de ferramentas pode mostrar um submenu. Pode fornecer a lista de comandos no submenu do construtor ou no CMFCToolBarMenuButton::CreateFromMenu como um handle para um menu (HMENU). O menu é convertido numa lista de objetos derivados da classe CMFCToolBarButton e armazenados no objeto interno CObList . Pode aceder a esta lista chamando este método.

CMFCToolBarMenuButton::GetImageRect

Recupera o retângulo delimitador para a imagem do botão.

void GetImageRect(CRect& rectImage);

Parâmetros

rectImage
[fora] Uma referência a um CRect objeto que recebe as coordenadas do retângulo delimitador da imagem.

CMFCToolBarMenuButton::GetPaletteRows

Devolve o número de linhas no menu suspenso quando o menu está em modo paleta.

int GetPaletteRows() const;

Valor de retorno

O número de carreiras na paleta.

Observações

Quando o botão do menu está definido para modo paleta, os itens do menu aparecem em várias colunas com apenas um número limitado de linhas. Chame este método para obter o número de linhas. Pode ativar ou desativar o modo de paleta e especificar o número de linhas usando o CMFCToolBarMenuButton::SetMenuPaletteMode.

CMFCToolBarMenuButton::GetPopupMenu

Devolve um ponteiro para o objeto CMFCPopupMenu Class que representa o menu suspenso do botão.

CMFCPopupMenu* GetPopupMenu() const;

Valor de retorno

Um apontador para um objeto CMFCPopupMenu Class criado quando a estrutura desenhava o submenu do botão do menu da barra de ferramentas; NULL se não for exibido nenhum submenu.

Observações

Quando um botão do menu da barra de ferramentas mostra um menu suspenso, o botão cria um objeto CMFCPopupMenu Class para representar o menu. Chame este método para obter um ponteiro para o CMFCPopupMenu objeto. Não deve armazenar o ponteiro devolvido, porque é temporário e torna-se inválido quando o utilizador fecha o menu suspenso.

CMFCToolBarMenuButton::IsDroppedDown

Indica se o menu pop-up está atualmente exibido.

virtual BOOL IsDroppedDown() const;

Valor de retorno

TRUE se o botão do menu da barra de ferramentas mostrar o seu submenu; caso contrário, FALSO.

CMFCToolBarMenuButton::IsEmptyMenuAllowed

Especifica se os itens do menu apresentam submenus vazios.

virtual BOOL IsEmptyMenuAllowed() const;

Valor de retorno

TRUE se o framework abrir um submenu a partir do item do menu atualmente selecionado mesmo quando o submenu está vazio; caso contrário, FALSO.

Observações

O framework chama este método quando um utilizador tenta abrir o submenu a partir do item do menu atualmente selecionado. Se o submenu estiver vazio e IsEmptyMenuAllowed devolver FALSE, o submenu não abrirá.

A implementação padrão devolve FALSE. Anule este método para personalizar este comportamento.

CMFCToolBarMenuButton::IsExclusivo

Indica se o botão está em modo exclusivo.

virtual BOOL IsExclusive() const;

Valor de retorno

TRUE se o botão estiver a funcionar em modo exclusivo; caso contrário, FALSO.

Observações

Quando um utilizador abre um menu popup para um botão e depois move o ponteiro do rato sobre outra barra de ferramentas ou botão do menu, o menu popup fecha, a menos que o botão esteja em modo exclusivo.

A implementação padrão devolve sempre FALSE. Anule este método numa classe derivada se quiser ativar o modo exclusivo.

CMFCToolBarMenuButton::IsMenuPaletteMode

Determina se o menu suspenso está em modo de paleta.

BOOL IsMenuPaletteMode() const;

Valor de retorno

TRUE se o modo paleta estiver ativado, caso contrário FALSE.

Observações

Quando o botão do menu está definido para modo paleta, os itens do menu aparecem em várias colunas com apenas um número limitado de linhas. Chame este método para obter o número de linhas. Pode ativar ou desativar o modo de paleta chamando CMFCToolBarMenuButton::SetMenuPaletteMode.

CMFCToolBarMenuButton::IsTearOffMenu

Indica se o menu suspenso tem uma barra de remoção.

virtual BOOL IsTearOffMenu() const;

Valor de retorno

TRUE se o botão do menu da barra de ferramentas tiver uma barra de remoção; caso contrário, FALSO.

Observações

Para ativar a funcionalidade de remoção e definir o ID da barra de remoção, ligue para CMFCToolBarMenuButton::SetTearOff.

CMFCToolBarMenuButton::m_bAlwaysCallOwnerDraw

Especifica se o framework chama sempre CFrameWndEx::OnDrawMenuImage quando um botão é desenhado.

static BOOL m_bAlwaysCallOwnerDraw;

Observações

Quando esta variável membro está definida como TRUE, o botão chama sempre o método CFrameWndEx::OnDrawMenuImage para mostrar a imagem no botão. Quando m_bAlwaysCallOwnerDraw é FALSE, o próprio botão desenha a imagem se a imagem estiver pré-definida. Caso contrário, chama OnDrawMenuImage.

CMFCToolBarMenuButton::OnAfterCreatePopupMenu

virtual void OnAfterCreatePopupMenu();

Observações

CMFCToolBarMenuButton::OnBeforeDrag

virtual BOOL OnBeforeDrag() const;

Valor de retorno

Observações

CMFCToolBarMenuButton::OnCalculateSize

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

Parâmetros

[dentro] pDC
[dentro] tamanhoPadrão
[dentro] bHorz

Valor de retorno

Observações

CMFCToolBarMenuButton::OnCancelMode

virtual void OnCancelMode();

Observações

CMFCToolBarMenuButton::OnChangeParentWnd

virtual void OnChangeParentWnd(CWnd* pWndParent);

Parâmetros

[dentro] pWndParent

Observações

CMFCToolBarMenuButton::OnClick

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

Parâmetros

[dentro] pWnd
[dentro] bDelay

Valor de retorno

Observações

CMFCToolBarMenuButton::OnClickMenuItem

É chamado pela framework quando o utilizador seleciona um item no menu suspenso.

virtual BOOL OnClickMenuItem();

Valor de retorno

FALSE se o framework continuar o processamento padrão dos itens do menu; caso contrário, VERDADE. A implementação padrão devolve sempre FALSE.

Observações

Quando o utilizador clica num item do menu, o framework executa um comando associado a esse item.

Para personalizar o processamento dos itens do menu, substitua OnClickMenuItem uma classe derivada da CMFCToolBarMenuButton classe. Também deve sobrescrever CFrameWndEx::OnShowPopupMenu e substituir os botões do menu que requerem processamento especial por instâncias da classe derivada.

CMFCToolBarMenuButton::OnContextHelp

virtual BOOL OnContextHelp(CWnd* pWnd);

Parâmetros

[dentro] pWnd

Valor de retorno

Observações

CMFCToolBarMenuButton::OnDraw

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

[dentro] pDC
[dentro] Rect
[dentro] pImagens
[dentro] bHorz
[dentro] bCustomizeMode
[dentro] bDestaques
[dentro] bDrawBorder
[dentro] bGrayDisabledButtons

Observações

CMFCToolBarMenuButton::OnDrawOnCustomizeList

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

Parâmetros

[dentro] pDC
[dentro] Rect
[dentro] bSelecionado

Valor de retorno

Observações

CMFCToolBarMenuButton::OpenPopupMenu

É chamado pelo framework quando o utilizador abre o menu suspenso de um botão do menu da barra de ferramentas.

virtual BOOL OpenPopupMenu(CWnd* pWnd=NULL);

Parâmetros

pWnd
[dentro] Especifica a janela que recebe os comandos do menu suspenso. Só pode ser NULL se o botão do menu da barra de ferramentas tiver uma janela parental.

Valor de retorno

TRUE quando um objeto CMFCPopupMenu Class era criado e aberto com sucesso; caso contrário, FALSO.

Observações

Esta função é chamada pelo framework quando o utilizador abre um menu suspenso a partir de um botão do menu da barra de ferramentas.

CMFCToolBarMenuButton::ResetImageToDefault

virtual void ResetImageToDefault();

Observações

CMFCToolBarMenuButton::SaveBarState

virtual void SaveBarState();

Observações

A estrutura chama este método quando cria um botão de barra de ferramentas como resultado de uma operação de arrastar e largar. Este método chama o método CMFCPopupMenu::SaveState do menu pop-up de topo, o que faz com que o botão pai do menu pop-up recrie o seu menu.

CMFCToolBarMenuButton::Serialize

virtual void Serialize(CArchive& ar);

Parâmetros

[dentro] ar

Observações

CMFCToolBarMenuButton::SetACCData

Define os dados de acessibilidade para o elemento fita.

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

Parâmetros

pParent
A janela principal para o elemento fita.

Dados
Os dados de acessibilidade para o elemento fita.

Valor de retorno

Retorna sempre VERDADEIRO.

Observações

Por defeito, este método define os dados de acessibilidade para o elemento da fita e devolve sempre TRUE. Substitua este método para definir os dados de acessibilidade e devolver um valor que indique sucesso ou fracasso.

CMFCToolBarMenuButton::SetMenuOnly

Especifica se o botão é desenhado como botão de menu ou de divisão quando tem tanto um ID de comando válido como um submenu.

void SetMenuOnly(BOOL bMenuOnly);

Parâmetros

bMenuOnly
[dentro] TRUE para mostrar este botão como um botão de menu quando tem tanto um ID de comando válido como um submenu, FALSE para mostrar este botão como um botão dividido quando tem tanto um ID de comando válido como um submenu.

Observações

Normalmente, quando um botão do menu da barra de ferramentas tem tanto um submenu como um ID de comando, o menu parece ser um botão dividido que tem um botão principal e um botão de seta para baixo anexado. Se chamares este método e o bMenuOnly for VERDADEIRO, o botão parece ser um único botão de menu com uma seta para baixo no botão. Quando o utilizador clica na seta em qualquer um dos modos, o submenu abre-se, e quando o utilizador clica na parte que não é seta do botão em qualquer um dos modos, a estrutura executa o comando .

CMFCToolBarMenuButton::SetMenuPaletteMode

Especifica se o menu suspenso está em modo de paleta.

void SetMenuPaletteMode(
    BOOL bMenuPaletteMode=TRUE,
    int nPaletteRows=1);

Parâmetros

bMenuPaletteMode
[dentro] Especifica se o menu suspenso está em modo de paleta.

nPaletteRows
[dentro] Número de carreiras na paleta.

Observações

No modo de paleta, todos os itens do menu são apresentados como uma paleta de múltiplas colunas. Especificas o número de linhas usando nPaletteRows.

CMFCToolBarMenuButton::SetMessageWnd

void SetMessageWnd(CWnd* pWndMessage);

Parâmetros

[dentro] pWndMessage

Observações

CMFCToolBarMenuButton::SetRadio

Define o botão do menu da barra de ferramentas para mostrar um ícone de estilo de botão de opção quando estiver selecionado.

virtual void SetRadio();

Observações

Quando o botão do menu é desenhado enquanto está assinalado, chama o CMFCVisualManager::OnDrawMenuCheck para desenhar um ícone de assinatura. Por defeito, OnDrawMenuCheck pede que o gestor visual atual desenhe uma marca de seleção ao estilo de uma caixa de seleção no botão do menu. Depois de chamar este método, o gestor visual atual desenha antes um símbolo de seleção no botão do menu. Esta alteração não pode ser desfeita.

Quando chamas este método e o botão do menu está a ser exibido, ele atualiza-se.

CMFCToolBarMenuButton::SetTearOff

Especifica o ID da barra de remoção no menu suspenso.

virtual void SetTearOff(UINT uiBarID);

Parâmetros

uiBarID
[dentro] Especifica um novo ID de barra removível.

Observações

Chame este método para especificar o ID da barra de remoção que é criada quando o utilizador arrasta o botão do menu para fora de uma barra de menu. Se o parâmetro uiBarID for 0, o utilizador não pode arrancar o botão do menu.

Ligue para CWinAppEx::EnableTearOffMenus para ativar a funcionalidade de menu de remoção na sua aplicação.

Consulte também

Gráfico de Hierarquia
Classes
Classe CMFCToolBarButton
Classe CMFCToolBar
Classe CMFCPopupMenu