Partilhar via


Classe CMFCRibbonCategory

Observação

A biblioteca Microsoft Foundation Classes (MFC) continua a ser suportada. No entanto, já não estamos a adicionar funcionalidades nem a atualizar a documentação.

A CMFCRibbonCategory classe implementa uma aba de fita que contém um grupo de painéis de fita.

Sintaxe

class CMFCRibbonCategory : public CObject

Membros

Construtores Protegidos

Nome Description
CMFCRibbonCategoria::CMFCRibbonCategoria O construtor.

Métodos Públicos

Nome Description
CMFCRibbonCategory::AddHidden Adiciona um elemento oculto à categoria de fitas.
CMFCRibbonCategoria::AddPanel Adiciona um novo painel à categoria de fitas.
CMFCRibbonCategoria::CópiaDe
CMFCRibbonCategoria::FindByData
CMFCRibbonCategoria::FindByID
CMFCRibbonCategoria::FindPainelWithElem
CMFCRibbonCategory::GetContextID Devolve o ID de contexto da categoria de fita.
CMFCRibbonCategoria::GetData Devolve os dados definidos pelo utilizador que estão associados à categoria fita.
CMFCRibbonCategoria::GetDroppedDown
CMFCRibbonCategoria::GetElements
CMFCRibbonCategoria::GetElementsByID
CMFCRibbonCategoria::GetFirstVisibleElement Obtenha um primeiro elemento visível que pertença à categoria fita.
CMFCRibbonCategoria::GetFocused Devolve um elemento focado.
CMFCRibbonCategoria::GetHighlight Devolve um elemento realçado.
CMFCRibbonCategoria::ReceberContagemImagensT
CMFCRibbonCategoria::ObterImageTamanho
CMFCRibbonCategoria::ObterItemIDsLista
CMFCRibbonCategoria::GetLastVisibleElement Obtenha um último elemento visível que pertença à categoria de fita
CMFCRibbonCategoria::GetLargeImages Retorna uma referência à lista de imagens grandes que a categoria de fita utiliza.
CMFCRibbonCategoria::ObtenhaAlturaMáxima
CMFCRibbonCategoria::GetName
CMFCRibbonCategoria::GetPanel Devolve um ponteiro para o painel de fita localizado no índice especificado.
CMFCRibbonCategoria::GetPanelCount Devolve o número de painéis de fita na categoria de fitas.
CMFCRibbonCategoria::GetPanelFromPoint
CMFCRibbonCategoria::GetPanelIndex Devolve o índice do painel de fita especificado.
CMFCRibbonCategoria::GetParentButton
CMFCRibbonCategoria::GetParentMenuBar
CMFCRibbonCategoria::GetParentRibbonBar
CMFCRibbonCategoria::GetRect
CMFCRibbonCategoria::GetSmallImagesT Devolve uma referência à lista de pequenas imagens que a categoria utiliza.
CMFCRibbonCategoria::GetTabColor Devolve a cor atual do separador de categoria da fita.
CMFCRibbonCategory::GetTabRect
CMFCRibbonCategoria::ObterTextoTopLine
CMFCRibbonCategoria::GetVisibleElements Obtenha todos os elementos visíveis que pertencem à categoria fita.
CMFCRibbonCategoria::Painel de Destaque
CMFCRibbonCategoria::HitTest
CMFCRibbonCategoria::HitTestEx
CMFCRibbonCategoria::BotõesDeScrollDeTestHit
CMFCRibbonCategoria::Está Ativo
CMFCRibbonCategoria::ÉVisível Determina se a categoria de fita é visível.
CMFCRibbonCategoria::IsWindows7Look Indica se a fita principal tem um aspeto ao estilo Windows 7 (pequeno botão retangular de aplicação)
CMFCRibbonCategoria::NotifyControlCommand
CMFCRibbonCategoria::OnCancelMode
CMFCRibbonCategoria::OnDraw
CMFCRibbonCategoria::NaDesenharImagem
CMFCRibbonCategoria::OnDrawMenuBorder
CMFCRibbonCategoria::OnKey É chamado pelo framework quando um utilizador pressiona um botão do teclado.
CMFCRibbonCategoria::OnLButtonDown
CMFCRibbonCategoria::OnLButtonUp
CMFCRibbonCategoria::OnMouseMove
CMFCRibbonCategoria::OnRTLCmudou
CMFCRibbonCategoria::OnScrollHorz
CMFCRibbonCategoria::OnUpdateCmdUI
CMFCRibbonCategoria::RecalcLayout
CMFCRibbonCategoria::RemovePanel
CMFCRibbonCategoria::ReposPainéis
CMFCRibbonCategoria::SetCollapseOrder Define a ordem de colapso dos painéis de fita presentes na categoria de fitas.
CMFCRibbonCategoria::SetData Armazena os dados definidos pelo utilizador na categoria de fitas.
CMFCRibbonCategoria::SetKeys Atribui uma dica de tecla à categoria fita.
CMFCRibbonCategoria::Nome do Conjunto
CMFCRibbonCategoria::SetTabColor Define a cor da categoria de fitas.

