Classe CMFCRibbonGallery

Implementa galerias de faixa de opções no estilo Office 2007. Para obter mais detalhes, confira o código-fonte localizado na pasta VC\atlmfc\src\mfc de sua instalação do Visual Studio.

Sintaxe

class CMFCRibbonGallery : public CMFCRibbonButton

Membros

Construtores públicos

Nome	Descrição
CMFCRibbonGallery::CMFCRibbonGallery	Constrói e inicializa um objeto CMFCRibbonGallery.

Métodos públicos

Nome	Descrição
CMFCRibbonGallery::AddGroup	Adiciona um novo grupo à galeria.
CMFCRibbonGallery::AddSubItem	Adiciona um novo item de menu ao menu suspenso.
CMFCRibbonGallery::Clear	Limpa o conteúdo da galeria.
CMFCRibbonGallery::EnableMenuResize	Habilita ou desabilita o redimensionamento do painel de menus.
CMFCRibbonGallery::EnableMenuSideBar	Habilita ou desabilita a barra lateral à esquerda do menu pop-up.
CMFCRibbonGallery::GetCompactSize	(Overrides CMFCRibbonButton::GetCompactSize.)
CMFCRibbonGallery::GetDroppedDown	(Substitui CMFCRibbonBaseElement::GetDroppedDown.)
CMFCRibbonGallery::GetGroupName	Retorna o nome do grupo localizado no índice especificado.
CMFCRibbonGallery::GetGroupOffset
CMFCRibbonGallery::GetIconsInRow	Retorna o número de itens em uma linha da galeria de faixas de opções.
CMFCRibbonGallery::GetItemToolTip	Retorna o texto de dica de ferramenta associado a um item na galeria.
CMFCRibbonGallery::GetLastSelectedItem	Retorna o índice do último item na galeria selecionado pelo usuário.
CMFCRibbonGallery::GetPaletteID	Retorna a ID de comando da galeria atual.
CMFCRibbonGallery::GetRegularSize	(Substitui CMFCRibbonButton::GetRegularSize.)
CMFCRibbonGallery::GetSelectedItem
CMFCRibbonGallery::HasMenu	(Substitui CMFCRibbonButton::HasMenu.)
CMFCRibbonGallery::IsButtonMode	Especifica se a galeria está presente em um botão da galeria.
CMFCRibbonGallery::IsMenuResizeEnabled	Especifica se o redimensionamento de menu está habilitado ou desabilitado.
CMFCRibbonGallery::IsMenuResizeVertical
CMFCRibbonGallery::IsMenuSideBar	Especifica se a barra lateral está habilitado ou desabilitado.
CMFCRibbonGallery::OnAfterChangeRect	(Substitui CMFCRibbonButton::OnAfterChangeRect.)
CMFCRibbonGallery::OnDraw	(Substitui CMFCRibbonButton::OnDraw.)
CMFCRibbonGallery::OnEnable	(Substitui CMFCRibbonBaseElement::OnEnable.)
CMFCRibbonGallery::OnRTLChanged	(Substitui CMFCRibbonBaseElement::OnRTLChanged.)
CMFCRibbonGallery::RedrawIcons	Redesenha a galeria.
CMFCRibbonGallery::RemoveItemToolTips	Remove as dicas de ferramenta de todos os itens da galeria.
CMFCRibbonGallery::SelectItem
CMFCRibbonGallery::SetACCData	(Substitui CMFCRibbonButton::SetACCData.)
CMFCRibbonGallery::SetButtonMode	Especifica se a galeria de faixas de opções deve ser exibida como botão suspenso ou como paleta diretamente na faixa de opções.
CMFCRibbonGallery::SetGroupName	Define o nome de um grupo.
CMFCRibbonGallery::SetIconsInRow	Define o número de itens por linha na galeria.
CMFCRibbonGallery::SetItemToolTip	Define o texto de dica de ferramenta para um item na galeria.
CMFCRibbonGallery::SetPalette	Anexa uma paleta a uma galeria de faixas de opções.
CMFCRibbonGallery::SetPaletteID	Define a ID de comando enviada na mensagem WM_COMMAND, quando um item da galeria é selecionado.

