Classe CMFCRibbonButton

A CMFCRibbonButton classe implementa botões que podes posicionar em elementos da barra de fita, como painéis, barras de Acesso Rápido e menus 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 CMFCRibbonButton : public CMFCRibbonBaseElement

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Example

O exemplo seguinte demonstra como usar os vários métodos na CMFCRibbonButton aula. O exemplo mostra como construir um objeto da CMFCRibbonButton classe, atribuir um menu pop-up ao botão de fita, definir a descrição do botão, remover um item do menu pop-up e alinhar à direita o menu pop-up à borda do botão.

strTemp.LoadString(IDS_RIBBON_STYLE);
// The first parameter is the command ID of the button.
// The third parameter is a zero-based index of the button's small image in the
// image list of the parent category.
// The fourth parameter is a zero-based index of the button's large image in the
// image list of the parent category.
CMFCRibbonButton *pVisualStyleButton = new CMFCRibbonButton(1, strTemp, -1, -1);

pVisualStyleButton->SetMenu(IDR_THEME_MENU, TRUE, TRUE);

strTemp.LoadString(IDS_RIBBON_STYLE_TIP);
pVisualStyleButton->SetToolTipText(strTemp);
strTemp.LoadString(IDS_RIBBON_STYLE_DESC);
pVisualStyleButton->SetDescription(strTemp);
pVisualStyleButton->RemoveSubItem(0);
pVisualStyleButton->SetRightAlignMenu(TRUE);

Observações

Para usar um botão de fita numa aplicação, constrói o objeto botão e adiciona-o ao painel de fita apropriado.

CMFCRibbonPanel* pPanel = pCategory->AddPanel (
    _T("Clipboard"), // Panel name
    m_PanelIcons.ExtractIcon (0)); // Panel icon

// Create the first button ("Paste"):
CMFCRibbonButton* pPasteButton =
    new CMFCRibbonButton (ID_EDIT_PASTE, _T("Paste"), -1, 0);

// The third parameter (-1) disables small images for button.
// This button is always displayed with a large image
// Associate a pop-up menu with the "Paste" button:
pPasteButton->SetMenu (IDR_CONTEXT_MENU);

// Add buttons to the panel. These buttons have only small images.
pPanel->Add (new CMFCRibbonButton (ID_EDIT_CUT, _T("Cut"), 1));
pPanel->Add (new CMFCRibbonButton (ID_EDIT_COPY, _T("Copy"), 2));
pPanel->Add (new CMFCRibbonButton (ID_EDIT_PAINT, _T("Paint"), 9));

Hierarquia de herança

CObject

CMFCRibbonBaseElement

CMFCRibbonButton

Requerimentos

Cabeçalho: afxribbonbutton.h

CMFCRibbonButton::AddSubItem

Adiciona um item de menu ao menu pop-up associado ao botão.

void AddSubItem(
    CMFCRibbonBaseElement* pSubItem,
    int nIndex=-1);

Parâmetros

pSubItem
[dentro] Especifica um ponteiro para o novo elemento a adicionar.

nIndex
[dentro] Especifica o índice onde adicionar o elemento ao array de itens do menu do botão; -1 adicionar o elemento no final do array de itens do menu.

CMFCRibbonButton::PodeSer Esticado

virtual BOOL CanBeStretched();

Valor de retorno

Observações

CMFCRibbonButton::CleanUpSizes.

virtual void CleanUpSizes();

Observações

CMFCRibbonButton::FecharMenuPopupT

virtual void ClosePopupMenu();

Observações

CMFCRibbonButton::CMFCRibbonButton

Constrói um objeto de botão de fita.

CMFCRibbonButton(
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex=-1,
    int nLargeImageIndex=-1,
    BOOL bAlwaysShowDescription=FALSE);

CMFCRibbonButton(
    UINT nID,
    LPCTSTR lpszText,
    HICON hIcon,
    BOOL bAlwaysShowDescription=FALSE,
    HICON hIconSmall=NULL,
    BOOL bAutoDestroyIcon=FALSE,
    BOOL bAlphaBlendIcon=FALSE);

