ホーム › UI.TextServices › ITfLangBarItem

ITfLangBarItem

COM

📘 Microsoft Learn (日本語) · English

IID73540d69-edeb-4ee9-96c9-23aa30b25916継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfLangBarItem インターフェイスは、言語バー項目のプロバイダーによって実装され、言語バーマネージャーが言語バー項目の詳細情報を取得するために使用します。

メソッド 4

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

vtbl 3 HRESULT GetInfo(TF_LANGBARITEMINFO* pInfo)

ITfLangBarItem::GetInfo メソッド

pInfo

TF_LANGBARITEMINFO*

out

言語バー項目の情報を受け取る TF_LANGBARITEMINFO 構造体へのポインターです。

Windows 8 以降では、この構造体に GUID_LBI_INPUTMODE が含まれていない場合、その項目は無視されます。詳細については、Windows 互換性クックブックのサードパーティ製 Input Method Editor を参照してください。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	pInfo が無効です。

vtbl 4 HRESULT GetStatus(DWORD* pdwStatus)

ITfLangBarItem::GetStatus メソッド

pdwStatus

DWORD*

out

項目の現在の状態を示す TF_LBI_STATUS_* 値のうち 1 つ以上の組み合わせ、または 0 を受け取る DWORD へのポインターです。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	pdwStatus が無効です。

vtbl 5 HRESULT Show(BOOL fShow)

ITfLangBarItem::Show メソッド

fShow

BOOL

項目を表示するか非表示にするかを示す BOOL を格納します。項目を表示する場合は 0 以外の値、それ以外の場合は 0 を格納します。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

値	説明
S_OK	メソッドは成功しました。
E_NOTIMPL	言語バー項目はこのメソッドをサポートしていません。

解説(Remarks)

言語バー項目の実装は、ITfLangBarItem::GetStatus が返す値を変更して TF_LBI_STATUS_HIDDEN 状態フラグを含めるか除外することにより、自身の表示状態を更新する必要があります。その後、TF_LBI_STATUS を指定して ITfLangBarItemSink::OnUpdate を呼び出し、言語バーに新しい状態値を取得させます。

このメソッドは、項目が TF_LBI_STYLE_HIDDENSTATUSCONTROL スタイルを持つ場合にのみ有効です。このスタイルがない場合、項目の表示と非表示を切り替えられるのは言語バーだけです。

vtbl 6 HRESULT GetTooltipString(LPWSTR* pbstrToolTip)

ITfLangBarItem::GetTooltipString メソッド

pbstrToolTip

LPWSTR*

out

言語バー項目のツールヒント文字列を受け取る BSTR 値へのポインターです。この文字列は SysAllocString 関数を使用して割り当てる必要があります。呼び出し元は、このバッファーが不要になった時点で SysFreeString を呼び出して解放する必要があります。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	pbstrToolTip が無効です。
E_NOTIMPL	言語バー項目はツールヒントのテキストをサポートしていません。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfLangBarItem "{73540D69-EDEB-4EE9-96C9-23AA30B25916}"
#usecom global ITfLangBarItem IID_ITfLangBarItem "{}"
#comfunc global ITfLangBarItem_GetInfo           3 var
#comfunc global ITfLangBarItem_GetStatus         4 var
#comfunc global ITfLangBarItem_Show              5 int
#comfunc global ITfLangBarItem_GetTooltipString  6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_ITfLangBarItem "{73540D69-EDEB-4EE9-96C9-23AA30B25916}"
#usecom global ITfLangBarItem IID_ITfLangBarItem "{}"
#comfunc global ITfLangBarItem_GetInfo           3 sptr
#comfunc global ITfLangBarItem_GetStatus         4 sptr
#comfunc global ITfLangBarItem_Show              5 int
#comfunc global ITfLangBarItem_GetTooltipString  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。