Métodos protegidos

Nome	Descrição
CMFCRibbonGallery::OnDrawPaletteIcon	Chamado pela estrutura quando um ícone de galeria é desenhado.

Comentários

Um botão de galeria se comporta como botão de menu normal, exceto pelo fato de que ele exibe uma galeria quando um usuário o abre. Quando você seleciona um item em uma galeria, a estrutura envia a mensagem WM_COMMAND juntamente com a ID de comando do botão. Ao tratar a mensagem, você deve chamar CMFCRibbonGallery::GetLastSelectedItem para determinar qual item foi selecionado na galeria.

Exemplo

O exemplo a seguir demonstra como usar vários métodos na classe CMFCRibbonGallery para configurar um objeto CMFCRibbonGallery. O exemplo ilustra como especificar o número de itens por linha na galeria, habilitar o redimensionamento do painel de menus, habilitar a barra lateral à esquerda do menu pop-up e exibir a galeria de faixas de opções como paleta diretamente na barra de faixa de opções. Esse snippet de código faz parte do exemplo Desenhar Cliente.

CMFCRibbonGallery *pBtnStyles = new CMFCRibbonGallery(ID_OBJECT_STYLES, _T("Styles\nk"), 0, 0, IDB_STYLES, 40);
pBtnStyles->SetIconsInRow(7);
pBtnStyles->EnableMenuResize(TRUE, TRUE);
pBtnStyles->EnableMenuSideBar();
pBtnStyles->SetButtonMode(false);
pBtnStyles->RedrawIcons();

Hierarquia de herança

CObject
└ CMFCRibbonBaseElement
 └ CMFCRibbonButton
  └ CMFCRibbonGallery

Requisitos

Cabeçalho: afxRibbonPaletteGallery.h

CMFCRibbonGallery::AddGroup

Adiciona um novo grupo à galeria.

void AddGroup(
    LPCTSTR lpszGroupName,
    UINT uiImagesPaletteResID,
    int cxPaletteImage);

void AddGroup(
    LPCTSTR lpszGroupName,
    CMFCToolBarImages& imagesGroup);

void AddGroup(
    LPCTSTR lpszGroupName,
    int nIconsNum);

Parâmetros

lpszGroupName
[in] Especifica o nome do grupo.

uiImagesPaletteResID
[in] Especifica a ID do recurso da lista de imagens que contém as imagens do grupo.

cxPaletteImage
[in] Especifica a largura em pixels de uma imagem.

imagesGroup
[in] Uma referência à lista de imagens que contém imagens de grupo.

nIconsNum
[in] Especifica o número de ícones no grupo. Esse parâmetro deve ser especificado apenas para grupos personalizados (desenhados pelo proprietário).

Comentários

Você pode dividir os itens de uma galeria de faixas de opções em vários grupos, chamando esse método. Cada grupo pode ter uma legenda.

CMFCRibbonGallery::AddSubItem

Adiciona um novo item de menu ao menu suspenso.

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

Parâmetros

pSubItem
[in] Um ponteiro para o item a ser adicionado ao menu.

nIndex
[in] Especifica o índice baseado em zero de um local em que o item deve ser inserido.

bOnTop
[in] TRUE, para especificar que o item deve ser inserido antes da galeria de faixas de opções. Caso contrário, FALSE.

Comentários

Você pode combinar galerias pop-up com itens de menu pop-up, chamando esse método. Os itens de menu podem ser colocados antes ou depois da galeria.

Para inserir o item antes da galeria, defina bOnTop como TRUE. Defina bOnTop como FALSE, para inserir o item abaixo da galeria.

Observação

O parâmetro nIndex especifica o índice de inserção na parte superior da galeria e na parte inferior da galeria. Por exemplo, se você precisar inserir um item uma posição antes da galeria, defina nIndex como 1 e bOnTop como TRUE. Da mesma forma, se você precisar inserir um item uma posição abaixo da galeria, defina nIndex como 1 e bOnTop como FALSE.

CMFCRibbonGallery::Clear