Observações

Normalmente, cria-se uma categoria de fita indiretamente ao chamar CMFCRibbonBar::AddCategory, que devolve um ponteiro para a nova categoria de fita criada. Adiciona-se painéis à categoria chamando CMFCRibbonCategory::AddPanel.

A CMFCRibbonTab turma sorteia categorias de fitas. Deriva da classe CMFCRibbonBaseElement.

O exemplo seguinte demonstra como criar uma categoria de fita e adicionar um painel a ela.

// Create a new ribbon category and get a pointer to it
CMFCRibbonCategory* pCategory = m_wndRibbonBar.AddCategory
    (_T("&Write"),           // Category name
    IDB_WRITE,               // Category small images (16 x 16)
    IDB_WRITE_LARGE);        // Category large images (32 x 32)

// Add a panel to the new category
CMFCRibbonPanel* pPanel = pCategory->AddPanel (
    _T("Clipboard"),                // Panel name
    m_PanelIcons.ExtractIcon (0));  // Panel icon

O diagrama seguinte mostra uma figura da categoria Home da aplicação de exemplo RibbonApp.

Categoria inicial da aplicação de exemplo RibbonApp.

Hierarquia de herança

CObject

CMFCRibbonCategory

Requerimentos

Cabeçalho: afxribboncategory.h

CMFCRibbonCategory::AddHidden

Adiciona o elemento de fita especificado ao array de elementos de fita que são exibidos na caixa de diálogo de personalização.

void AddHidden(CMFCRibbonBaseElement* pElem);

Parâmetros

pElem
[dentro] Aponta para um elemento fita.

Observações

Elementos de fita na caixa de diálogo de personalização são os comandos que podes adicionar à barra de acesso rápido.

CMFCRibbonCategoria::AddPanel

Cria um painel de fita para a categoria fita.

CMFCRibbonPanel* AddPanel(
    LPCTSTR lpszPanelName,
    HICON hIcon = 0,
    CRuntimeClass* pRTI = NULL);

Parâmetros

lpszPanelName
[dentro] Aponta para o nome do novo painel de fita.

hIcon
[dentro] Usar o handle para o ícone padrão do novo painel de fita.

pRTI
[dentro] Apontar para a informação da classe em tempo de execução para um painel de fita personalizado.

Valor de retorno

Apontar para o novo painel de fita se o método fosse bem-sucedido; caso contrário, NULL se o painel não tivesse sido criado.

Observações

Se quiseres criar um painel de fita personalizado, tens de especificar a informação da sua classe de execução em pRTI. A classe de painel de fita personalizada deve ser derivada da CMFCRibbonPanel classe.

O ícone padrão do painel de fita é exibido quando não há espaço suficiente para exibir os elementos da fita.

Example

O exemplo seguinte demonstra como usar o AddPanel método na CMFCRibbonCategory aula.

// Create "Favorites" panel:
strTemp.LoadString(IDS_RIBBON_FAVORITES);
// CMFCRibbonCategory* pCategoryCustom
CMFCRibbonPanel *pPanelFavorites = pCategoryCustom->AddPanel(strTemp,
                                                             m_PanelImages.ExtractIcon(15));

CMFCRibbonCategoria::CMFCRibbonCategoria

Constrói e inicializa um objeto CMFCRibbonCategory .

