CMFCRibbonBaseElement Classe

A classe CMFCRibbonBaseElement é a classe base para todos os elementos que você pode adicionar a uma barra de faixa de opções . Exemplos de elementos da faixa de opções são botões da faixa de opções, caixas de seleção da faixa de opções e caixas de combinação da faixa de opções.

Sintaxe

class CMFCRibbonBaseElement : public CObject

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Comentários

A classe CMFCRibbonBaseElement define as propriedades que são comuns a todos os elementos da faixa de opções que incluem ID de comando, rótulo de texto, texto de dica de ferramenta, descrição do elemento e estado (que podem ser focados, realçados, pressionados, desabilitados, marcados ou suspensos).

O tamanho da imagem de um elemento da faixa de opções é definido pelo membro RibbonImageType, que pode ser um dos seguintes valores:

• RibbonImageLarge

• RibbonImageSmall

Dependendo do tamanho, um elemento da faixa de opções exibe uma imagem pequena ou grande.

Exemplo

O exemplo a seguir demonstra como usar vários métodos na classe CMFCRibbonBaseElement. O exemplo mostra como obter um objeto CMFCRibbonBaseElement de uma classe CMFCRibbonStatusBar, definir a descrição para o elemento da faixa de opções, definir o texto, definir uma dica de tecla e definir o texto da dica de ferramenta para o elemento da faixa de opções. Este trecho de código faz parte do exemplo de Draw Client.

// CMFCRibbonStatusBar m_wndStatusBar
CMFCRibbonBaseElement *pPane = m_wndStatusBar.FindByID(nID);

pPane->SetDescription(_T("a pane"));
// CString strText
pPane->SetText(strText);
pPane->SetKeys(_T("p"));
pPane->SetToolTipText(_T("this is a pane"));

Hierarquia de herança

CObject

CMFCRibbonBaseElement

Requerimentos

Cabeçalho: afxbaseribbonelement.h

CMFCRibbonBaseElement::AddToKeyList

Adiciona uma dica de tecla para o elemento da faixa de opções a uma matriz de dicas de teclas.

virtual void AddToKeyList(
    CArray<CMFCRibbonKeyTip*, CMFCRibbonKeyTip*>& arElems);

Parâmetros

arElems
[em] Referência a um CArray de dicas de teclas.

Comentários

Quando o recurso de dicas de teclas da faixa de opções está habilitado, a estrutura exibe as dicas de teclas da faixa de opções quando o usuário pressiona a tecla ALT ou a tecla F10.

CMFCRibbonBaseElement::AddToListBox

Adiciona um elemento da faixa de opções à caixa de listagem de comandos da faixa de opções especificados.

virtual int AddToListBox(
    CMFCRibbonCommandsListBox* pWndListBox,
    BOOL bDeep);

Parâmetros

pWndListBox
[em] Ponteiro para uma caixa de listagem de comandos.

bDeep
[em] Este parâmetro não é usado.

Valor de retorno

O índice baseado em zero do elemento da faixa de opções adicionado.

Comentários

A estrutura adiciona elementos da faixa de opções a uma caixa de listagem de comandos para permitir que o usuário personalize a interface do usuário.

CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar

Indica se o elemento da faixa de opções pode ser adicionado à barra de ferramentas de acesso rápido.

virtual BOOL CanBeAddedToQuickAccessToolBar() const;

Valor de retorno

TRUE se o elemento puder ser adicionado; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::CanBeCompacted

Indica se o tamanho do elemento da faixa de opções pode ser compacto.

virtual BOOL CanBeCompacted() const;

Valor de retorno

TRUE se o tamanho do elemento da faixa de opções puder ser compacto; caso contrário, FALSE.

Comentários

O tamanho de um elemento da faixa de opções pode ser compacto, intermediário ou grande.

CMFCRibbonBaseElement::CanBeStretched

Indica se a altura do elemento da faixa de opções pode aumentar verticalmente até a altura de uma linha da faixa de opções.

virtual BOOL CanBeStretched();

Valor de retorno

Sempre retorna TRUE.

Comentários

Por padrão, esse método sempre retorna TRUE. Substitua esse método para indicar se a altura do elemento da faixa de opções pode aumentar verticalmente até a altura de uma linha da faixa de opções.

CMFCRibbonBaseElement::CanBeStretchedHorizontally

Indica se a largura do elemento da faixa de opções pode ser alterada.

virtual BOOL CanBeStretchedHorizontally();

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método para indicar se a largura do elemento da faixa de opções pode ser alterada.

CMFCRibbonBaseElement::CleanUpSizes

Limpa as configurações de dimensão do elemento da faixa de opções.

virtual void CleanUpSizes();

Comentários

Por padrão, esse método não faz nada. Substitua esse método em uma classe derivada para redefinir as configurações de dimensão para o elemento da faixa de opções.

CMFCRibbonBaseElement::ClosePopupMenu

Fecha o menu pop-up do elemento da faixa de opções.

virtual void ClosePopupMenu();

Comentários

CMFCRibbonBaseElement::CopyFrom

Copia o estado do especificado CMFCRibbonBaseElement para o objeto atual.

virtual void CopyFrom(const CMFCRibbonBaseElement& src);

Parâmetros

src
[em] A origem CMFCRibbonBaseElement objeto.

