Compartilhar via

Classe CTooltipManager

  • Artigo

Mantém informações de runtime sobre dicas de ferramentas. A classe CTooltipManager é instanciada uma vez por aplicativo.

Sintaxe

class CTooltipManager : public CObject

Membros

Métodos públicos

Nome Descrição
CTooltipManager::CreateToolTip Cria um controle de dica de ferramenta para os tipos de controle do Windows especificados.
CTooltipManager::DeleteToolTip Exclui um controle de dica de ferramenta.
CTooltipManager::SetTooltipParams Personaliza a aparência visual do controle de dica de ferramenta para os tipos de controle do Windows especificados.
CTooltipManager::SetTooltipText Define o texto e a descrição para um controle de dica de ferramenta.
CTooltipManager::UpdateTooltips

Comentários

Use a Classe CMFCToolTipCtrl, CMFCToolTipInfo e CTooltipManager juntas para implementar dicas de ferramenta personalizadas em seu aplicativo. Para um exemplo de como usar essas classes de dica de ferramenta, confira o tópico Classe CMFCToolTipCtrl.

Hierarquia de herança

CObject

CTooltipManager

Requisitos

Cabeçalho: afxtooltipmanager.h

CTooltipManager::CreateToolTip

Cria um controle de dica de ferramenta.

static BOOL CreateToolTip(
    CToolTipCtrl*& pToolTip,
    CWnd* pWndParent,
    UINT nType);

Parâmetros

pToolTip
[out] Uma referência a um ponteiro de dica de ferramenta. É definida para apontar para a dica de ferramenta que acaba de ser criada quando a função retorna.

pWndParent
[in] Pai da dica de ferramenta.

nType
[in] Tipo da dica de ferramenta.

Valor de retorno

Não zero se uma dica de ferramenta tiver sido criada com êxito.

Comentários

Você deve chamar CTooltipManager::DeleteToolTip para excluir o controle de dica de ferramenta que é passado de volta no pToolTip.

O CTooltipManager define os parâmetros de exibição visual de cada dica de ferramenta que ele cria com base no tipo de dica de ferramenta especificado por nType. Para alterar os parâmetros para um ou mais tipos de dica de ferramenta, chame CTooltipManager::SetTooltipParams.

Tipos de dica de ferramenta válidos estão listados na seguinte tabela:

Tipo de dica de ferramenta Categoria de controle Tipos de exemplo
AFX_TOOLTIP_TYPE_BUTTON Botão A. CMFCButton
AFX_TOOLTIP_TYPE_CAPTIONBAR Uma barra de legenda. CMFCCaptionBar
AFX_TOOLTIP_TYPE_DEFAULT Qualquer controle que não se ajuste a outra categoria. Nenhum.
AFX_TOOLTIP_TYPE_DOCKBAR Um painel encaixável. CDockablePane
AFX_TOOLTIP_TYPE_EDIT Uma caixa de texto. Nenhum.
AFX_TOOLTIP_TYPE_MINIFRAME Uma minimoldura. CPaneFrameWnd
AFX_TOOLTIP_TYPE_PLANNER Um planejador. Nenhum.
AFX_TOOLTIP_TYPE_RIBBON Uma barra de faixa de opções. CMFCRibbonBar, CMFCRibbonPanelMenuBar
AFX_TOOLTIP_TYPE_TAB Um controle guia. CMFCTabCtrl
AFX_TOOLTIP_TYPE_TOOLBAR Uma barra de ferramentas. CMFCToolBar, CMFCPopupMenuBar
AFX_TOOLTIP_TYPE_TOOLBOX Uma caixa de ferramentas. Nenhum.

CTooltipManager::DeleteToolTip

Exclui um controle de dica de ferramenta.

static void DeleteToolTip(CToolTipCtrl*& pToolTip);

Parâmetros

pToolTip
[in, out] Uma referência a um ponteiro para uma dica de ferramenta a ser destruída.

Comentários

Chame esse método para cada Classe CToolTipCtrl criada por CTooltipManager::CreateToolTip. O controle pai deve chamar esse método de seu manipulador OnDestroy. Isso é necessário para remover corretamente a dica de ferramenta da estrutura. Esse método define pToolTip como NULL antes de retornar.

CTooltipManager::SetTooltipParams

Personaliza a aparência do controle de dica de ferramenta para os tipos de controle do Windows especificados.

void SetTooltipParams(
    UINT nTypes,
    CRuntimeClass* pRTC=RUNTIME_CLASS(CMFCToolTipCtrl),
    CMFCToolTipInfo* pParams=NULL);

Parâmetros

nTypes
[in] Especifica tipos de controle.

pRTC
[in] Classe de runtime da dica de ferramenta personalizada.

pParams
[in] Parâmetros de dica de ferramenta.

Comentários

Esse método define a classe de runtime e os parâmetros iniciais que o CToolTipManager usa quando cria dicas de ferramenta. Quando um controle chama CTooltipManager::CreateToolTip e passa um tipo de dica de ferramenta que é um dos tipos indicados por nTypes, o gerenciador de dicas de ferramenta cria um controle de dica de ferramenta que é uma instância da classe de runtime especificada pelo pRTC e passa os parâmetros especificados por pParams para a nova dica de ferramenta.

Quando você chama esse método, todos os proprietários de dicas de ferramenta recebem a mensagem AFX_WM_UPDATETOOLTIPS e devem recriar suas dicas de ferramenta usando CTooltipManager::CreateToolTip.

nTypes podem ser qualquer combinação dos tipos de dica de ferramenta válidos que CTooltipManager::CreateToolTip usa ou pode ser AFX_TOOLTIP_TYPE_ALL. Se você passar AFX_TOOLTIP_TYPE_ALL, todos os tipos de dica de ferramenta serão afetados.

Exemplo

O exemplo a seguir demonstra como usar o método SetTooltipParams da classe CTooltipManager. Esse snippet de código faz parte do exemplo Desenhar Cliente.

CMFCToolTipInfo params;
params.m_bVislManagerTheme = TRUE;

theApp.GetTooltipManager()->SetTooltipParams(AFX_TOOLTIP_TYPE_ALL, RUNTIME_CLASS(CMFCToolTipCtrl), &params);

CTooltipManager::SetTooltipText

Define o texto e a descrição de uma dica de ferramenta.

static void SetTooltipText(
    TOOLINFO* pTI,
    CToolTipCtrl* pToolTip,
    UINT nType,
    const CString strText,
    LPCTSTR lpszDescr=NULL);

Parâmetros

pTI
[in] Um ponteiro para um objeto TOOLINFO.

pToolTip
[in, out] Um ponteiro para o controle de dica de ferramenta para o qual definir o texto e a descrição.

nType
[in] Especifica o tipo de controle com o qual essa dica de ferramenta está associada.

strText
[in] O texto a ser definido como o texto da dica de ferramenta.

lpszDescr
[in] Um ponteiro para a descrição da dica de ferramenta. Pode ser NULL.

Comentários

O valor de nType deve ser o mesmo valor que o parâmetro nType de CTooltipManager::CreateToolTip quando você criou a dica de ferramenta.

CTooltipManager::UpdateTooltips

Para obter mais detalhes, confira o código-fonte localizado na pasta VC\atlmfc\src\mfc de sua instalação do Visual Studio.

void UpdateTooltips();

Comentários

Confira também

Gráfico da hierarquia
Classes
Classe CMFCToolTipCtrl
Classe CMFCToolTipInfo