CToolTipCtrl
クラス
アプリケーション内のツールの目的を説明する 1 行のテキストを表示する小さなポップアップ ウィンドウである "ツールヒント コントロール" の機能をカプセル化します。
構文
class CToolTipCtrl : public CWnd
メンバー
パブリック コンストラクター
名前 | 説明 |
---|---|
CToolTipCtrl::CToolTipCtrl |
CToolTipCtrl オブジェクトを構築します。 |
パブリック メソッド
名前 | 説明 |
---|---|
CToolTipCtrl::Activate |
ツールヒント コントロールをアクティブ化および非アクティブ化します。 |
CToolTipCtrl::AddTool |
ツールをツールヒント コントロールに登録します。 |
CToolTipCtrl::AdjustRect |
ツールヒント コントロールのテキスト表示四角形とそのウィンドウの四角形を変換します。 |
CToolTipCtrl::Create |
ツールヒント コントロールを作成し、 CToolTipCtrl オブジェクトにアタッチします。 |
CToolTipCtrl::CreateEx |
指定した Windows 拡張スタイルを使用してツールヒント コントロールを作成し、 CToolTipCtrl オブジェクトにアタッチします。 |
CToolTipCtrl::DelTool |
ツールヒント コントロールからツールを削除します。 |
CToolTipCtrl::GetBubbleSize |
ツールヒントのサイズを取得します。 |
CToolTipCtrl::GetCurrentTool |
現在のツールヒント コントロールに表示されるツールヒント ウィンドウのサイズ、位置、テキストなどの情報を取得します。 |
CToolTipCtrl::GetDelayTime |
ツールヒント コントロールに現在設定されている初期、ポップアップ、および再表示の期間を取得します。 |
CToolTipCtrl::GetMargin |
ヒント ウィンドウに設定されている上、左、下、および右の余白を取得します。 |
CToolTipCtrl::GetMaxTipWidth |
ツールヒント ウィンドウの最大幅を取得します。 |
CToolTipCtrl::GetText |
ツールヒント コントロールがツールに対して保持するテキストを取得します。 |
CToolTipCtrl::GetTipBkColor |
ツールヒント ウィンドウの背景色を取得します。 |
CToolTipCtrl::GetTipTextColor |
ツールヒント ウィンドウのテキスト色を取得します。 |
CToolTipCtrl::GetTitle |
現在のツールヒント コントロールのタイトルを取得します。 |
CToolTipCtrl::GetToolCount |
ツールヒント コントロールが維持するツール数を取得します。 |
CToolTipCtrl::GetToolInfo |
ツールに関するツールヒント コントロールの情報を取得します。 |
CToolTipCtrl::HitTest |
ポイントをテストして、指定されたツールの外接する四角形内にあるかどうかを判断します。 その場合は、ツールに関する情報を取得します。 |
CToolTipCtrl::Pop |
表示されているツールヒント ウィンドウをビューから削除します。 |
CToolTipCtrl::Popup |
現在のツールヒント コントロールを最後のマウス メッセージの座標に表示します。 |
CToolTipCtrl::RelayEvent |
マウス メッセージをツールヒント コントロールに渡して処理します。 |
CToolTipCtrl::SetDelayTime |
ヒント コントロールの初期表示、ポップアップ表示、再表示の期間を設定します。 |
CToolTipCtrl::SetMargin |
ツールヒント ウィンドウの上、左、下、右の余白を設定します。 |
CToolTipCtrl::SetMaxTipWidth |
ツールヒント ウィンドウの最大幅を設定します。 |
CToolTipCtrl::SetTipBkColor |
ツールヒント ウィンドウの背景色を設定します。 |
CToolTipCtrl::SetTipTextColor |
ツールヒント ウィンドウのテキスト色を設定します。 |
CToolTipCtrl::SetTitle |
標準のアイコンとタイトル文字列をツールヒントに追加します。 |
CToolTipCtrl::SetToolInfo |
ツールに対してツールヒントが保持する情報を設定します。 |
CToolTipCtrl::SetToolRect |
ツールの新しい外接矩形を設定します。 |
CToolTipCtrl::SetWindowTheme |
ツールヒント ウィンドウの表示スタイルを設定します。 |
CToolTipCtrl::Update |
現在のツールを強制的に再描画します。 |
CToolTipCtrl::UpdateTipText |
ツールのツールヒント テキストを設定します。 |
解説
"ツール" は、子ウィンドウやコントロールなどのウィンドウ、またはウィンドウのクライアント領域内のアプリケーション定義の四角形領域のいずれかです。 ツールヒントは、ほとんどの場合非表示になり、ユーザーがツールにカーソルを置き、約 2 分の 1 秒だけそこに残っている場合にのみ表示されます。 ツールヒントはカーソルの近くに表示され、ユーザーがマウス ボタンをクリックするか、ツールの外にカーソルを移動すると消えます。
CToolTipCtrl
には、ツールヒントの初期時間と期間、ヒント テキストを囲む余白の幅、ヒント ウィンドウ自体の幅、ヒントの背景色とテキストの色を制御する機能が用意されています。 1 つのツールヒント コントロールで、複数のツールに関する情報を提供できます。
CToolTipCtrl
クラスは、Windows 共通ツールヒント コントロールの機能を提供します。 このコントロール (したがって、 CToolTipCtrl
クラス) は、Windows 95/98 および Windows NT バージョン 3.51 以降で実行されているプログラムでのみ使用できます。
ツールヒントの有効化の詳細については、「CFrameWnd
から派生していない Windows のツール ヒント」参照してください。
CToolTipCtrl
の使用方法の詳細については、「ControlsとCToolTipCtrl
の使用」を参照してください。
継承階層
CToolTipCtrl
要件
ヘッダー: afxcmn.h
CToolTipCtrl::Activate
ツールヒント コントロールをアクティブ化または非アクティブ化するには、この関数を呼び出します。
void Activate(BOOL bActivate);
パラメーター
bActivate
ツールヒント コントロールをアクティブにするか非アクティブにするかを指定します。
解説
bActivate
がTRUE
されると、コントロールがアクティブになり、FALSE
場合は非アクティブになります。
ツールヒント コントロールがアクティブな場合、カーソルがコントロールに登録されているツール上にあると、ツールヒント情報が表示されます。非アクティブな場合、カーソルがツール上にある場合でも、ツールヒント情報は表示されません。
例
CPropertySheet::GetTabControl
の例を参照してください。
CToolTipCtrl::AddTool
ツールをツールヒント コントロールに登録します。
BOOL AddTool(
CWnd* pWnd,
UINT nIDText,
LPCRECT lpRectTool = NULL,
UINT_PTR nIDTool = 0);
BOOL AddTool(
CWnd* pWnd,
LPCTSTR lpszText = LPSTR_TEXTCALLBACK,
LPCRECT lpRectTool = NULL,
UINT_PTR nIDTool = 0);
パラメーター
pWnd
ツールを含むウィンドウへのポインター。
nIDText
ツールのテキストを含む文字列リソースの ID。
lpRectTool
ツールの外接する四角形の座標を含む RECT
構造体へのポインター。 座標は、 pWnd
によって識別されるウィンドウのクライアント領域の左上隅を基準にしています。
nIDTool
ツールの ID。
lpszText
ツールのテキストへのポインター。 このパラメーターに値 LPSTR_TEXTCALLBACK
が含まれている場合、 TTN_NEEDTEXT
通知メッセージは、 pWnd
が指すウィンドウの親に移動します。
戻り値
正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。
解説
lpRectTool
パラメーターとnIDTool
パラメーターの両方が有効であるか、lpRectTool
がNULL
されている場合は、nIDTool
0 にする必要があります。
ツールヒント コントロールは、複数のツールに関連付けることができます。 この関数を呼び出してツールをツールヒント コントロールに登録し、ツールにカーソルが置いているときにヒントに格納されている情報が表示されるようにします。
Note
AddTool
を使用して静的コントロールにツールヒントを設定することはできません。
例
CPropertySheet::GetTabControl
の例を参照してください。
CToolTipCtrl::AdjustRect
ツールヒント コントロールのテキスト表示四角形とそのウィンドウの四角形を変換します。
BOOL AdjustRect(
LPRECT lprc,
BOOL bLarger = TRUE);
パラメーター
lprc
ツールヒント ウィンドウの四角形またはテキスト表示の四角形を保持する RECT
構造体へのポインター。
bLarger
TRUE
場合、lprc
を使用してテキスト表示の四角形を指定し、対応するウィンドウの四角形を受け取ります。 FALSE
場合、lprc
を使用してウィンドウの四角形を指定し、対応するテキスト表示四角形を受け取ります。
戻り値
四角形が正常に調整された場合は 0 以外。それ以外の場合は 0。
解説
このメンバー関数は、ツールヒント コントロールのテキスト表示四角形をウィンドウの四角形から計算するか、指定したテキスト表示四角形を表示するために必要なツールヒント ウィンドウの四角形を計算します。
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_ADJUSTRECT
の動作が実装されます。
CToolTipCtrl::Create
ツールヒント コントロールを作成し、 CToolTipCtrl
オブジェクトにアタッチします。
virtual BOOL Create(CWnd* pParentWnd, DWORD dwStyle = 0);
パラメーター
pParentWnd
ツールヒント コントロールの親ウィンドウ (通常は CDialog
) を指定します。 NULL
することはできません。
dwStyle
ツールヒント コントロールのスタイルを指定します。 詳細については、「解説」セクションを参照してください。
戻り値
CToolTipCtrl
オブジェクトが正常に作成された場合は 0 以外、それ以外の場合は 0。
解説
2 つの手順で CToolTipCtrl
を構築します。 まず、コンストラクターを呼び出して CToolTipCtrl
オブジェクトを構築し、 Create
を呼び出してツールヒント コントロールを作成し、 CToolTipCtrl
オブジェクトにアタッチします。
dwStyle
パラメーターには、Window スタイルの任意の組み合わせを指定できます。 さらに、ツールヒント コントロールには、 TTS_ALWAYSTIP
と TTS_NOPREFIX
の 2 つのクラス固有のスタイルがあります。
スタイル | 意味 |
---|---|
TTS_ALWAYSTIP |
ツールヒント コントロールの所有者ウィンドウがアクティブか非アクティブかに関係なく、ツール上にカーソルがあるときにツールヒントを表示することを指定します。 このスタイルがない場合、ツールの所有者ウィンドウがアクティブなときにツールヒント コントロールが表示されますが、非アクティブな場合は表示されません。 |
TTS_NOPREFIX |
このスタイルを使用すると、アンパサンド (& ) 文字が文字列から削除されなくなります。 ツールヒント コントロールに TTS_NOPREFIX スタイルがない場合、システムはアンパサンド文字を自動的に除去し、アプリケーションがメニュー項目とツールヒント コントロールのテキストの両方と同じ文字列を使用できるようにします。 |
ツールヒント コントロールには、コントロールの作成時に指定するかどうかに関係なく、 WS_POPUP
と WS_EX_TOOLWINDOW
ウィンドウ スタイルがあります。
拡張ウィンドウ スタイルのツールヒント コントロールを作成するには、Create
ではなくCToolTipCtrl::CreateEx
を呼び出します。
例
CPropertySheet::GetTabControl
の例を参照してください。
CToolTipCtrl::CreateEx
コントロール (子ウィンドウ) を作成し、 CToolTipCtrl
オブジェクトに関連付けます。
virtual BOOL CreateEx(
CWnd* pParentWnd,
DWORD dwStyle = 0,
DWORD dwStyleEx = 0);
パラメーター
pParentWnd
コントロールの親であるウィンドウへのポインター。
dwStyle
ツールヒント コントロールのスタイルを指定します。 詳細については、Create
の「Remarks」セクションを参照してください。
dwStyleEx
作成するコントロールの拡張スタイルを指定します。 拡張 Windows スタイルの一覧については、Windows SDK のCreateWindowEx
の dwExStyle
パラメーターを参照してください。
戻り値
成功した場合は 0 以外の場合は 0。
解説
Create
ではなくCreateEx
を使用して、Windows 拡張スタイルの前置WS_EX_
で指定された拡張 Windows スタイルを適用します。
CToolTipCtrl::CToolTipCtrl
CToolTipCtrl
オブジェクトを構築します。
CToolTipCtrl();
解説
オブジェクトを構築した後、 Create
を呼び出す必要があります。
例
// Declare a CToolTipCtrl object.
CToolTipCtrl m_ToolTipCtrl;
CToolTipCtrl::DelTool
ツールヒント コントロールでサポートされているツールのコレクションから、 pWnd
および nIDTool
で指定されたツールを削除します。
void DelTool(
CWnd* pWnd,
UINT_PTR nIDTool = 0);
パラメーター
pWnd
ツールを含むウィンドウへのポインター。
nIDTool
ツールの ID。
CToolTipCtrl::GetBubbleSize
ツールヒントのサイズを取得します。
CSize GetBubbleSize(LPTOOLINFO lpToolInfo) const;
パラメーター
lpToolInfo
ツールヒントの TOOLINFO
構造体へのポインター。
戻り値
ヒントのサイズ。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_GETBUBBLESIZE
の動作が実装されます。
CToolTipCtrl::GetCurrentTool
現在のツールヒント コントロールによって表示されるツールヒント ウィンドウのサイズ、位置、テキストなどの情報を取得します。
BOOL GetCurrentTool(LPTOOLINFO lpToolInfo) const;
パラメーター
lpToolInfo
[out]現在のツールヒント ウィンドウに関する情報を受け取る TOOLINFO
構造体へのポインター。
戻り値
TRUE
情報が正常に取得された場合。それ以外の場合は FALSE
。
解説
このメソッドは、Windows SDK で説明されている TTM_GETCURRENTTOOL
メッセージを送信します。
例
次のコード例では、現在のツールヒント ウィンドウに関する情報を取得します。
{
//Get information about the current tooltip.
TOOLINFO tInfo = {0};
tInfo.cbSize = sizeof(TOOLINFO);
CToolBarCtrl& m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
CToolTipCtrl* m_toolTip = m_toolBarCtrl.GetToolTips();
BOOL bRet = m_toolTip->GetCurrentTool( &tInfo );
}
CToolTipCtrl::GetDelayTime
ツールヒント コントロールに現在設定されている初期期間、ポップアップ期間、および再表示期間を取得します。
int GetDelayTime(DWORD dwDuration) const;
パラメーター
dwDuration
取得する期間の値を指定するフラグ。 このパラメーターには、次の 値のいずれかを指定できます。
TTDT_AUTOPOP
ツールの外接する四角形内でポインターが固定されている場合に、ツールヒント ウィンドウが表示されたままの時間の長さを取得します。TTDT_INITIAL
ツールヒント ウィンドウが表示される前に、ポインターがツールの外接する四角形内で静止している必要がある時間の長さを取得します。TTDT_RESHOW
ポインターが 1 つのツールから別のツールに移動すると、後続のツールヒント ウィンドウが表示されるまでにかかる時間を取得します。
戻り値
指定された遅延時間 (ミリ秒単位)
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_GETDELAYTIME
の動作が実装されます。
CToolTipCtrl::GetMargin
ツールヒント ウィンドウに設定されている上、左、下、および右の余白を取得します。
void GetMargin(LPRECT lprc) const;
パラメーター
lprc
余白情報を受け取る RECT
構造体のアドレス。 RECT
構造体のメンバーは、外接する四角形を定義しません。 このメッセージの目的上、構造体のメンバーは次のように解釈されます。
メンバー | [表記] |
---|---|
top |
上罫線とツールヒント テキストの上との間の距離 (ピクセル単位)。 |
left |
左罫線と先端テキストの左端までの距離 (ピクセル単位)。 |
bottom |
下罫線と先端テキストの下部の間の距離 (ピクセル単位)。 |
right |
右罫線と先端テキストの右端の間の距離 (ピクセル単位)。 |
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_GETMARGIN
の動作が実装されます。
CToolTipCtrl::GetMaxTipWidth
ツールヒント ウィンドウの最大幅を取得します。
int GetMaxTipWidth() const;
戻り値
ヒント ウィンドウの最大幅。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_GETMAXTIPWIDTH
の動作が実装されます。
CToolTipCtrl::GetText
ツールヒント コントロールがツールに対して保持するテキストを取得します。
void GetText(
CString& str,
CWnd* pWnd,
UINT_PTR nIDTool = 0) const;
パラメーター
str
ツールのテキストを受け取る CString
オブジェクトへの参照。
pWnd
ツールを含むウィンドウへのポインター。
nIDTool
ツールの ID。
解説
pWnd
パラメーターとnIDTool
パラメーターによって、ツールが識別されます。 そのツールが以前に CToolTipCtrl::AddTool
の呼び出しによってツールヒント コントロールに登録されている場合は、 str
パラメーターによって参照されるオブジェクトにツールのテキストが割り当てられます。
CToolTipCtrl::GetTipBkColor
ツールヒント ウィンドウの背景色を取得します。
COLORREF GetTipBkColor() const;
戻り値
背景色を表す COLORREF
値。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_GETTIPBKCOLOR
の動作が実装されます。
CToolTipCtrl::GetTipTextColor
ツールヒント ウィンドウのテキスト色を取得します。
COLORREF GetTipTextColor() const;
戻り値
テキストの色を表す COLORREF
値。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_GETTIPTEXTCOLOR
の動作が実装されます。
CToolTipCtrl::GetTitle
現在のツールヒント コントロールのタイトルを取得します。
void GetTitle(PTTGETTITLE pttgt) const;
パラメーター
pttgt
[out]ツールヒント コントロールに関する情報を含む TTGETTITLE
構造体へのポインター。 このメソッドから制御が戻ると、TTGETTITLE
構造体のpszTitle
メンバーがタイトルのテキストを指します。
解説
このメソッドは、Windows SDK で説明されている TTM_GETTITLE
メッセージを送信します。
CToolTipCtrl::GetToolCount
ツールヒント コントロールに登録されているツールの数を取得します。
int GetToolCount() const;
戻り値
ツールヒント コントロールに登録されているツールの数。
CToolTipCtrl::GetToolInfo
ツールに関するツールヒント コントロールの情報を取得します。
BOOL GetToolInfo(
CToolInfo& ToolInfo,
CWnd* pWnd,
UINT_PTR nIDTool = 0) const;
パラメーター
ToolInfo
ツールのテキストを受け取る TOOLINFO
オブジェクトへの参照。
pWnd
ツールを含むウィンドウへのポインター。
nIDTool
ツールの ID。
戻り値
正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。
解説
ツールによって参照されるTOOLINFO
構造体のhwnd
およびuId
メンバーCToolInfo
識別します。 AddTool
に対する以前の呼び出しによってツールヒント コントロールにそのツールが登録されている場合、TOOLINFO
構造体にはツールに関する情報が入力されます。
CToolTipCtrl::HitTest
ポイントをテストして、指定されたツールの外接する四角形内にあるかどうかを判断し、存在する場合はツールに関する情報を取得します。
BOOL HitTest(
CWnd* pWnd,
CPoint pt,
LPTOOLINFO lpToolInfo) const;
パラメーター
pWnd
ツールを含むウィンドウへのポインター。
pt
テストするポイントの座標を含む CPoint
オブジェクトへのポインター。
lpToolInfo
ツールに関する情報を含む TOOLINFO
構造体へのポインター。
戻り値
ヒット テスト情報で指定された点がツールの外接する四角形内にある場合は 0 以外。それ以外の場合は 0。
解説
この関数が 0 以外の値を返す場合、 lpToolInfo
が指す構造体には、そのポイントが存在する四角形内のツールに関する情報が入力されます。
TTHITTESTINFO
構造体は次のように定義されます。
typedef struct _TT_HITTESTINFO { // tthti
HWND hwnd; // handle of tool or window with tool
POINT pt; // client coordinates of point to test
TOOLINFO ti; // receives information about the tool
} TTHITTESTINFO, FAR * LPHITTESTINFO;
hwnd
ツールのハンドルを指定します。
pt
ポイントがツールの外接する四角形内にある場合に、ポイントの座標を指定します。
ti
ツールに関する情報。
TOOLINFO
構造の詳細については、CToolTipCtrl::GetToolInfo
を参照してください。
CToolTipCtrl::Pop
表示されているツールヒント ウィンドウをビューから削除します。
void Pop();
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_POP
の動作が実装されます。
CToolTipCtrl::Popup
現在のツールヒント コントロールを最後のマウス メッセージの座標に表示します。
void Popup();
解説
このメソッドは、Windows SDK で説明されている TTM_POPUP
メッセージを送信します。
例
次のコード例では、ツールヒント ウィンドウを表示します。
{
// Display the most recent tooltip.
CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
CToolTipCtrl *m_toolTip = m_toolBarCtrl.GetToolTips();
m_toolTip->Popup();
}
CToolTipCtrl::RelayEvent
マウス メッセージをツールヒント コントロールに渡して処理します。
void RelayEvent(LPMSG lpMsg);
パラメーター
lpMsg
リレーするメッセージを含む MSG
構造体へのポインター。
解説
ツールヒント コントロールでは、次のメッセージのみが処理され、 RelayEvent
によって送信されます。
WM_LBUTTONDOWN |
WM_MOUSEMOVE |
---|---|
WM_LBUTTONUP |
WM_RBUTTONDOWN |
WM_MBUTTONDOWN |
WM_RBUTTONUP |
WM_MBUTTONUP |
例
CPropertySheet::GetTabControl
の例を参照してください。
CToolTipCtrl::SetDelayTime
ツールヒント コントロールの遅延時間を設定します。
void SetDelayTime(UINT nDelay);
void SetDelayTime(
DWORD dwDuration,
int iTime);
パラメーター
nDelay
新しい遅延時間をミリ秒単位で指定します。
dwDuration
取得する期間の値を指定するフラグ。 有効な値の説明については、 CToolTipCtrl::GetDelayTime
を参照してください。
iTime
指定された遅延時間 (ミリ秒)。
解説
遅延時間は、ツールヒント ウィンドウが表示されるまでにカーソルをツールに残しておく必要がある時間の長さです。 既定の遅延時間は 500 ミリ秒です。
CToolTipCtrl::SetMargin
ツールヒント ウィンドウの上、左、下、右の余白を設定します。
void SetMargin(LPRECT lprc);
パラメーター
lprc
設定する余白情報を含む RECT
構造体のアドレス。 RECT
構造体のメンバーは、外接する四角形を定義しません。 余白情報の説明については、 CToolTipCtrl::GetMargin
を参照してください。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_SETMARGIN
の動作が実装されます。
CToolTipCtrl::SetMaxTipWidth
ツールヒント ウィンドウの最大幅を設定します。
int SetMaxTipWidth(int iWidth);
パラメーター
iWidth
設定するツールヒント ウィンドウの最大幅。
戻り値
前の最大チップ幅。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_SETMAXTIPWIDTH
の動作が実装されます。
CToolTipCtrl::SetTipBkColor
ツールヒント ウィンドウの背景色を設定します。
void SetTipBkColor(COLORREF clr);
パラメーター
clr
新しい背景色。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_SETTIPBKCOLOR
の動作が実装されます。
CToolTipCtrl::SetTipTextColor
ツールヒント ウィンドウのテキスト色を設定します。
void SetTipTextColor(COLORREF clr);
パラメーター
clr
新しいテキストの色。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_SETTIPTEXTCOLOR
の動作が実装されます。
CToolTipCtrl::SetTitle
標準のアイコンとタイトル文字列をツールヒントに追加します。
BOOL SetTitle(
UINT uIcon,
LPCTSTR lpstrTitle);
パラメーター
uIcon
Windows SDK のTTM_SETTITLE
のicon
を参照してください。
lpstrTitle
タイトル文字列へのポインター。
戻り値
正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。
解説
このメンバー関数では、Windows SDK で説明されているように、Win32 メッセージ TTM_SETTITLE
の動作が実装されます。
CToolTipCtrl::SetToolInfo
ツールに対してツールヒントが保持する情報を設定します。
void SetToolInfo(LPTOOLINFO lpToolInfo);
パラメーター
lpToolInfo
設定する情報を指定する TOOLINFO
構造体へのポインター。
CToolTipCtrl::SetToolRect
ツールの新しい外接矩形を設定します。
void SetToolRect(
CWnd* pWnd,
UINT_PTR nIDTool,
LPCRECT lpRect);
パラメーター
pWnd
ツールを含むウィンドウへのポインター。
nIDTool
ツールの ID。
lpRect
新しい外接する四角形を指定する RECT
構造体へのポインター。
CToolTipCtrl::SetWindowTheme
ツールヒント ウィンドウの表示スタイルを設定します。
HRESULT SetWindowTheme(LPCWSTR pszSubAppName);
パラメーター
pszSubAppName
設定するビジュアル スタイルを含む Unicode 文字列へのポインター。
戻り値
戻り値は使用されません。
解説
このメンバー関数は、Windows SDK で説明されているように、 TTM_SETWINDOWTHEME
メッセージの機能をエミュレートします。
CToolTipCtrl::Update
現在のツールを強制的に再描画します。
void Update();
CToolTipCtrl::UpdateTipText
このコントロールのツールのツールヒント テキストを更新します。
void UpdateTipText(
LPCTSTR lpszText,
CWnd* pWnd,
UINT_PTR nIDTool = 0);
void UpdateTipText(
UINT nIDText,
CWnd* pWnd,
UINT_PTR nIDTool = 0);
パラメーター
lpszText
ツールのテキストへのポインター。
pWnd
ツールを含むウィンドウへのポインター。
nIDTool
ツールの ID。
nIDText
ツールのテキストを含む文字列リソースの ID。