ホーム › UI.TextServices › ITfLangBarItemBitmapButton

ITfLangBarItemBitmapButton

COM

IIDa26a0525-3fae-4fa0-89ee-88a964f9f1b5継承元ITfLangBarItem自前メソッド開始 vtbl7

公式ドキュメント

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

解説(Remarks)

言語バーのビットマップボタンは、テキストと小さなビットマップを表示する言語バー上のボタン項目として機能します。項目に表示されるビットマップは、小さいアイコンのサイズを超えないようにしてください。このサイズは、GetSystemMetrics を呼び出し、幅には SM_CXSMICON、高さには SM_CYSMICON を指定することで取得できます。

メソッド 6

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

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

このメソッドは、ボタン項目が TF_LBI_STYLE_BTN_BUTTON スタイルを持たない場合には使用されません。(ITfLangBarItemBitmapButton.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 スタイルを持たない場合には使用されません。(ITfLangBarItemBitmapButton.InitMenu)

pMenu

ITfMenu*

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

戻り値

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

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

vtbl 9 HRESULT OnMenuSelect(DWORD wID)

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

wID

DWORD

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

戻り値

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

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

vtbl 10 HRESULT GetPreferredSize(SIZE* pszDefault, SIZE* psz)

ITfLangBarItemBitmapButton::GetPreferredSize メソッド

pszDefault	SIZE*	in	ビットマップの既定のサイズ(ピクセル単位)を格納する SIZE 構造体へのポインターです。
psz	SIZE*	out	ビットマップの推奨サイズ(ピクセル単位)を受け取る SIZE 構造体へのポインターです。この構造体の cy メンバーは無視されます。

戻り値

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

値	説明
S_OK	メソッドは成功しました。

解説(Remarks)

このメソッドの結果は現在使用されていません。ビットマップボタン項目のビットマップは、小さいアイコンのサイズを超えないようにしてください。このサイズは、GetSystemMetrics を呼び出し、幅には SM_CXSMICON、高さには SM_CYSMICON を指定することで取得できます。

vtbl 11 HRESULT DrawBitmap(INT bmWidth, INT bmHeight, DWORD dwFlags, HBITMAP* phbmp, HBITMAP* phbmpMask)

ITfLangBarItemBitmapButton::DrawBitmap メソッド

bmWidth	INT	in	ビットマップボタン項目の幅(ピクセル単位)を格納します。
bmHeight	INT	in	ビットマップボタン項目の高さ(ピクセル単位)を格納します。
dwFlags	DWORD	in	現在使用されていません。
phbmp	HBITMAP*	out	ビットマップ項目用に描画されたビットマップのハンドルを受け取る HBITMAP 値へのポインターです。
phbmpMask	HBITMAP*	out	マスクビットマップのハンドルを受け取る HBITMAP 値へのポインターです。これは phbmp のマスクとして機能するモノクロビットマップです。このビットマップ内の黒いピクセルは、phbmp の対応するピクセルを通常の色で表示させます。白いピクセルは、phbmp の対応するピクセルを通常の色の反転色で表示させます。色の変換を行わずにビットマップを表示するには、phbmp と同じサイズのモノクロビットマップを作成し、各ピクセルを黒 (RGB(0, 0, 0)) に設定してください。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

vtbl 12 HRESULT GetText(LPWSTR* pbstrText)

ITfLangBarItemBitmapButton::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_ITfLangBarItemBitmapButton "{A26A0525-3FAE-4FA0-89EE-88A964F9F1B5}"
#usecom global ITfLangBarItemBitmapButton IID_ITfLangBarItemBitmapButton "{}"
#comfunc global ITfLangBarItemBitmapButton_OnClick           7 int,int,var
#comfunc global ITfLangBarItemBitmapButton_InitMenu          8 sptr
#comfunc global ITfLangBarItemBitmapButton_OnMenuSelect      9 int
#comfunc global ITfLangBarItemBitmapButton_GetPreferredSize  10 var,var
#comfunc global ITfLangBarItemBitmapButton_DrawBitmap        11 int,int,int,sptr,sptr
#comfunc global ITfLangBarItemBitmapButton_GetText           12 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfLangBarItemBitmapButton "{A26A0525-3FAE-4FA0-89EE-88A964F9F1B5}"
#usecom global ITfLangBarItemBitmapButton IID_ITfLangBarItemBitmapButton "{}"
#comfunc global ITfLangBarItemBitmapButton_OnClick           7 int,int,sptr
#comfunc global ITfLangBarItemBitmapButton_InitMenu          8 sptr
#comfunc global ITfLangBarItemBitmapButton_OnMenuSelect      9 int
#comfunc global ITfLangBarItemBitmapButton_GetPreferredSize  10 sptr,sptr
#comfunc global ITfLangBarItemBitmapButton_DrawBitmap        11 int,int,int,sptr,sptr
#comfunc global ITfLangBarItemBitmapButton_GetText           12 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。