CMFCRibbonCategory(
    CMFCRibbonBar* pParenrRibbonBar,
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

Parâmetros

pParenrRibbonBar
[dentro] Aponta para a barra de fita principal da categoria de fitas.

lpszName
[dentro] Nome da categoria da fita.

uiSmallImagesResID
[dentro] ID de recurso da lista de imagens para imagens pequenas que são usadas por elementos de fita na categoria fita.

uiLargeImagesResID
[dentro] ID de recurso da lista de imagens para imagens grandes que são usadas por elementos de fita na categoria de fita.

tamanhoPequenaImagem
[dentro] Tamanho padrão das imagens pequenas para elementos de fita na categoria fita.

tamanhoGrandeImagem
[dentro] Tamanho padrão das imagens grandes para elementos de fita na categoria de fita.

CMFCRibbonCategoria::CópiaDe

Copia o estado do CMFCRibbonCategory especificado para o objeto CMFCRibbonCategory atual.

virtual void CopyFrom(CMFCRibbonCategory& src);

Parâmetros

src
[dentro] O objeto de origem CMFCRibbonCategory .

Observações

CMFCRibbonCategoria::FindByData

Recupera o elemento fita associado aos dados especificados.

CMFCRibbonBaseElement* FindByData(
    DWORD_PTR dwData,
    BOOL bVisibleOnly = TRUE) const;

Parâmetros

dwData
[dentro] Os dados associados a um elemento fita.

bVisibleOnly
[dentro] TRUE para incluir elementos de fita de acesso rápido na pesquisa; FALSE para excluir elementos de fita de acesso rápido na pesquisa.

Valor de retorno

Apontar para um elemento de fita se o método fosse bem-sucedido; caso contrário, NULL.

Observações

CMFCRibbonCategoria::FindByID

Recupera o elemento de fita associado ao ID de comando especificado.

CMFCRibbonBaseElement* FindByID(
    UINT uiCmdID,
    BOOL bVisibleOnly = TRUE) const;

Parâmetros

uiCmdID
[dentro] ID de comando associado a um elemento de fita.

bVisibleOnly
[dentro] TRUE para incluir elementos de fita de acesso rápido na pesquisa; FALSE para excluir elementos de fita de acesso rápido na pesquisa.

Valor de retorno

Apontar para um elemento de fita se o método fosse bem-sucedido; caso contrário, NULL.

Observações

CMFCRibbonCategoria::FindPainelWithElem

Recupera o painel de fita que contém o elemento de fita especificado.

CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);

Parâmetros

pElement
[dentro] Aponta para um elemento fita.

Valor de retorno

Apontar para um painel de fita se o método fosse bem-sucedido; caso contrário, NULL.

Observações

CMFCRibbonCategory::GetContextID

Recupera o ID de contexto da categoria fita.

UINT GetContextID() const;

Valor de retorno

ID de contexto da categoria fita.

Observações

O ID de contexto é 0 se a categoria de fita não for uma categoria de fita de contexto.

CMFCRibbonCategoria::GetData

Recupera os dados definidos pelo utilizador associados à categoria fita.

DWORD_PTR GetData() const;

Valor de retorno

Os dados definidos pelo utilizador associados à categoria fita.

CMFCRibbonCategoria::GetDroppedDown

Recupera um apontador para o elemento de fita que atualmente tem o seu menu pop-up exibido.

CMFCRibbonBaseElement* GetDroppedDown();

Valor de retorno

Apontar para um elemento de fita se o método fosse bem-sucedido; caso contrário, NULL.

Observações

CMFCRibbonCategoria::GetElements

Recupera todos os elementos da fita na categoria fita.

