CTooltipManager 類別

發行項
08/04/2024

維護工具提示的執行階段資訊。 CTooltipManager 類別會在每個應用程式具現化一次。

語法

class CTooltipManager : public CObject

成員

公用方法

名稱	描述
CTooltipManager：：CreateToolTip	建立指定的 Windows 控制項類型的工具提示控制項。
CTooltipManager：:D eleteToolTip	刪除工具提示控制項。
CTooltipManager：：SetTooltipParams	自訂指定的 Windows 控制項類型的工具提示控制項的視覺外觀。
CTooltipManager：：SetTooltipText	設定工具提示控制項的文字和描述。
CTooltipManager：：UpdateTooltips

備註

使用 CMFCToolTipCtrl 類別和 CMFCToolTipInfo一 CTooltipManager 起使用，在應用程式中實作自定義的工具提示。如需如何使用這些工具提示類別的範例，請參閱 CMFCToolTipCtrl 類別主題。

繼承階層架構

CObject

CTooltipManager

需求

標頭： afxtooltipmanager.h

CTooltipManager：：CreateToolTip

建立工具提示控件。

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

參數

pToolTip
[out]工具提示指標的參考。它會設定為在函式傳回時指向新建立的工具提示。

pWndParent
[in]工具提示的父代。

nType
[in]工具提示的類型。

傳回值

如果已成功建立工具提示，則為非零。

備註

您必須呼叫 CTooltipManager：:D eleteToolTip 來刪除 pToolTip 中 傳回的工具提示控制件。

CTooltipManager 會根據 nType 指定的工具提示類型，設定它所建立之每個工具提示的視覺顯示參數。若要變更一或多個工具提示類型的參數，請呼叫 CTooltipManager：：SetTooltipParams。

下表列出有效的工具提示類型：

工具提示類型	控制項類別	範例類型
AFX_TOOLTIP_TYPE_BUTTON	按鈕。	CMFCButton
AFX_TOOLTIP_TYPE_CAPTIONBAR	標題列。	CMFCCaptionBar
AFX_TOOLTIP_TYPE_DEFAULT	任何不符合另一個類別的控制件。	無。
AFX_TOOLTIP_TYPE_DOCKBAR	可停駐窗格。	CDockablePane
AFX_TOOLTIP_TYPE_EDIT	文字框。	無。
AFX_TOOLTIP_TYPE_MINIFRAME	小型框架。	CPaneFrameWnd
AFX_TOOLTIP_TYPE_PLANNER	規劃師。	無。
AFX_TOOLTIP_TYPE_RIBBON	功能區列。	CMFCRibbonBar、CMFCRibbonPanelMenuBar
AFX_TOOLTIP_TYPE_TAB	索引標籤控件。	CMFCTabCtrl
AFX_TOOLTIP_TYPE_TOOLBAR	工具列。	CMFCToolBar、CMFCPopupMenuBar
AFX_TOOLTIP_TYPE_TOOLBOX	工具箱。	無。

CTooltipManager：:D eleteToolTip

刪除工具提示控制項。

static void DeleteToolTip(CToolTipCtrl*& pToolTip);

參數

pToolTip
[in， out]要終結之工具提示之指標的參考。

備註

針對 CTooltipManager：：CreateToolTip 所建立的每個 CToolTipCtrl 類別呼叫這個方法。父控件應該從其 OnDestroy 處理程式呼叫這個方法。這是從架構正確移除工具提示的必要專案。這個方法會將 pToolTip 設定為 NULL，再傳回。

CTooltipManager：：SetTooltipParams

自定義指定之 Windows 控制件類型的工具提示控件外觀。

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

參數

nTypes
[in]指定控制項類型。

pRTC
[in]自訂工具提示的運行時間類別。

pParams
[in]工具提示參數。

備註

此方法會設定 CToolTipManager 在建立工具提示時所使用的運行時間類別和初始參數。當控件呼叫 CTooltipManager：：CreateToolTip，並傳入 nTypes 所指示之其中一種型別的工具提示類型時，工具提示管理員會建立工具提示控件，該控件是 pRTC 所指定的運行時間類別實例，並將 pParams 指定的參數傳遞至新的工具提示。

當您呼叫此方法時，所有現有的工具提示擁有者都會收到AFX_WM_UPDATETOOLTIPS訊息，而且他們必須使用 CTooltipManager：：CreateToolTip 重新建立其工具提示。

nTypes 可以是 CTooltipManager：：CreateToolTip 所使用的有效工具提示類型的任何組合，也可以AFX_TOOLTIP_TYPE_ALL。如果您傳遞AFX_TOOLTIP_TYPE_ALL，所有工具提示類型都會受到影響。

範例

下列範例示範如何使用 SetTooltipParams 類別的 CTooltipManager 方法。這段程式碼片段是 Draw 用戶端範例的一部分。

CMFCToolTipInfo params;
params.m_bVislManagerTheme = TRUE;

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

CTooltipManager：：SetTooltipText

設定工具提示的文字和描述。

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

參數

pTI
[in]TOOLINFO 物件的指標。

pToolTip
[in， out]要設定文字和描述的工具提示控件指標。

nType
[in]指定與此工具提示相關聯的控制項類型。

strText
[in]要設定為工具提示文字的文字。

lpszDescr
[in]工具提示描述的指標。可以是 NULL。

備註

當您建立工具提示時，nType 的值必須與 CTooltipManager：：CreateToolTip 的 nType 參數值相同。

CTooltipManager：：UpdateTooltips

如需更多詳細資料，請參閱 Visual Studio 安裝位置下之 VC\atlmfc\src\mfc 資料夾中的原始程式碼。

void UpdateTooltips();

備註

另請參閱

階層架構圖表
 類別
 CMFCToolTipCtrl 類別
 CMFCToolTipInfo 類別

共用方式為