Comentários

CMFCRibbonBaseElement::D estroyCtrl

Destrói o elemento da fita.

virtual void DestroyCtrl();

Comentários

Por padrão, esse método não faz nada. Substitua esse método em uma classe derivada para destruir o elemento da faixa de opções.

CMFCRibbonBaseElement::D rawImage

Desenha a imagem para o elemento da faixa de opções.

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

Parâmetros

pDC
[em] Ponteiro para um contexto de dispositivo.

tipo
[em] Um tipo de imagem valor enumerado. Consulte a seção Comentários para obter uma lista de valores possíveis.

rectImage
[em] O retângulo da imagem.

Comentários

Por padrão, esse método não faz nada. Substitua esse método em uma classe derivada para desenhar a imagem para o elemento da faixa de opções.

A tabela a seguir lista os valores possíveis para o tipo parâmetro:

CMFCRibbonBaseElement::Localizar

Retorna o ponteiro especificado se ele apontar para o objeto atual.

virtual CMFCRibbonBaseElement* Find(const CMFCRibbonBaseElement* pElement);

Parâmetros

pElement
[em] Ponteiro para um elemento da faixa de opções.

Valor de retorno

Um ponteiro para o elemento da faixa de opções se pElement apontar para o objeto atual; caso contrário, NULL.

Comentários

CMFCRibbonBaseElement::FindByData

Recupera um ponteiro para o elemento da faixa de opções se ele contiver os dados especificados.

virtual CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData);

Parâmetros

dwData
[em] Os dados associados a um elemento da faixa de opções.

Valor de retorno

Um ponteiro para o elemento da faixa de opções se ele contiver os dados especificados; caso contrário, NULL.

Comentários

CMFCRibbonBaseElement::FindByID

Recupera um ponteiro para o elemento da faixa de opções se esse elemento for identificado pela ID de comando especificada.

virtual CMFCRibbonBaseElement* FindByID(UINT uiCmdID);

Parâmetros

uiCmdID
[em] ID de comando para um elemento da faixa de opções.

Valor de retorno

Um ponteiro para o elemento da faixa de opções se esse elemento for identificado pela ID de comando especificada; caso contrário, NULL.

Comentários

CMFCRibbonBaseElement::FindByOriginal

Recupera um ponteiro para o elemento da faixa de opções atual se o elemento original da faixa de opções corresponder ao elemento da faixa de opções especificado.

virtual CMFCRibbonBaseElement* FindByOriginal(CMFCRibbonBaseElement* pOriginal);

Parâmetros

pOriginal
[em] Ponteiro para um elemento da faixa de opções.

Valor de retorno

Um ponteiro para o elemento da faixa de opções se o elemento original da faixa de opções corresponder ao elemento da faixa de opções especificado; caso contrário, NULL.

Comentários

Os elementos da faixa de opções copiados para outro contêiner mantêm um ponteiro para o elemento original da faixa de opções.

CMFCRibbonBaseElement::GetCompactSize

Retorna o tamanho compacto do elemento da faixa de opções.

virtual CSize GetCompactSize(CDC* pDC);

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

Valor de retorno

O tamanho compacto de um elemento da faixa de opções.

CMFCRibbonBaseElement::GetData

Recupera os dados definidos pelo usuário associados ao elemento da faixa de opções.

DWORD_PTR GetData() const;

Valor de retorno

Os dados definidos pelo usuário associados ao elemento da faixa de opções.

CMFCRibbonBaseElement::GetDescription

Retorna a descrição do elemento da faixa de opções.

virtual CString GetDescription() const;

Valor de retorno

A descrição do elemento da faixa de opções. A descrição é exibida na barra de status, em uma dica de ferramenta ou no botão de menu se o elemento da faixa de opções estiver localizado no CMFCRibbonMainPanel Class.

CMFCRibbonBaseElement::GetDroppedDown

Recupera um ponteiro para o elemento da faixa de opções se o menu pop-up estiver suspenso.

virtual CMFCRibbonBaseElement* GetDroppedDown();

Valor de retorno

Um ponteiro para o elemento da faixa de opções se o menu pop-up estiver suspenso; caso contrário, NULL.

Comentários

CMFCRibbonBaseElement::GetElements

Adiciona o elemento da faixa de opções atual à matriz especificada.

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

Parâmetros

arElements
[dentro, fora] Uma matriz de elementos da faixa de opções.

Comentários

CMFCRibbonBaseElement::GetElementsByID

Adiciona o elemento da faixa de opções atual à matriz especificada se o elemento da faixa de opções atual contiver a ID de comando especificada.

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

Parâmetros

uiCmdID
[em] ID de comando de um elemento da faixa de opções.

arElements
[em] Uma matriz de elementos da faixa de opções.

Comentários

CMFCRibbonBaseElement::GetHighlighted

Recupera um ponteiro para o elemento da faixa de opções se ele estiver realçado.

virtual CMFCRibbonBaseElement* GetHighlighted();

Valor de retorno

Um ponteiro para o elemento da faixa de opções se ele estiver realçado; caso contrário, NULL.

Comentários

CMFCRibbonBaseElement::GetID

Retorna a ID do comando do elemento da faixa de opções.

UINT GetID() const;

Valor de retorno

