ITfUIElement

COM

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

公式ドキュメント

ITfUIElement インターフェイスは UIElement オブジェクトの基底インターフェイスであり、テキストサービスによって実装されます。

解説(Remarks)

テキストサービスは、QI で取得できる同一オブジェクト上に ITfCandidateListUIElement などの他の UIElement インターフェイスを実装することもできます。アプリケーション側で描画する必要はないものの表示状態はアプリケーションから制御できる UI オブジェクトに対しては、テキストサービスは ITfUIElement インターフェイスのみを実装することもできます。GUID_TFCAT_TIPCAP_UIELEMENTENABLED に分類されるテキストサービスは、すべての UI オブジェクトに対して ITfUIElement を実装する必要があります。

メソッド 4

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

vtbl 3 HRESULT GetDescription(LPWSTR* pbstrDescription)

ITfUIElement::GetDescription メソッドは、UI 要素の説明を返します。

pbstrDescription

LPWSTR*

out

[in] UI 要素の説明を格納する BSTR へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。

vtbl 4 HRESULT GetGUID(GUID* pguid)

ITfUIElement::GetGUID メソッドは、この UI 要素の一意な ID を返します。

pguid

GUID*

out

[out] UI 要素の GUID を受け取るポインター。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。

vtbl 5 HRESULT Show(BOOL bShow)

ITfUIElement::Show メソッドは、この UI 要素に対応するテキストサービスの UI を表示します。

bShow

BOOL

[in] 要素の本来の UI を表示する場合は TRUE。要素の本来の UI を非表示にする場合は FALSE。

戻り値

このメソッドは次のいずれかの値を返します。

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

vtbl 6 HRESULT IsShown(BOOL* pbShow)

ITfUIElement::IsShown メソッドは、UI が現在テキストサービスによって表示されている場合は true を、そうでない場合は false を返します。

pbShow

BOOL*

out

[out] この要素の本来の UI の現在の表示状態を受け取る bool へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfUIElement "{EA1EA137-19DF-11D7-A6D2-00065B84435C}"
#usecom global ITfUIElement IID_ITfUIElement "{}"
#comfunc global ITfUIElement_GetDescription  3 var
#comfunc global ITfUIElement_GetGUID         4 var
#comfunc global ITfUIElement_Show            5 int
#comfunc global ITfUIElement_IsShown         6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_ITfUIElement "{EA1EA137-19DF-11D7-A6D2-00065B84435C}"
#usecom global ITfUIElement IID_ITfUIElement "{}"
#comfunc global ITfUIElement_GetDescription  3 sptr
#comfunc global ITfUIElement_GetGUID         4 sptr
#comfunc global ITfUIElement_Show            5 int
#comfunc global ITfUIElement_IsShown         6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。