Parâmetros

nID
[dentro] Especifica o ID do comando do botão.

lpszText
[dentro] Especifica o rótulo de texto do botão.

nSmallImageIndex
[dentro] Especifica um índice em base zero da pequena imagem do botão na lista de imagens da categoria pai.

nLargeImageIndex
[dentro] Especifica um índice baseado em zero da imagem grande do botão na lista de imagens da categoria pai.

hIcon
[dentro] Especifica um handle para o ícone que a aplicação usa como imagem do botão.

Example

O exemplo seguinte demonstra como construir um CMFCRibbonButton objeto.

strTemp.LoadString(IDS_RIBBON_CUT);
CMFCRibbonButton *butn = new CMFCRibbonButton(ID_EDIT_CUT, strTemp, 1);
butn->SetKeys(_T("k"));

CMFCRibbonButton::D rawBottomText

CSize DrawBottomText(
    CDC* pDC,
    BOOL bCalcOnly);

Parâmetros

[dentro] pDC
[dentro] bCalcOnly

Valor de retorno

Observações

CMFCRibbonButton::D rawImage

virtual void DrawImage(
    CDC* pDC,
    RibbonImageType type,
    CRect rectImage);

Parâmetros

[dentro] pDC
[dentro] Tipo
[dentro] rectImage

Observações

CMFCRibbonButton::D rawRibbonText

virtual int DrawRibbonText(
    CDC* pDC,
    const CString& strText,
    CRect rectText,
    UINT uiDTFlags,
    COLORREF clrText = (COLORREF)-1);

Parâmetros

[dentro] pDC
[dentro] strText
[dentro] rectText
[dentro] uiDTFlags
[dentro] clrText

Valor de retorno

Observações

CMFCRibbonButton::FindSubItemIndexByID

Devolve o índice de um elemento do menu pop-up associado ao ID de comando especificado.

int FindSubItemIndexByID(UINT uiID) const;

Parâmetros

uiID
[dentro] Especifica o ID do comando do item do menu pop-up.

Valor de retorno

O índice baseado em zero do subitem associado ao uiID. -1 se não existir tal subitem.

CMFCRibbonButton::GetCommandRect

CRect GetCommandRect() const;

Valor de retorno

Observações

CMFCRibbonButton::GetCompactSize

virtual CSize GetCompactSize(CDC* pDC);

Parâmetros

[dentro] pDC

Valor de retorno

Observações

CMFCRibbonButton::GetIcon

HICON GetIcon(BOOL bLargeIcon = TRUE) const;

Parâmetros

[dentro] bLargeIcon

Valor de retorno

Observações

CMFCRibbonButton::GetImageIndex

Devolve o índice da imagem associada ao botão.

int GetImageIndex(BOOL bLargeImage) const;

Parâmetros

bGrandeImagem
[dentro] Se TRUE, retorna o índice de imagens na lista de imagens que contém as imagens grandes; caso contrário, retorna o índice de imagens na lista de imagens que contém as imagens pequenas.

Valor de retorno

O índice da imagem do botão na lista de imagens associada.

CMFCRibbonButton::GetImageSize

virtual CSize GetImageSize(RibbonImageType type) const;

Parâmetros

[dentro] Tipo

Valor de retorno

Observações

CMFCRibbonButton::GetIntermediateSize

virtual CSize GetIntermediateSize(CDC* pDC);

Parâmetros

[dentro] pDC

Valor de retorno

Observações

CMFCRibbonButton::GetMenu

Devolve um handle a um menu do Windows atribuído ao botão de fita.

HMENU GetMenu() const;

Valor de retorno

Um handle para um menu do Windows atribuído ao botão; NULL se não houver menu atribuído.

CMFCRibbonButton::GetMenuRect

CRect GetMenuRect() const;

Valor de retorno

Observações

CMFCRibbonButton::GetRegularSize

virtual CSize GetRegularSize(CDC* pDC);

Parâmetros

[dentro] pDC

Valor de retorno