Limpa o conteúdo da galeria.

virtual void Clear();

Comentários

Chame esse método para remover todo o conteúdo da galeria de faixas de opções. Isso deve ser feito antes de anexar uma nova galeria de faixas de opções ou um conjunto de grupos à galeria de faixas de opções.

CMFCRibbonGallery::CMFCRibbonGallery

Constrói e inicializa um objeto CMFCRibbonGallery.

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    CMFCToolBarImages& imagesPalette);

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    UINT uiImagesPaletteResID=0,
    int cxPaletteImage=0);

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    CSize sizeIcon,
    int nIconsNum,
    BOOL bDefaultButtonStyle=TRUE);

Parâmetros

Nid
Especifica a ID de comando do comando a ser executado quando um usuário clica no botão.

lpszTexto
Especifica o texto a ser exibido no botão.

nSmallImageIndex
O índice de base zero da imagem pequena a ser exibida no botão.

nLargeImageIndex
O índice de base zero da imagem grande a ser exibida no botão.

imagesPalette
Uma referência ao objeto CMFCToolBarImages que contém as imagens a serem exibidas na galeria.

uiImagesPaletteResID
A ID do recurso da lista de imagens a ser exibida na galeria.

cxPaletteImage
Especifica a largura em pixels da imagem na galeria.

sizeIcon
Especifica o tamanho, em pixels, da imagem da galeria.

nIconsNum
Especifica o número de ícones na galeria.

bDefaultButtonStyle
Especifica se o padrão ou o estilo de botão desenhado pelo proprietário deve ser usado.

Comentários

CMFCRibbonGallery::EnableMenuResize

Habilita ou desabilita o redimensionamento do painel de menus.

void EnableMenuResize(
    BOOL bEnable = TRUE,
    BOOL bVertcalOnly = FALSE);

Parâmetros

bEnable
[in] TRUE, para habilitar o redimensionamento de menus. Caso contrário, FALSE.

bVertcalOnly
[in] TRUE, para especificar que a galeria só pode ser redimensionada verticalmente. FALSE, para especificar que a galeria pode ser redimensionada vertical e horizontalmente.

Comentários

Use este método para habilitar ou desabilitar o redimensionamento da galeria de faixas de opções. Quando o redimensionamento está habilitado, a galeria de faixas de opções exibe uma garra que um usuário pode usar para redimensioná-la.

CMFCRibbonGallery::EnableMenuSideBar

Habilita ou desabilita a barra lateral à esquerda do menu pop-up.

void EnablMenuSideBar(BOOL bEnable=TRUE);

Parâmetros

bEnable
[in] TRUE, para especificar que a barra lateral está habilitada. Caso contrário, FALSE.

Comentários

Chame esse método para habilitar ou desabilitar a barra lateral estilo Office XP no lado esquerdo do menu.

CMFCRibbonGallery::GetCompactSize

virtual CSize GetCompactSize(CDC* pDC);

Parâmetros

[in] pDC

Valor de retorno

Comentários

CMFCRibbonGallery::GetDroppedDown

virtual CMFCRibbonBaseElement* GetDroppedDown();

Valor de retorno

Comentários

CMFCRibbonGallery::GetGroupName

Retorna o nome do grupo localizado no índice especificado.

LPCTSTR GetGroupName(int nGroupIndex) const;

Parâmetros

nGroupIndex
[in] Especifica o índice baseado em zero para o grupo cujo nome você deseja recuperar.

Valor de retorno

O nome do grupo localizado no índice especificado. Passar um índice inválido resultará em uma declaração com falha.

Comentários

CMFCRibbonGallery::GetGroupOffset

virtual int GetGroupOffset() const;

Valor de retorno

Comentários

CMFCRibbonGallery::GetIconsInRow

Retorna o número de itens em uma linha da galeria de faixas de opções.

int GetIconsInRow() const;

Valor de retorno

O número de itens em uma linha.

Comentários

CMFCRibbonGallery::GetItemToolTip

Retorna o texto de dica de ferramenta associado a um item na galeria.

LPCTSTR GetItemToolTip(int nItemIndex) const;

