ITfContextOwner

COM

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

公式ドキュメント

ITfContextOwner インターフェイスは、テキストストアを持たずにテキスト入力を受け取るために、アプリケーションまたはテキストサービスが実装します。このインターフェイスのインスタンスは、アプリケーションが ITfSource::AdviseSink メソッドを呼び出したときに取得されます。

メソッド 6

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

vtbl 3 HRESULT GetACPFromPoint(POINT* ptScreen, DWORD dwFlags, INT* pacp)

ITfContextOwner::GetACPFromPoint メソッドは、スクリーン座標の点をアプリケーションの文字位置に変換します。

ptScreen

POINT*

点のスクリーン座標を格納した POINT 構造体へのポインターです。

dwFlags

DWORD

文字の境界ボックスに対する点のスクリーン座標に基づいて、返す文字位置を指定します。既定では、返される文字位置は、その点のスクリーン座標を含む文字の境界ボックスです。点が文字の境界ボックスの外側にある場合、このメソッドは NULL または TF_E_INVALIDPOINT を返します。

このパラメーターに GXFPF_ROUND_NEAREST フラグを指定し、点のスクリーン座標が文字の境界ボックスに含まれる場合、返される文字位置は、点のスクリーン座標に最も近い境界の端になります。

このパラメーターに GXFPF_NEAREST フラグを指定し、点のスクリーン座標が文字の境界ボックスに含まれない場合、最も近い文字位置が返されます。

これらのビットフラグは組み合わせて指定できます。

pacp

INT*

out

点のスクリーン座標に対応する文字位置を受け取ります。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
TS_E_INVALIDPOINT	ptScreen パラメーターがどの文字の境界ボックスにも含まれていません。
TS_E_NOLAYOUT	アプリケーションがテキストレイアウトを計算していません。

解説(Remarks)

Point 1 is in character bounding box and point 2 is outside the character bounding box.

この図を使用して、dwFlags パラメーターに指定したフラグに応じて返される文字位置を確認してください。

点 1

既定-- pacp = 0 --点のスクリーン座標が文字位置 0 の文字の境界ボックス内にあります。
GXFPF_ROUND_NEAREST-- pacp = 1 --点のスクリーン座標は、文字位置 1 の開始レンジ位置であるレンジ位置 1 に最も近くにあります。
GXFPF_NEAREST-- pacp = 0 --点が文字位置 0 の文字の境界ボックス内にあるため、既定の動作になります。

点 2

既定-- hr = TF_E_INVALIDPOINT --点のスクリーン座標が文字の境界ボックスの外側にあります。
GXFPF_ROUND_NEAREST-- hr = TF_E_INVALIDPOINT --点のスクリーン座標が文字の境界ボックスの外側にあるため、既定の動作になります。
GXFPF_NEAREST-- pacp = 1 --点のスクリーン座標に最も近い文字位置は文字位置 1 です。

vtbl 4 HRESULT GetTextExt(INT acpStart, INT acpEnd, RECT* prc, BOOL* pfClipped)

ITfContextOwner::GetTextExt メソッドは、指定した文字位置にあるテキストの境界ボックスをスクリーン座標で返します。呼び出し元は、このメソッドを呼び出す前にドキュメントに対する読み取り専用ロックを取得している必要があります。

acpStart	INT	in	取得するテキストの、ドキュメント内での開始文字位置を指定します。
acpEnd	INT	in	取得するテキストの、ドキュメント内での終了文字位置を指定します。
prc	RECT*	out	指定した文字位置にあるテキストの境界ボックスをスクリーン座標で受け取ります。
pfClipped	BOOL*	out	境界ボックス内のテキストがクリップされているかどうかを示すブール値を受け取ります。このパラメーターが TRUE の場合、境界ボックスにはクリップされたテキストが含まれており、要求された範囲のテキスト全体は含まれていません。境界ボックスがクリップされるのは、要求された範囲が表示されていないためです。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
TS_E_INVALIDARG	指定された開始文字位置と終了文字位置が同じです。
TS_E_INVALIDPOS	acpStart パラメーターと acpEnd パラメーターで指定された範囲が、ドキュメントの末尾または先頭を超えています。
TS_E_NOLAYOUT	アプリケーションがテキストレイアウトを計算していません。
TS_E_NOLOCK	呼び出し元がドキュメントに対する読み取り専用ロックを取得していません。

解説(Remarks)

ドキュメントウィンドウが最小化されている場合、または指定したテキストが現在表示されていない場合、このメソッドは prc パラメーターに {0,0,0,0} を設定して S_OK を返します。

vtbl 5 HRESULT GetScreenExt(RECT* prc)

ITfContextOwner::GetScreenExt メソッドは、テキストストリームが描画される表示面の境界ボックスをスクリーン座標で返します。

prc

RECT*

out

ドキュメントの表示面の境界ボックスをスクリーン座標で受け取ります。

戻り値

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

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

解説(Remarks)

ドキュメントウィンドウが最小化されている場合など、テキストが現在表示されていない場合、prc には { 0, 0, 0, 0 } が設定されます。

vtbl 6 HRESULT GetStatus(TS_STATUS* pdcs)

ITfContextOwner::GetStatus メソッドは、ドキュメントの状態を取得します。ドキュメントの状態は TS_STATUS 構造体で返されます。

pdcs

TS_STATUS*

out

ドキュメントの状態を格納した TS_STATUS 構造体を受け取ります。NULL にはできません。

戻り値

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

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

vtbl 7 HRESULT GetWnd(HWND* phwnd)

ITfContextOwner::GetWnd メソッドは、現在のドキュメントに対応するウィンドウのハンドルを返します。

phwnd

HWND*

out

現在のドキュメントに対応するウィンドウのハンドルへのポインターを受け取ります。ドキュメントに対応するウィンドウハンドルが存在しない場合、このパラメーターは NULL になることがあります。

戻り値

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

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

解説(Remarks)

ドキュメントがメモリ上に存在するが画面に表示されていない場合、またはドキュメントがウィンドウレスコントロールであり、そのコントロールがウィンドウレスコントロールの所有者のウィンドウハンドルを把握していない場合、ドキュメントには対応するウィンドウハンドルが存在しないことがあります。呼び出し元は、メソッドが成功した場合でも phwnd パラメーターが非 NULL の値を受け取ると想定してはいけません。呼び出し元は phwnd パラメーターに NULL を受け取ることもあります。

vtbl 8 HRESULT GetAttribute(GUID* rguidAttribute, VARIANT* pvarValue)

ITfContextOwner::GetAttribute メソッドは、サポートされている属性の値を返します。属性がサポートされていない場合、pvarValue パラメーターには VT_EMPTY が設定されます。

rguidAttribute	GUID*	in	属性の GUID を指定します。
pvarValue	VARIANT*	out	属性の値を受け取ります。属性がサポートされていない場合、このパラメーターには VT_EMPTY が設定されます。

戻り値

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

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

解説(Remarks)

TSF マネージャーの既定のテキストストアを使用するコンテキストオーナーは、このメソッドで属性の簡易版を実装できます。サポートされる属性は、アプリケーションまたはテキストサービスに依存します。TSF で認識される定義済みの属性の詳細については、次のトピックを参照してください。

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