Win32 API 日本語リファレンス
ホームUI.TextServices › ITfTextLayoutSink

ITfTextLayoutSink

COM
IID2af2d06a-dd5b-4927-a0b4-54f19c91fade継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfTextLayoutSink インターフェイスは、アプリケーションによるコンテキストのレイアウト変更に対応します。このアドバイズシンクは、IID_ITfTextLayoutSink を指定して ITfSource::AdviseSink を呼び出すことでインストールします。テキストサービスは、必要に応じてこのインターフェイスを実装できます。

解説(Remarks)

TSF は現在複数のビューをサポートしていないため、このインターフェイスの一部の機能は制限されます。

メソッド 1

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

vtbl 3 HRESULT OnLayoutChange(ITfContext* pic, TfLayoutCode lcode, ITfContextView* pView)

ITfTextLayoutSink::OnLayoutChange メソッド

picITfContext*in変更が発生したコンテキストの ITfContext インターフェイスへのポインター。
lcodeTfLayoutCodeinレイアウトの変更内容を示す TfLayoutCode の要素を指定します。
pViewITfContextView*inレイアウト変更が発生したコンテキストビューの ITfContextView インターフェイスへのポインター。

戻り値

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

解説(Remarks)

各コンテキストには既定のビューがあり、その参照は ITfContext::GetActiveView メソッドで取得できます。このビューについて、本メソッドは lcode パラメーターとして TF_LC_CHANGE の値のみを返します。他の値は複数ビューの場合にのみ発生し得るためです。TSF は複数ビューをサポートしていないため、本メソッドが TfLayoutCode 列挙型の他の値を受け取ることはありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfTextLayoutSink "{2AF2D06A-DD5B-4927-A0B4-54F19C91FADE}"
#usecom global ITfTextLayoutSink IID_ITfTextLayoutSink "{}"
#comfunc global ITfTextLayoutSink_OnLayoutChange  3 sptr,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。