ITfContextView
COM公式ドキュメント
ITfContextView インターフェイスは TSF マネージャーによって実装され、クライアント (アプリケーションまたはテキストサービス) がコンテキストのビューに関する情報を取得するために使用します。
メソッド 4
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
ITfContextView::GetRangeFromPoint メソッドは、スクリーン座標で指定された点を、対応する位置にある空のテキスト範囲 (レンジ) に変換します。
| ec | DWORD | in | 読み取り専用アクセス権を持つ編集クッキーを指定します。 | ||||||
| ppt | POINT* | in | スクリーン座標での点を指定します。 | ||||||
| dwFlags | DWORD | in | 点のスクリーン座標を文字のバウンディング ボックスと対応付けて、どの範囲位置を返すかを指定します。既定では、返される範囲位置は、その点のスクリーン座標を含む文字のバウンディング ボックスです。点が文字のバウンディング ボックスの外にある場合、このメソッドは NULL または TF_E_INVALIDPOINT を返します。このパラメーターに指定できるその他のビット フラグは次のとおりです。 これらのビット フラグは組み合わせて指定できます。
| ||||||
| ppRange | ITfRange** | out | ITfRange インターフェイスへのポインターを受け取ります。 |
戻り値
このメソッドは次のいずれかの値を返します。
| 値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| pptScreen パラメーターがドキュメントのテキストのいずれも指していません。 | |
| アプリケーションがテキストのレイアウトを計算していません。 | |
| 指定された編集クッキーが無効です。 |
解説(Remarks)
既定では、このメソッドは点 1 に対して位置 0 の範囲を返し、点 2 に対しては TF_E_INVALIDPOINT を返します。dwFlags パラメーターに GXFPF_ROUND_NEAREST を指定した場合、このメソッドは点 1 に対して範囲位置 1 を返します。dwFlags パラメーターに GXFPF_NEAREST を指定した場合、このメソッドは点 2 に対して範囲位置 2 を返します。ITfContextView::GetTextExt メソッドは、テキストの範囲 (レンジ) のバウンディング ボックスをスクリーン座標で返します。
| ec | DWORD | in | 読み取り専用アクセス権を持つ編集クッキーを指定します。 |
| pRange | ITfRange* | in | 問い合わせる範囲 (レンジ) を指定します。 |
| prc | RECT* | out | 範囲のバウンディング ボックスをスクリーン座標で受け取ります。 |
| pfClipped | BOOL* | out | バウンディング ボックス内のテキストがクリップされているかどうかを示すブール値を受け取ります。このパラメーターが TRUE の場合、バウンディング ボックスにはクリップされたテキストが含まれており、要求された範囲全体は含まれません。バウンディング ボックスがクリップされるのは、要求された範囲が表示されていないためです。 |
戻り値
このメソッドは次のいずれかの値を返します。
| 値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| テキストが描画されていないか、コンテキストがテキストのレイアウトを計算していません。 | |
| 編集クッキーのパラメーターが無効です。 |
解説(Remarks)
ドキュメント ウィンドウが最小化されている場合、または指定されたテキストが現在表示されていない場合、このメソッドは prc パラメーターを {0,0,0,0} に設定して S_OK を返します。
ITfContextView::GetScreenExt メソッドは、ドキュメントの表示領域のバウンディング ボックスをスクリーン座標で返します。
| prc | RECT* | out | 表示面のバウンディング ボックスをスクリーン座標で受け取ります。 |
戻り値
このメソッドは次のいずれかの値を返します。
| 値 | 説明 |
|---|---|
| メソッドは成功しました。 |
解説(Remarks)
ドキュメントが現在表示されていない場合、prc パラメーターは {0,0,0,0} にクリアされます。
ITfContextView::GetWnd メソッドは、現在のドキュメントに対応するウィンドウのハンドルを返します。
| phwnd | HWND* | out | 現在のドキュメントに対応するウィンドウのハンドルへのポインターを受け取ります。 |
戻り値
このメソッドは次のいずれかの値を返します。
| 値 | 説明 |
|---|---|
| メソッドは成功しました。 |
解説(Remarks)
ドキュメントがメモリ上にあるだけで画面に表示されていない場合や、ドキュメントがウィンドウレス コントロールであり、そのコントロールがウィンドウレス コントロールの所有者のウィンドウ ハンドルを保持していない場合、ドキュメントに対応するウィンドウ ハンドルが存在しないことがあります。呼び出し元は、メソッドが成功した場合でも phwnd パラメーターが NULL 以外の値を受け取ると想定してはなりません。呼び出し元は phwnd パラメーターとして NULL を受け取ることもあります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ITfContextView "{2433BF8E-0F9B-435C-BA2C-180611978C30}" #usecom global ITfContextView IID_ITfContextView "{}" #comfunc global ITfContextView_GetRangeFromPoint 3 int,var,int,sptr #comfunc global ITfContextView_GetTextExt 4 int,sptr,var,var #comfunc global ITfContextView_GetScreenExt 5 var #comfunc global ITfContextView_GetWnd 6 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfContextView "{2433BF8E-0F9B-435C-BA2C-180611978C30}" #usecom global ITfContextView IID_ITfContextView "{}" #comfunc global ITfContextView_GetRangeFromPoint 3 int,sptr,int,sptr #comfunc global ITfContextView_GetTextExt 4 int,sptr,sptr,sptr #comfunc global ITfContextView_GetScreenExt 5 sptr #comfunc global ITfContextView_GetWnd 6 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。