A ID de comando do elemento da faixa de opções.

CMFCRibbonBaseElement::GetImageSize

Retorna o tamanho da imagem do elemento da faixa de opções.

virtual CSize GetImageSize(RibbonImageType R) const;

Valor de retorno

O tamanho da imagem do elemento da faixa de opções.

CMFCRibbonBaseElement::GetIntermediateSize

Retorna o tamanho do elemento da faixa de opções em seu estado intermediário.

virtual CSize GetIntermediateSize(CDC* pDC);

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

Valor de retorno

O tamanho do elemento da faixa de opções em seu estado intermediário.

CMFCRibbonBaseElement::GetKeys

Retorna a dica de tecla associada ao elemento da faixa de opções.

LPCTSTR GetKeys() const;

Valor de retorno

Uma dica de tecla associada ao elemento da faixa de opções.

CMFCRibbonBaseElement::GetKeyTipRect

Recupera o retângulo de limite da dica de tecla para o elemento da faixa de opções.

virtual CRect GetKeyTipRect(
    CDC* pDC,
    BOOL bIsMenu);

Parâmetros

pDC
[em] Ponteiro para um contexto de dispositivo.

bIsMenu
[em] TRUE se o elemento da faixa de opções exibir um menu pop-up; caso contrário, FALSE.

Valor de retorno

Sempre retorna um retângulo com 0 valores.

Comentários

Substitua esse método em uma classe derivada para retornar o retângulo de limite da dica de chave.

CMFCRibbonBaseElement::GetKeyTipSize

Recupera o tamanho do texto da dica de tecla.

virtual CSize GetKeyTipSize(CDC* pDC);

Parâmetros

pDC
[em] Ponteiro para um contexto de dispositivo.

Valor de retorno

O tamanho do texto da dica de tecla.

Comentários

CMFCRibbonBaseElement::GetLocationInGroup

Indica o local de exibição do elemento da faixa de opções em um grupo da faixa de opções.

RibbonElementLocation GetLocationInGroup() const;

Valor de retorno

Um RibbonElementLocation valor enumerado. A tabela a seguir lista os valores possíveis.

Comentários

Os grupos de elementos da faixa de opções são alinhados apenas horizontalmente.

CMFCRibbonBaseElement::GetMenuKeys

Retorna a dica de tecla de menu para o elemento da faixa de opções.

LPCTSTR GetMenuKeys() const;

Valor de retorno

A dica de tecla de menu associada ao elemento da faixa de opções.

Comentários

Quando invocada, uma dica de tecla de menu exibe um menu pop-up.

CMFCRibbonBaseElement::GetNotifyID

Recupera a ID do comando de notificação para o elemento da faixa de opções.

virtual UINT GetNotifyID();

Valor de retorno

O ID do comando de notificação.

Comentários

CMFCRibbonBaseElement::GetOriginal

Recupera o elemento original da faixa de opções.

CMFCRibbonBaseElement* GetOriginal() const;

Valor de retorno

Um ponteiro para o elemento original da faixa de opções.

Comentários

Os elementos da faixa de opções copiados para outro contêiner mantêm um ponteiro para o elemento original da faixa de opções.

CMFCRibbonBaseElement::GetParentCategory

Recupera a categoria da faixa de opções para o elemento da faixa de opções.

CMFCRibbonCategory* GetParentCategory() const;

Valor de retorno

Um ponteiro para a categoria da faixa de opções.

Comentários

CMFCRibbonBaseElement::GetParentPanel

Recupera o painel da faixa de opções que contém o elemento da faixa de opções.

virtual CMFCRibbonPanel* GetParentPanel() const;

Valor de retorno

Um ponteiro para o painel da faixa de opções que contém o elemento da faixa de opções.

Comentários

CMFCRibbonBaseElement::GetParentRibbonBar

Recupera a barra da faixa de opções pai para o elemento da faixa de opções.

CMFCRibbonBar* GetParentRibbonBar() const;

Valor de retorno

Um ponteiro para a barra de faixa de opções pai para o elemento da faixa de opções.

Comentários

CMFCRibbonBaseElement::GetParentWnd

Recupera a janela pai do elemento da faixa de opções.

virtual CWnd* GetParentWnd() const;

Valor de retorno

Um ponteiro para a janela pai para o elemento da faixa de opções se o método tiver sido bem-sucedido; caso contrário, NULL.

Comentários

A janela pai para um elemento da faixa de opções é um CMFCRibbonBar Class ou um CMFCRibbonPanelMenuBar.

CMFCRibbonBaseElement::GetPressed

Recupera um ponteiro para o elemento da faixa de opções se o usuário pressioná-lo no momento.

virtual CMFCRibbonBaseElement* GetPressed();

Valor de retorno

Um ponteiro para o elemento da faixa de opções se o usuário pressioná-lo no momento; caso contrário, NULL.

Comentários

CMFCRibbonBaseElement::GetQuickAccessToolBarID

Recupera a ID de comando do elemento da faixa de opções quando ele está localizado na barra de ferramentas de acesso rápido.

virtual UINT GetQuickAccessToolBarID() const;

Valor de retorno

O ID de comando do elemento da faixa de opções quando ele está localizado na barra de ferramentas de acesso rápido.

Comentários

