ホーム › UI.TextServices › ITfMouseTrackerACP

ITfMouseTrackerACP

COM

📘 Microsoft Learn (日本語) · English

IID3bdd78e2-c16e-47fd-b883-ce6facc1a208継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfMouseTrackerACP インターフェイスは、マウスイベントシンクをサポートするためにアプリケーションが実装します。

メソッド 2

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

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

ITfMouseTrackerACP::AdviseMouseSink メソッド

range	ITfRangeACP*	in	マウスシンクをインストールする対象のテキスト範囲 (レンジ) を指定する ITfRange インターフェイスへのポインターです。
pSink	ITfMouseSink*	in	ITfMouseSink インターフェイスへのポインターです。アプリケーションはこのオブジェクトの参照カウントをインクリメントし、インターフェイスを保持する必要があります。
pdwCookie	DWORD*	out	マウスイベントシンクを識別するクッキーを受け取る DWORD へのポインターです。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_NOTIMPL	アプリケーションはマウスイベントシンクをサポートしていません。

解説(Remarks)

このアドバイズシンクがインストールされている場合、range で指定された範囲 (レンジ) 上で発生したマウスイベントにより、マウスイベントシンクの ITfMouseSink::OnMouseEvent メソッドが呼び出されます。

pdwCookie に格納された値は呼び出し元が保存し、マウスイベントシンクを削除する際に ITfMouseTrackerACP::UnadviseMouseSink メソッドへ渡します。

vtbl 4 HRESULT UnadviseMouseSink(DWORD dwCookie)

ITfMouseTrackerACP::UnadviseMouseSink メソッド

dwCookie

DWORD

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

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_NOTIMPL	アプリケーションはマウスイベントシンクをサポートしていません。

解説(Remarks)

アプリケーションは、dwCookie に対応する ITfMouseTrackerACP::AdviseMouseSink の呼び出しで渡された ITfMouseSink を解放する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfMouseTrackerACP "{3BDD78E2-C16E-47FD-B883-CE6FACC1A208}"
#usecom global ITfMouseTrackerACP IID_ITfMouseTrackerACP "{}"
#comfunc global ITfMouseTrackerACP_AdviseMouseSink    3 sptr,sptr,var
#comfunc global ITfMouseTrackerACP_UnadviseMouseSink  4 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfMouseTrackerACP "{3BDD78E2-C16E-47FD-B883-CE6FACC1A208}"
#usecom global ITfMouseTrackerACP IID_ITfMouseTrackerACP "{}"
#comfunc global ITfMouseTrackerACP_AdviseMouseSink    3 sptr,sptr,sptr
#comfunc global ITfMouseTrackerACP_UnadviseMouseSink  4 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。