ホーム › UI.TextServices › ITfContextOwnerCompositionSink
ITfContextOwnerCompositionSink
COM公式ドキュメント
ITfContextOwnerCompositionSink インターフェイスは、コンポジション(変換中の文字列)に関する通知を受け取るためにアプリケーションが実装します。
メソッド 3
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
vtbl 3 HRESULT OnStartComposition(ITfCompositionView* pComposition, BOOL* pfOk)
ITfContextOwnerCompositionSink::OnStartComposition メソッド
| pComposition | ITfCompositionView* | in | 新しいコンポジションを表す ITfCompositionView オブジェクトへのポインター。 |
| pfOk | BOOL* | out | 新しいコンポジションを許可するか拒否するかを示す値を受け取る BOOL 値へのポインター。コンポジションを許可する場合は 0 以外の値、拒否する場合は 0 が格納されます。 |
戻り値
このメソッドは次のいずれかの値を返します。
| 値 | 説明 |
|---|---|
| メソッドは成功しました。 |
vtbl 4 HRESULT OnUpdateComposition(ITfCompositionView* pComposition, ITfRange* pRangeNew)
ITfContextOwnerCompositionSink::OnUpdateComposition メソッド
| pComposition | ITfCompositionView* | in | 更新されたコンポジションを表す ITfCompositionView オブジェクトへのポインター。 |
| pRangeNew | ITfRange* | in | コンポジションの更新後にコンポジションが対象とするテキストの範囲(レンジ)を格納する ITfRange オブジェクトへのポインター。 |
戻り値
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
コンポジション内で何が変更されたかを判断するには、pRangeNew と ITfCompositionView::GetRange から返される範囲を比較します。ITfCompositionView::GetRange が返す範囲は、ITfContextOwnerCompositionSink::OnUpdateComposition が戻るまで更新されません。
vtbl 5 HRESULT OnEndComposition(ITfCompositionView* pComposition)
ITfContextOwnerCompositionSink::OnEndComposition メソッド
| pComposition | ITfCompositionView* | in | 終了したコンポジションを表す ITfCompositionView オブジェクトへのポインター。 |
戻り値
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_ITfContextOwnerCompositionSink "{5F20AA40-B57A-4F34-96AB-3576F377CC79}" #usecom global ITfContextOwnerCompositionSink IID_ITfContextOwnerCompositionSink "{}" #comfunc global ITfContextOwnerCompositionSink_OnStartComposition 3 sptr,var #comfunc global ITfContextOwnerCompositionSink_OnUpdateComposition 4 sptr,sptr #comfunc global ITfContextOwnerCompositionSink_OnEndComposition 5 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfContextOwnerCompositionSink "{5F20AA40-B57A-4F34-96AB-3576F377CC79}" #usecom global ITfContextOwnerCompositionSink IID_ITfContextOwnerCompositionSink "{}" #comfunc global ITfContextOwnerCompositionSink_OnStartComposition 3 sptr,sptr #comfunc global ITfContextOwnerCompositionSink_OnUpdateComposition 4 sptr,sptr #comfunc global ITfContextOwnerCompositionSink_OnEndComposition 5 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。