CMFCRibbonBaseElement::GetRect

Retorna o retângulo delimitador do elemento da faixa de opções.

CRect GetRect() const;

Valor de retorno

O retângulo delimitador do elemento da faixa de opções. A posição do retângulo está nas coordenadas do controle da Faixa de Opções pai.

CMFCRibbonBaseElement::GetRegularSize

Retorna o tamanho normal do elemento da faixa de opções.

virtual CSize GetRegularSize(CDC* pDC) = 0;

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

Valor de retorno

O tamanho normal do elemento da faixa de opções.

Comentários

CMFCRibbonBaseElement::GetSize

Retorna o tamanho atual do elemento da faixa de opções.

virtual CSize GetSize(CDC* pDC);

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

Valor de retorno

O tamanho atual do elemento da faixa de opções.

CMFCRibbonBaseElement::GetText

Retorna o texto associado ao elemento da faixa de opções.

LPCTSTR GetText() const;

Valor de retorno

O texto associado ao elemento da faixa de opções.

CMFCRibbonBaseElement::GetToolTipText

Retorna o texto da dica de ferramenta do elemento da faixa de opções.

virtual CString GetToolTipText() const;

Valor de retorno

O texto da dica de ferramenta do elemento da faixa de opções.

CMFCRibbonBaseElement::GetTopLevelRibbonBar

Recupera a barra da faixa de opções de nível superior para o elemento da faixa de opções.

CMFCRibbonBar* GetTopLevelRibbonBar() const;

Valor de retorno

Um ponteiro para a barra da faixa de opções de nível superior para o elemento da faixa de opções se o método tiver sido bem-sucedido; caso contrário, NULL.

Comentários

CMFCRibbonBaseElement::HasCompactMode

Especifica se o elemento da faixa de opções tem um modo compacto.

virtual BOOL HasCompactMode() const;

Valor de retorno

TRUE se o elemento da faixa de opções tiver um modo compacto. FALSO caso contrário.

Comentários

CMFCRibbonBaseElement::HasIntermediateMode

Especifica se o elemento da faixa de opções tem um modo intermediário.

virtual BOOL HasIntermediateMode() const;

Valor de retorno

TRUE se o elemento da faixa de opções tiver um modo intermediário, FALSE caso contrário. No modo intermediário, um elemento exibe uma pequena imagem e texto à direita da imagem.

Comentários

CMFCRibbonBaseElement::HasLargeMode

Determina se o elemento da faixa de opções tem um modo grande.

virtual BOOL HasLargeMode() const;

Valor de retorno

TRUE se o elemento da faixa de opções tiver um modo grande. FALSO caso contrário.

Comentários

No modo grande, um elemento pode ter a altura total do painel pai.

CMFCRibbonBaseElement::HasMenu

Indica se o elemento da faixa de opções tem um menu.

virtual BOOL HasMenu() const;

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método em uma classe derivada para indicar se o elemento da faixa de opções tem um menu.

CMFCRibbonBaseElement::HitTest

Recupera um ponteiro para o elemento da faixa de opções se o ponto especificado estiver localizado nele.

virtual CMFCRibbonBaseElement* HitTest(CPoint point);

Parâmetros

ponto
[em] Este parâmetro não é usado.

Valor de retorno

Um ponteiro para o elemento da faixa de opções, se ele existir; caso contrário, FALSE.

Comentários

Por padrão, esse método sempre retorna um ponteiro válido para o elemento da faixa de opções quando ele existe. Substitua esse método para indicar se o ponto reside no elemento da faixa de opções.

CMFCRibbonBaseElement::IsAlignByColumn

Indica se o elemento da faixa de opções está alinhado verticalmente com outros elementos da faixa de opções.

virtual BOOL IsAlignByColumn() const;

Valor de retorno

Sempre retorna TRUE.

Comentários

Por padrão, esse método sempre retorna TRUE. Substitua esse método em uma classe derivada para indicar se o elemento da faixa de opções derivado está alinhado verticalmente com outros elementos da faixa de opções.

CMFCRibbonBaseElement::IsAlwaysLargeImage

Indica se o tamanho da imagem do elemento da faixa de opções é sempre grande.

virtual BOOL IsAlwaysLargeImage() const;

Valor de retorno

TRUE se o tamanho da imagem do elemento da faixa de opções for sempre grande; caso contrário, FALSE.

Comentários

O tamanho da imagem grande é de 32 x 32 pixels.

CMFCRibbonBaseElement::IsAutoRepeatMode

Indica se o elemento da faixa de opções está no modo de repetição automática.

virtual BOOL IsAutoRepeatMode(int& nDelay) const;

Parâmetros

nDelay
[em] Este parâmetro não é usado.

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método para indicar se o elemento da faixa de opções está no modo de repetição automática.

No modo de repetição automática, o elemento da faixa de opções responde em um intervalo definido, medido em milissegundos, à entrada sustentada do usuário.

CMFCRibbonBaseElement::IsChecked

Especifica se o elemento da faixa de opções está marcado.

virtual BOOL IsChecked() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver marcado; caso contrário, FALSE.

CMFCRibbonBaseElement::IsCompactMode

Especifica se o elemento da faixa de opções está em um modo compacto.

BOOL IsCompactMode() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver em um modo compacto; caso contrário, FALSE.

