CTooltipManager クラス

ツールヒントに関するランタイム情報を保持します。 CTooltipManager クラスのインスタンスは、アプリケーションごとに 1 回作成されます。

構文

class CTooltipManager : public CObject

メンバー

パブリック メソッド

名前	説明
CTooltipManager::CreateToolTip	指定された Windows コントロールの種類のツールヒント コントロールを作成します。
CTooltipManager::D eleteToolTip	ツールヒント コントロールを削除します。
CTooltipManager::SetTooltipParams	指定された Windows コントロールの種類のツールヒント コントロールの外観をカスタマイズします。
CTooltipManager::SetTooltipText	ツールヒント コントロールのテキストと説明を設定します。
CTooltipManager::UpdateTooltips

解説

CMFCToolTipCtrl クラスを使用してCTooltipManager、CMFCToolTipInfoカスタマイズされたヒントをアプリケーションに実装します。 これらのツールヒント クラスの使用方法の例については、CMFCToolTipCtrl クラスのトピックを参照してください。

継承階層

CObject

CTooltipManager

必要条件

ヘッダー: afxtooltipmanager.h

CTooltipManager::CreateToolTip

ツールヒント コントロールを作成します。

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

パラメーター

pToolTip
[out]ツールヒント ポインターへの参照。 関数が戻るときに、新しく作成されたツールヒントを指すように設定されます。

pWndParent
[in]ツールヒントの親。

nType
[in]ツールヒントの種類。

戻り値

ヒントが正常に作成された場合は 0 以外。

解説

pToolTip で返されるツールヒント コントロールを削除するには、CTooltipManager::D eleteToolTip を呼び出す必要があります。

CTooltipManager は、nType が指定するツールヒントの種類に基づいて、作成する各ツールヒントのビジュアル表示パラメーターを設定します。 1 つ以上のツールヒントの種類のパラメーターを変更するには、CTooltipManager::SetTooltipParams を呼び出します。

有効なツールヒントの種類を次の表に示します。

ツールヒントの種類	コントロール カテゴリ	型の例
AFX_TOOLTIP_TYPE_BUTTON	ボタン。	CMFCButton
AFX_TOOLTIP_TYPE_CAPTIONBAR	キャプション バー。	CMFCCaptionBar
AFX_TOOLTIP_TYPE_DEFAULT	別のカテゴリに適合しないコントロール。	なし。
AFX_TOOLTIP_TYPE_DOCKB (キロバイト)AR	ドッキング可能なウィンドウ。	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
[入力、出力]破棄するヒントへのポインターへの参照。

解説

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 で示される型の 1 つであるツールヒント型を渡すと、ツールヒント マネージャーは、pRTC で指定されたランタイム クラスのインスタンスであるツールヒント コントロールを作成し、pParams で指定されたパラメーターを新しいツールヒントに渡します。

このメソッドを呼び出すと、既存のすべてのツールヒントの所有者がAFX_WM_UPDATETOOLTIPSメッセージを受け取り、CTooltipManager::CreateToolTip を使用してツールヒントを再作成する必要があります。

nTypes には、CTooltipManager::CreateToolTip で使用される有効なツールヒントの種類を任意に組み合わせて使用することも、AFX_TOOLTIP_TYPE_ALLすることもできます。 AFX_TOOLTIP_TYPE_ALL渡すと、すべてのツールヒントの種類が影響を受けます。

例

次の例では、クラスのメソッドを使用する SetTooltipParams 方法を CTooltipManager 示します。 このコード スニペットは、「 クライアント サンプルの描画」の一部です。

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
[入力、出力]テキストと説明を設定するツールヒント コントロールへのポインター。

nType
[in]このツールヒントを関連付けるコントロールの種類を指定します。

strText
[in]ヒント テキストとして設定するテキスト。

lpszDescr
[in]ツールヒントの説明へのポインター。 NULL にすることができます。

解説

ヒントの作成時に、nType の値は CTooltipManager::CreateToolTip の nType パラメーターと同じ値である必要があります。

CTooltipManager::UpdateTooltips

詳細については、Visual Studio インストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。

void UpdateTooltips();

解説

関連項目

階層図
クラス
CMFCToolTipCtrl クラス
CMFCToolTipInfo クラス