Classe CMFCRibbonGaleria

Implementa galerias de fitas ao estilo Office 2007. Para mais detalhes, consulte o código-fonte localizado na pasta VC\atlmfc\src\mfc da sua instalação no Visual Studio.

Sintaxe

class CMFCRibbonGallery : public CMFCRibbonButton

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Observações

Um botão de galeria comporta-se como um botão de menu normal, exceto que mostra uma galeria quando o utilizador o abre. Quando selecionas um item numa galeria, a framework envia a mensagem WM_COMMAND juntamente com o ID do comando do botão. Quando tratar da mensagem, deve ligar para CMFCRibbonGallery::GetLastSelectedItem para determinar qual item foi selecionado da galeria.

Example

O exemplo seguinte demonstra como usar vários métodos na CMFCRibbonGallery classe para configurar um CMFCRibbonGallery objeto. O exemplo ilustra como especificar o número de itens por linha na galeria, ativar o redimensionamento do painel do menu, ativar a barra lateral à esquerda do menu pop-up e exibir a galeria de fitas como uma paleta diretamente na barra de fitas. Este excerto de código faz parte do exemplo Draw Client.

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
  └ CMFCRibbonGaleria

Requerimentos

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
[dentro] Especifica o nome do grupo.

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

cxPaletteImage
[dentro] Especifica a largura em píxeis de uma imagem.

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

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

Observações

Pode dividir os itens numa galeria de fitas em vários grupos chamando este 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
[dentro] Um apontador para o item para adicionar ao menu.

nIndex
[dentro] Especifica o índice em base zero de um local onde inserir o item.

bOnTop
[dentro] TRUE para especificar que o item deve ser inserido antes da galeria de fitas; caso contrário, FALSO.

Observações

Pode combinar galerias pop-up com itens do menu popup chamando este método. Os itens do menu podem ser colocados antes ou depois da galeria.

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

CMFCRibbonGallery::Limpo

Limpa o conteúdo da galeria.

virtual void Clear();

Observações

Chame este método para remover todo o conteúdo da galeria de fitas. Isto deve ser feito antes de anexar uma nova galeria de fitas ou conjunto de grupos à galeria de fitas.

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 o ID do comando a executar quando o utilizador clica no botão.

lpszText
Especifica o texto a aparecer no botão.

nSmallImageIndex
O índice em base zero da imagem pequena aparecerá no botão.

nLargeImageIndex
O índice em base zero da imagem grande deve aparecer no botão.

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

uiImagesPaletteResID
O ID do recurso da lista de imagens a exibir 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 deve usar o estilo de botão padrão ou desenhado pelo dono.

Observações

CMFCRibbonGallery::EnableMenuResize

Ativa ou desativa o redimensionamento do painel de menus.

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

Parâmetros

bEnable
[dentro] TRUE para permitir o redimensionamento do menu; caso contrário, FALSO.

bVertcalOnly
[dentro] TRUE para especificar que a galeria só pode ser redimensionada verticalmente; FALSE para especificar que a galeria pode ser redimensionada tanto vertical como horizontalmente.

Observações

Use este método para ativar ou desativar o redimensionamento da galeria de fitas. Quando o redimensionamento está ativado, a galeria de fitas mostra uma pinça que o utilizador pode usar para a redimensionar.

CMFCRribbonGallery::EnableMenuSideBar

Ativa ou desativa a barra lateral à esquerda do menu pop-up.

void EnablMenuSideBar(BOOL bEnable=TRUE);

Parâmetros

bEnable
[dentro] TRUE para especificar que a barra lateral está ativada; caso contrário, FALSO.

Observações

Chame este método para ativar ou desativar a barra lateral ao estilo Office XP no lado esquerdo do menu.

CMFCRibbonGallery::GetCompactSize

virtual CSize GetCompactSize(CDC* pDC);

Parâmetros

[dentro] pDC

Valor de retorno

Observações

CMFCRibbonGallery::GetDroppedDown

virtual CMFCRibbonBaseElement* GetDroppedDown();

