ITfContextComposition
COM公式ドキュメント
ITfContextComposition インターフェイスは TSF マネージャーによって実装され、テキストサービスがコンポジション (変換中の文字列) を作成および操作するために使用します。このインターフェイスのインスタンスは、IID_ITfContextComposition を指定した ITfContext::QueryInterface によって取得します。
メソッド 4
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
ITfContextComposition::StartComposition メソッド
| ecWrite | DWORD | in | 編集コンテキストを識別する編集クッキーを指定します。これは ITfEditSession::DoEditSession から取得します。 |
| pCompositionRange | ITfRange* | in | コンポジションが最初に対象とするテキストを指定する ITfRange オブジェクトへのポインターです。 |
| pSink | ITfCompositionSink* | in | コンポジションのイベント通知を受け取る ITfCompositionSink オブジェクトへのポインターです。このパラメーターは省略可能で、NULL を指定できます。指定した場合、コンポジションが終了するときにこのオブジェクトは解放されます。 |
| ppComposition | ITfComposition** | out | 新しいコンポジションオブジェクトを受け取る ITfComposition インターフェイスポインターへのポインターです。コンテキストオーナーがコンポジションを拒否した場合、このパラメーターは NULL を受け取ります。 |
戻り値
このメソッドは次の値のいずれかを返します。
| 値 | 説明 |
|---|---|
| メソッドは成功しました。コンテキストオーナーのコンポジションアドバイズシンクがコンポジションを拒否した場合、ppComposition には NULL が設定されます。 | |
| 不特定のエラーが発生しました。 | |
| 1 つ以上のパラメーターが無効です。 | |
| コンポジションオブジェクトを作成できません。 | |
| このメソッドが別のコンポジション操作の中から呼び出されました。 | |
| コンテキストオブジェクトがドキュメントスタック上にありません。 | |
| ecWrite で識別される編集コンテキストが読み取り/書き込みロックを保持していません。 |
解説(Remarks)
コンテキストオーナーがコンテキストオーナーコンポジションアドバイズシンクをインストールしている場合、ITfContextOwnerCompositionSink::OnStartComposition メソッドが呼び出されます。アドバイズシンクが新しいコンポジションを拒否した場合、このメソッドは S_OK を返しますが、ppComposition には NULL が設定されます。
pCompositionRange が対象とするテキストには、GUID_PROP_COMPOSING プロパティが設定されます。
ITfContextComposition::EnumCompositions メソッド
| ppEnum | IEnumITfCompositionView** | out | 列挙子オブジェクトを受け取る IEnumITfCompositionView インターフェイスポインターへのポインターです。 |
戻り値
このメソッドは次の値のいずれかを返します。
| 値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| 列挙子オブジェクトを初期化できませんでした。 | |
| ppEnum が無効です。 | |
| 列挙子オブジェクトを作成できません。 | |
| コンテキストオブジェクトがドキュメントスタック上にありません。 |
ITfContextComposition::FindComposition メソッド
| ecRead | DWORD | in | 編集コンテキストを識別する編集クッキーを指定します。これは ITfEditSession::DoEditSession から取得します。 |
| pTestRange | ITfRange* | in | 検索対象の範囲 (レンジ) を指定する ITfRange オブジェクトへのポインターです。このパラメーターには NULL を指定できます。NULL を指定した場合、列挙子には編集コンテキスト内のすべてのコンポジションが含まれます。 |
| ppEnum | IEnumITfCompositionView** | out | 列挙子オブジェクトを受け取る IEnumITfCompositionView インターフェイスポインターへのポインターです。 |
戻り値
| 値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| 列挙子オブジェクトを初期化できません。 | |
| 1 つ以上のパラメーターが無効です。 | |
| 列挙子オブジェクトを作成できません。 | |
| コンテキストオブジェクトがドキュメントスタック上にありません。 |
ecRead で識別される編集コンテキストが読み取り専用ロックを保持していません。
ITfContextComposition::TakeOwnership メソッド
| ecWrite | DWORD | in | 使用されません。 |
| pComposition | ITfCompositionView* | in | 使用されません。 |
| pSink | ITfCompositionSink* | in | 使用されません。 |
| ppComposition | ITfComposition** | out | 使用されません。 |
戻り値
このメソッドは次の値のいずれかを返します。
| 値 | 説明 |
|---|---|
| このメソッドは現在実装されていません。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ITfContextComposition "{D40C8AAE-AC92-4FC7-9A11-0EE0E23AA39B}"
#usecom global ITfContextComposition IID_ITfContextComposition "{}"
#comfunc global ITfContextComposition_StartComposition 3 int,sptr,sptr,sptr
#comfunc global ITfContextComposition_EnumCompositions 4 sptr
#comfunc global ITfContextComposition_FindComposition 5 int,sptr,sptr
#comfunc global ITfContextComposition_TakeOwnership 6 int,sptr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。