Parâmetros

nItemIndex
[in] Especifica o índice baseado em zero do item para o qual o texto de dica de ferramenta deve ser recuperado.

Valor de retorno

Um ponteiro para a cadeia de caracteres de dica de ferramenta atribuída a um item na galeria de faixas de opções. Pode ser NULL, se nenhuma dica de ferramenta for atribuída a esse item.

Comentários

CMFCRibbonGallery::GetLastSelectedItem

Retorna o índice do último item na galeria de faixas de opções selecionado pelo usuário.

static int GetLastSelectedItem(UINT uiCmdID);

Parâmetros

uiCmdID
[in] Especifica a ID de comando do item de menu que abriu a galeria de faixas de opções.

Valor de retorno

Quando o usuário seleciona qualquer item na galeria de faixas de opções, a biblioteca envia a mensagem WM_COMMAND, juntamente com a ID de Comando do botão de menu que abriu a galeria de faixas de opções.

Comentários

CMFCRibbonGallery::GetPaletteID

Retorna a ID de comando da paleta atual.

int GetPaletteID() const;

Valor de retorno

A ID de comando da paleta selecionada no momento.

Comentários

CMFCRibbonGallery::GetRegularSize

virtual CSize GetRegularSize(CDC* pDC);

Parâmetros

[in] pDC

Valor de retorno

Comentários

CMFCRibbonGallery::GetSelectedItem

int GetSelectedItem() const;

Valor de retorno

Comentários

CMFCRibbonGallery::HasMenu

virtual BOOL HasMenu() const;

Valor de retorno

Comentários

CMFCRibbonGallery::IsButtonMode

Especifica se a paleta está presente em um botão da galeria.

BOOL IsButtonMode() const;

Valor de retorno

TRUE, se a paleta for exibida como botão de menu suspenso. FALSE, se a paleta for exibida diretamente na faixa de opções.

Comentários

CMFCRibbonGallery::IsMenuResizeEnabled

Especifica se o redimensionamento de menu está habilitado.

BOOL IsMenuResizeEnabled() const;

Valor de retorno

TRUE, se o redimensionamento de menu foi habilitado. Caso contrário, FALSE.

Comentários

CMFCRibbonGallery::IsMenuResizeVertical

BOOL IsMenuResizeVertical() const;

Valor de retorno

Comentários

CMFCRibbonGallery::IsMenuSideBar

Especifica se a barra lateral está habilitado ou desabilitado.

BOOL IsMenuSideBar() const;

Valor de retorno

TRUE, se a barra lateral estilo Office XP for desenhada no lado esquerdo do menu pop-up. Caso contrário, FALSE.

Comentários

CMFCRibbonGallery::OnAfterChangeRect

virtual void OnAfterChangeRect(CDC* pDC);

Parâmetros

[in] pDC

Comentários

CMFCRibbonGallery::OnDraw

virtual void OnDraw(CDC* pDC);

Parâmetros

[in] pDC

Comentários

CMFCRibbonGallery::OnDrawPaletteIcon

Chamado pela estrutura quando um ícone de galeria é desenhado.

virtual void OnDrawPaletteIcon(
    CDC* pDC,
    CRect rectIcon,
    int nIconIndex,
    CMFCRibbonGalleryIcon* pIcon,
    COLORREF clrText);

Parâmetros

pDC
[in] Um ponteiro para o contexto do dispositivo usado para desenho.

rectIcon
[in] Especifica o retângulo delimitador do ícone a ser desenhado.

nIconIndex
[in] Especifica o índice baseado em zero na lista de imagens dos ícones da galeria do ícone a ser desenhado.

pIcon
[in] Um ponteiro para o ícone que está sendo desenhado.

clrTexto
[in] Especifica a cor do texto do item a ser desenhado.

Comentários

Você pode substituir esse método em uma classe derivada para personalizar a aparência de uma galeria de faixas de opções.

CMFCRibbonGallery::OnEnable

virtual void OnEnable(BOOL bEnable);

Parâmetros

[in] bEnable

Comentários

