ITfMouseTracker

COM

IID09d146cd-a544-4132-925b-7afa8ef322d0継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfMouseTracker インターフェイスは TSF マネージャーによって実装され、テキストサービスがマウスイベント通知シンクを管理するために使用します。このインターフェイスのインスタンスは、ITfContext オブジェクトに対して IID_ITfMouseTracker をクエリすることで取得します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT AdviseMouseSink(ITfRange* range, ITfMouseSink* pSink, DWORD* pdwCookie)

ITfMouseTracker::AdviseMouseSink メソッド

range	ITfRange*	in	マウスシンクを設定する対象のテキスト範囲を指定する ITfRange インターフェイスへのポインター。
pSink	ITfMouseSink*	in	ITfMouseSink インターフェイスへのポインター。
pdwCookie	DWORD*	out	マウスイベントシンクを識別する Cookie を受け取る DWORD 値へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
TF_E_DISCONNECTED	コンテキストオブジェクトがドキュメントスタック上にありません。
E_NOTIMPL	コンテキストの所有者がマウスイベントシンクをサポートしていません。
E_FAIL	不明なエラーが発生しました。

解説(Remarks)

アドバイズシンクが設定されると、range で指定された範囲上で発生したマウスイベントによって、マウスイベントシンクの ITfMouseSink::OnMouseEvent が呼び出されます。

pdwCookie に格納される値は保存しておき、マウスイベントシンクを解除する際に ITfMouseTracker::UnadviseMouseSink に渡す必要があります。

vtbl 4 HRESULT UnadviseMouseSink(DWORD dwCookie)

ITfMouseTracker::UnadviseMouseSink メソッド

dwCookie

DWORD

マウスアドバイズシンクの識別子を指定します。この値は ITfMouseTracker::AdviseMouseSink の呼び出しによって取得されます。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
TF_E_DISCONNECTED	コンテキストオブジェクトがドキュメントスタック上にありません。
E_NOTIMPL	コンテキストの所有者がマウスイベントシンクをサポートしていません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ITfMouseTracker "{09D146CD-A544-4132-925B-7AFA8EF322D0}"
#usecom global ITfMouseTracker IID_ITfMouseTracker "{}"
#comfunc global ITfMouseTracker_AdviseMouseSink    3 sptr,sptr,var
#comfunc global ITfMouseTracker_UnadviseMouseSink  4 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfMouseTracker "{09D146CD-A544-4132-925B-7AFA8EF322D0}"
#usecom global ITfMouseTracker IID_ITfMouseTracker "{}"
#comfunc global ITfMouseTracker_AdviseMouseSink    3 sptr,sptr,sptr
#comfunc global ITfMouseTracker_UnadviseMouseSink  4 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。