ホーム › UI.TextServices › ITfReadingInformationUIElement

ITfReadingInformationUIElement

COM

📘 Microsoft Learn (日本語) · English

IIDea1ea139-19df-11d7-a6d2-00065b84435c継承元ITfUIElement自前メソッド開始 vtbl7

公式ドキュメント

ITfCandidateListUIElement インターフェイスは、キャレット近傍に読み情報 UI を表示する UI を持つテキストサービスが実装します。

メソッド 6

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

vtbl 7 HRESULT GetUpdatedFlags(DWORD* pdwFlags)

このメソッドは、この要素のどの部分が更新されたかを示すフラグを返します。

pdwFlags

DWORD*

out

[out] 次のビットの組み合わせであるフラグを受け取るポインター:

値	意味
TF_RIUIE_CONTEXT	対象の ITfContext が変更されました。
TF_RIUIE_STRING	読み情報の文字列が変更されました。
TF_RIUIE_MAXREADINGSTRINGLENGTH	読み情報の文字列の最大長が変更されました。
TF_RIUIE_ERRORINDEX	読み情報の文字列のエラーインデックスが変更されました。
TF_RIUIE_VERTICALORDER	縦方向表示の優先設定が変更されました。

戻り値

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

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

vtbl 8 HRESULT GetContext(ITfContext** ppic)

このメソッドは、この読み情報 UI の対象となる ITfContext を返します。

ppic

ITfContext**

out

[out] この UI 要素の対象となる ITfContext インターフェイスを受け取るポインター。

戻り値

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

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

vtbl 9 HRESULT GetString(LPWSTR* pstr)

このメソッドは、読み情報 UI に表示される文字列を返します。

pstr

LPWSTR*

out

[out] 読み情報の文字列を格納する BSTR へのポインター。

戻り値

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

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

vtbl 10 HRESULT GetMaxReadingStringLength(DWORD* pcchMax)

ITfReadingInformationUIElement::GetMaxReadingStringLength メソッドは、読み情報 UI に表示できる最大文字数を返します。

pcchMax

DWORD*

out

[out] 読み情報の文字列の最大長を受け取るポインター。

戻り値

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

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

vtbl 11 HRESULT GetErrorIndex(DWORD* pErrorIndex)

このメソッドは、入力エラーが発生した文字インデックスを返します。

pErrorIndex

DWORD*

out

[out] 入力エラーが発生した文字インデックスを受け取るポインター。

戻り値

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

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

vtbl 12 HRESULT IsVerticalOrderPreferred(BOOL* pfVertical)

このメソッドは、UI を縦方向に表示することが望ましいかどうかを返します。

pfVertical

BOOL*

out

[out] UI を縦方向に表示することが望ましい場合は True。

戻り値

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

値	説明
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_ITfReadingInformationUIElement "{EA1EA139-19DF-11D7-A6D2-00065B84435C}"
#usecom global ITfReadingInformationUIElement IID_ITfReadingInformationUIElement "{}"
#comfunc global ITfReadingInformationUIElement_GetUpdatedFlags            7 var
#comfunc global ITfReadingInformationUIElement_GetContext                 8 sptr
#comfunc global ITfReadingInformationUIElement_GetString                  9 var
#comfunc global ITfReadingInformationUIElement_GetMaxReadingStringLength  10 var
#comfunc global ITfReadingInformationUIElement_GetErrorIndex              11 var
#comfunc global ITfReadingInformationUIElement_IsVerticalOrderPreferred   12 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfReadingInformationUIElement "{EA1EA139-19DF-11D7-A6D2-00065B84435C}"
#usecom global ITfReadingInformationUIElement IID_ITfReadingInformationUIElement "{}"
#comfunc global ITfReadingInformationUIElement_GetUpdatedFlags            7 sptr
#comfunc global ITfReadingInformationUIElement_GetContext                 8 sptr
#comfunc global ITfReadingInformationUIElement_GetString                  9 sptr
#comfunc global ITfReadingInformationUIElement_GetMaxReadingStringLength  10 sptr
#comfunc global ITfReadingInformationUIElement_GetErrorIndex              11 sptr
#comfunc global ITfReadingInformationUIElement_IsVerticalOrderPreferred   12 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。