Observações

CMFCRibbonButton::GetSubItems

const CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& GetSubItems() const;

Valor de retorno

Observações

CMFCRibbonButton::GetTextRowHeight

int GetTextRowHeight() const;

Valor de retorno

Observações

CMFCRibbonButton::GetToolTipText

virtual CString GetToolTipText() const;

Valor de retorno

Observações

CMFCRibbonButton::HasCompactMode

virtual BOOL HasCompactMode() const;

Valor de retorno

Observações

CMFCRibbonButton::HasIntermediateMode

virtual BOOL HasIntermediateMode() const;

Valor de retorno

Observações

CMFCRibbonButton::HasLargeMode

virtual BOOL HasLargeMode() const;

Valor de retorno

Observações

CMFCRibbonButton::HasMenu

virtual BOOL HasMenu() const;

Valor de retorno

Observações

CMFCRibbonButton::IsAlwaysAlDrawBorder

virtual BOOL IsAlwaysDrawBorder() const;

Valor de retorno

Observações

CMFCRibbonButton::IsAlwaysAlLargeImage

virtual BOOL IsAlwaysLargeImage() const;

Valor de retorno

Observações

CMFCRibbonButton::IsApplicationButton

virtual BOOL IsApplicationButton() const;

Valor de retorno

Observações

CMFCRibbonButton::IsCommandAreaHighlighted

virtual BOOL IsCommandAreaHighlighted() const;

Valor de retorno

Observações

CMFCRibbonButton::IsDefaultCommand

Especifica se o comando predefinido para um botão de fita está ativado.

BOOL IsDefaultCommand() const;

Valor de retorno

TRUE se tiver ativado o comando padrão para um botão de fita; FALSO, caso contrário.

CMFCRibbonButton::IsDefaultPanelButton

virtual BOOL IsDefaultPanelButton() const;

Valor de retorno

Observações

CMFCRibbonButton::IsDrawTooltipImage

virtual BOOL IsDrawTooltipImage() const;

Valor de retorno

Observações

CMFCRibbonButton::IsLargeImage

BOOL IsLargeImage() const;

Valor de retorno

Observações

CMFCRibbonButton::IsMenuAreaDestacado

virtual BOOL IsMenuAreaHighlighted() const;

Valor de retorno

Observações

CMFCRibbonButton::ÉMenuEmBaixo

BOOL IsMenuOnBottom() const;

Valor de retorno

Observações

CMFCRibbonButton::IsPopupDefaultMenuLook

virtual BOOL IsPopupDefaultMenuLook() const;

Valor de retorno

Observações

CMFCRibbonButton::IsRightAlignMenu

Especifica se o menu está alinhado à direita.

BOOL IsRightAlignMenu() const;

Valor de retorno

TRUE se o menu estiver alinhado à direita; caso contrário, FALSO.

CMFCRibbonButton::IsSingleLineText

BOOL IsSingleLineText() const;

Valor de retorno

Observações

CMFCRibbonButton::OnCalcTextSize

virtual void OnCalcTextSize(CDC* pDC);

Parâmetros

[dentro] pDC

Observações

CMFCRibbonButton::OnClick

É chamado pelo framework quando o utilizador clica no botão.

virtual void OnClick(CPoint point);

Parâmetros

ponto
[dentro] Especifica a posição do clique do rato.

Observações

Substitua este método numa classe derivada se quiser lidar com este evento.

CMFCRibbonButton::OnDraw

virtual void OnDraw(CDC* pDC);

Parâmetros

[dentro] pDC

Observações

CMFCRibbonButton::OnDrawBorder

virtual void OnDrawBorder(CDC* pDC);

Parâmetros

[dentro] pDC

Observações

CMFCRibbonButton::OnFillBackground

virtual COLORREF OnFillBackground(CDC* pDC);

Parâmetros

[dentro] pDC

Valor de retorno

Observações

CMFCRibbonButton::RemoveAllSubItems

Remove todos os itens do menu pop-up.

void RemoveAllSubItems();