Valor de retorno

Observações

CMFCRibbonGallery::GetGroupName

Devolve o nome do grupo localizado no índice especificado.

LPCTSTR GetGroupName(int nGroupIndex) const;

Parâmetros

nGroupIndex
[dentro] Especifica o índice baseado em zero para o grupo cujo nome queres recuperar.

Valor de retorno

O nome do grupo localizado no índice especificado. Passar um índice inválido resultará numa afirmação falhada.

Observações

CMFCRibbonGallery::GetGroupOffset

virtual int GetGroupOffset() const;

Valor de retorno

Observações

CMFCRibbonGallery::GetIconsInRow

Devolve o número de itens numa fila da galeria de fitas.

int GetIconsInRow() const;

Valor de retorno

O número de itens seguidos.

Observações

CMFCRibbonGallery::GetItemToolTip

Devolve o texto de tooltip associado a um item na galeria.

LPCTSTR GetItemToolTip(int nItemIndex) const;

Parâmetros

nItemIndex
[dentro] Especifica o índice em base zero do item para o qual recuperar o texto da tooltip.

Valor de retorno

Um apontador para a string tooltip atribuída a um item na galeria de fitas. Pode ser NULL se não for atribuída nenhuma tooltip a esse item.

Observações

CMFCRibbonGallery::GetLastSelectedItem

Devolve o índice do último item da galeria de fitas que o utilizador selecionou.

static int GetLastSelectedItem(UINT uiCmdID);

Parâmetros

uiCmdID
[dentro] Especifica o ID do comando do item do menu que abriu a galeria de fitas.

Valor de retorno

Quando o utilizador seleciona qualquer item na galeria de fitas, a biblioteca envia a mensagem WM_COMMAND juntamente com o ID de Comando do botão do menu que abriu a galeria de fitas.

Observações

CMFCRibbonGallery::GetPaletteID

Devolve o ID do comando da paleta atual.

int GetPaletteID() const;

Valor de retorno

O ID do comando da paleta atualmente selecionada.

Observações

CMFCRibbonGallery::GetRegularSize

virtual CSize GetRegularSize(CDC* pDC);

Parâmetros

[dentro] pDC

Valor de retorno

Observações

CMFCRibbonGallery::GetSelectedItem

int GetSelectedItem() const;

Valor de retorno

Observações

CMFCRibbonGallery::HasMenu

virtual BOOL HasMenu() const;

Valor de retorno

Observações

CMFCRibbonGallery::IsButtonMode

Especifica se a paleta está contida num botão de galeria.

BOOL IsButtonMode() const;

Valor de retorno

TRUE se a paleta for apresentada como um botão de menu suspenso; FALSE se a paleta for exibida diretamente na fita.

Observações

CMFCRibbonGallery::IsMenuResizeEnabled

Especifica se o redimensionamento do menu está ativado.

BOOL IsMenuResizeEnabled() const;

Valor de retorno

TRUE se o redimensionamento do menu estiver ativado; caso contrário, FALSO.

Observações

CMFCRibbonGallery::ÉMenuRedimensionarVertical

BOOL IsMenuResizeVertical() const;

Valor de retorno

Observações

CMFCRibbonGallery::ÉMenuSideBar

Especifica se a barra lateral está ativada ou desativada.

BOOL IsMenuSideBar() const;

Valor de retorno

VERDADE se a barra lateral ao estilo Office XP estiver desenhada no lado esquerdo do menu pop-up; caso contrário, FALSO.

Observações

CMFCRibbonGallery::OnAfterChangeRect

virtual void OnAfterChangeRect(CDC* pDC);

Parâmetros

[dentro] pDC

Observações

CMFCRibbonGallery::OnDraw

virtual void OnDraw(CDC* pDC);

Parâmetros

[dentro] pDC

Observações

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
[dentro] Um apontador para o contexto do dispositivo usado para desenhar.

rectIcon
[dentro] Especifica o retângulo delimitador do ícone a desenhar.

