カスタマイズ通知の処理

[アーティクル]
06/16/2023

Windows ツールバーコモンコントロールには、システム定義のカスタマイズダイアログボックスなどのカスタマイズ機能が組み込まれています。この機能を使用して、ユーザーはツールバーボタンを挿入、削除、または再配置できます。アプリケーションは、カスタマイズ機能が使用できるかどうかを判断し、ユーザーがツールバーをどの程度までカスタマイズできるかを制御します。

ツールバーに CCS_ADJUSTABLE スタイルを設定することで、これらのカスタマイズ機能をユーザーが使用できるようになります。カスタマイズ機能を使用すると、ユーザーはボタンを新しい位置にドラッグしたり、ボタンをツールバーの外にドラッグして削除したりできます。さらに、ユーザーはツールバーをダブルクリックして [ツールバーのカスタマイズ] ダイアログボックスを表示し、このダイアログボックスから、ツールバーボタンを追加、削除、再配置できます。アプリケーションでは、 Customize メンバー関数を使用することでこのダイアログボックスを表示できます。

ツールバーコントロールは、カスタマイズ処理の各手順で通知メッセージを親ウィンドウに送信します。ユーザーが Shift キーを押しながらボタンのドラッグを開始すると、ツールバーは自動的にドラッグ操作を処理します。ツールバーは TBN_QUERYDELETE 通知メッセージを親ウィンドウに送信し、ボタンを削除できるかどうかを判断します。親ウィンドウが FALSEを返すと、ドラッグ操作は終了します。それ以外の場合、ツールバーはマウス入力をキャプチャし、ユーザーがマウスボタンを離すのを待機します。

ユーザーがマウスボタンを離すと、ツールバーコントロールはマウスカーソルの場所を確認します。カーソルがツールバーの外側にある場合、ボタンは削除されます。カーソルが別のツールバーボタン上にある場合、ツールバーは TBN_QUERYINSERT 通知メッセージを親ウィンドウに送信し、指定したボタンの左側にボタンを挿入できるかどうかを判断します。親ウィンドウが TRUEを返すと、ボタンは挿入されます。それ以外の場合は、挿入されません。ツールバーは TBN_TOOLBARCHANGE 通知メッセージを送信し、ドラッグ操作の終了を知らせます。

ユーザーが Shift キーを押さずにドラッグ操作を開始すると、ツールバーコントロールは TBN_BEGINDRAG 通知メッセージをオーナーウィンドウに送信します。独自のボタンドラッグコードを実装しているアプリケーションでは、ドラッグ操作を開始するシグナルとしてこのメッセージを使用できます。ツールバーは TBN_ENDDRAG 通知メッセージを送信し、ドラッグ操作の終了を知らせます。

ユーザーが [ツールバーのカスタマイズ] ダイアログボックスを使用してツールバーをカスタマイズすると、ツールバーコントロールは通知メッセージを送信します。ユーザーがツールバーをダブルクリックすると、ダイアログボックスが作成される前に、ツールバーは TBN_BEGINADJUST 通知メッセージを送信します。次に、ツールバーは一連の TBN_QUERYINSERT 通知メッセージの送信を開始し、ツールバーにボタンを挿入できるかどうかを判断します。親ウィンドウが TRUEを返すと、ツールバーは TBN_QUERYINSERT 通知メッセージの送信を終了します。親ウィンドウが、どのボタンに対しても TRUE を返さない場合、ツールバーはダイアログボックスを破棄します。

次に、ツールバーコントロールは、ツールバーのボタンごとに TBN_QUERYDELETE 通知メッセージを送り、ツールバーからボタンを削除できるかどうかを判断します。ボタンを削除できる場合、親ウィンドウは TRUE を返します。それ以外の場合は FALSEを返します。ツールバーはすべてのツールバーボタンをダイアログボックスに追加しますが、削除できないボタンは淡色表示します。

ツールバーコントロールは、[ツールバーのカスタマイズ] ダイアログボックスのボタンに関する情報が必要になると、 TBN_GETBUTTONINFO 通知メッセージを送り、情報が必要なボタンのインデックスと TBNOTIFY 構造体のアドレスを指定します。親ウィンドウは構造体に適切な情報を格納する必要があります。

[ツールバーのカスタマイズ] ダイアログボックスには、[ヘルプ] ボタンと [リセット] ボタンがあります。ユーザーが [ヘルプ] ボタンを選ぶと、ツールバーコントロールは TBN_CUSTHELP 通知メッセージを送信します。親ウィンドウは、ヘルプ情報を表示して応答する必要があります。ユーザーが [リセット] ボタンを選ぶと、ダイアログボックスは TBN_RESET 通知メッセージを送信します。このメッセージは、ツールバーがダイアログボックスを再初期化しようとしていることを示します。

これらのメッセージはすべて WM_NOTIFY メッセージです。メッセージをオーナーウィンドウで処理するには、オーナーウィンドウのメッセージマップに次のような形式でメッセージマップのエントリを追加します。

ON_NOTIFY( wNotifyCode, idControl, memberFxn )

wNotifyCode

通知メッセージの識別子コード。 TBN_BEGINADJUSTなど。
idControl

通知を送信するコントロールの識別子。
memberFxn

この通知を受信したときに呼び出されるメンバー関数。

メンバー関数は次のプロトタイプで宣言されます。

afx_msg void memberFxn( NMHDR * pNotifyStruct, LRESULT * result );

通知メッセージハンドラーが値を返す場合は、その値を result が指す LRESULTに格納する必要があります。

各メッセージに対して、 pNotifyStruct は NMHDR 構造体か TBNOTIFY 構造体のいずれかを指します。これらの構造体は次のとおりです。

NMHDR 構造体には次のメンバーが含まれます。

