ホーム › UI.TextServices › ITfUIElementSink

ITfUIElementSink

COM

IIDea1ea136-19df-11d7-a6d2-00065b84435c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfUIElementSink インターフェイスは、UI 要素が変更されたときに通知を受け取るためにアプリケーションが実装します。

解説(Remarks)

このアドバイズシンクをインストールするには、ITfUIElementMgr オブジェクトに対して IID_ITfSource を指定して ITfUIElementMgr::QueryInterface を呼び出し、ITfSource オブジェクトを取得します。次に、IID_ITfUIElementSink を指定して ITfSource::AdviseSink を呼び出します。

メソッド 3

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

vtbl 3 HRESULT BeginUIElement(DWORD dwUIElementId, BOOL* pbShow)

ITfUIElementSink::BeginUIElement メソッドは、UIElement が開始されたときに呼び出されます。このシンクにより、テキストサービスに UI 要素を描画させるかどうかを制御できます。

dwUIElementId	DWORD	in	[in] 開始された UIElement の ID。
pbShow	BOOL*	inout	[in, out] アプリケーションが UIElement の内容を描画せず、テキストサービスが本来の UI を描画する場合は true を返します。アプリケーションが UIElement の内容を描画し、テキストサービスによる描画を抑止する場合は false を返します。アプリケーションは ITfUIElementMgr::GetUIElement を使用して ITfUIElement インターフェイスを取得し、IID_ITfCandidateListUIElement やその他の UIElement インターフェイスで QueryInterface を行うことで、その UIElement を処理できるかどうかを判断できます。未知の UIElement や処理できない UIElement の場合、アプリケーションは常に FALSE を返して構いません。この場合、テキストサービスは画面上に追加の UI を表示しません。これは全画面表示のアプリケーションなどに適した方法です。逆に、特定の UI や未知の UI についてはテキストサービスの UI を利用するために TRUE を返すこともできます。

戻り値

TSF マネージャーはこのメソッドの戻り値を無視します。

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。

vtbl 4 HRESULT UpdateUIElement(DWORD dwUIElementId)

ITfUIElementSink::UpdateUIElement メソッドは、UIElement の内容が更新されたときに呼び出されます。

dwUIElementId

DWORD

[in] 内容が更新された UIElement の ID。

戻り値

TSF マネージャーはこのメソッドの戻り値を無視します。

vtbl 5 HRESULT EndUIElement(DWORD dwUIElementId)

ITfUIElementSink::EndUIElement メソッドは、UIElement が終了したときに呼び出されます。

dwUIElementId

DWORD

[in] 終了した UIElement の ID。

戻り値

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_ITfUIElementSink "{EA1EA136-19DF-11D7-A6D2-00065B84435C}"
#usecom global ITfUIElementSink IID_ITfUIElementSink "{}"
#comfunc global ITfUIElementSink_BeginUIElement   3 int,var
#comfunc global ITfUIElementSink_UpdateUIElement  4 int
#comfunc global ITfUIElementSink_EndUIElement     5 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_ITfUIElementSink "{EA1EA136-19DF-11D7-A6D2-00065B84435C}"
#usecom global ITfUIElementSink IID_ITfUIElementSink "{}"
#comfunc global ITfUIElementSink_BeginUIElement   3 int,sptr
#comfunc global ITfUIElementSink_UpdateUIElement  4 int
#comfunc global ITfUIElementSink_EndUIElement     5 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。