void GetElements(
    CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

Parâmetros

arElements
[inspira, expira] Referência a um CArray de elementos de fita.

Observações

Elementos de fita desenhados para uso na barra de ferramentas de acesso rápido estão incluídos no array.

CMFCRibbonCategoria::GetElementsByID

Recupera todos os elementos da fita associados ao ID de comando especificado.

void GetElementsByID(
    UINT uiCmdID,
    CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

Parâmetros

uiCmdID
[dentro] ID de comando associado a um elemento de fita.

arElements
[inspira, expira] Referência a um CArray de elementos de fita.

Observações

Elementos de fita desenhados para uso na barra de ferramentas de acesso rápido estão incluídos no array.

CMFCRibbonCategoria::GetFirstVisibleElement

Recupera o primeiro elemento visível que pertence à categoria fita.

CMFCRibbonBaseElement* GetFirstVisibleElement() const;

Valor de retorno

Apontador para o primeiro elemento visível; pode ser NULL se a categoria não tiver elementos visíveis.

Observações

CMFCRibbonCategoria::GetFocused

Devolve um elemento focado.

CMFCRibbonBaseElement* GetFocused();

Valor de retorno

Um apontador para um elemento focado ou NULL.

Observações

CMFCRibbonCategoria::GetHighlight

Devolve um elemento realçado.

CMFCRibbonBaseElement* GetHighlighted();

Valor de retorno

Um apontador para um elemento destacado ou NULL se nenhum elemento estiver destacado.

Observações

CMFCRibbonCategoria::ReceberContagemImagensT

Recupera o número de imagens na lista de imagens especificada que está contida na categoria fita.

int GetImageCount(BOOL bIsLargeImage) const;

Parâmetros

bÉGrandeImagem
[dentro] TRUE para o número de imagens na lista de imagens grandes; FALSE para o número de imagens na pequena lista de imagens.

Valor de retorno

O número de imagens na lista de imagens especificada.

Observações

CMFCRibbonCategoria::ObterImageTamanho

Recupera o tamanho de uma imagem na lista de imagens especificada que está contida na categoria fita.

CSize GetImageSize(BOOL bIsLargeImage) const;

Parâmetros

bÉGrandeImagem
[dentro] VERDADE para o tamanho de imagens grandes; FALSE para o tamanho de imagens pequenas.

Valor de retorno

O tamanho de uma imagem na lista de imagens especificada.

Observações

O tamanho recuperado inclui o fator de escala global da imagem.

CMFCRibbonCategoria::ObterItemIDsLista

Recupera os IDs de comandos para os elementos da fita contidos na categoria da fita.

void GetItemIDsList(
    CList<UINT, UINT>& lstItems,
    BOOL bHiddenOnly = FALSE) const;

Parâmetros

lstItens
[fora] A lista de IDs de comando para os elementos da fita na categoria da fita.

bHiddenOnly
[dentro] TRUE para excluir elementos de fita exibidos nos painéis de fita na categoria de fita; FALSE para incluir todos os elementos da fita na categoria da fita.

Observações

CMFCRibbonCategoria::GetLargeImages

Recupera a lista de imagens grandes contidas na categoria fita.

CMFCToolBarImages& GetLargeImages();

Valor de retorno

A lista de imagens grandes contidas na categoria de fitas.

CMFCRibbonCategoria::GetLastVisibleElement

Recupera o último elemento visível que pertence à categoria fita.

CMFCRibbonBaseElement* GetLastVisibleElement() const;

Valor de retorno

Apontar para o último elemento visível; pode ser NULL se a categoria não tiver elementos visíveis.

Observações

CMFCRibbonCategoria::ObtenhaAlturaMáxima

Recupera a altura máxima dos painéis de fita contidos na categoria de fitas.

int GetMaxHeight(CDC* pDC);

Parâmetros

pDC
[dentro] Apontar para o contexto de um dispositivo para os painéis de fita.

Valor de retorno

A altura máxima dos painéis de fita que estão incluídos na categoria de fitas.

Observações

O valor recuperado inclui a altura das margens superior e inferior dos painéis de fita.

CMFCRibbonCategoria::GetName

Recupera o nome da categoria da fita.

LPCTSTR GetName() const;

Valor de retorno

O nome da categoria fita.

Observações

CMFCRibbonCategoria::GetPanel

Devolve um ponteiro para o painel de fita localizado no índice especificado.

CMFCRibbonPanel* GetPanel(int nIndex);

Parâmetros

nIndex
[dentro] O índice de base zero de um painel de fita.

Valor de retorno

Aponta para o painel de fita localizado no índice especificado.

Observações

É feita uma exceção se o nIndex estiver fora do alcance.

CMFCRibbonCategoria::GetPanelCount

Devolve o número de painéis de fita na categoria de fitas.

int GetPanelCount() const;

Valor de retorno

O número de painéis de fita na categoria de fitas.

CMFCRibbonCategoria::GetPanelFromPoint

Recupera um ponteiro para um painel de fita se o ponto especificado estiver localizado nele.

CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;

Parâmetros

ponto
[dentro] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.

Valor de retorno

Apontar para um painel de fita se o método fosse bem-sucedido; caso contrário, NULL.

Observações

Apenas os painéis de fita contidos na categoria de fita são testados.

CMFCRibbonCategoria::GetPanelIndex

Recupera o índice baseado em zero do painel de fita especificado.

int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;

Parâmetros

pPanel
[dentro] Aponta para um painel de fita.

Valor de retorno

Índice baseado em zero do painel de fita especificado, caso o método tenha sido bem-sucedido; caso contrário -1.

Observações

Apenas os painéis de fita contidos na categoria de fita são pesquisados.

CMFCRibbonCategoria::GetParentButton

Recupera o elemento de fita principal da categoria fita.

CMFCRibbonBaseElement* GetParentButton() const;

Valor de retorno

Devolve um ponteiro para o elemento de fita pai, ou NULL se não houver elemento pai.

Observações

CMFCRibbonCategoria::GetParentMenuBar

Devolve um ponteiro para a barra de menu pai do CMFCRibbonCategory objeto.

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

Valor de retorno

Devolve o conteúdo do m_pParentMenuBar membro protegido.

Observações

CMFCRibbonCategoria::GetParentRibbonBar

Recupera a barra de fita principal para a categoria fita.

CMFCRibbonBar* GetParentRibbonBar() const;

Valor de retorno

Aponte para a barra de fita principal da categoria de fitas.

Observações

CMFCRibbonCategoria::GetRect

Recupera o retângulo do ecrã para a categoria fita.

CRect GetRect() const;

Valor de retorno

O retângulo de exibição para a categoria fita.

Observações

O retângulo de exibição da categoria de fita não inclui o separador de categoria.

CMFCRibbonCategoria::GetSmallImagesT

Recupera a lista de pequenas imagens contidas na categoria fita.

CMFCToolBarImages& GetSmallImages();

Valor de retorno

A lista de pequenas imagens contidas na categoria fita.

CMFCRibbonCategoria::GetTabColor

Devolve a cor atual do separador de categoria da fita.

AFX_RibbonCategoryColor GetTabColor() const;

Valor de retorno

A cor atual do separador de categoria de fitas.

Observações

O valor devolvido pode ser um dos seguintes valores enumerados:

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

CMFCRibbonCategory::GetTabRect

Recupera o retângulo do ecrã para o separador de categoria de fita.

CRect GetTabRect() const;

Valor de retorno

O retângulo de ecrã para o separador de categoria fita.

Observações

CMFCRibbonCategoria::ObterTextoTopLine

Recupera a localização vertical do texto nos botões da fita na categoria de fita que mostram imagens grandes.

int GetTextTopLine() const;

Valor de retorno

A localização vertical do texto, em píxeis, em botões de fita que mostram imagens grandes.

Observações

CMFCRibbonCategoria::GetVisibleElements

Recupera todos os elementos visíveis que pertencem à categoria fita.

void GetVisibleElements(
    CArray <CMFCRibbonBaseElement*,
    CMFCRibbonBaseElement*>& arElements);

Parâmetros

arElements
Array de todos os elementos visíveis.

Observações

CMFCRibbonCategoria::Painel de Destaque

Destaca o painel de fita especificado.

CMFCRibbonPanel* HighlightPanel(
    CMFCRibbonPanel* pHLPanel,
    CPoint point);

Parâmetros

pHLPanel
[dentro] Aponta para o painel de fita para destacar.

ponto
[dentro] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.

Valor de retorno

Apontar para o painel de fita anteriormente destacado; caso contrário, NULL se nenhum painel de fita for destacado quando este método é invocado.

Observações

Para mais informações sobre como destacar um painel de fita, veja CMFCRibbonPanel::Highlight.

CMFCRibbonCategoria::HitTest

Recupera um ponteiro para um elemento de fita se o ponto especificado estiver localizado nele.

CMFCRibbonBaseElement* HitTest(
    CPoint point,
    BOOL bCheckPanelCaption = FALSE) const;

Parâmetros

ponto
[dentro] As coordenadas x e y do ponteiro do rato, em relação ao canto superior esquerdo da janela.

bCheckPanelCaption
[dentro] TRUE para testar a legenda do painel de fita; FALSE para excluir a legenda do painel de fita.

Valor de retorno

Apontar para um elemento de fita se o método fosse bem-sucedido; caso contrário, NULL.

Observações

Apenas os elementos de fita contidos na categoria de fita são testados.

CMFCRibbonCategoria::HitTestEx

Recupera o índice em base zero de um elemento de fita se o ponto especificado estiver localizado nele.

int HitTestEx(CPoint point) const;

Parâmetros

ponto
[dentro] As coordenadas x e y do ponteiro do rato, em relação ao canto superior esquerdo da janela.

Valor de retorno

Índice baseado em zero de um elemento de fita se o método tivesse sido bem-sucedido; caso contrário -1.

Observações

Apenas os elementos de fita contidos na categoria de fita são testados.

CMFCRibbonCategoria::BotõesDeScrollDeTestHit

Se um ponto cair dentro do botão de scroll esquerdo ou direito de uma categoria de fita, devolve um ponteiro para esse botão.

CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;

Parâmetros

ponto
[dentro] O objetivo de testar.

Valor de retorno

Se o ponto cair dentro do retângulo delimitador do botão de deslocamento esquerdo ou direito da categoria de fita, devolve um ponteiro para esse botão, ou, caso contrário, devolve NULL.

Observações

CMFCRibbonCategoria::Está Ativo

Indica se a categoria de fita é a categoria ativa na barra de fita.

BOOL IsActive() const;

Valor de retorno

TRUE se a categoria de fita for a categoria ativa; caso contrário, FALSO.

Observações

A categoria de fita ativa mostra os seus painéis de fita.

CMFCRibbonCategoria::ÉVisível

Indica se a categoria de fita é visível.

BOOL IsVisible() const;

Valor de retorno

TRUE se a categoria de fita for visível; caso contrário, FALSO.

Observações

As categorias de fita visíveis exibem um separador de categoria.

CMFCRibbonCategoria::IsWindows7Look

Indica se a fita principal tem o aspeto do Windows 7 (pequeno botão retangular de aplicação).

BOOL IsWindows7Look() const;

Valor de retorno

TRUE se a fita principal tiver aspeto Windows 7; caso contrário, FALSO.

Observações

CMFCRibbonCategoria::NotifyControlCommand

Entrega uma mensagem de comando WM_NOTIFY a todos CMFCRibbonPanel os elementos até CMFCRibbonCategory que a mensagem seja tratada.

virtual BOOL NotifyControlCommand(
    BOOL bAccelerator,
    int nNotifyCode,
    WPARAM wParam,
    LPARAM lParam);

Parâmetros

bAccelerator
[dentro] TRUE se este comando tiver origem num acelerador, ou FALSE caso contrário.

nNotifyCode
[dentro] O código de notificação.

wParam
[dentro] O campo WPARAM da mensagem.

lParam
[dentro] O campo LPARAM da mensagem.

Valor de retorno

Retorna TRUE se a mensagem foi tratada, ou FALSE se não for tratado.

Observações

CMFCRibbonCategoria::OnCancelMode

Invoca o modo de cancelamento em todos os CMFCRibbonPanel elementos do CMFCRibbonCategory.

virtual void OnCancelMode();

Observações

CMFCRibbonCategoria::OnDraw

Chamado pela estrutura para desenhar a categoria de fita.

virtual void OnDraw(CDC* pDC);

Parâmetros

pDC
[dentro] Apontar para o contexto de um dispositivo para a categoria de fitas.

Observações

CMFCRibbonCategoria::NaDesenharImagem

Chamado pelo framework para desenhar a imagem especificada na categoria de fita.

virtual BOOL OnDrawImage(
    CDC* pDC,
    CRect rect,
    CMFCRibbonBaseElement* pElement,
    BOOL bIsLargeImage,
    BOOL nImageIndex,
    BOOL bCenter);

Parâmetros

pDC
[dentro] Apontar para o contexto de um dispositivo para a imagem.

retângulo
[dentro] Mostrar o retângulo para a imagem.

pElement
[dentro] Apontar para o elemento de fita que contém a imagem.

bÉGrandeImagem
[dentro] TRUE se a imagem for de tamanho grande; FALSE se a imagem for de tamanho pequeno.

nImageIndex
[dentro] Índice em base zero da imagem no array de imagens que está contido na categoria fita.

bCenter
[dentro] TRUE para centralizar a imagem no retângulo do ecrã; FALSE para desenhar a imagem no canto superior esquerdo do retângulo do ecrã.

Valor de retorno

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

Observações

CMFCRibbonCategoria::OnDrawMenuBorder

É chamado pelo framework para desenhar a borda de um menu pop-up.

virtual void OnDrawMenuBorder(
    CDC* pDC,
    CMFCRibbonPanelMenuBar* pMenuBar);

Parâmetros

pDC
[dentro] Este parâmetro não é utilizado.

pMenuBar
[dentro] Este parâmetro não é utilizado.

Observações

Por defeito, este método não faz nada. Substitua este método para desenhar a borda de um menu pop-up.

CMFCRibbonCategoria::OnKey

É chamado pelo framework quando um utilizador pressiona um botão do teclado.

virtual BOOL OnKey(UINT nChar);

Parâmetros

nChar
O código de tecla virtual para a tecla que o utilizador pressionou.

Observações

CMFCRibbonCategoria::OnLButtonDown

Chamado pela framework para recuperar o elemento fita sob o ponto especificado quando o utilizador pressiona o botão esquerdo do rato.

virtual CMFCRibbonBaseElement* OnLButtonDown(CPoint point);

Parâmetros

ponto
[dentro] As coordenadas x e y do ponteiro do rato, em relação ao canto superior esquerdo da janela.

Valor de retorno

Apontar para um elemento de fita se o método fosse bem-sucedido; caso contrário, NULL.

Observações

CMFCRibbonCategoria::OnLButtonUp

É chamado pela estrutura quando o utilizador solta o botão esquerdo do rato e o ponteiro está sobre a categoria fita.

virtual void OnLButtonUp(CPoint point);

Parâmetros

ponto
[dentro] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.

Observações

CMFCRibbonCategoria::OnMouseMove

Chamado pela framework quando o ponteiro se move na barra de fita para atualizar a exibição da categoria de fita.

virtual void OnMouseMove(CPoint point);

Parâmetros

ponto
[dentro] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.

Observações

CMFCRibbonCategoria::OnRTLCmudou

É chamado pelo framework quando o layout muda de direção.

virtual void OnRTLChanged(BOOL bIsRTL);

Parâmetros

bIsRTL
[dentro] TRUE se o layout for da direita para a esquerda; FALSE se o layout for da esquerda para a direita.

Observações

Este método ajusta a disposição de todos os painéis de fita e elementos de fita contidos na categoria de fita.

CMFCRibbonCategoria::OnScrollHorz

Desloca a categoria de fita na direção horizontal.

virtual BOOL OnScrollHorz(
    BOOL bScrollLeft,
    int nScrollOffset = 0);

Parâmetros

bScrollLeft
[dentro] TRUE para deslocar para a esquerda; FALSE para deslocar para a direita.

nScrollOffset
[dentro] A distância de scroll em pixels.

Valor de retorno

VERDADEIRO se a categoria de fita se mover numa direção horizontal; caso contrário, FALSO.

Observações

CMFCRibbonCategoria::OnUpdateCmdUI

Chama a OnUpdateCmdUI função membro em cada um dos CMFCRibbonPanel elementos do CMFCRibbonCategory para ativar ou desativar os elementos da interface de utilizador neles.

virtual void OnUpdateCmdUI(
    CMFCRibbonCmdUI* pCmdUI,
    CFrameWnd* pTarget,
    BOOL bDisableIfNoHndler);

Parâmetros

pCmdUI
[dentro] Apontador para o CMFCRibbonCmdUI objeto que especifica quais elementos da interface de utilizador devem ser ativados e quais devem ser desativados.

pTarget
[dentro] Apontador para a janela que controla a ativação ou desativação dos elementos da interface de utilizador.

bDisableSeNoHndler
[dentro] TRUE para desativar o elemento da interface de utilizador se não houver um handler definido num mapa de mensagens; caso contrário, FALSO.

Observações

CMFCRibbonCategoria::RecalcLayout

Ajusta a disposição de todos os controlos na categoria de fita.

virtual void RecalcLayout(CDC* pDC);

Parâmetros

pDC
[dentro] Apontar para o contexto de um dispositivo para a categoria de fitas.

Observações

CMFCRibbonCategoria::RemovePanel

Remove um painel de fita da categoria de fita.

BOOL RemovePanel(
    int nIndex,
    BOOL bDelete = TRUE);

Parâmetros

nIndex
[dentro] O número de índice do painel a remover. Obtido ao chamar o método CMFCRibbonCategory::GetPanelIndex .

bDelete
[dentro] TRUE para eliminar o objeto painel da memória; FALSE para remover o objeto do painel sem o apagar.

Valor de retorno

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

CMFCRibbonCategoria::ReposPainéis

Ajusta a disposição de todos os controlos nos painéis de fita contidos na categoria de fita.

virtual void ReposPanels(CDC* pDC);

Parâmetros

pDC
[dentro] Apontar para um contexto de dispositivo para os painéis de fita contidos na categoria de fitas.

Observações

CMFCRibbonCategoria::SetCollapseOrder

Define a ordem em que os painéis de fita da categoria de fita colapsam.

void SetCollapseOrder(const CArray<int,int>& arCollapseOrder);

Parâmetros

arCollapseOrder
[dentro] Especifica a ordem de colapso. O array contém índices baseados em zero dos painéis de fita.

Observações

A biblioteca define a ordem de colapso. No entanto, pode personalizar este comportamento fornecendo à categoria a lista de índices que especifica a ordem de colapso.

Quando a categoria deteta que tem de colapsar um painel de fita, procura o próximo elemento na lista especificada. Se a lista estiver vazia, ou se não tiver especificado elementos suficientes, então a categoria utiliza o algoritmo interno.

Por exemplo, a categoria tem três painéis de fita e pode ser dobrada várias vezes até que todos os painéis estejam totalmente colapsados. Pode definir a seguinte ordem de colapso: 0, 0, 2, 2. Neste caso, a categoria colapsará o painel 0 duas vezes, o painel 2 duas vezes. O painel com índice 1 permanece sem colapso.

Example

O exemplo seguinte demonstra como usar o SetCollapseOrder método na CMFCRibbonCategory aula. O exemplo mostra como construir um array para a ordem de colapso e como definir a ordem de colapso para a categoria de fita.

CArray<int, int> arCollapseOrder;
arCollapseOrder.Add(0);
arCollapseOrder.Add(1);
arCollapseOrder.Add(2);
// CMFCRibbonCategory* pCategoryHome
pCategoryHome->SetCollapseOrder(arCollapseOrder);

CMFCRibbonCategoria::SetData

Define os dados definidos pelo utilizador para serem associados à categoria fita.

void SetData(DWORD_PTR dwData);

Parâmetros

dwData
[dentro] Os dados definidos pelo utilizador.

CMFCRibbonCategoria::SetKeys

Atribui uma dica de tecla à categoria fita.

void SetKeys(LPCTSTR lpszKeys);

Parâmetros

lpszKeys
[dentro] O texto da dica.

Observações

As dicas são exibidas quando o utilizador pressiona a tecla Alt ou a tecla F10.

CMFCRibbonCategoria::Nome do Conjunto

Atribui um nome e uma dica de tecla à categoria de fita.

void SetName(LPCTSTR lpszName);

Parâmetros

lpszName
[dentro] O nome e a dica da chave da categoria fita.

Observações

Para definir a dica de tecla para a categoria de fita, adicione uma sequência de escape de nova linha seguida dos caracteres de dica a lpszName.

CMFCRibbonCategoria::SetTabColor

Define a cor da categoria de fitas.

void SetTabColor(AFX_RibbonCategoryColor color);

Parâmetros

cor
[dentro] Especifica a nova cor da categoria de fitas.

Observações

A cor pode ser um dos seguintes valores:

  • AFX_CategoryColor_None

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

Consulte também

Gráfico de Hierarquia
Classes
CObject Classe