ホーム › UI.TextServices › ITfSystemLangBarItem

ITfSystemLangBarItem

COM

IID1e13e9ec-6b33-4d4a-b5eb-8a92f029f356継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfSystemLangBarItem インターフェイスは、システム言語バーメニューによって実装され、システム言語バーの拡張機能がメニューに表示されるアイコンやツールチップ文字列を変更するために使用します。

解説(Remarks)

システム言語バーメニューは、サードパーティの拡張機能によって追加されるメニュー項目をサポートする、言語バー上のオブジェクトです。システム項目は ITfSource インターフェイスをサポートし、その ITfSource::AdviseSink の実装において IID_ITfSystemLangBarItemSink 識別子をサポートする必要があります。また、システム項目は ITfSystemLangBarItem インターフェイスも実装する必要があります。システム項目は ITfSystemLangBarItemSink インターフェイスを使用して、拡張機能が項目を追加できるようにします。

メソッド 2

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

vtbl 3 HRESULT SetIcon(HICON hIcon)

ITfSystemLangBarItem::SetIcon メソッド

hIcon

HICON

新しいアイコンのハンドルを格納します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_NOTIMPL	システム言語バーメニューはアイコンの変更を許可していません。

解説(Remarks)

このメソッドへの応答として、システム言語バーメニューは TF_LBI_ICON を指定して ITfLangBarItemSink::OnUpdate を呼び出し、言語バーに新しいアイコンを取得させる必要があります。

vtbl 4 HRESULT SetTooltipString(LPWSTR pchToolTip, DWORD cch)

ITfSystemLangBarItem::SetTooltipString メソッド

pchToolTip	LPWSTR	in	ツールチップとして表示される文字列。
cch	DWORD	in	文字列のサイズ (文字数)。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_NOTIMPL	システム言語バーメニューのツールチップ文字列は変更できません。

解説(Remarks)

このメソッドへの応答として、システム言語バーメニューは TF_LBI_TOOLTIP を指定して ITfLangBarItemSink::OnUpdate を呼び出し、言語バーに新しいツールチップテキストを取得させる必要があります。

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