ITfKeyEventSink

COM

IIDaa80e7f5-2021-11d2-93e0-0060b067b86e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfKeyEventSink インターフェイスは、キーボードイベントおよびフォーカスイベントの通知を受け取るためにテキストサービスが実装します。このイベントシンクをインストールするには、ITfKeystrokeMgr::AdviseKeyEventSink を呼び出します。

メソッド 6

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

vtbl 3 HRESULT OnSetFocus(BOOL fForeground)

ITfKeyEventSink::OnSetFocus メソッド

fForeground

BOOL

TRUE の場合、テキストサービスがフォーカスを受け取ります。それ以外の場合、テキストサービスはフォーカスを失います。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 HRESULT OnTestKeyDown(ITfContext* pic, WPARAM wParam, LPARAM lParam, BOOL* pfEaten)

ITfKeyEventSink::OnTestKeyDown メソッド

pic	ITfContext*	in	キーイベントを受け取る入力コンテキストへのポインターです。
wParam	WPARAM	in	キーの仮想キーコードを指定します。このパラメーターの詳細については、WM_KEYDOWN の wParam パラメーターを参照してください。
lParam	LPARAM	in	キーのリピート回数、スキャンコード、拡張キーフラグ、コンテキストコード、直前のキー状態フラグ、遷移状態フラグを指定します。このパラメーターの詳細については、WM_KEYDOWN の lParam パラメーターを参照してください。
pfEaten	BOOL*	out	キーイベントが処理されるかどうかを、終了時に示す BOOL へのポインターです。この値に TRUE が格納された場合、キーイベントは処理されます。FALSE の場合、キーイベントは処理されません。

戻り値

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

値	説明
S_OK	メソッドは成功しました。

vtbl 5 HRESULT OnTestKeyUp(ITfContext* pic, WPARAM wParam, LPARAM lParam, BOOL* pfEaten)

ITfKeyEventSink::OnTestKeyUp メソッド

pic	ITfContext*	in	キーイベントを受け取る入力コンテキストへのポインターです。
wParam	WPARAM	in	キーの仮想キーコードを指定します。このパラメーターの詳細については、WM_KEYUP の wParam パラメーターを参照してください。
lParam	LPARAM	in	キーのリピート回数、スキャンコード、拡張キーフラグ、コンテキストコード、直前のキー状態フラグ、遷移状態フラグを指定します。このパラメーターの詳細については、WM_KEYUP の lParam パラメーターを参照してください。
pfEaten	BOOL*	out	キーイベントが処理されるかどうかを、終了時に示す BOOL へのポインターです。この値に TRUE が格納された場合、キーイベントは処理されます。この値に FALSE が格納された場合、キーイベントは処理されません。

戻り値

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

値	説明
S_OK	メソッドは成功しました。

vtbl 6 HRESULT OnKeyDown(ITfContext* pic, WPARAM wParam, LPARAM lParam, BOOL* pfEaten)

ITfKeyEventSink::OnKeyDown メソッド

pic	ITfContext*	in	キーイベントを受け取る入力コンテキストへのポインターです。
wParam	WPARAM	in	キーの仮想キーコードを指定します。このパラメーターの詳細については、WM_KEYDOWN の wParam パラメーターを参照してください。
lParam	LPARAM	in	キーのリピート回数、スキャンコード、拡張キーフラグ、コンテキストコード、直前のキー状態フラグ、遷移状態フラグを指定します。このパラメーターの詳細については、WM_KEYDOWN の lParam パラメーターを参照してください。
pfEaten	BOOL*	out	キーイベントが処理されたかどうかを、終了時に示す BOOL へのポインターです。この値に TRUE が格納された場合、キーイベントは処理されました。FALSE の場合、キーイベントは処理されませんでした。

戻り値

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

値	説明
S_OK	メソッドは成功しました。

vtbl 7 HRESULT OnKeyUp(ITfContext* pic, WPARAM wParam, LPARAM lParam, BOOL* pfEaten)

ITfKeyEventSink::OnKeyUp メソッド

pic	ITfContext*	in	キーイベントを受け取る入力コンテキストへのポインターです。
wParam	WPARAM	in	キーの仮想キーコードを指定します。このパラメーターの詳細については、WM_KEYUP の wParam パラメーターを参照してください。
lParam	LPARAM	in	キーのリピート回数、スキャンコード、拡張キーフラグ、コンテキストコード、直前のキー状態フラグ、遷移状態フラグを指定します。このパラメーターの詳細については、WM_KEYUP の lParam パラメーターを参照してください。
pfEaten	BOOL*	out	キーイベントが処理されたかどうかを、終了時に示す BOOL へのポインターです。この値に TRUE が格納された場合、キーイベントは処理されました。この値に FALSE が格納された場合、キーイベントは処理されませんでした。

戻り値

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

値	説明
S_OK	メソッドは成功しました。

vtbl 8 HRESULT OnPreservedKey(ITfContext* pic, GUID* rguid, BOOL* pfEaten)

ITfKeyEventSink::OnPreservedKey メソッド

pic	ITfContext*	in	キーイベントを受け取る入力コンテキストへのポインターです。
rguid	GUID*	in	予約キー (preserved key) のコマンド GUID を格納します。
pfEaten	BOOL*	out	予約キーイベントが処理されたかどうかを、終了時に示す BOOL 値へのポインターです。この値に TRUE が格納された場合、予約キーイベントは処理されました。この値に FALSE が格納された場合、予約キーイベントは処理されませんでした。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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