Classe CMFCRibbonBaseElement
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 de faixa de opções são botões de 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
| Nome | Descrição |
|---|---|
CMFCRibbonBaseElement |
Constrói um objeto CMFCRibbonBaseElement. |
Métodos públicos
| Nome | Descrição |
|---|---|
| CMFCRibbonBaseElement::AddToKeyList | Adiciona uma dica de tecla para o elemento de faixa de opções a uma matriz de dicas de tecla. |
| CMFCRibbonBaseElement::AddToListBox | Adiciona um elemento de faixa de opções à caixa de listagem de comandos de faixa de opções especificada. |
| CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar | Indica se o elemento de faixa de opções pode ser adicionado à barra de ferramentas de acesso rápido. |
| CMFCRibbonBaseElement::CanBeCompacted | Indica se o tamanho do elemento de faixa de opções pode ser compacto. |
| CMFCRibbonBaseElement::CanBeStretched | Indica se a altura do elemento de faixa de opções pode aumentar verticalmente até a altura de uma linha de faixa de opções. |
| CMFCRibbonBaseElement::CanBeStretchedHorizontally | Indica se a largura do elemento de faixa de opções pode ser alterada. |
| CMFCRibbonBaseElement::CleanUpSizes | Limpa as configurações de dimensão do elemento de faixa de opções. |
| CMFCRibbonBaseElement::ClosePopupMenu | Fecha o menu de item pop-up do elemento de faixa de opções. |
| CMFCRibbonBaseElement::CopyFrom | Copia o estado do CMFCRibbonBaseElement especificado para o objeto atual. |
| CMFCRibbonBaseElement::DestroyCtrl | Destrói o elemento de faixa de opções. |
| CMFCRibbonBaseElement::DrawImage | Desenha a imagem para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::Find | Retorna o ponteiro especificado para o elemento de faixa de opções se ele apontar para o objeto atual. |
| CMFCRibbonBaseElement::FindByData | Recupera um ponteiro para o elemento de faixa de opções se ele contiver os dados especificados. |
| CMFCRibbonBaseElement::FindByID | Recupera um ponteiro para o elemento de faixa de opções se esse elemento for identificado pela ID de comando especificada. |
| CMFCRibbonBaseElement::FindByOriginal | Recupera um ponteiro para o elemento de faixa de opções se seu elemento de faixa de opções original corresponder ao elemento de faixa de opções especificado. |
| CMFCRibbonBaseElement::GetCompactSize | Retorna o tamanho compacto do elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetData | Recupera os dados definidos pelo usuário associados ao elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetDescription | Retorna a descrição do elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetDroppedDown | Recupera um ponteiro para o elemento de faixa de opções se o menu de item pop-up for descartado. |
| CMFCRibbonBaseElement::GetElements | Adiciona o elemento de faixa de opções atual à matriz especificada. |
| CMFCRibbonBaseElement::GetElementsByID | Adiciona o elemento de faixa de opções atual à matriz especificada se o elemento de faixa de opções atual contiver a ID de comando especificada. |
| CMFCRibbonBaseElement::GetHighlighted | Recupera um ponteiro para o elemento de faixa de opções se ele estiver realçado. |
| CMFCRibbonBaseElement::GetID | Retorna a ID de comando do elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetImageSize | Retorna o tamanho da imagem do elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetIntermediateSize | Retorna o tamanho do elemento de faixa de opções em seu estado intermediário. |
| CMFCRibbonBaseElement::GetKeys | Retorna a dica de tecla associada ao elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetKeyTipRect | Recupera o retângulo delimitador da dica de tecla para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetKeyTipSize | Recupera o tamanho do texto da dica de tecla. |
| CMFCRibbonBaseElement::GetLocationInGroup | Indica o local de exibição do elemento de faixa de opções em um grupo de faixas de opções. |
| CMFCRibbonBaseElement::GetMenuKeys | Retorna as dica de tecla associadas a um botão. |
| CMFCRibbonBaseElement::GetNotifyID | Recupera a ID do comando de notificação para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetOriginal | Recupera o elemento de faixa de opções original. |
| CMFCRibbonBaseElement::GetParentCategory | Recupera a categoria de faixa de opções para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetParentPanel | Recupera o painel de faixa de opções que contém o elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetParentRibbonBar | Recupera a barra de faixa de opções pai para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetParentWnd | Recupera a janela pai do elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetPressed | Recupera um ponteiro para o elemento de faixa de opções se o usuário o pressionar no momento. |
| CMFCRibbonBaseElement::GetQuickAccessToolBarID | Recupera a ID de comando do elemento de faixa de opções quando ele está localizado na barra de ferramentas de acesso rápido. |
| CMFCRibbonBaseElement::GetRect | Retorna o retângulo delimitador do elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetRegularSize | Retorna o tamanho regular do elemento da faixa de opções. |
| CMFCRibbonBaseElement::GetSize | Retorna o tamanho atual do elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetText | Retorna o texto associado ao elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetToolTipText | Retorna o texto da dica de ferramenta do elemento de faixa de opções. |
| CMFCRibbonBaseElement::GetTopLevelRibbonBar | Recupera a barra de faixa de opções de nível superior para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::HasCompactMode | Especifica se o elemento de faixa de opções tem um modo compacto. |
| CMFCRibbonBaseElement::HasFocus | Indica se o elemento pai tem foco do teclado. |
| CMFCRibbonBaseElement::HasIntermediateMode | Especifica se o elemento de faixa de opções tem um modo intermediário. |
| CMFCRibbonBaseElement::HasLargeMode | Especifica se o elemento de faixa de opções tem um modo grande. |
| CMFCRibbonBaseElement::HasMenu | Indica se o elemento de faixa de opções tem um menu. |
| CMFCRibbonBaseElement::HitTest | Recupera um ponteiro para o elemento de faixa de opções se o ponto especificado estiver localizado nele. |
| CMFCRibbonBaseElement::IsAlignByColumn | Indica se o elemento de faixa de opções está alinhado verticalmente com outros elementos de faixa de opções. |
| CMFCRibbonBaseElement::IsAlwaysLargeImage | Indica se o tamanho da imagem do elemento de faixa de opções é sempre grande. |
| CMFCRibbonBaseElement::IsAutoRepeatMode | Indica se o elemento de faixa de opções está no modo de repetição automática. |
| CMFCRibbonBaseElement::IsChecked | Especifica se o elemento de faixa de opções está selecionado. |
| CMFCRibbonBaseElement::IsCompactMode | Especifica se o elemento de faixa de opções está em um modo compacto. |
| CMFCRibbonBaseElement::IsDefaultMenuLook | |
| CMFCRibbonBaseElement::IsDisabled | Especifica se o elemento de faixa de opções está desabilitado. |
| CMFCRibbonBaseElement::IsDroppedDown | Determina se o elemento de faixa de opções exibe um menu de item pop-up e está suspenso. |
| CMFCRibbonBaseElement::IsFocused | Especifica se o elemento de faixa de opções tem o foco. |
| CMFCRibbonBaseElement::IsGalleryIcon | Indica se o elemento de faixa de opções está contido em uma galeria de faixas de opções. |
| CMFCRibbonBaseElement::IsHighlighted | Especifica se o elemento de faixa de opções está realçado. |
| CMFCRibbonBaseElement::IsIntermediateMode | Indica se a imagem atual do elemento de faixa de opções é de tamanho intermediário. |
| CMFCRibbonBaseElement::IsLargeMode | Indica se a imagem atual do elemento de faixa de opções é de tamanho grande. |
| CMFCRibbonBaseElement::IsMenuMode | Indica se o elemento de faixa de opções está contido em um menu. |
| CMFCRibbonBaseElement::IsPressed | Indica se o usuário clicou no elemento de faixa de opções. |
| CMFCRibbonBaseElement::IsQATMode | Indica se o elemento de faixa de opções está contido na barra de ferramentas de acesso rápido. |
| CMFCRibbonBaseElement::IsSeparator | Indica se o elemento de faixa de opções é um separador de exibição. |
| CMFCRibbonBaseElement::IsShowGroupBorder | Indica se o elemento de faixa de opções está contido em um grupo que exibe uma borda comum. |
| CMFCRibbonBaseElement::IsShowTooltipOnBottom | Indica se a dica de ferramenta é exibida sob o elemento de faixa de opções. |
| CMFCRibbonBaseElement::IsTabStop | Indica se o elemento de faixa de opções pode ser selecionado com o teclado. |
| CMFCRibbonBaseElement::IsTextAlwaysOnRight | Indica se o texto do elemento de faixa de opções é exibido à direita. |
| CMFCRibbonBaseElement::IsVisible | Indica se o elemento de faixa de opções é exibido atualmente. |
| CMFCRibbonBaseElement::IsWholeRowHeight | Indica se a altura da exibição do elemento de faixa de opções é igual à altura de exibição do painel de faixa de opções que o contém. |
| CMFCRibbonBaseElement::NotifyCommand | Envia uma notificação de comando para a janela pai do elemento de faixa de opções. |
| CMFCRibbonBaseElement::NotifyHighlightListItem | Notifica a janela pai da barra de faixa de opções quando um usuário realça um elemento de faixa de opções localizado em uma lista. |
| CMFCRibbonBaseElement::OnAddToQAToolbar | Adiciona o elemento de faixa de opções à barra de ferramentas de acesso rápido especificada. |
| CMFCRibbonBaseElement::OnAfterChangeRect | Atualizações a dica de ferramenta para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::OnAutoRepeat | Atualiza o elemento de faixa de opções em resposta à entrada de usuário sustentada. |
| CMFCRibbonBaseElement::OnCalcTextSize | Calcula o tamanho do texto para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::OnChangeMenuHighlight | Chamado pela estrutura quando o realce é alterado para um elemento de faixa de opções localizado em um menu. |
| CMFCRibbonBaseElement::OnDraw | Chamado pela estrutura para desenhar o elemento da faixa de opções. |
| CMFCRibbonBaseElement::OnDrawKeyTip | Chamado pela estrutura para desenhar a dica de tecla para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::OnDrawMenuImage | Chamado pela estrutura quando a imagem do menu do elemento de faixa de opções é desenhada. |
| CMFCRibbonBaseElement::OnDrawOnList | Chamado pela estrutura para desenhar o elemento de faixa de opções em uma caixa de listagem de comandos. |
| CMFCRibbonBaseElement::OnKey | Chamado pela estrutura quando o usuário pressiona uma dica de tecla e o elemento de faixa de opções tem o foco. |
| CMFCRibbonBaseElement::OnMenuKey | |
| CMFCRibbonBaseElement::OnRTLChanged | Chamado pela estrutura quando o layout muda de direção. |
| CMFCRibbonBaseElement::OnShow | Chamado pela estrutura para mostrar ou ocultar o elemento de faixa de opções. |
| CMFCRibbonBaseElement::OnShowPopupMenu | Chamado pela estrutura quando o elemento de faixa de opções exibirá um menu de item pop-up. |
| CMFCRibbonBaseElement::PostMenuCommand | |
| CMFCRibbonBaseElement::Redraw | Atualiza a exibição do elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetACCData | Define os dados de acessibilidade para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetCompactMode | Define o tamanho de exibição para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetData | Associa um item de dados ao elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetDefaultMenuLook | |
| CMFCRibbonBaseElement::SetDescription | Define a descrição do elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetID | Define a ID de comando do elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetInitialMode | Define o tamanho de exibição inicial para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetKeys | Define uma dica de tecla para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetOriginal | Define o elemento de faixa de opções original para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetParentCategory | Define a categoria pai para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetParentMenu | Define o contêiner de menu pai para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetParentRibbonBar | Define a barra de faixa de opções pai para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetRect | Define as dimensões do retângulo de exibição para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetText | Define o texto para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetTextAlwaysOnRight | Define o texto do elemento de faixa de opções a ser exibido à direita. |
| CMFCRibbonBaseElement::SetToolTipText | Define o texto da dica de ferramenta para o elemento de faixa de opções. |
| CMFCRibbonBaseElement::SetVisible | Define o estado de visibilidade do elemento de faixa de opções. |
| CMFCRibbonBaseElement::StretchHorizontally | Alonga a largura do elemento de faixa de opções. |
| CMFCRibbonBaseElement::StretchToWholeRow | Altera a altura de exibição do elemento de 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 de faixa de opções. |
Métodos protegidos
| Nome | Descrição |
|---|---|
| CMFCRibbonBaseElement::OnProcessKey | Chamado pela estrutura quando o usuário pressiona a tecla de atalho. |
| CMFCRibbonBaseElement::OnSetFocus | Chamado pela estrutura quando um elemento de faixa de opções recebe ou perde o foco de entrada. |
Comentários
A classe CMFCRibbonBaseElement define as propriedades que são comuns a todos os elementos de faixa de opções que incluem ID de comando, rótulo de texto, texto da dica de ferramenta, descrição do elemento e estado (que podem ser focados, realçados, pressionados, desabilitados, selecionados ou suspensos).
O tamanho da imagem de um elemento de faixa de opções é definido pelo membro RibbonImageType, que pode ser um dos seguintes valores:
RibbonImageLargeRibbonImageSmall
Dependendo de seu tamanho, um elemento de 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 do elemento de faixa de opções, definir o texto, definir uma dica de chave e definir o texto da dica de ferramenta para o elemento de faixa de opções. Esse snippet de código faz parte do exemplo Desenhar Cliente.
// 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
Requisitos
Cabeçalho: afxbaseribbonelement.h
CMFCRibbonBaseElement::AddToKeyList
Adiciona uma dica de tecla para o elemento de faixa de opções a uma matriz de dicas de tecla.
virtual void AddToKeyList(
CArray<CMFCRibbonKeyTip*, CMFCRibbonKeyTip*>& arElems);
Parâmetros
arElems
[in] Referência a uma CArray de dicas de tecla.
Comentários
Quando o recurso de dicas de tecla de faixa de opções está habilitado, a estrutura exibe as dicas de tecla de faixa de opções quando o usuário pressiona a tecla ALT ou a tecla F10.
CMFCRibbonBaseElement::AddToListBox
Adiciona um elemento de faixa de opções à caixa de listagem de comandos de faixa de opções especificada.
virtual int AddToListBox(
CMFCRibbonCommandsListBox* pWndListBox,
BOOL bDeep);
Parâmetros
pWndListBox
[in] Ponteiro para uma caixa de listagem de comandos.
bDeep
[in] Esse parâmetro não é usado.
Valor de retorno
O índice de base zero do elemento de faixa de opções adicionado.
Comentários
A estrutura adiciona elementos de 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 de 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 de faixa de opções pode ser compacto.
virtual BOOL CanBeCompacted() const;
Valor de retorno
TRUE se o tamanho do elemento de faixa de opções puder ser compacto. Caso contrário, FALSE.
Comentários
O tamanho de um elemento de faixa de opções pode ser compacto, intermediário ou grande.
CMFCRibbonBaseElement::CanBeStretched
Indica se a altura do elemento de faixa de opções pode aumentar verticalmente até a altura de uma linha de 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 de faixa de opções pode aumentar verticalmente até a altura de uma linha de faixa de opções.
CMFCRibbonBaseElement::CanBeStretchedHorizontally
Indica se a largura do elemento de 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 de faixa de opções pode ser alterada.
CMFCRibbonBaseElement::CleanUpSizes
Limpa as configurações de dimensão do elemento de 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 do elemento de faixa de opções.
CMFCRibbonBaseElement::ClosePopupMenu
Fecha o menu de item pop-up do elemento de faixa de opções.
virtual void ClosePopupMenu();
Comentários
CMFCRibbonBaseElement::CopyFrom
Copia o estado do CMFCRibbonBaseElement especificado para o objeto atual.
virtual void CopyFrom(const CMFCRibbonBaseElement& src);
Parâmetros
src
[in] O objeto CMFCRibbonBaseElement de origem.
Comentários
CMFCRibbonBaseElement::DestroyCtrl
Destrói o elemento de faixa de opções.
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 de faixa de opções.
CMFCRibbonBaseElement::DrawImage
Desenha a imagem para o elemento de faixa de opções.
virtual void DrawImage(
CDC* pDC,
RibbonImageType type,
CRect rectImage);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo.
tipo
[in] Um valor enumerado de tipo de imagem. Consulte a seção Comentários para obter uma lista de valores possíveis.
rectImage
[in] 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 arrastas a imagem para o elemento de faixa de opções.
A tabela a seguir lista os possíveis valores do parâmetro type:
| Valor | Descrição |
|---|---|
RibbonImageLarge |
Tamanho de imagem grande de 32x32 pixels. |
RibbonImageSmall |
Tamanho de imagem pequeno de 16x16 pixels. |
CMFCRibbonBaseElement::Find
Retorna o ponteiro especificado se ele apontar para o objeto atual.
virtual CMFCRibbonBaseElement* Find(const CMFCRibbonBaseElement* pElement);
Parâmetros
pElement
[in] Ponteiro para um elemento de faixa de opções.
Valor de retorno
Um ponteiro para o elemento de 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 de faixa de opções se ele contiver os dados especificados.
virtual CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData);
Parâmetros
dwData
[in] Os dados associados a um elemento de faixa de opções.
Valor de retorno
Um ponteiro para o elemento de faixa de opções se ele contiver os dados especificados, caso contrário, NULL.
Comentários
CMFCRibbonBaseElement::FindByID
Recupera um ponteiro para o elemento de faixa de opções se esse elemento for identificado pela ID de comando especificada.
virtual CMFCRibbonBaseElement* FindByID(UINT uiCmdID);
Parâmetros
uiCmdID
[in] ID de comando para um elemento de faixa de opções.
Valor de retorno
Um ponteiro para o elemento de 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 de faixa de opções atual se seu elemento de faixa de opções original corresponder ao elemento de faixa de opções especificado.
virtual CMFCRibbonBaseElement* FindByOriginal(CMFCRibbonBaseElement* pOriginal);
Parâmetros
pOriginal
[in] Ponteiro para um elemento de faixa de opções.
Valor de retorno
Um ponteiro para o elemento de faixa de opções se seu elemento de faixa de opções original corresponder ao elemento de faixa de opções especificado, caso contrário, NULL.
Comentários
Os elementos de faixa de opções copiados para outro contêiner retêm um ponteiro para o elemento de faixa de opções original.
CMFCRibbonBaseElement::GetCompactSize
Retorna o tamanho compacto do elemento de faixa de opções.
virtual CSize GetCompactSize(CDC* pDC);
Parâmetros
pDC
[in] Um ponteiro para um contexto de dispositivo.
Valor de retorno
O tamanho compacto de um elemento de faixa de opções.
Observação
O tamanho compacto significa que o elemento de faixa de opções é truncado (exibe uma imagem pequena ou uma imagem sem texto).
CMFCRibbonBaseElement::GetData
Recupera os dados definidos pelo usuário associados ao elemento de faixa de opções.
DWORD_PTR GetData() const;
Valor de retorno
Os dados definidos pelo usuário associados ao elemento de faixa de opções.
CMFCRibbonBaseElement::GetDescription
Retorna a descrição do elemento de faixa de opções.
virtual CString GetDescription() const;
Valor de retorno
A descrição do elemento de faixa de opções. A descrição será exibida na barra de status, em uma dica de ferramenta ou no botão de menu se o elemento de faixa de opções estiver localizado na Classe CMFCRibbonMainPanel.
CMFCRibbonBaseElement::GetDroppedDown
Recupera um ponteiro para o elemento de faixa de opções se o menu de item pop-up for descartado.
virtual CMFCRibbonBaseElement* GetDroppedDown();
Valor de retorno
Um ponteiro para o elemento de faixa de opções se o menu de item pop-up for suspenso, caso contrário, NULL.
Comentários
CMFCRibbonBaseElement::GetElements
Adiciona o elemento de faixa de opções atual à matriz especificada.
virtual void GetElements(
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Parâmetros
arElements
[in, out] Uma matriz de elementos de faixa de opções.
Comentários
CMFCRibbonBaseElement::GetElementsByID
Adiciona o elemento de faixa de opções atual à matriz especificada se o elemento de faixa de opções atual contiver a ID de comando especificada.
virtual void GetElementsByID(
UINT uiCmdID,
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Parâmetros
uiCmdID
[in] ID de comando de um elemento de faixa de opções.
arElements
[in] Uma matriz de elementos de faixa de opções.
Comentários
CMFCRibbonBaseElement::GetHighlighted
Recupera um ponteiro para o elemento de faixa de opções se ele estiver realçado.
virtual CMFCRibbonBaseElement* GetHighlighted();
Valor de retorno
Um ponteiro para o elemento de faixa de opções se ele estiver realçado, caso contrário, NULL.
Comentários
CMFCRibbonBaseElement::GetID
Retorna a ID de comando do elemento de faixa de opções.
UINT GetID() const;
Valor de retorno
A ID de comando do elemento de faixa de opções.
CMFCRibbonBaseElement::GetImageSize
Retorna o tamanho da imagem do elemento de faixa de opções.
virtual CSize GetImageSize(RibbonImageType R) const;
Valor de retorno
O tamanho da imagem do elemento de faixa de opções.
CMFCRibbonBaseElement::GetIntermediateSize
Retorna o tamanho do elemento de faixa de opções em seu estado intermediário.
virtual CSize GetIntermediateSize(CDC* pDC);
Parâmetros
pDC
[in] Um ponteiro para um contexto de dispositivo.
Valor de retorno
O tamanho do elemento de faixa de opções em seu estado intermediário.
CMFCRibbonBaseElement::GetKeys
Retorna a dica de tecla associada ao elemento de faixa de opções.
LPCTSTR GetKeys() const;
Valor de retorno
A dica de tecla associada ao elemento de faixa de opções.
CMFCRibbonBaseElement::GetKeyTipRect
Recupera o retângulo delimitador da dica de tecla para o elemento de faixa de opções.
virtual CRect GetKeyTipRect(
CDC* pDC,
BOOL bIsMenu);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo.
bIsMenu
[in] TRUE se o elemento de faixa de opções exibir um menu de item pop-up, caso contrário, FALSE.
Valor de retorno
Sempre retorna um retângulo com valores 0.
Comentários
Substitua esse método em uma classe derivada para retornar o retângulo delimitador da dica de tecla.
CMFCRibbonBaseElement::GetKeyTipSize
Recupera o tamanho do texto da dica de tecla.
virtual CSize GetKeyTipSize(CDC* pDC);
Parâmetros
pDC
[in] 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 de faixa de opções em um grupo de faixas de opções.
RibbonElementLocation GetLocationInGroup() const;
Valor de retorno
Um valor enumerado de RibbonElementLocation. A seguinte tabela lista os possíveis valores.
| Valor | Descrição |
|---|---|
RibbonElementNotInGroup |
O elemento de faixa de opções não está contido em um grupo de faixas de opções. |
RibbonElementSingleInGroup |
O elemento de faixa de opções é exibido como o único item em um grupo de faixa de opções. |
RibbonElementFirstInGroup |
O elemento de faixa de opções é exibido na extremidade esquerda de um grupo de faixas de opções. |
RibbonElementLastInGroup |
O elemento de faixa de opções é exibido na extremidade direita de um grupo de faixas de opções. |
RibbonElementMiddleInGroup |
O elemento de faixa de opções não é exibido em nenhuma das extremidades de um grupo de faixas de opções. |
Comentários
Os grupos de elementos de faixa de opções são alinhados somente horizontalmente.
CMFCRibbonBaseElement::GetMenuKeys
Retorna a dica de tecla de menu para o elemento de faixa de opções.
LPCTSTR GetMenuKeys() const;
Valor de retorno
A dica de tecla de menu associada ao elemento de faixa de opções.
Comentários
Quando invocada, uma dica de tecla de menu exibe um menu de item pop-up.
CMFCRibbonBaseElement::GetNotifyID
Recupera a ID do comando de notificação para o elemento de faixa de opções.
virtual UINT GetNotifyID();
Valor de retorno
A ID do comando de notificação.
Comentários
CMFCRibbonBaseElement::GetOriginal
Recupera o elemento de faixa de opções original.
CMFCRibbonBaseElement* GetOriginal() const;
Valor de retorno
Um ponteiro para o elemento de faixa de opções original.
Comentários
Os elementos de faixa de opções copiados para outro contêiner retêm um ponteiro para o elemento de faixa de opções original.
CMFCRibbonBaseElement::GetParentCategory
Recupera a categoria de faixa de opções para o elemento de faixa de opções.
CMFCRibbonCategory* GetParentCategory() const;
Valor de retorno
Um ponteiro para a categoria de faixa de opções.
Comentários
CMFCRibbonBaseElement::GetParentPanel
Recupera o painel de faixa de opções que contém o elemento de faixa de opções.
virtual CMFCRibbonPanel* GetParentPanel() const;
Valor de retorno
O painel de faixa de opções que contém o elemento de faixa de opções.
Comentários
CMFCRibbonBaseElement::GetParentRibbonBar
Recupera a barra de faixa de opções pai para o elemento de faixa de opções.
CMFCRibbonBar* GetParentRibbonBar() const;
Valor de retorno
Um ponteiro para a barra de faixa de opções pai para o elemento de faixa de opções.
Comentários
CMFCRibbonBaseElement::GetParentWnd
Recupera a janela pai do elemento de faixa de opções.
virtual CWnd* GetParentWnd() const;
Valor de retorno
Um ponteiro para a janela pai do elemento de faixa de opções se o método foi bem-sucedido, caso contrário, NULL.
Comentários
A janela pai de um elemento de faixa de opções é uma Classe CMFCRibbonBar ou um CMFCRibbonPanelMenuBar.
CMFCRibbonBaseElement::GetPressed
Recupera um ponteiro para o elemento de faixa de opções se o usuário o pressionar no momento.
virtual CMFCRibbonBaseElement* GetPressed();
Valor de retorno
Um ponteiro para o elemento de faixa de opções se o usuário o pressionar no momento, caso contrário, NULL.
Comentários
CMFCRibbonBaseElement::GetQuickAccessToolBarID
Recupera a ID de comando do elemento de faixa de opções quando ele está localizado na barra de ferramentas de acesso rápido.
virtual UINT GetQuickAccessToolBarID() const;
Valor de retorno
A ID de comando do elemento de 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 de faixa de opções.
CRect GetRect() const;
Valor de retorno
O retângulo delimitador do elemento de faixa de opções. A posição do retângulo está nas coordenadas do controle de faixa de Opções pai.
CMFCRibbonBaseElement::GetRegularSize
Retorna o tamanho regular do elemento da faixa de opções.
virtual CSize GetRegularSize(CDC* pDC) = 0;
Parâmetros
pDC
[in] Um ponteiro para um contexto de dispositivo.
Valor de retorno
O tamanho normal do elemento de faixa de opções.
Comentários
Observação
O tamanho normal é o tamanho máximo possível do elemento de faixa de opções.
CMFCRibbonBaseElement::GetSize
Retorna o tamanho atual do elemento de faixa de opções.
virtual CSize GetSize(CDC* pDC);
Parâmetros
pDC
[in] Um ponteiro para um contexto de dispositivo.
Valor de retorno
O tamanho atual do elemento de faixa de opções.
CMFCRibbonBaseElement::GetText
Retorna o texto associado ao elemento de faixa de opções.
LPCTSTR GetText() const;
Valor de retorno
O texto associado ao elemento de faixa de opções.
CMFCRibbonBaseElement::GetToolTipText
Retorna o texto da dica de ferramenta do elemento de faixa de opções.
virtual CString GetToolTipText() const;
Valor de retorno
O texto da dica de ferramenta do elemento de faixa de opções.
CMFCRibbonBaseElement::GetTopLevelRibbonBar
Recupera a barra de faixa de opções de nível superior para o elemento de faixa de opções.
CMFCRibbonBar* GetTopLevelRibbonBar() const;
Valor de retorno
Um ponteiro para a barra de faixa de opções de nível superior do elemento de faixa de opções se o método foi bem-sucedido, caso contrário, NULL.
Comentários
CMFCRibbonBaseElement::HasCompactMode
Especifica se o elemento de faixa de opções tem um modo compacto.
virtual BOOL HasCompactMode() const;
Valor de retorno
TRUE se o elemento de faixa de opções tiver um modo compacto. Caso contrário, FALSE.
Comentários
Observação
No modo compacto, um elemento exibe apenas uma imagem pequena.
CMFCRibbonBaseElement::HasIntermediateMode
Especifica se o elemento de faixa de opções tem um modo intermediário.
virtual BOOL HasIntermediateMode() const;
Valor de retorno
TRUE se o elemento de faixa de opções tiver um modo intermediário. Caso contrário, FALSE. No modo intermediário, um elemento exibe uma imagem pequena e um texto à direita da imagem.
Comentários
CMFCRibbonBaseElement::HasLargeMode
Determina se o elemento de faixa de opções tem um modo grande.
virtual BOOL HasLargeMode() const;
Valor de retorno
TRUE se o elemento de faixa de opções tiver um modo grande. Caso contrário, FALSE.
Comentários
No modo grande, um elemento pode ter a altura total do painel pai.
CMFCRibbonBaseElement::HasMenu
Indica se o elemento de 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 de faixa de opções tem um menu.
CMFCRibbonBaseElement::HitTest
Recupera um ponteiro para o elemento de faixa de opções se o ponto especificado estiver localizado nele.
virtual CMFCRibbonBaseElement* HitTest(CPoint point);
Parâmetros
point
[in] Esse parâmetro não é usado.
Valor de retorno
Um ponteiro para o elemento de 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 de faixa de opções quando ele existe. Substitua esse método para indicar se o ponto reside no elemento de faixa de opções.
CMFCRibbonBaseElement::IsAlignByColumn
Indica se o elemento de faixa de opções está alinhado verticalmente com outros elementos de 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 de faixa de opções derivada está alinhado verticalmente com outros elementos de faixa de opções.
CMFCRibbonBaseElement::IsAlwaysLargeImage
Indica se o tamanho da imagem do elemento de faixa de opções é sempre grande.
virtual BOOL IsAlwaysLargeImage() const;
Valor de retorno
TRUE se o tamanho da imagem do elemento de faixa de opções sempre for grande. Caso contrário, FALSE.
Comentários
O tamanho de imagem grande é de 32x32 pixels.
CMFCRibbonBaseElement::IsAutoRepeatMode
Indica se o elemento de faixa de opções está no modo de repetição automática.
virtual BOOL IsAutoRepeatMode(int& nDelay) const;
Parâmetros
nDelay
[in] Esse 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 de faixa de opções está no modo de repetição automática.
No modo de repetição automática, o elemento de faixa de opções responde em um intervalo definido, medido em milissegundos, para entrada de usuário sustentada.
CMFCRibbonBaseElement::IsChecked
Especifica se o elemento de faixa de opções está selecionado.
virtual BOOL IsChecked() const;
Valor de retorno
TRUE se o elemento de faixa de opções for verificado. Caso contrário, FALSE.
CMFCRibbonBaseElement::IsCompactMode
Especifica se o elemento de faixa de opções está em um modo compacto.
BOOL IsCompactMode() const;
Valor de retorno
TRUE se o elemento de faixa de opções estiver em um modo compacto. Caso contrário, FALSE.
CMFCRibbonBaseElement::IsDefaultMenuLook
Indica se o elemento de faixa de opções está definido para aparecer como um comando de item pop-up.
BOOL IsDefaultMenuLook() const;
Valor de retorno
TRUE se o elemento de faixa de opções estiver definido para aparecer como um comando de item pop-up. Caso contrário, FALSE.
Comentários
CMFCRibbonBaseElement::IsDisabled
Especifica se o elemento de faixa de opções está desabilitado.
virtual BOOL IsDisabled() const;
Valor de retorno
TRUE se o elemento de faixa de opções estiver desabilitado. Caso contrário, FALSE.
CMFCRibbonBaseElement::IsDroppedDown
Especifica se o elemento de faixa de opções exibe um menu de item pop-up e está suspenso.
virtual BOOL IsDroppedDown() const;
Valor de retorno
TRUE se o elemento de faixa de opções está suspenso e exibe um menu de item pop-up. Caso contrário, FALSE.
CMFCRibbonBaseElement::IsFocused
Especifica se o elemento de faixa de opções tem o foco.
virtual BOOL IsFocused() const;
Valor de retorno
TRUE se o elemento de faixa de opções tiver o foco. Caso contrário, FALSE.
CMFCRibbonBaseElement::IsGalleryIcon
Indica se o elemento de faixa de opções está contido em uma galeria de faixas 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 de faixa de opções está contido em uma galeria de faixas de opções.
CMFCRibbonBaseElement::IsHighlighted
Especifica se o elemento de faixa de opções está realçado.
virtual BOOL IsHighlighted() const;
Valor de retorno
TRUE se o elemento de faixa de opções estiver realçado. Caso contrário, FALSE.
Comentários
CMFCRibbonBaseElement::IsIntermediateMode
Indica se a imagem atual do elemento de faixa de opções é de tamanho intermediário.
BOOL IsIntermediateMode() const;
Valor de retorno
TRUE se a imagem do elemento de faixa de opções for de tamanho intermediário. Caso contrário, FALSE.
Comentários
O tamanho de imagem intermediário é de 16x16 pixels.
CMFCRibbonBaseElement::IsLargeMode
Indica se a imagem atual do elemento de faixa de opções é de tamanho grande.
BOOL IsLargeMode() const;
Valor de retorno
TRUE se a imagem do elemento de faixa de opções for de tamanho grande. Caso contrário, FALSE.
Comentários
O tamanho de imagem grande é de 32x32 pixels.
CMFCRibbonBaseElement::IsMenuMode
Indica se o elemento de faixa de opções está contido em um menu.
BOOL IsMenuMode() const;
Valor de retorno
TRUE se o elemento de 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 de faixa de opções.
virtual BOOL IsPressed() const;
Valor de retorno
TRUE se o usuário tiver clicado no elemento de faixa de opções;. Caso contrário, FALSE.
CMFCRibbonBaseElement::IsQATMode
Indica se o elemento de faixa de opções está contido na barra de ferramentas de acesso rápido.
BOOL IsQATMode() const;
Valor de retorno
TRUE se o elemento de 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 de faixa de opções é um separador de exibição.
virtual BOOL IsSeparator() const;
Valor de retorno
TRUE se o elemento de faixa de opções for um separador de exibição. Caso contrário, FALSE.
Comentários
CMFCRibbonBaseElement::IsShowGroupBorder
Indica se o elemento de faixa de opções está contido em um grupo que exibe uma borda comum.
BOOL IsShowGroupBorder() const;
Valor de retorno
TRUE se o elemento de faixa de opções está 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 de faixa de opções.
virtual BOOL IsShowTooltipOnBottom() const;
Valor de retorno
TRUE se a dica de ferramenta for exibida sob o elemento de faixa de opções e FALSE se a dica de ferramenta for exibida perto do ponteiro.
Comentários
CMFCRibbonBaseElement::IsTabStop
Indica se o elemento de 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 de faixa de opções pode ser selecionado a partir do teclado.
CMFCRibbonBaseElement::IsTextAlwaysOnRight
Indica se o texto do elemento de faixa de opções é exibido à direita.
BOOL IsTextAlwaysOnRight() const;
Valor de retorno
TRUE se o texto do elemento de faixa de opções for exibido à direita. Caso contrário, FALSE.
Comentários
CMFCRibbonBaseElement::IsVisible
Indica se o elemento de faixa de opções é exibido atualmente.
BOOL IsVisible() const;
Valor de retorno
TRUE se o elemento de faixa de opções for exibido no momento. Caso contrário, FALSE.
Comentários
CMFCRibbonBaseElement::IsWholeRowHeight
Indica se a altura da exibição do elemento de faixa de opções é igual à altura de exibição do painel de faixa de opções que o contém.
virtual BOOL IsWholeRowHeight() const;
Valor de retorno
Sempre retorna FALSE.
Comentários
Por padrão, esse método sempre retorna FALSE. Substituir esse mesma para indicar se a altura da exibição do elemento de faixa de opções é igual à altura de exibição do painel de faixa de opções que o contém.
CMFCRibbonBaseElement::NotifyCommand
Envia uma notificação de comando para a janela pai do elemento de faixa de opções.
BOOL NotifyCommand(BOOL bWithDelay = FALSE);
Parâmetros
bWithDelay
[in] TRUE para adicionar a notificação de comando à fila de mensagens da janela pai e 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 de faixa de opções quando um usuário realça um elemento de faixa de opções localizado em uma lista.
virtual void NotifyHighlightListItem(int nIndex);
Parâmetros
nIndex
[in] O índice do elemento de faixa de opções na lista.
Comentários
CMFCRibbonBaseElement::OnAddToQAToolbar
Adiciona o elemento de faixa de opções à barra de ferramentas de acesso rápido especificada.
virtual BOOL OnAddToQAToolbar(CMFCRibbonQuickAccessToolBar& qat);
Parâmetros
qat
[in] A barra de ferramentas de acesso rápido.
Valor de retorno
Sempre retorna TRUE indicando que o elemento de faixa de opções foi adicionado à barra de ferramentas de acesso rápido.
Comentários
CMFCRibbonBaseElement::OnAfterChangeRect
Atualizações a dica de ferramenta para o elemento de faixa de opções.
virtual void OnAfterChangeRect(CDC* pDC);
Parâmetros
pDC
[in] Esse parâmetro não é usado.
Comentários
Por padrão, esse método atualiza a dica de ferramenta para o elemento de faixa de opções. Substitua esse método para atualizar o elemento de faixa de opções após a alteração do retângulo de exibição.
CMFCRibbonBaseElement::OnAutoRepeat
Atualiza o elemento de faixa de opções em resposta à entrada de usuário sustentada.
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 de usuário sustentada.
CMFCRibbonBaseElement::OnCalcTextSize
Calcula o tamanho do texto para o elemento de faixa de opções.
virtual void OnCalcTextSize(CDC* pDC);
Parâmetros
pDC
[in] Esse 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 de faixa de opções.
CMFCRibbonBaseElement::OnChangeMenuHighlight
Chamado pela estrutura quando o realce é alterado para um elemento de faixa de opções localizado em um menu.
virtual void OnChangeMenuHighlight(CMFCRibbonPanelMenuBar* pPanelMenuBar
CMFCRibbonBaseElement* pHot);
Parâmetros
pPanelMenuBar
[in] Esse parâmetro não é usado.
pHot
[in] Esse 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 de faixa de opções localizado em um menu quando o realce for alterado.
CMFCRibbonBaseElement::OnDraw
Chamado pela estrutura para desenhar o elemento da faixa de opções.
virtual void OnDraw(CDC* pDC) = 0;
Parâmetros
pDC
[in] Um ponteiro para um contexto de dispositivo.
Comentários
Substitua esse método em uma classe derivada se você quiser personalizar o desenho de um elemento de faixa de opções específico.
CMFCRibbonBaseElement::OnDrawKeyTip
Chamado pela estrutura para desenhar a dica de tecla para o elemento de faixa de opções.
virtual void OnDrawKeyTip(
CDC* pDC,
const CRect& rect,
BOOL bIsMenu);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo.
rect
[in] Retângulo delimitador para a dica de tecla.
bIsMenu
[in] TRUE se a dica de tecla for para um botão de menu de item pop-up. Caso contrário, FALSE.
Comentários
CMFCRibbonBaseElement::OnDrawMenuImage
Chamado pela estrutura quando a imagem do menu do elemento de faixa de opções é desenhada.
virtual BOOL OnDrawMenuImage(
CDC* pDC,
CRect rect);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo.
rect
[in] Retângulo da imagem de 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 de 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
[in] Ponteiro para um contexto de dispositivo para o elemento de faixa de opções.
strText
[in] O texto de exibição.
nTextOffset
[in] Distância, em pixels, do lado esquerdo da caixa de listagem até o texto de exibição.
rect
[in] O retângulo de exibição para o elemento de faixa de opções.
bIsSelected
[in] Esse parâmetro não é usado.
bHighlighted
[in] Esse parâmetro não é usado.
Comentários
A caixa de listagem de comandos exibe elementos de 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 de faixa de opções tem o foco.
virtual BOOL OnKey(BOOL bIsMenuKey);
Parâmetros
bIsMenuKey
[in] TRUE se a dica de tecla exibir um menu de item pop-up. Caso contrário, FALSE.
Valor de retorno
TRUE se o evento tiver sido tratado. 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
[in] Esse 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 a tecla de atalho.
virtual BOOL OnProcessKey(UINT nChar);
Parâmetros
nChar
[in] Esse parâmetro não é usado.
Valor de retorno
Sempre retorna FALSE.
Comentários
Substitua esse método se você desejar que o elemento de 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
[in] Esse 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 de faixa de opções quando o layout mudar de direção. A direção de layout padrão é da esquerda para a direita.
CMFCRibbonBaseElement::OnSetFocus
Chamado pela estrutura quando um elemento de 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ê desejar que seu aplicativo trate uma alteração no foco de um elemento de faixa de opções.
CMFCRibbonBaseElement::OnShow
Chamado pela estrutura para mostrar ou ocultar o elemento de faixa de opções.
virtual void OnShow(BOOL bShow);
Parâmetros
bShow
[in] Esse 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 de faixa de opções.
CMFCRibbonBaseElement::OnShowPopupMenu
Chamado pela estrutura antes que o elemento de faixa de opções mostre um menu item de pop-up.
virtual void OnShowPopupMenu();
Comentários
Esse método notifica a janela pai da barra de faixa de opções que o elemento de faixa de opções mostrará um menu de item pop-up.
CMFCRibbonBaseElement::PostMenuCommand
Fecha o menu de item pop-up do elemento de faixa de opções e envia uma mensagem de fechamento para o menu pai.
void PostMenuCommand(UINT uiCmdId);
Parâmetros
uiCmdId
[in] O parâmetro não é usado.
Comentários
A mensagem de fechamento só será enviada se o elemento de faixa de opções estiver localizado em um menu de item pop-up.
CMFCRibbonBaseElement::Redraw
Atualiza a exibição do elemento de faixa de opções.
virtual void Redraw();
Comentários
Esse método redesenha o retângulo de exibição para o elemento de 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 de faixa de opções.
virtual BOOL SetACCData(
CWnd* pParent,
CAccessibilityData& data);
Parâmetros
pParent
A janela pai do elemento de faixa de opções.
data
Os dados de acessibilidade para o elemento de 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 de faixa de opções e sempre retorna TRUE. Substitua esse método para definir os dados de acessibilidade e retornar um valor que indique êxito ou falha.
CMFCRibbonBaseElement::SetCompactMode
Define o tamanho de exibição para o elemento de faixa de opções.
virtual void SetCompactMode(BOOL bCompactMode = TRUE);
Parâmetros
bCompactMode
[in] TRUE para reduzir o tamanho de exibição do elemento de faixa de opções e FALSE para aumentar o tamanho de exibição do elemento de faixa de opções.
Comentários
A tabela a seguir resume a lógica para esse método.
| bCompactMode | Tamanho do elemento de faixa de opções atual | Tamanho do elemento de faixa de opções novo |
|---|---|---|
| TRUE | Compacto | Nenhuma alteração. |
| TRUE | Intermediário | Compacto, se for possível. |
| TRUE | grande | Intermediário, se for possível. |
| FALSE | Compacto | Intermediário, se for possível. Caso contrário, grande. |
CMFCRibbonBaseElement::SetData
Associa um item de dados ao elemento de faixa de opções.
void SetData(DWORD_PTR dwData);
Parâmetros
dwData
[in] O valor dos dados.
CMFCRibbonBaseElement::SetDefaultMenuLook
Define o elemento de faixa de opções a ser exibido como um comando de item pop-up.
void SetDefaultMenuLook(BOOL bIsDefaultMenuLook = TRUE);
Parâmetros
bIsDefaultMenuLook
[in] TRUE para definir que o elemento de faixa de opções apareça como um comando de item pop-up. Caso contrário, FALSE.
Comentários
CMFCRibbonBaseElement::SetDescription
Define a descrição do elemento de faixa de opções.
virtual void SetDescription(LPCTSTR lpszText);
Parâmetros
lpszTexto
A descrição do elemento de 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 de comando do elemento de faixa de opções.
virtual void SetID(UINT nID);
Parâmetros
Nid
[in] A ID de comando.
CMFCRibbonBaseElement::SetInitialMode
Define o tamanho de exibição inicial para o elemento de faixa de opções.
virtual void SetInitialMode(BOOL bOneRow = FALSE);
Parâmetros
bOneRow
[in] TRUE para limitar o tamanho da exibição do elemento de faixa de opções como compacto ou intermediário. Caso contrário, FALSE.
Comentários
O tamanho de exibição dos elementos de faixa de opções pode ser compacto, intermediário ou grande.
CMFCRibbonBaseElement::SetKeys
Define as dicas de tecla para o elemento de faixa de opções.
virtual void SetKeys(
LPCTSTR lpszKeys,
LPCTSTR lpszMenuKeys=NULL);
Parâmetros
lpszKeys
[in] A dica de tecla para o elemento de faixa de opções.
lpszMenuKeys
[in] A dica de tecla para o menu de item pop-up do elemento de faixa de opções.
CMFCRibbonBaseElement::SetOriginal
Define o elemento de faixa de opções original para o elemento de faixa de opções.
virtual void SetOriginal(CMFCRibbonBaseElement* pOriginal);
Parâmetros
pOriginal
[in] Ponteiro para um elemento de faixa de opções.
Comentários
Os elementos de faixa de opções copiados para outro contêiner retêm um ponteiro para o elemento de faixa de opções original.
CMFCRibbonBaseElement::SetParentCategory
Define a categoria pai para o elemento de faixa de opções.
virtual void SetParentCategory(CMFCRibbonCategory* pParent);
Parâmetros
pParent
[in] Ponteiro para uma categoria de faixa de opções.
Comentários
Os grupos com guias em controles de faixa de opções são chamados de categorias.
CMFCRibbonBaseElement::SetParentMenu
Define o contêiner de menu pai para o elemento de faixa de opções.
virtual void SetParentMenu(CMFCRibbonPanelMenuBar* pMenuBar);
Parâmetros
pMenuBar
[in] O menu pai.
Comentários
CMFCRibbonBaseElement::SetParentRibbonBar
Define a barra de faixa de opções pai para o elemento de faixa de opções.
virtual void SetParentRibbonBar(CMFCRibbonBar* pRibbonBar);
Parâmetros
pRibbonBar
[in] 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 de faixa de opções.
void SetRect(CRect rect);
Parâmetros
rect
[in] As dimensões do retângulo.
Comentários
CMFCRibbonBaseElement::SetText
Define o texto e a dica de tecla para o elemento de faixa de opções.
virtual void SetText(LPCTSTR lpszText);
Parâmetros
lpszTexto
[in] O texto e a dica de tecla para o elemento de faixa de opções.
Comentários
Para definir a dica de tecla para o elemento de faixa de opções, anexe 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 do elemento de faixa de opções a ser exibido à direita.
virtual void SetTextAlwaysOnRight(BOOL bSet = TRUE);
Parâmetros
bSet
[in] TRUE para exibir o texto à direita. Caso contrário, FALSE.
Comentários
CMFCRibbonBaseElement::SetToolTipText
Define o texto da dica de ferramenta para o elemento de faixa de opções.
virtual void SetToolTipText(LPCTSTR lpszText);
Parâmetros
lpszTexto
[in] O texto da dica de ferramenta.
CMFCRibbonBaseElement::SetVisible
Define a visibilidade do elemento de faixa de opções.
void SetVisible(BOOL bIsVisible);
Parâmetros
bIsVisible
[in] TRUE para exibir o elemento de faixa de opções e FALSE para ocultar o elemento de faixa de opções.
Comentários
CMFCRibbonBaseElement::StretchHorizontally
Alonga a largura do elemento de faixa de opções.
virtual void StretchHorizontally();
Comentários
Por padrão, esse método gera uma falha de declaração em builds de depuração e, portanto, não deve ser chamado. Substitua esse método para alongar a largura do elemento de faixa de opções.
CMFCRibbonBaseElement::StretchToWholeRow
Altera a altura de exibição do elemento de faixa de opções para a altura da linha especificada.
virtual BOOL StretchToWholeRow(
CDC* pDC,
int nHeight);
Parâmetros
pDC
[in] Esse parâmetro não é usado.
nHeight
[in] A altura da linha.
Valor de retorno
TRUE se a altura de exibição foi definida. Caso contrário, FALSE.
Comentários
Substitua esse método para alterar a altura de exibição do elemento de 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 de faixa de opções.
virtual void UpdateTooltipInfo();
Comentários
CMFCRibbonBaseElement::HasFocus
Indica se o elemento pai tem foco do teclado.
virtual BOOL HasFocus() const;
Valor de retorno
TRUE se o elemento de faixa de opções for focado. Caso contrário, FALSE.