CMFCRibbonBaseElement::IsDefaultMenuLook

Indica se o elemento da faixa de opções está definido para aparecer como um comando pop-up.

BOOL IsDefaultMenuLook() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver definido para aparecer como um comando pop-up; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::IsDisabled

Especifica se o elemento da faixa de opções está desabilitado.

virtual BOOL IsDisabled() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver desabilitado; caso contrário, FALSE.

CMFCRibbonBaseElement::IsDroppedDown

Especifica se o elemento da faixa de opções exibe um menu pop-up e é suspenso.

virtual BOOL IsDroppedDown() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver suspenso e exibir um menu pop-up; caso contrário, FALSE.

CMFCRibbonBaseElement::IsFocused

Especifica se o elemento da faixa de opções tem o foco.

virtual BOOL IsFocused() const;

Valor de retorno

TRUE se o elemento da faixa de opções tiver o foco; caso contrário, FALSE.

CMFCRibbonBaseElement::IsGalleryIcon

Indica se o elemento da faixa de opções está contido em uma galeria da faixa de opções.

virtual BOOL IsGalleryIcon() const;

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método em uma classe derivada para indicar se o elemento da faixa de opções está contido em uma galeria da faixa de opções.

CMFCRibbonBaseElement::IsHighlighted

Especifica se o elemento da faixa de opções está realçado.

virtual BOOL IsHighlighted() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver realçado; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::IsIntermediateMode

Indica se a imagem atual do elemento da faixa de opções é de tamanho intermediário.

BOOL IsIntermediateMode() const;

Valor de retorno

TRUE se a imagem do elemento da faixa de opções for de tamanho intermediário; caso contrário, FALSE.

Comentários

O tamanho intermediário da imagem é de 16 x 16 pixels.

CMFCRibbonBaseElement::IsLargeMode

Indica se a imagem atual do elemento da faixa de opções é grande.

BOOL IsLargeMode() const;

Valor de retorno

TRUE se a imagem do elemento da faixa de opções for grande; caso contrário, FALSE.

Comentários

O tamanho da imagem grande é de 32 x 32 pixels.

CMFCRibbonBaseElement::IsMenuMode

Indica se o elemento da faixa de opções está contido em um menu.

BOOL IsMenuMode() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver contido em um menu; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::IsPressed

Indica se o usuário clicou no elemento da faixa de opções.

virtual BOOL IsPressed() const;

Valor de retorno

TRUE se o usuário clicou no elemento da faixa de opções; caso contrário, FALSE.

CMFCRibbonBaseElement::IsQATMode

Indica se o elemento da faixa de opções está contido na barra de ferramentas de acesso rápido.

BOOL IsQATMode() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver contido na barra de ferramentas de acesso rápido; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::IsSeparator

Indica se o elemento da faixa de opções é um separador de exibição.

virtual BOOL IsSeparator() const;

Valor de retorno

TRUE se o elemento da faixa de opções for um separador de exibição; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::IsShowGroupBorder

Indica se o elemento da faixa de opções está contido em um grupo que exibe uma borda comum.

BOOL IsShowGroupBorder() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver contido em um grupo que exibe uma borda comum; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::IsShowTooltipOnBottom

Indica se a dica de ferramenta é exibida sob o elemento da faixa de opções.

virtual BOOL IsShowTooltipOnBottom() const;

Valor de retorno

TRUE se a dica de ferramenta for exibida sob o elemento da faixa de opções; FALSO se a dica de ferramenta for exibida perto do ponteiro.

Comentários

CMFCRibbonBaseElement::IsTabStop

Indica se o elemento da faixa de opções pode ser selecionado com o teclado.

virtual BOOL IsTabStop() const;

Valor de retorno

Sempre retorna TRUE.

Comentários

Por padrão, esse método sempre retorna TRUE. Substitua esse método para indicar se o elemento da faixa de opções pode ser selecionado com o teclado.

CMFCRibbonBaseElement::IsTextAlwaysOnRight

Indica se o texto do elemento da faixa de opções é exibido à direita.

BOOL IsTextAlwaysOnRight() const;

Valor de retorno

TRUE se o texto do elemento da faixa de opções for exibido à direita; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::IsVisible

Indica se o elemento da faixa de opções é exibido no momento.

BOOL IsVisible() const;

Valor de retorno

TRUE se o elemento da faixa de opções for exibido no momento; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::IsWholeRowHeight

Indica se a altura de exibição do elemento da faixa de opções é a mesma que a altura de exibição do painel da faixa de opções que a contém.

virtual BOOL IsWholeRowHeight() const;

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método para indicar se a altura de exibição do elemento da faixa de opções é a mesma que a altura de exibição do painel da faixa de opções que a contém.

CMFCRibbonBaseElement::NotifyCommand

Envia uma notificação de comando para a janela pai do elemento da faixa de opções.

BOOL NotifyCommand(BOOL bWithDelay = FALSE);

Parâmetros

bWithDelay
[em] TRUE para adicionar a notificação de comando à fila de mensagens da janela pai; FALSE para enviar a mensagem imediatamente para a janela pai.

Valor de retorno

TRUE se a mensagem foi enviada; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::NotifyHighlightListItem