CMFCRibbonGallery::OnRTLChanged

virtual void OnRTLChanged(BOOL bIsRTL);

Parâmetros

[in] bIsRTL

Comentários

CMFCRibbonGallery::RedrawIcons

Redesenha a galeria.

void RedrawIcons();

Comentários

Chame essa função para redesenhar a galeria. Você deve chamar esse método, se tiver alterado o conteúdo da galeria em runtime.

CMFCRibbonGallery::RemoveItemToolTips

Remove as dicas de ferramenta de todos os itens da galeria.

void RemoveItemToolTips();

Comentários

CMFCRibbonGallery::SelectItem

void SelectItem(int nItemIndex);

Parâmetros

[in] nItemIndex

Comentários

CMFCRibbonGallery::SetACCData

Preenche o objeto CAccessibilityData especificado usando dados de acessibilidade da galeria de faixas de opções.

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

Parâmetros

pParent
[in] A janela pai da janela da galeria de faixas de opções.

data
[out] Um objeto CAccessibilityData que recebe os dados de acessibilidade da galeria de faixas de opções.

Valor de retorno

Comentários

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

CMFCRibbonGallery::SetButtonMode

Determina se a galeria de faixas de opções deve ser exibida como botão suspenso ou como paleta diretamente na faixa de opções.

void SetButtonMode(BOOL bSet=TRUE);

Parâmetros

bSet
[in] TRUE, para exibir a galeria de faixas de opções como botão de menu suspenso. FALSE, para exibir o conteúdo da galeria de faixas de opções diretamente na faixa de opções.

Comentários

CMFCRibbonGallery::SetGroupName

Define o nome de um grupo.

void SetGroupName(
    int nGroupIndex,
    LPCTSTR lpszGroupName);

Parâmetros

nGroupIndex
[in] Especifica o índice baseado em zero para o grupo para o qual o nome está sendo alterado.

lpszGroupName
[in] Especifica o novo nome do grupo.

Comentários

O grupo cujo nome está sendo alterado deve ter sido adicionado usando o método CMFCRibbonGallery::AddGroup.

CMFCRibbonGallery::SetIconsInRow

Especifica o número de itens por linha na galeria.

void SetIconsInRow(int nIconsInRow);

Parâmetros

nIconsInRow
[in] Especifica o número de itens a serem exibidos em cada linha da galeria.

Comentários

Use este método para especificar a largura da galeria de faixas de opções.

CMFCRibbonGallery::SetItemToolTip

Define o texto de dica de ferramenta para um item na galeria.

void SetItemToolTip(
    int nItemIndex,
    LPCTSTR lpszToolTip);

Parâmetros

nItemIndex
[in] O índice baseado em zero do item de paleta ao qual a dica de ferramenta deve ser associada.

lpszToolTip
[in] O texto a ser exibido na dica de ferramenta.

Comentários

CMFCRibbonGallery::SetPalette

Anexa uma paleta a uma galeria de faixas de opções.

void SetPalette(CMFCToolBarImages& imagesPalette);

void SetPalette(
    UINT uiImagesPaletteResID,
    int cxPaletteImage);

Parâmetros

imagesPalette
[in] Especifica a lista de imagens que contém os ícones a serem exibidos na galeria.

uiImagesPaletteResID
[in] Especifica a ID do recurso da lista de imagens que contém os ícones a serem exibidos na galeria.

cxPaletteImage
[in] Especifica a largura em pixels de uma imagem na galeria.

Comentários

CMFCRibbonGallery::SetPaletteID

Define a ID de comando enviada na mensagem WM_COMMAND, quando um usuário seleciona um item da galeria.

void SetPaletteID(UINT nID);

Parâmetros

Nid
[in] Especifica a ID de comando enviada na mensagem WM_COMMAND, quando um usuário seleciona um item da galeria.

Comentários

Para determinar o item específico que um usuário selecionou na galeria, chame o método estático CMFCRibbonGallery::GetLastSelectedItem.

Confira também

Gráfico da hierarquia
Classes
Classe CMFCRibbonButton
Classe CMFCRibbonGalleryMenuButton