CMFCRibbonButton::RemoveSubItem

Remove um item do menu pop-up.

BOOL RemoveSubItem(int nIndex);

Parâmetros

nIndex
[dentro] Especifica o índice em base zero do item do menu que pretende remover.

Valor de retorno

TRUE se o item especificado tiver sido removido com sucesso; caso contrário, FALSE se o nIndex for negativo ou exceder o número de itens no menu pop-up.

CMFCRibbonButton::SetACCData

Define os dados de acessibilidade para o botão de 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 TRUE se for bem-sucedido; caso contrário, FALSO.

Observações

CMFCRibbonButton::SetAlwaysLargeImage

Especifica se o botão mostra uma imagem grande ou pequena quando o utilizador dobra o botão.

void SetAlwaysLargeImage(BOOL bSet=TRUE);

Parâmetros

bSet
[dentro] Se TRUE, o botão mostra uma imagem grande. Caso contrário, o botão mostra uma pequena imagem.

CMFCRibbonButton::SetDefaultCommand

Ativa o comando padrão para o botão de fita.

void SetDefaultCommand(BOOL bSet=TRUE);

Parâmetros

bSet
[dentro] Se TRUE, o botão pode executar o seu comando padrão. Se FALSE, o botão não pode executar o seu comando padrão.

Observações

bSet só é relevante quando o botão tem um menu. Se bSet for VERDADEIRO, o botão pode executar o seu comando padrão e o menu pop-up atribuído só aparece quando o utilizador clica na seta na extremidade direita do botão. Caso contrário, o botão não pode executar o seu comando padrão, e o menu pop-up aparece independentemente da área do botão que o utilizador clica.

CMFCRibbonButton::SetDescription

virtual void SetDescription(LPCTSTR lpszText);

Parâmetros

[dentro] lpszText

Observações

CMFCRibbonButton::SetImageIndex

Atribui um índice à imagem do botão.

void SetImageIndex(
    int nIndex,
    BOOL bLargeImage);

Parâmetros

nIndex
[dentro] Especifica o índice da imagem.

bGrandeImagem
[dentro] Se TRUE, o índice especificado refere-se à lista de imagens grandes. Caso contrário, o índice refere-se à lista das imagens pequenas.

CMFCRibbonButton::SetMenu

Atribui um menu pop-up ao botão da fita.

void SetMenu(
    HMENU hMenu,
    BOOL bIsDefaultCommand=FALSE,
    BOOL bRightAlign=FALSE);

void SetMenu(
    UINT uiMenuResID,
    BOOL bIsDefaultCommand=FALSE,
    BOOL bRightAlign=FALSE);

Parâmetros

hMenu
Um handle para um menu do Windows.

bIsDefaultCommand
Se TRUE, o botão pode executar o seu comando padrão; caso contrário, o botão mostra um menu pop-up.

bRightAlign
Se TRUE, o menu está alinhado à direita. Caso contrário, o menu está alinhado à esquerda.

uiMenuResID
Um ID de recurso no menu.

Observações

Quando a aplicação atribui o menu ao botão, este mostra uma seta no lado direito. Se o bIsDefaultCommand for TRUE, o menu só aparece quando o utilizador clica na seta. Se o utilizador clicar no botão, o seu comando padrão é executado. Se bIsDefaultCommand for FALSE, o menu aparece ao clicar em qualquer lugar do botão.

CMFCRibbonButton::SetParentCategory

virtual void SetParentCategory(CMFCRibbonCategory* pParent);

Parâmetros

[dentro] pParent

Observações

CMFCRibbonButton::SetRightAlignMenu

Alinha o menu pop-up à borda do botão.

void SetRightAlignMenu(BOOL bSet=TRUE);

Parâmetros

bSet
[dentro] Se TRUE, o menu está alinhado à direita. Caso contrário, o menu está alinhado à esquerda

CMFCRibbonButton::SetText

virtual void SetText(LPCTSTR lpszText);

Parâmetros

[dentro] lpszText

Observações

Consulte também

Gráfico de Hierarquia
Classes