Notifica a janela pai da barra da faixa de opções quando um usuário realça um elemento da faixa de opções localizado em uma lista.

virtual void NotifyHighlightListItem(int nIndex);

Parâmetros

nIndex
[em] O índice do elemento da faixa de opções na lista.

Comentários

CMFCRibbonBaseElement::OnAddToQAToolbar

Adiciona o elemento da faixa de opções à barra de ferramentas de acesso rápido especificada.

virtual BOOL OnAddToQAToolbar(CMFCRibbonQuickAccessToolBar& qat);

Parâmetros

qat
[em] A barra de ferramentas de acesso rápido.

Valor de retorno

Sempre retorna TRUE indicando que o elemento da faixa de opções foi adicionado à barra de ferramentas de acesso rápido.

Comentários

CMFCRibbonBaseElement::OnAfterChangeRect

Atualiza a dica de ferramenta para o elemento da faixa de opções.

virtual void OnAfterChangeRect(CDC* pDC);

Parâmetros

pDC
[em] Este parâmetro não é usado.

Comentários

Por padrão, esse método atualiza a dica de ferramenta para o elemento da faixa de opções. Substitua esse método para atualizar o elemento da faixa de opções depois que seu retângulo de exibição for alterado.

CMFCRibbonBaseElement::OnAutoRepeat

Atualiza o elemento da faixa de opções em resposta à entrada sustentada do usuário.

virtual BOOL OnAutoRepeat();

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método para processar a entrada sustentada do usuário.

CMFCRibbonBaseElement::OnCalcTextSize

Calcula o tamanho do texto para o elemento da faixa de opções.

virtual void OnCalcTextSize(CDC* pDC);

Parâmetros

pDC
[em] Este parâmetro não é usado.

Comentários

Por padrão, esse método não faz nada. Substitua esse método para calcular o tamanho do texto para o elemento da faixa de opções.

CMFCRibbonBaseElement::OnChangeMenuHighlight

Chamado pela estrutura quando o realce muda para um elemento da faixa de opções localizado em um menu.

virtual void OnChangeMenuHighlight(CMFCRibbonPanelMenuBar* pPanelMenuBar
    CMFCRibbonBaseElement* pHot);

Parâmetros

pPanelMenuBar
[em] Este parâmetro não é usado.

pHot
[em] Este parâmetro não é usado.

Comentários

Por padrão, esse método não faz nada. Substitua esse método para atualizar um elemento da faixa de opções que está localizado em um menu quando o realce é alterado.

CMFCRibbonBaseElement::OnDraw

Chamado pela estrutura para desenhar o elemento da faixa de opções.

virtual void OnDraw(CDC* pDC) = 0;

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

Comentários

Substitua esse método em uma classe derivada se desejar personalizar o desenho de um elemento específico da faixa de opções.

CMFCRibbonBaseElement::OnDrawKeyTip

Chamado pela estrutura para desenhar a dica de tecla para o elemento da faixa de opções.

virtual void OnDrawKeyTip(
    CDC* pDC,
    const CRect& rect,
    BOOL bIsMenu);

Parâmetros

pDC
[em] Ponteiro para um contexto de dispositivo.

rect
[em] Retângulo de limite para a dica de tecla.

bIsMenu
[em] TRUE se a dica de tecla for para um botão de menu pop-up; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::OnDrawMenuImage

Chamado pela estrutura quando a imagem de menu para o elemento da faixa de opções é desenhada.

virtual BOOL OnDrawMenuImage(
    CDC* pDC,
    CRect rect);

Parâmetros

pDC
[em] Ponteiro para um contexto de dispositivo.

rect
[em] Retângulo de imagem do menu.

Valor de retorno

Sempre retorna TRUE para indicar que a imagem foi desenhada.

Comentários

CMFCRibbonBaseElement::OnDrawOnList

Chamado pela estrutura para desenhar o elemento da faixa de opções em uma caixa de listagem de comandos.

virtual void OnDrawOnList(
    CDC* pDC,
    CString strText,
    int nTextOffset,
    CRect rect,
    BOOL bIsSelected,
    BOOL bHighlighted);

Parâmetros

pDC
[em] Ponteiro para um contexto de dispositivo para o elemento da faixa de opções.

strText
[em] O texto de exibição.

nTextOffset
[em] Distância, em pixels, do lado esquerdo da caixa de listagem até o texto de exibição.

rect
[em] O retângulo de exibição para o elemento da faixa de opções.

bIsSelected
[em] Este parâmetro não é usado.

bDestaque
[em] Este parâmetro não é usado.

Comentários

A caixa de listagem de comandos exibe elementos da faixa de opções para permitir que os usuários personalizem a barra de ferramentas de acesso rápido.

CMFCRibbonBaseElement::OnKey

Chamado pela estrutura quando o usuário pressiona uma dica de tecla e o elemento da faixa de opções tem o foco.

virtual BOOL OnKey(BOOL bIsMenuKey);

Parâmetros

bIsMenuKey
[em] TRUE se a dica de tecla exibir um menu pop-up; caso contrário, FALSE.

Valor de retorno

TRUE se o evento foi manipulado; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::OnMenuKey

Chamado pela estrutura quando o usuário pressiona uma dica de tecla de menu no painel principal.

