Classe CMFCRibbonCategory
A classe CMFCRibbonCategory implementa uma guia da faixa de opções que contém um grupo de painéis de faixa de opções.
Sintaxe
class CMFCRibbonCategory : public CObject
Membros
Construtores Protegidos
| Nome | Descrição |
|---|---|
| CMFCRibbonCategory::CMFCRibbonCategory | O construtor . |
Métodos públicos
Comentários
Normalmente, você cria uma categoria de faixa de opções indiretamente chamando CMFCRibbonBar::AddCategory, que retorna um ponteiro para a categoria de faixa de opções recém-criada. Para adicionar painéis à categoria, chame CMFCRibbonCategory::AddPanel.
A classe CMFCRibbonTab desenha categorias de faixa de opções. Ela é derivada da classe CMFCRibbonBaseElement.
Este exemplo a seguir demonstra como criar uma categoria de faixa de opções 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 a seguir mostra uma figura da categoria Home do aplicativo de exemplo RibbonApp.
Hierarquia de herança
CMFCRibbonCategory
Requisitos
Cabeçalho: afxribboncategory.h
CMFCRibbonCategory::AddHidden
Adiciona o elemento de faixa de opções especificado à matriz de elementos de faixa de opções exibidos na caixa de diálogo de personalização.
void AddHidden(CMFCRibbonBaseElement* pElem);
Parâmetros
pElem
[in] Ponteiro para um elemento de faixa de opções.
Comentários
Os elementos da faixa de opções na caixa de diálogo de personalização são os comandos que você pode adicionar à barra de ferramentas de acesso rápido.
CMFCRibbonCategory::AddPanel
Cria um painel de faixa de opções para a categoria da faixa de opções.
CMFCRibbonPanel* AddPanel(
LPCTSTR lpszPanelName,
HICON hIcon = 0,
CRuntimeClass* pRTI = NULL);
Parâmetros
lpszPanelName
[in] Ponteiro para o nome do novo painel da faixa de opções.
hIcon
[in] Alça do ícone padrão do novo painel de faixa de opções.
pRTI
[in] Ponteiro para informações de classe de runtime para um painel de faixa de opções personalizado.
Valor de retorno
Ponteiro para o novo painel da faixa de opções caso o método tenha tido êxito. Do contrário, será NULL.
Comentários
Para criar um painel de faixa de opções personalizado, especifique suas informações de classe de runtime no pRTI. A classe de painel de faixa de opções personalizada deve ser derivada da classe CMFCRibbonPanel.
O ícone padrão do painel da faixa de opções é exibido quando não há espaço suficiente para exibir os elementos da faixa de opções.
Exemplo
O seguinte exemplo demonstra como usar o método AddPanel na classe CMFCRibbonCategory.
// Create "Favorites" panel:
strTemp.LoadString(IDS_RIBBON_FAVORITES);
// CMFCRibbonCategory* pCategoryCustom
CMFCRibbonPanel *pPanelFavorites = pCategoryCustom->AddPanel(strTemp,
m_PanelImages.ExtractIcon(15));
CMFCRibbonCategory::CMFCRibbonCategory
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
[in] Ponteiro para a barra de faixa de opções pai da categoria da faixa de opções.
lpszName
[in] Nome da categoria da faixa de opções.
uiSmallImagesResID
[in] ID de recurso da lista correspondente para imagens pequenas que são usadas por elementos de faixa de opções na categoria dessa faixa.
uiLargeImagesResID
[in] ID de recurso da lista correspondente para imagens grandes que são usadas por elementos de faixa de opções na categoria dessa faixa.
sizeSmallImage
[in] Tamanho padrão de imagens pequenas para elementos de faixa de opções na categoria dessa faixa.
sizeLargeImage
[in] Tamanho padrão de imagens grandes para elementos de faixa de opções na categoria de faixa de opções.
CMFCRibbonCategory::CopyFrom
Copia o estado do CMFCRibbonCategory especificado para o objeto CMFCRibbonCategory atual.
virtual void CopyFrom(CMFCRibbonCategory& src);
Parâmetros
src
[in] O objeto CMFCRibbonCategory de origem.
Comentários
CMFCRibbonCategory::FindByData
Recupera o elemento da faixa de opções associado aos dados especificados.
CMFCRibbonBaseElement* FindByData(
DWORD_PTR dwData,
BOOL bVisibleOnly = TRUE) const;
Parâmetros
dwData
[in] Os dados associados a um elemento de faixa de opções.
bVisibleOnly
[in] TRUE para incluir elementos da faixa de opções de acesso rápido na pesquisa. FALSE para excluir elementos da faixa de opções de acesso rápido na pesquisa.
Valor de retorno
Ponteiro para um elemento da faixa de opções caso o método tenha tido êxito; caso contrário, NULL.
Comentários
CMFCRibbonCategory::FindByID
Recupera o elemento de faixa de opções associado à ID de comando especificada.
CMFCRibbonBaseElement* FindByID(
UINT uiCmdID,
BOOL bVisibleOnly = TRUE) const;
Parâmetros
uiCmdID
[in] ID de comando associada a um elemento de faixa de opções.
bVisibleOnly
[in] TRUE para incluir elementos da faixa de opções de acesso rápido na pesquisa. FALSE para excluir elementos da faixa de opções de acesso rápido na pesquisa.
Valor de retorno
Ponteiro para um elemento da faixa de opções caso o método tenha tido êxito; caso contrário, NULL.
Comentários
CMFCRibbonCategory::FindPanelWithElem
Recupera o painel da faixa de opções que contém o elemento de faixa de opções especificado.
CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);
Parâmetros
pElement
[in] Ponteiro para um elemento de faixa de opções.
Valor de retorno
Ponteiro para um painel de faixa de opções se o método tenha tido êxito. Do contrário, será NULL.
Comentários
CMFCRibbonCategory::GetContextID
Recupera a ID de contexto da categoria da faixa de opções.
UINT GetContextID() const;
Valor de retorno
ID de contexto da categoria da faixa de opções.
Comentários
A ID de contexto será 0 se a categoria da faixa de opções não for uma categoria de faixa de opções de contexto.
CMFCRibbonCategory::GetData
Recupera os dados definidos pelo usuário associados à categoria de faixa de opções.
DWORD_PTR GetData() const;
Valor de retorno
Os dados definidos pelo usuário associados à categoria de faixa de opções.
CMFCRibbonCategory::GetDroppedDown
Recupera um ponteiro para o elemento de faixa de opções que no momento tem seu menu pop-up exibido.
CMFCRibbonBaseElement* GetDroppedDown();
Valor de retorno
Ponteiro para um elemento da faixa de opções caso o método tenha tido êxito; caso contrário, NULL.
Comentários
CMFCRibbonCategory::GetElements
Recupera todos os elementos da faixa de opções na categoria correspondente.
void GetElements(
CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Parâmetros
arElements
[in, out] Referência a um CArray de elementos da faixa de opções.
Comentários
Os elementos de faixa de opções projetados para uso na barra de ferramentas de acesso rápido são incluídos na matriz.
CMFCRibbonCategory::GetElementsByID
Recupera todos os elementos da faixa de opções associados à ID de comando especificada.
void GetElementsByID(
UINT uiCmdID,
CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Parâmetros
uiCmdID
[in] ID de comando associada a um elemento de faixa de opções.
arElements
[in, out] Referência a um CArray de elementos da faixa de opções.
Comentários
Os elementos de faixa de opções projetados para uso na barra de ferramentas de acesso rápido são incluídos na matriz.
CMFCRibbonCategory::GetFirstVisibleElement
Recupera o primeiro elemento visível que pertence à categoria de faixa de opções.
CMFCRibbonBaseElement* GetFirstVisibleElement() const;
Valor de retorno
Ponteiro para o primeiro elemento visível. Poderá ser NULL se a categoria não tiver nenhum elemento visível.
Comentários
CMFCRibbonCategory::GetFocused
Retorna um elemento focalizado.
CMFCRibbonBaseElement* GetFocused();
Valor de retorno
Um ponteiro para um elemento focalizado ou NULL.
Comentários
CMFCRibbonCategory::GetHighlighted
Retorna um elemento realçado.
CMFCRibbonBaseElement* GetHighlighted();
Valor de retorno
Um ponteiro para um elemento realçado ou NULL se nenhum elemento estiver realçado.
Comentários
CMFCRibbonCategory::GetImageCount
Recupera o número de imagens na lista correspondente especificada que está contida na categoria de faixa de opções.
int GetImageCount(BOOL bIsLargeImage) const;
Parâmetros
bIsLargeImage
[in] TRUE para o número de imagens grandes na lista correspondente. FALSE para o número de imagens pequenas na lista correspondente.
Valor de retorno
O número de imagens na lista.
Comentários
CMFCRibbonCategory::GetImageSize
Recupera o tamanho de uma imagem na lista correspondente especificada que está contida na categoria de faixa de opções.
CSize GetImageSize(BOOL bIsLargeImage) const;
Parâmetros
bIsLargeImage
[in] TRUE para o tamanho de imagens grandes. FALSE para o tamanho de imagens pequenas.
Valor de retorno
O tamanho de uma imagem na lista especificada correspondente.
Comentários
O tamanho recuperado inclui o fator de escala de imagem global.
CMFCRibbonCategory::GetItemIDsList
Recupera as IDs de comando para os elementos da faixa de opções contidos na categoria dessa faixa.
void GetItemIDsList(
CList<UINT, UINT>& lstItems,
BOOL bHiddenOnly = FALSE) const;
Parâmetros
lstItems
[out] A lista de IDs de comando para os elementos da faixa de opções na categoria dessa faixa.
bHiddenOnly
[in] TRUE para excluir elementos de faixa de opções exibidos nos painéis da faixa de opções na categoria da faixa de opções. FALSE para incluir todos os elementos da faixa de opções na categoria dessa faixa.
Comentários
CMFCRibbonCategory::GetLargeImages
Recupera a lista de imagens grandes contidas na categoria de faixa de opções.
CMFCToolBarImages& GetLargeImages();
Valor de retorno
A lista de imagens grandes contidas na categoria de faixa de opções.
CMFCRibbonCategory::GetLastVisibleElement
Recupera o último elemento visível que pertence à categoria de faixa de opções.
CMFCRibbonBaseElement* GetLastVisibleElement() const;
Valor de retorno
Ponteiro para o último elemento visível. Poderá ser NULL se a categoria não tiver nenhum elemento visível.
Comentários
CMFCRibbonCategory::GetMaxHeight
Recupera a altura máxima dos painéis de faixa de opções contidos na categoria dessa faixa.
int GetMaxHeight(CDC* pDC);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo para os painéis da faixa de opções.
Valor de retorno
A altura máxima dos painéis da faixa de opções que estão contidos na categoria dessa faixa.
Comentários
O valor recuperado inclui a altura das margens superior e inferior para os painéis de faixa de opções.
CMFCRibbonCategory::GetName
Recupera o nome da categoria da faixa de opções.
LPCTSTR GetName() const;
Valor de retorno
O nome da categoria da faixa de opções.
Comentários
CMFCRibbonCategory::GetPanel
Retorna um ponteiro para o painel da faixa de opções localizado no índice especificado.
CMFCRibbonPanel* GetPanel(int nIndex);
Parâmetros
nIndex
[in] O índice baseado em zero de um painel de faixa de opções.
Valor de retorno
Ponteiro para o painel da faixa de opções localizado no índice especificado.
Comentários
Uma exceção será lançada se nIndex estiver fora do intervalo.
CMFCRibbonCategory::GetPanelCount
Retorna o número de painéis de faixa de opções na categoria da faixa de opções.
int GetPanelCount() const;
Valor de retorno
O número de painéis de faixa de opções na categoria de faixa de opções.
CMFCRibbonCategory::GetPanelFromPoint
Recupera um ponteiro para um painel de faixa de opções se o ponto especificado estiver localizado nele.
CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;
Parâmetros
point
[in] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.
Valor de retorno
Ponteiro para um painel de faixa de opções se o método tenha tido êxito. Do contrário, será NULL.
Comentários
Somente os painéis de faixa de opções contidos na categoria dessa faixa são testados.
CMFCRibbonCategory::GetPanelIndex
Recupera o índice baseado em zero do painel de faixa de opções especificado.
int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;
Parâmetros
pPanel
[in] Ponteiro para um painel de faixa de opções.
Valor de retorno
Índice baseado em zero do painel de faixa de opções especificado se o método tiver sido bem-sucedido. Do contrário, será -1.
Comentários
Somente painéis de faixa de opções contidos na categoria de faixa de opções são pesquisados.
CMFCRibbonCategory::GetParentButton
Recupera o elemento da faixa de opções pai da categoria da faixa de opções.
CMFCRibbonBaseElement* GetParentButton() const;
Valor de retorno
Retornará um ponteiro para o elemento da faixa de opções pai ou NULL se não houver nenhum elemento pai.
Comentários
CMFCRibbonCategory::GetParentMenuBar
Retorna um ponteiro para a barra de menus pai do objeto CMFCRibbonCategory.
CMFCRibbonPanelMenuBar* GetParentMenuBar() const;
Valor de retorno
Retorna o conteúdo do membro protegido m_pParentMenuBar.
Comentários
CMFCRibbonCategory::GetParentRibbonBar
Recupera a barra da faixa de opções pai para a categoria dessa faixa.
CMFCRibbonBar* GetParentRibbonBar() const;
Valor de retorno
Ponteiro para a barra da faixa de opções pai da categoria dessa faixa.
Comentários
CMFCRibbonCategory::GetRect
Recupera o retângulo de exibição para a categoria da faixa de opções.
CRect GetRect() const;
Valor de retorno
O retângulo de exibição para a categoria da faixa de opções.
Comentários
O retângulo de exibição para a categoria da faixa de opções não inclui a guia de categoria.
CMFCRibbonCategory::GetSmallImages
Recupera a lista de pequenas imagens contidas na categoria da faixa de opções.
CMFCToolBarImages& GetSmallImages();
Valor de retorno
A lista de pequenas imagens contidas na categoria da faixa de opções.
CMFCRibbonCategory::GetTabColor
Retorna a cor atual da guia categoria da faixa de opções.
AFX_RibbonCategoryColor GetTabColor() const;
Valor de retorno
A cor atual da guia de categoria da faixa de opções.
Comentários
O valor retornado 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 de exibição para a guia de categoria da faixa de opções.
CRect GetTabRect() const;
Valor de retorno
O retângulo de exibição para a guia de categoria da faixa de opções.
Comentários
CMFCRibbonCategory::GetTextTopLine
Recupera a localização vertical do texto nos botões da faixa de opções na categoria da faixa de opções que exibem imagens grandes.
int GetTextTopLine() const;
Valor de retorno
A localização vertical do texto, em pixels, nos botões da faixa de opções que exibem imagens grandes.
Comentários
CMFCRibbonCategory::GetVisibleElements
Recupera todos os elementos visíveis que pertencem à categoria da faixa de opções.
void GetVisibleElements(
CArray <CMFCRibbonBaseElement*,
CMFCRibbonBaseElement*>& arElements);
Parâmetros
arElements
Matriz de todos os elementos visíveis.
Comentários
CMFCRibbonCategory::HighlightPanel
Realça o painel de faixa de opções especificado.
CMFCRibbonPanel* HighlightPanel(
CMFCRibbonPanel* pHLPanel,
CPoint point);
Parâmetros
pHLPanel
[in] Ponteiro para o painel da faixa de opções a ser realçado.
point
[in] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.
Valor de retorno
Ponteiro para o painel de faixa de opções realçado anteriormente. Do contrário, será NULL se nenhum painel de faixa de opções for realçado quando esse método for invocado.
Comentários
Para obter mais informações sobre como realçar um painel de faixa de opções, confira CMFCRibbonPanel::Highlight.
CMFCRibbonCategory::HitTest
Recupera um ponteiro para um elemento de faixa de opções se o ponto especificado estiver localizado nele.
CMFCRibbonBaseElement* HitTest(
CPoint point,
BOOL bCheckPanelCaption = FALSE) const;
Parâmetros
point
[in] As coordenadas x e y do ponteiro do mouse em relação ao canto superior esquerdo da janela.
bCheckPanelCaption
[in] TRUE para testar a legenda do painel da faixa de opções. FALSE para excluir a legenda do painel da faixa de opções.
Valor de retorno
Ponteiro para um elemento da faixa de opções caso o método tenha tido êxito; caso contrário, NULL.
Comentários
Somente os elementos de faixa de opções contidos na categoria dessa faixa são testados.
CMFCRibbonCategory::HitTestEx
Recuperará o índice baseado em zero de um elemento de faixa de opções se o ponto especificado estiver localizado nele.
int HitTestEx(CPoint point) const;
Parâmetros
point
[in] As coordenadas x e y do ponteiro do mouse em relação ao canto superior esquerdo da janela.
Valor de retorno
Índice baseado em zero de um elemento de faixa de opções se o método tiver sido bem-sucedido, do contrário, será -1.
Comentários
Somente os elementos de faixa de opções contidos na categoria dessa faixa são testados.
CMFCRibbonCategory::HitTestScrollButtons
Se um ponto estiver dentro do botão de rolagem esquerdo ou direito de uma categoria de faixa de opções, retornará um ponteiro para esse botão.
CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;
Parâmetros
point
[in] O ponto a ser testado.
Valor de retorno
Se o ponto estiver dentro do retângulo delimitador da esquerda ou do botão de rolagem para a direita da categoria da faixa de opções, retornará um ponteiro para esse botão ou, do contrário, retornará NULL.
Comentários
CMFCRibbonCategory::IsActive
Indica se a categoria da faixa de opções é a categoria ativa na barra dessa faixa.
BOOL IsActive() const;
Valor de retorno
TRUE se a categoria da faixa de opções for a categoria ativa, do contrário, será FALSE.
Comentários
A categoria de faixa de opções ativa exibe os painéis dessa faixa.
CMFCRibbonCategory::IsVisible
Determina se a categoria da faixa de opções está visível.
BOOL IsVisible() const;
Valor de retorno
TRUE se a categoria da faixa de opções estiver visível, do contrário, será FALSE.
Comentários
As categorias de faixa de opções visíveis exibem uma guia de categoria.
CMFCRibbonCategory::IsWindows7Look
Indica se a faixa de opções pai tem a aparência do Windows 7 (botão de aplicativo retangular pequeno).
BOOL IsWindows7Look() const;
Valor de retorno
TRUE se a faixa de opções pai tiver aparência do Windows 7; caso contrário, será FALSE.
Comentários
CMFCRibbonCategory::NotifyControlCommand
Fornece uma mensagem de comando WM_NOTIFY a todos os elementos CMFCRibbonPanel em CMFCRibbonCategory até que a mensagem seja tratada.
virtual BOOL NotifyControlCommand(
BOOL bAccelerator,
int nNotifyCode,
WPARAM wParam,
LPARAM lParam);
Parâmetros
bAccelerator
[in] TRUE se esse comando se originou de um acelerador, do contrário, será FALSE.
nNotifyCode
[in] O código de notificação.
wParam
[in] O campo WPARAM da mensagem.
lParam
[in] O campo LPARAM da mensagem.
Valor de retorno
Retornará TRUE se a mensagem tiver sido tratada, do contrário, será FALSE.
Comentários
CMFCRibbonCategory::OnCancelMode
Invoca o modo de cancelamento em todos os elementos CMFCRibbonPanel do CMFCRibbonCategory.
virtual void OnCancelMode();
Comentários
CMFCRibbonCategory::OnDraw
Chamado pela estrutura para desenhar a categoria da faixa de opções.
virtual void OnDraw(CDC* pDC);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo para a categoria da faixa de opções.
Comentários
CMFCRibbonCategory::OnDrawImage
Chamado pela estrutura para desenhar a imagem especificada na categoria da faixa de opções.
virtual BOOL OnDrawImage(
CDC* pDC,
CRect rect,
CMFCRibbonBaseElement* pElement,
BOOL bIsLargeImage,
BOOL nImageIndex,
BOOL bCenter);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo para a imagem.
rect
[in] Exibir retângulo para a imagem.
pElement
[in] Ponteiro para o elemento da faixa de opções que contém a imagem.
bIsLargeImage
[in] TRUE se a imagem for de tamanho grande, se a imagem for do tamanho pequeno, será FALSE.
nImageIndex
[in] Índice baseado em zero da imagem na matriz de imagem contida na categoria da faixa de opções.
bCenter
[in] TRUE para centralizar a imagem no retângulo de exibição. FALSE para desenhar a imagem no canto superior esquerdo do retângulo de exibição.
Valor de retorno
TRUE se o método foi bem-sucedido; caso contrário, FALSE.
Comentários
CMFCRibbonCategory::OnDrawMenuBorder
Chamado pela estrutura para desenhar a borda de um menu pop-up.
virtual void OnDrawMenuBorder(
CDC* pDC,
CMFCRibbonPanelMenuBar* pMenuBar);
Parâmetros
pDC
[in] Esse parâmetro não é usado.
pMenuBar
[in] Esse parâmetro não é usado.
Comentários
Por padrão, esse método não faz nada. Substitua esse método para desenhar a borda de um menu pop-up.
CMFCRibbonCategory::OnKey
Chamado pela estrutura quando um usuário pressiona um botão do teclado.
virtual BOOL OnKey(UINT nChar);
Parâmetros
nChar
O código de chave virtual para a chave que um usuário pressionou.
Comentários
CMFCRibbonCategory::OnLButtonDown
Chamado pela estrutura para recuperar o elemento da faixa de opções no ponto especificado quando o usuário pressiona o botão esquerdo do mouse.
virtual CMFCRibbonBaseElement* OnLButtonDown(CPoint point);
Parâmetros
point
[in] As coordenadas x e y do ponteiro do mouse em relação ao canto superior esquerdo da janela.
Valor de retorno
Ponteiro para um elemento da faixa de opções caso o método tenha tido êxito; caso contrário, NULL.
Comentários
CMFCRibbonCategory::OnLButtonUp
Chamado pela estrutura quando o usuário libera o botão esquerdo do mouse e o ponteiro está sobre a categoria da faixa de opções.
virtual void OnLButtonUp(CPoint point);
Parâmetros
point
[in] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.
Comentários
CMFCRibbonCategory::OnMouseMove
Chamado pela estrutura quando o ponteiro se move na barra de faixa de opções para atualizar a exibição da categoria dessa faixa.
virtual void OnMouseMove(CPoint point);
Parâmetros
point
[in] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.
Comentários
CMFCRibbonCategory::OnRTLChanged
Chamado pela estrutura quando o layout muda de direção.
virtual void OnRTLChanged(BOOL bIsRTL);
Parâmetros
bIsRTL
[in] TRUE se o layout for da direita para a esquerda, se o layout for da esquerda para a direita, será FALSE.
Comentários
Esse método ajusta o layout de todos os painéis de faixa de opções e elementos de faixa de opções contidos na categoria dessa faixa.
CMFCRibbonCategory::OnScrollHorz
Rola a categoria da faixa de opções na direção horizontal.
virtual BOOL OnScrollHorz(
BOOL bScrollLeft,
int nScrollOffset = 0);
Parâmetros
bScrollLeft
[in] TRUE para rolar para a esquerda, para rolar para a direita, será FALSE.
nScrollOffset
[in] A distância de rolagem em pixels.
Valor de retorno
TRUE se a categoria da faixa de opções for movida em uma direção horizontal, do contrário, será FALSE.
Comentários
CMFCRibbonCategory::OnUpdateCmdUI
Chama a função membro OnUpdateCmdUI em cada um dos elementos CMFCRibbonPanel para que CMFCRibbonCategory habilite ou desabilite os elementos de interface do usuário neles.
virtual void OnUpdateCmdUI(
CMFCRibbonCmdUI* pCmdUI,
CFrameWnd* pTarget,
BOOL bDisableIfNoHndler);
Parâmetros
pCmdUI
[in] Ponteiro para o objeto CMFCRibbonCmdUI que especifica quais elementos de interface do usuário devem ser habilitados e quais devem ser desabilitados.
pTarget
[in] Ponteiro para a janela que controla a habilitação ou desabilitação dos elementos de interface do usuário.
bDisableIfNoHndler
[in] TRUE para desabilitar o item de interface do usuário, se nenhum identificador for definido em um mapa de mensagens. Caso contrário, FALSE.
Comentários
CMFCRibbonCategory::RecalcLayout
Ajusta o layout de todos os controles na categoria da faixa de opções.
virtual void RecalcLayout(CDC* pDC);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo para a categoria da faixa de opções.
Comentários
CMFCRibbonCategory::RemovePanel
Remove um painel da faixa de opções da categoria da faixa de opções.
BOOL RemovePanel(
int nIndex,
BOOL bDelete = TRUE);
Parâmetros
nIndex
O número de índice do item a ser removido. Obtido chamando o método CMFCRibbonCategory::GetPanelIndex.
bDelete
[in] TRUE para excluir o objeto do painel da memória. FALSE para remover o objeto do painel sem excluí-lo.
Valor de retorno
TRUE se o método foi bem-sucedido, do contrário, será FALSE.
CMFCRibbonCategory::ReposPanels
Ajusta o layout de todos os controles nos painéis da faixa de opções contidos na categoria dessa faixa.
virtual void ReposPanels(CDC* pDC);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo para os painéis da faixa de opções que estão contidos na categoria dessa faixa.
Comentários
CMFCRibbonCategory::SetCollapseOrder
Define a ordem na qual os painéis da faixa de opções da categoria dessa faixa são recolhidos.
void SetCollapseOrder(const CArray<int,int>& arCollapseOrder);
Parâmetros
arCollapseOrder
[in] Especifica a ordem de recolhimento. A matriz contém índices baseados em zero de painéis de faixa de opções.
Comentários
A biblioteca define a ordem de recolhimento. No entanto, você pode personalizar esse comportamento fornecendo à categoria a lista de índices que especifica a ordem de recolhimento.
Quando a categoria detecta que precisa recolher um painel de faixa de opções, ela procura o próximo elemento na lista especificada. Se a lista estiver vazia ou você não tiver especificado elementos suficientes, a categoria usará o algoritmo interno.
Por exemplo, a categoria tem três painéis da faixa de opções e pode ser recolhido várias vezes até que todos os painéis estejam no estado totalmente recolhido. Você pode definir a seguinte ordem de recolhimento: 0, 0, 2, 2. Neste caso, a categoria recolherá o painel 0 duas vezes, o painel 2 duas vezes. O painel que tem o índice de 1 permanece não compilado.
Exemplo
O seguinte exemplo demonstra como usar o método SetCollapseOrder na classe CMFCRibbonCategory. O exemplo mostra como construir uma matriz para a ordem de recolhimento e como definir a ordem de recolhimento para a categoria da faixa de opções.
CArray<int, int> arCollapseOrder;
arCollapseOrder.Add(0);
arCollapseOrder.Add(1);
arCollapseOrder.Add(2);
// CMFCRibbonCategory* pCategoryHome
pCategoryHome->SetCollapseOrder(arCollapseOrder);
CMFCRibbonCategory::SetData
Define os dados definidos pelo usuário a serem associados à categoria da faixa de opções.
void SetData(DWORD_PTR dwData);
Parâmetros
dwData
[in] Os dados definidos pelo usuário.
CMFCRibbonCategory::SetKeys
Atribui uma dica de chave à categoria da faixa de opções.
void SetKeys(LPCTSTR lpszKeys);
Parâmetros
lpszKeys
[in] O texto da dica de chave.
Comentários
As dicas de tecla são exibidas quando o usuário pressiona a tecla Alt ou a tecla F10.
CMFCRibbonCategory::SetName
Atribui um nome e uma dica de chave à categoria da faixa de opções.
void SetName(LPCTSTR lpszName);
Parâmetros
lpszName
[in] O nome e a dica de chave da categoria da faixa de opções.
Comentários
Para definir a dica de tecla para a categoria da faixa de opções, anexe uma sequência de escape de nova linha seguida pelos caracteres de dica de tecla a lpszName.
CMFCRibbonCategory::SetTabColor
Define a cor da categoria da faixa de opções.
void SetTabColor(AFX_RibbonCategoryColor color);
Parâmetros
color
[in] Especifica a nova cor da categoria da faixa de opções.
Comentários
A cor pode ter 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