typedef struct tagNMHDR {
    HWND hwndFrom;  // handle of control sending message
    UINT idFrom;// identifier of control sending message
    UINT code;  // notification code; see below
} NMHDR;

hwndFrom

通知を送信するコントロールのウィンドウハンドル。このハンドルを CWnd ポインターに変換するには、 CWnd::FromHandleを使用します。
idFrom

通知を送信するコントロールの識別子。
code

通知コード。このメンバーは、 TBN_BEGINADJUST や TTN_NEEDTEXTなどのコントロールの種類に固有の値になるか、以下に示す通知に共通の値のいずれかになります。
- NM_CLICK ユーザーがコントロール内でマウスの左ボタンをクリックしました。
- NM_DBLCLK ユーザーがコントロール内でマウスの左ボタンをダブルクリックしました。
- NM_KILLFOCUS コントロールは入力フォーカスを失いました。
- NM_OUTOFMEMORY メモリ不足のために、コントロールは操作を完了できませんでした。
- NM_RCLICK ユーザーがコントロール内でマウスの右ボタンをクリックしました。
- NM_RDBLCLK ユーザーがコントロール内でマウスの右ボタンをダブルクリックしました。
- NM_RETURN コントロールに入力フォーカスがあり、ユーザーが Enter キーを押しました。
- NM_SETFOCUS コントロールは入力フォーカスを受け取りました。

TBNOTIFY 構造体には次のメンバーが含まれます。

typedef struct {
    NMHDR hdr; // information common to all WM_NOTIFY messages
    int iItem; // index of button associated with notification
    TBBUTTON tbButton; // info about button associated withnotification
    int cchText;   // count of characters in button text
    LPSTR lpszText;// address of button text
} TBNOTIFY, FAR* LPTBNOTIFY;

hdr

すべての WM_NOTIFY メッセージに共通の情報。
iItem

通知に関連付けられたボタンのインデックス。
tbButton

通知に関連付けられたツールバーボタンに関する情報を格納する TBBUTTON 構造体。
cchText

ボタンのテキスト文字の数。
lpszText

ボタンのテキストへのポインター。

ツールバーが送信する通知は、次のとおりです。

TBN_BEGINADJUST

ユーザーがツールバーコントロールのカスタマイズを開始すると送信されます。ポインターは、通知についての情報を格納する NMHDR 構造体を指します。ハンドラーが特定の値を返す必要はありません。
TBN_BEGINDRAG

ユーザーがツールバーコントロールにあるボタンのドラッグを開始すると送信されます。ポインターは TBNOTIFY 構造体を指します。 iItem メンバーには、ドラッグされているボタンの 0 から始まるインデックスが含まれます。ハンドラーが特定の値を返す必要はありません。
TBN_CUSTHELP

ユーザーが [ツールバーのカスタマイズ] ダイアログボックスの [ヘルプ] ボタンを選ぶと送信されます。戻り値はありません。ポインターは、この通知メッセージについての情報を格納する NMHDR 構造体を指します。ハンドラーが特定の値を返す必要はありません。
TBN_ENDADJUST

ユーザーがツールバーコントロールのカスタマイズを終了すると送信されます。ポインターは、この通知メッセージについての情報を格納する NMHDR 構造体を指します。ハンドラーが特定の値を返す必要はありません。
TBN_ENDDRAG

ユーザーがツールバーコントロールにあるボタンのドラッグを終了すると送信されます。ポインターは TBNOTIFY 構造体を指します。 iItem メンバーには、ドラッグされているボタンの 0 から始まるインデックスが含まれます。ハンドラーが特定の値を返す必要はありません。
TBN_GETBUTTONINFO

ユーザーがツールバーコントロールをカスタマイズしているときに送信されます。ツールバーは、この通知メッセージを使用して [ツールバーのカスタマイズ] ダイアログボックスで必要になる情報を取得します。ポインターは TBNOTIFY 構造体を指します。 iItem メンバーは、ボタンの 0 から始まるインデックスを指定します。 pszText メンバーと cchText メンバーは、現在のボタンのテキストのアドレスと長さ (文字数) で指定します。アプリケーションでは、ボタンに関する情報をこの構造体に格納する必要があります。ボタンの情報が構造体にコピーされた場合は TRUE を返し、それ以外の場合は FALSE を返します。
TBN_QUERYDELETE

ユーザーがツールバーコントロールをカスタマイズしているときに、ツールバーコントロールからボタンを削除できるかどうかを判断するために送信されます。ポインターは TBNOTIFY 構造体を指します。 iItem メンバーには、削除するボタンの 0 から始まるインデックスが含まれます。ボタンの削除を許可する場合は TRUE を返し、ボタンの削除を禁止する場合は FALSE を返します。
TBN_QUERYINSERT

ユーザーがツールバーコントロールをカスタマイズしているときに、指定したボタンの左側にボタンを挿入できるかどうかを判断するために送信されます。ポインターは TBNOTIFY 構造体を指します。 iItem メンバーには、挿入するボタンの 0 から始まるインデックスが含まれます。指定したボタンの前にボタンの挿入を許可する場合は TRUE を返し、ボタンの挿入を禁止する場合は FALSE を返します。
TBN_RESET

ユーザーが [ツールバーのカスタマイズ] ダイアログボックスの内容をリセットすると送信されます。ポインターは、この通知メッセージについての情報を格納する NMHDR 構造体を指します。ハンドラーが特定の値を返す必要はありません。
TBN_TOOLBARCHANGE

ユーザーがツールバーコントロールをカスタマイズした後に送信されます。ポインターは、この通知メッセージについての情報を格納する NMHDR 構造体を指します。ハンドラーが特定の値を返す必要はありません。

カスタマイズ通知の処理

関連項目

フィードバック

フィードバック

その他のリソース