virtual BOOL OnMenuKey(UINT nUpperChar);

Parâmetros

nUpperChar
[em] Este parâmetro não é usado.

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método para responder quando um usuário pressiona uma dica de tecla de menu no painel principal.

CMFCRibbonBaseElement::OnProcessKey

Chamado pela estrutura quando o usuário pressiona uma tecla de atalho.

virtual BOOL OnProcessKey(UINT nChar);

Parâmetros

nChar
[em] Este parâmetro não é usado.

Valor de retorno

Sempre retorna FALSE.

Comentários

Substitua esse método se desejar que o elemento da faixa de opções processe uma tecla de atalho.

CMFCRibbonBaseElement::OnRTLChanged

Chamado pela estrutura quando o layout muda de direção.

virtual void OnRTLChanged(BOOL bIsRTL);

Parâmetros

bIsRTL
[em] Este parâmetro não é usado.

Comentários

Por padrão, esse método não faz nada. Substitua esse método para ajustar o elemento da faixa de opções quando o layout mudar de direção. A direção do layout padrão é da esquerda para a direita.

CMFCRibbonBaseElement::OnSetFocus

Chamado pela estrutura quando um elemento da faixa de opções recebe ou perde o foco de entrada.

virtual void OnSetFocus(BOOL B);

Comentários

Substitua esse método em uma classe derivada se você quiser que seu aplicativo manipule uma alteração no foco de um elemento da faixa de opções.

CMFCRibbonBaseElement::OnShow

Chamado pela estrutura para mostrar ou ocultar o elemento da faixa de opções.

virtual void OnShow(BOOL bShow);

Parâmetros

bMostrar
[em] Este parâmetro não é usado.

Comentários

Por padrão, esse método não faz nada. Substitua esse método para mostrar ou ocultar o elemento da faixa de opções.

CMFCRibbonBaseElement::OnShowPopupMenu

Chamado pela estrutura antes do elemento da faixa de opções mostra um menu pop-up.

virtual void OnShowPopupMenu();

Comentários

Esse método notifica a janela pai da barra da faixa de opções de que o elemento da faixa de opções mostrará um menu pop-up.

CMFCRibbonBaseElement::P ostMenuCommand

Fecha o menu pop-up do elemento da faixa de opções e envia uma mensagem de fechamento para o menu pai.

void PostMenuCommand(UINT uiCmdId);

Parâmetros

uiCmdId
[em] O parâmetro não é usado.

Comentários

A mensagem de fechamento só será enviada se o elemento da faixa de opções estiver localizado em um menu pop-up.

CMFCRibbonBaseElement::Redesenhar

Atualiza a exibição do elemento da faixa de opções.

virtual void Redraw();

Comentários

Esse método redesenha o retângulo de exibição para o elemento da faixa de opções chamando CWnd::RedrawWindow com os sinalizadores RDW_INVALIDATE, RDW_ERASE e RDW_UPDATENOW definidos.

CMFCRibbonBaseElement::SetACCData

Define os dados de acessibilidade para o elemento da faixa de opções.

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

Parâmetros

pParent
A janela pai para o elemento da faixa de opções.

de dados
Os dados de acessibilidade para o elemento da faixa de opções.

Valor de retorno

Sempre retorna TRUE.

Comentários

Por padrão, esse método define os dados de acessibilidade para o elemento da faixa de opções e sempre retorna TRUE. Substitua esse método para definir os dados de acessibilidade e retornar um valor que indique sucesso ou falha.

CMFCRibbonBaseElement::SetCompactMode

Define o tamanho de exibição para o elemento da faixa de opções.

virtual void SetCompactMode(BOOL bCompactMode = TRUE);

Parâmetros

bCompactMode
[em] TRUE para reduzir o tamanho de exibição do elemento da faixa de opções; FALSE para aumentar o tamanho de exibição do elemento da faixa de opções.

Comentários

A tabela a seguir resume a lógica para esse método.

CMFCRibbonBaseElement::SetData

Associa um item de dados ao elemento da faixa de opções.

void SetData(DWORD_PTR dwData);

Parâmetros

dwData
[em] O valor dos dados.

CMFCRibbonBaseElement::SetDefaultMenuLook

Define o elemento da faixa de opções para aparecer como um comando pop-up.

void SetDefaultMenuLook(BOOL bIsDefaultMenuLook = TRUE);

Parâmetros

bIsDefaultMenuLook
[em] TRUE para definir o elemento da faixa de opções para aparecer como um comando pop-up; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::SetDescription

Define a descrição do elemento da faixa de opções.

virtual void SetDescription(LPCTSTR lpszText);

Parâmetros

lpszText
[em] A descrição do elemento da faixa de opções.

Comentários

A estrutura exibe a nova descrição na barra de status, na dica de ferramenta ou no botão de menu.

CMFCRibbonBaseElement::SetID

Define a ID do comando do elemento da faixa de opções.

virtual void SetID(UINT nID);

Parâmetros

nID
[em] O ID do comando.

CMFCRibbonBaseElement::SetInitialMode

Define o tamanho de exibição inicial para o elemento da faixa de opções.

virtual void SetInitialMode(BOOL bOneRow = FALSE);

Parâmetros

bOneRow
[em] TRUE para limitar o tamanho de exibição do elemento da faixa de opções para compacto ou intermediário; caso contrário, FALSE.