nIconIndex
[dentro] Especifica o índice em base zero na lista de imagens dos ícones de galeria do ícone a desenhar.

pIcon
[dentro] Um indicador para o ícone que está a ser desenhado.

clrText
[dentro] Especifica a cor do texto do item a desenhar.

Observações

Pode sobrescrever este método numa classe derivada para personalizar a aparência de uma galeria de fitas.

CMFCRibbonGallery::OnEnable

virtual void OnEnable(BOOL bEnable);

Parâmetros

[dentro] bEnable

Observações

CMFCRibbonGallery::OnRTLCmudou

virtual void OnRTLChanged(BOOL bIsRTL);

Parâmetros

[dentro] bIsRTL

Observações

CMFCRibbonGallery::RedrawIcons

Redesenha a galeria.

void RedrawIcons();

Observações

Chama esta função para redesenhar a galeria. Deve chamar este método se tiver alterado o conteúdo da galeria em tempo de execução.

CMFCRibbonGallery::RemoveItemToolTips

Remove as dicas de todos os itens na galeria.

void RemoveItemToolTips();

Observações

CMFCRibbonGallery::SelectItem

void SelectItem(int nItemIndex);

Parâmetros

[dentro] nItemIndex

Observações

CMFCRibbonGallery::SetACCData

Preenche o objeto especificado CAccessibilityData usando dados de acessibilidade da galeria de fitas.

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

Parâmetros

pParent
[dentro] A janela principal da janela da galeria de fitas.

Dados
[fora] Um CAccessibilityData objeto que recebe os dados de acessibilidade da galeria de fitas.

Valor de retorno

Observações

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

CMFCRibbonGallery::SetButtonMode

Determina se deve mostrar a galeria de fitas como um botão suspenso ou como uma paleta diretamente na fita.

void SetButtonMode(BOOL bSet=TRUE);

Parâmetros

bSet
[dentro] TRUE para mostrar a galeria de fitas como um botão de menu suspenso; FALSE para exibir o conteúdo da galeria de fitas diretamente na fita.

Observações

CMFCRibbonGallery::SetGroupName

Define o nome de um grupo.

void SetGroupName(
    int nGroupIndex,
    LPCTSTR lpszGroupName);

Parâmetros

nGroupIndex
[dentro] Especifica o índice baseado em zero para o grupo para o qual o nome está a ser alterado.

lpszGroupName
[dentro] Especifica o novo nome do grupo.

Observações

O grupo cujo nome está a ser 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
[dentro] Especifica o número de itens a aparecer em cada linha da galeria.

Observações

Use este método para especificar a largura da galeria de fitas.

CMFCRibbonGallery::SetItemToolTip

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

void SetItemToolTip(
    int nItemIndex,
    LPCTSTR lpszToolTip);

Parâmetros

nItemIndex
[dentro] O índice em base zero do item da paleta com o qual associar a dica de ferramenta.

lpszToolTip
[dentro] O texto para aparecer na dica de ferramenta.

Observações

CMFCRibbonGallery::SetPalette

Anexa uma paleta a uma galeria de fitas.

void SetPalette(CMFCToolBarImages& imagesPalette);

void SetPalette(
    UINT uiImagesPaletteResID,
    int cxPaletteImage);

Parâmetros

imagesPalette
[dentro] Especifica a lista de imagens que contém os ícones a aparecer na galeria.

uiImagesPaletteResID
[dentro] Especifica o ID de recurso da lista de imagens que contém os ícones a aparecer na galeria.

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

Observações

CMFCRibbonGallery::SetPaletteID

Define o ID do comando que é enviado na mensagem WM_COMMAND quando um utilizador seleciona um item da galeria.

void SetPaletteID(UINT nID);

Parâmetros

nID
[dentro] Especifica o ID do comando que é enviado na mensagem WM_COMMAND quando um utilizador seleciona um item da galeria.

Observações

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

Consulte também

Gráfico de Hierarquia
Classes
Classe CMFCRibbonButton
CMFCRibbonGalleryMenuButton Class