ホーム › UI.TextServices › ITfLangBarItemButton

ITfLangBarItemButton

COM

IID28c7f1d0-de25-11d2-afdd-00105a2799b5継承元ITfLangBarItem自前メソッド開始 vtbl7

公式ドキュメント

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

解説(Remarks)

言語バーのボタンは、言語バー上でプッシュボタン、トグルボタン、またはメニューとして機能します。

ボタンが TF_LBI_STYLE_BTN_BUTTON スタイルを持つ場合、ボタンはユーザーがマウスでクリックできるプッシュボタンとして動作します。ユーザーがボタンをクリックすると、ITfLangBarItemButton::OnClick が呼び出されます。ITfLangBarItemButton::InitMenu および ITfLangBarItemButton::OnMenuSelect は使用されません。

ボタンが TF_LBI_STYLE_BTN_TOGGLE スタイルを持つ場合、ボタンはユーザーがマウスで選択または選択解除できるチェックボックスに似た動作をします。ユーザーがボタンをクリックすると、ITfLangBarItemButton::OnClick が呼び出されます。ITfLangBarItemButton::InitMenu および ITfLangBarItemButton::OnMenuSelect は使用されません。

ボタンが TF_LBI_STYLE_BTN_MENU スタイルを持つ場合、ボタンはトップレベルのメニュー項目のように動作します。ユーザーがボタンをクリックすると、ITfLangBarItemButton::InitMenu が呼び出されます。ユーザーがメニュー内の項目を選択すると、ITfLangBarItemButton::OnMenuSelect が呼び出されます。ITfLangBarItemButton::OnClick は使用されません。

メソッド 5

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

vtbl 7 HRESULT OnClick(TfLBIClick click, POINT pt, RECT* prcArea)

ボタン項目が TF_LBI_STYLE_BTN_BUTTON スタイルを持たない場合、このメソッドは使用されません。(ITfLangBarItemButton.OnClick)

click	TfLBIClick	in	ボタンのクリックにどのマウスボタンが使用されたかを示す TfLBIClick の値のいずれかを格納します。
pt	POINT	in	クリックイベント発生時のマウスカーソルの位置を画面座標で格納する POINT 構造体へのポインターです。
prcArea	RECT*	in	ボタンの外接矩形を画面座標で格納する RECT 構造体へのポインターです。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	1 つ以上の引数が無効です。

vtbl 8 HRESULT InitMenu(ITfMenu* pMenu)

ボタン項目が TF_LBI_STYLE_BTN_MENU スタイルを持たない場合、このメソッドは使用されません。(ITfLangBarItemButton.InitMenu)

pMenu

ITfMenu*

言語バーのボタンが、言語バーによってそのボタン用に表示されるメニューへ項目を追加するために使用する ITfMenu インターフェイスへのポインターです。

戻り値

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

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

vtbl 9 HRESULT OnMenuSelect(DWORD wID)

ボタン項目が TF_LBI_STYLE_BTN_MENU スタイルを持たない場合、このメソッドは使用されません。(ITfLangBarItemButton.OnMenuSelect)

wID

DWORD

選択されたメニュー項目の識別子を指定します。これは ITfMenu::AddMenuItem の uId 引数に渡された値です。

戻り値

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

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

vtbl 10 HRESULT GetIcon(HICON* phIcon)

ITfLangBarItemButton::GetIcon メソッド

phIcon

HICON*

out

アイコンのハンドルを受け取る HICON 値へのポインターです。ボタンにアイコンがない場合は NULL を受け取ります。呼び出し元は、このアイコンが不要になった時点で DestroyIcon を呼び出して解放する必要があります。

戻り値

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

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

解説(Remarks)

アイコンの理想的なサイズは、幅については GetSystemMetrics(SM_CXSMICON)、高さについては GetSystemMetrics(SM_CYSMICON) を呼び出すことで取得できます。

ボタンが TF_LBI_STYLE_TEXTCOLORICON スタイルを持つ場合、このメソッドで取得されるアイコンはモノクロのアイコンである必要があります。

vtbl 11 HRESULT GetText(LPWSTR* pbstrText)

ITfLangBarItemButton::GetText メソッド

pbstrText

LPWSTR*

out

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

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	pbstrText が無効です。
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_ITfLangBarItemButton "{28C7F1D0-DE25-11D2-AFDD-00105A2799B5}"
#usecom global ITfLangBarItemButton IID_ITfLangBarItemButton "{}"
#comfunc global ITfLangBarItemButton_OnClick       7 int,int,var
#comfunc global ITfLangBarItemButton_InitMenu      8 sptr
#comfunc global ITfLangBarItemButton_OnMenuSelect  9 int
#comfunc global ITfLangBarItemButton_GetIcon       10 sptr
#comfunc global ITfLangBarItemButton_GetText       11 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfLangBarItemButton "{28C7F1D0-DE25-11D2-AFDD-00105A2799B5}"
#usecom global ITfLangBarItemButton IID_ITfLangBarItemButton "{}"
#comfunc global ITfLangBarItemButton_OnClick       7 int,int,sptr
#comfunc global ITfLangBarItemButton_InitMenu      8 sptr
#comfunc global ITfLangBarItemButton_OnMenuSelect  9 int
#comfunc global ITfLangBarItemButton_GetIcon       10 sptr
#comfunc global ITfLangBarItemButton_GetText       11 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。