Comentários

O tamanho de exibição dos elementos da faixa de opções pode ser compacto, intermediário ou grande.

CMFCRibbonBaseElement::SetKeys

Define as dicas de teclas para o elemento da faixa de opções.

virtual void SetKeys(
    LPCTSTR lpszKeys,
    LPCTSTR lpszMenuKeys=NULL);

Parâmetros

lpszKeys
[em] A dica de tecla para o elemento da faixa de opções.

lpszMenuKeys
[em] A dica de tecla para o menu pop-up do elemento da faixa de opções.

CMFCRibbonBaseElement::SetOriginal

Define o elemento original da faixa de opções para o elemento da faixa de opções.

virtual void SetOriginal(CMFCRibbonBaseElement* pOriginal);

Parâmetros

pOriginal
[em] Ponteiro para um elemento da faixa de opções.

Comentários

Os elementos da faixa de opções copiados para outro contêiner mantêm um ponteiro para o elemento original da faixa de opções.

CMFCRibbonBaseElement::SetParentCategory

Define a categoria pai para o elemento da faixa de opções.

virtual void SetParentCategory(CMFCRibbonCategory* pParent);

Parâmetros

pParent
[em] Ponteiro para uma categoria de faixa de opções.

Comentários

Os grupos com guias nos controles da faixa de opções são chamados de categorias.

CMFCRibbonBaseElement::SetParentMenu

Define o contêiner de menu pai para o elemento da faixa de opções.

virtual void SetParentMenu(CMFCRibbonPanelMenuBar* pMenuBar);

Parâmetros

pMenuBar
[em] O menu pai.

Comentários

CMFCRibbonBaseElement::SetParentRibbonBar

Define a barra da faixa de opções pai para o elemento da faixa de opções.

virtual void SetParentRibbonBar(CMFCRibbonBar* pRibbonBar);

Parâmetros

pRibbonBar
[em] Ponteiro para a barra de faixa de opções pai.

Comentários

CMFCRibbonBaseElement::SetRect

Define as dimensões do retângulo de exibição para o elemento da faixa de opções.

void SetRect(CRect rect);

Parâmetros

rect
[em] As dimensões do retângulo.

Comentários

CMFCRibbonBaseElement::SetText

Define o texto e a dica de tecla para o elemento da faixa de opções.

virtual void SetText(LPCTSTR lpszText);

Parâmetros

lpszText
[em] O texto e a dica de tecla para o elemento da faixa de opções.

Comentários

Para definir a dica de tecla para o elemento da faixa de opções, acrescente a sequência de escape de nova linha seguida pelos caracteres de dica de tecla a lpszText.

Exemplo

//Set the text for the ribbon element
SetText(_T("Margins"))
//Set the text and a single-letter keytip
SetText(_T("Margins\nm"))
//Set the text and a multiple-letter keytip
SetText(_T("Line Numbers\nln"))

CMFCRibbonBaseElement::SetTextAlwaysOnRight

Define o texto para o elemento da faixa de opções a ser exibido à direita.

virtual void SetTextAlwaysOnRight(BOOL bSet = TRUE);

Parâmetros

bSet
[em] TRUE para exibir o texto à direita; caso contrário, FALSE.

Comentários

CMFCRibbonBaseElement::SetToolTipText

Define o texto da dica de ferramenta para o elemento da faixa de opções.

virtual void SetToolTipText(LPCTSTR lpszText);

Parâmetros

lpszText
[em] O texto da dica de ferramenta.

CMFCRibbonBaseElement::SetVisible

Define a visibilidade do elemento da faixa de opções.

void SetVisible(BOOL bIsVisible);

Parâmetros

bIsVisible
[em] TRUE para exibir o elemento da faixa de opções; FALSE para ocultar o elemento da faixa de opções.

Comentários

CMFCRibbonBaseElement::StretchHorizontally

Estende a largura do elemento da faixa de opções.

virtual void StretchHorizontally();

Comentários

Por padrão, esse método gera uma falha de asserção em compilações de depuração e, portanto, não deve ser chamado. Substitua esse método para esticar a largura do elemento da faixa de opções.

CMFCRibbonBaseElement::StretchToWholeRow

Altera a altura de exibição do elemento da faixa de opções para a altura da linha especificada.

virtual BOOL StretchToWholeRow(
    CDC* pDC,
    int nHeight);

Parâmetros

pDC
[em] Este parâmetro não é usado.

nAltura
[em] A altura da linha.

Valor de retorno

TRUE se a altura do visor foi definida; caso contrário, FALSE.

Comentários

Substitua esse método para alterar a altura de exibição do elemento da faixa de opções para a altura da linha especificada.

CMFCRibbonBaseElement::UpdateTooltipInfo

Atualiza o texto da dica de ferramenta usando o recurso de comando para o elemento da faixa de opções.

virtual void UpdateTooltipInfo();

Comentários

CMFCRibbonBaseElement::HasFocus

Indica se o elemento pai tem foco no teclado.

virtual BOOL HasFocus() const;

Valor de retorno

TRUE se o elemento da faixa de opções estiver focado; caso contrário, FALSE.

Comentários

Ver também

Gráfico de Hierarquia
Aulas