ホーム ATL/WTL
UI更新ハンドラ - ポップアップメニューアイテム
ドキュメント種別 ATL/WTL に関する文書
最終更新日 2005/04/18
PR
 UI更新ハンドラとは、適切なタイミング(アイドル時やWM_INITMENUPOPUPメッセージが送られてきた時など)に UIの状態を更新するための仕組みです。例えば、メニューアイテムにチェックマークを入れたり、 ツールバーボタンを使用不可にするときなどに使用します。UI更新ハンドラはWTLのCUpdateUIクラスによって実現します。

 ここでは、前回のステータスバーを追加した「Hello, ATL/WTL」プログラムのメニューバーに、 [常に手前に表示]というメニューアイテムを追加します。 このとき、メニューアイテムが選択されるたびに、UI更新ハンドラによってメニューアイテムのチェックマークの付加と消去を繰り返すようにします。


// stdafx.h内
#include <atlbase.h>
#include <atlapp.h>
extern CAppModule _Module;
#include <atlwin.h>

#include <atlcrack.h>
#include <atlmisc.h>
#include <atlframe.h> // CFrameWindowImplクラスを使用するため
			

// MainWindow.h内
// メインウィンドウの基底クラスをCFrameWindowImplに変更
class CMyWindow : public CFrameWindowImpl<CMyWindow>,
    public CMessageFilter, public CIdleHandler, public CUpdateUI<CMyWindow>
{
public:
    // ウィンドウクラス名、共通リソースID、スタイル、背景色を登録
    DECLARE_FRAME_WND_CLASS_EX(_T("Hello"), IDR_MAINFRAME,
        CS_HREDRAW | CS_VREDRAW | CS_DBLCLKS, COLOR_WINDOW)

    // UI更新ハンドラマップ
    BEGIN_UPDATE_UI_MAP(CMyWindow)
        UPDATE_ELEMENT(ID_MENUITEM_TOPMOST, UPDUI_MENUPOPUP)
    END_UPDATE_UI_MAP()

private:
    // メッセージフィルタ処理
    virtual BOOL PreTranslateMessage(MSG* pMsg){
        // 基底クラスのPreTranslateMessageを呼び出す
        return CFrameWindowImpl<CMyWindow>::PreTranslateMessage(pMsg);
    }

    // アイドル処理
    virtual BOOL OnIdle(){
        return FALSE;
    }

    // メッセージマップ
    BEGIN_MSG_MAP_EX(CMyWindow)
        MSG_WM_PAINT(OnPaint)
        MSG_WM_CONTEXTMENU(OnContextMenu)
        MSG_WM_CREATE(OnCreate)
        COMMAND_ID_HANDLER_EX(ID_MENUITEM_TOPMOST, OnMenuTopmost)
        COMMAND_ID_HANDLER_EX(ID_MENUITEM_HELLO, OnMenuHello)
        COMMAND_ID_HANDLER_EX(ID_MENUITEM_EXIT, OnMenuExit)
        CHAIN_MSG_MAP(CUpdateUI<CMyWindow>)         // CUpdateUIクラスへチェーン
        CHAIN_MSG_MAP(CFrameWindowImpl<CMyWindow>)  // CFrameWindowImplクラスへチェーン
    END_MSG_MAP()

    void OnPaint(HDC /*hDC*/){
        CPaintDC dc(m_hWnd);
        CRect rect;
        GetClientRect(rect);
        dc.DrawText(_T("Hello, ATL/WTL"), -1,
            rect, DT_SINGLELINE | DT_CENTER | DT_VCENTER);
    }

    void OnContextMenu(HWND hWnd, CPoint pt){
        // [Shift]+[F10]キーが押された場合は座標をクライアント領域の左上に設定
        if(pt.x == -1 && pt.y == -1){
            pt.SetPoint(0, 0);
            ClientToScreen(&pt);
        }

        // 座標がクライアント領域内の場合のみポップアップメニューを表示
        CRect rc;
        GetClientRect(&rc);
        ClientToScreen(&rc);
        if(rc.PtInRect(pt)){
            CMenu menuPopup;
            menuPopup.LoadMenu(IDR_MENU_POPUP);
            menuPopup.GetSubMenu(0).TrackPopupMenu(
                TPM_LEFTALIGN | TPM_TOPALIGN | TPM_LEFTBUTTON, pt.x, pt.y, m_hWnd);
        }else{
            SetMsgHandled(false);
        }
    }

    LRESULT OnCreate(LPCREATESTRUCT lpcs){
        // リバーを作成
        CreateSimpleReBar();

        // ツールバーを作成してバンドに追加
        HWND hWndToolBar = CreateSimpleToolBarCtrl(m_hWnd,
            IDR_MAINFRAME, FALSE, ATL_SIMPLE_TOOLBAR_PANE_STYLE);
        AddSimpleReBarBand(hWndToolBar);

        // ステータスバーを作成
        CreateSimpleStatusBar();

        // [常に手前に表示]メニューのチェックマーク設定
        UISetCheck(ID_MENUITEM_TOPMOST, false);

        // メッセージループにメッセージフィルタとアイドルハンドラを追加
        CMessageLoop* pLoop = _Module.GetMessageLoop();
        pLoop->AddMessageFilter(this);
        pLoop->AddIdleHandler(this);
        return 0;
    }

    void OnMenuTopmost(UINT uNotifyCode, int nID, HWND hWndCtl){
        bool bTopmost = !(UIGetState(nID) & UPDUI_CHECKED);
        SetWindowPos(bTopmost ? HWND_TOPMOST : HWND_NOTOPMOST,
            0, 0, 0, 0, SWP_NOSIZE | SWP_NOMOVE | SWP_SHOWWINDOW);
        UISetCheck(nID, bTopmost);
    }

    void OnMenuHello(UINT uNotifyCode, int nID, HWND hWndCtl){
        MessageBox(_T("Hello, ATL/WTL"));
    }

    void OnMenuExit(UINT uNotifyCode, int nID, HWND hWndCtl){
        PostMessage(WM_CLOSE);
    }
};
			

// hello.cpp内
#include "stdafx.h"

#include "resource.h"

#include "MainWindow.h"

CAppModule _Module;

int WINAPI _tWinMain(HINSTANCE hInstance, HINSTANCE, LPTSTR lpCmdLine, int nCmdShow)
{
    // コモンコントロール及びリバー初期化
    AtlInitCommonControls(ICC_WIN95_CLASSES | ICC_COOL_CLASSES);

    _Module.Init(NULL, hInstance);

    CMessageLoop theLoop;
    _Module.AddMessageLoop(&theLoop);

    // 独自ウィンドウを作成
    CMyWindow wnd;
    wnd.CreateEx();
    wnd.ShowWindow(nCmdShow);
    wnd.UpdateWindow();

    int nRet = theLoop.Run();

    _Module.RemoveMessageLoop();

    _Module.Term();

    return nRet;
}
			

 まず、メニューバーのトップレベルに[表示]を、その下に[常に手前に表示]メニューアイテムを追加します。 [常に手前に表示]メニューアイテムにはID_MENUITEM_TOPMOSTというリソースIDを設定します。



 CUpdateUIクラスは、メインウィンドウであるCMyWindowクラスの基底クラスとして使用します。 CMyWindowクラスではUI更新ハンドラマップを用意し、更新するメニューアイテムのリソースIDとUIのタイプを登録します。 なお、UI更新ハンドラマップはpublicでなければなりません。

public:
    // UI更新ハンドラマップ
    BEGIN_UPDATE_UI_MAP(CMyWindow)
        UPDATE_ELEMENT(ID_MENUITEM_TOPMOST, UPDUI_MENUPOPUP)
    END_UPDATE_UI_MAP()
			

この例では、ポップアップタイプのメニューアイテムを登録するので、UIのタイプをUPDUI_MENUPOPUPとしています。 UIのタイプはこれを含め次のようなものが用意されています。

UIタイプ 説明
UPDUI_MENUPOPUP ポップアップメニュー(メニューバー下のメニューアイテム含む)
UPDUI_MENUBAR メニューバー(トップレベルのメニューアイテム)
UPDUI_CHILDWINDOW 子ウィンドウ
UPDUI_TOOLBAR ツールバー
UPDUI_STATUSBAR ステータスバー

 次に、メッセージマップに、基底クラスであるCUpdateUIクラスへチェーンを追加します。 これは、今回の例ではポップアップメニューアイテムを更新するからです。 CUpdateUIクラスへチェーンすることによって、 メインウィンドウにWM_INITMENUPOPUPメッセージが送られてくるたびに CUpdateUIクラスへメッセージが送られます。 CUpdateUIクラスの基底クラスであるCUpdateUIBaseにはWM_INITMENUPOPUPメッセージハンドラが用意されており、 そこでポップアップメニューアイテムの状態が更新されます。

 次に、[常に手前に表示]メニューアイテムが選択されたときのコマンドメッセージハンドラを追加します。 メッセージマップにIDがID_MENUITEM_TOPMOSTのコマンドメッセージ用のエントリを追加して、 OnMenuTopmost()というメッセージハンドラを呼び出すようにします。 このハンドラでは、UIGetState()によって現在のチェック状態を取得し、 CUpdateUIクラスのメンバ関数であるUISetCheck()で チェックマークの付加と消去を切り替えています。

ここで注意しなければならないのは、UISetCheck()を呼び出した直後に ポップアップメニューアイテムのチェックマークが更新されるのではなく、 あくまでも、UISetCheck()を呼び出した後にWM_INITMENUPOPUPメッセージが送られてきてから、 UI更新ハンドラによって自動的に更新されるということです。

ダイナミックUI更新ハンドラ
 WTL7.5.5002ではCDynamicUpdateUIクラスが追加されました。 これまでの例では、リソースIDとUIタイプをUI更新ハンドラマップ (BEGIN_UPDATE_UI_MAP/END_UPDATE_UI_MAP)の中で静的に設定していましたが、 CDynamicUpdateUIクラスを使うとリソースIDとUIタイプを動的に設定することができます。

以下に示すのは、先述のCUpdateUIクラスを使用したプログラムを、 CDynamicUpdateUIクラスを使用して書き換える例です。 変更するのはCMyWindowクラスだけです。

// MainWindow.h内
// メインウィンドウの基底クラスにCDynamicUpdateUIを追加
class CMyWindow : public CFrameWindowImpl<CMyWindow>,
    public CMessageFilter, public CIdleHandler, public CDynamicUpdateUI<CMyWindow>
{
public:
    // ウィンドウクラス名、共通リソースID、スタイル、背景色を登録
    DECLARE_FRAME_WND_CLASS_EX(_T("Hello"), IDR_MAINFRAME,
        CS_HREDRAW | CS_VREDRAW | CS_DBLCLKS, COLOR_WINDOW)

    // UI更新ハンドラマップ
    BEGIN_UPDATE_UI_MAP(CMyWindow)
        // エントリなし
    END_UPDATE_UI_MAP()

private:
    // メッセージフィルタ処理
    virtual BOOL PreTranslateMessage(MSG* pMsg){
        // 基底クラスのPreTranslateMessageを呼び出す
        return CFrameWindowImpl<CMyWindow>::PreTranslateMessage(pMsg);
    }

    // アイドル処理
    virtual BOOL OnIdle(){
        return FALSE;
    }

    // メッセージマップ
    BEGIN_MSG_MAP_EX(CMyWindow)
        MSG_WM_PAINT(OnPaint)
        MSG_WM_CONTEXTMENU(OnContextMenu)
        MSG_WM_CREATE(OnCreate)
        COMMAND_ID_HANDLER_EX(ID_MENUITEM_TOPMOST, OnMenuTopmost)
        COMMAND_ID_HANDLER_EX(ID_MENUITEM_HELLO, OnMenuHello)
        COMMAND_ID_HANDLER_EX(ID_MENUITEM_EXIT, OnMenuExit)
        CHAIN_MSG_MAP(CDynamicUpdateUI<CMyWindow>)  // CDynamicUpdateUIクラスへチェーン
        CHAIN_MSG_MAP(CFrameWindowImpl<CMyWindow>)  // CFrameWindowImplクラスへチェーン
    END_MSG_MAP()

    void OnPaint(HDC /*hDC*/){
        CPaintDC dc(m_hWnd);
        CRect rect;
        GetClientRect(rect);
        dc.DrawText(_T("Hello, ATL/WTL"), -1,
            rect, DT_SINGLELINE | DT_CENTER | DT_VCENTER);
    }

    void OnContextMenu(HWND hWnd, CPoint pt){
        // [Shift]+[F10]キーが押された場合は座標をクライアント領域の左上に設定
        if(pt.x == -1 && pt.y == -1){
            pt.SetPoint(0, 0);
            ClientToScreen(&pt);
        }

        // 座標がクライアント領域内の場合のみポップアップメニューを表示
        CRect rc;
        GetClientRect(&rc);
        ClientToScreen(&rc);
        if(rc.PtInRect(pt)){
            CMenu menuPopup;
            menuPopup.LoadMenu(IDR_MENU_POPUP);
            menuPopup.GetSubMenu(0).TrackPopupMenu(
                TPM_LEFTALIGN | TPM_TOPALIGN | TPM_LEFTBUTTON, pt.x, pt.y, m_hWnd);
        }else{
            SetMsgHandled(false);
        }
    }

    LRESULT OnCreate(LPCREATESTRUCT lpcs){
        // リバーを作成
        CreateSimpleReBar();

        // ツールバーを作成してバンドに追加
        HWND hWndToolBar = CreateSimpleToolBarCtrl(m_hWnd,
            IDR_MAINFRAME, FALSE, ATL_SIMPLE_TOOLBAR_PANE_STYLE);
        AddSimpleReBarBand(hWndToolBar);

        // ステータスバーを作成
        CreateSimpleStatusBar();

        // UI更新ハンドラにリソースIDとUIタイプを追加
        UIAddUpdateElement(ID_MENUITEM_TOPMOST, UPDUI_MENUPOPUP);

        // [常に手前に表示]メニューのチェックマーク設定
        UISetCheck(ID_MENUITEM_TOPMOST, false);

        // メッセージループにメッセージフィルタとアイドルハンドラを追加
        CMessageLoop* pLoop = _Module.GetMessageLoop();
        pLoop->AddMessageFilter(this);
        pLoop->AddIdleHandler(this);
        return 0;
    }

    void OnMenuTopmost(UINT uNotifyCode, int nID, HWND hWndCtl){
        bool bTopmost = !(UIGetState(nID) & UPDUI_CHECKED);
        SetWindowPos(bTopmost ? HWND_TOPMOST : HWND_NOTOPMOST,
            0, 0, 0, 0, SWP_NOSIZE | SWP_NOMOVE | SWP_SHOWWINDOW);
        UISetCheck(nID, bTopmost);
    }

    void OnMenuHello(UINT uNotifyCode, int nID, HWND hWndCtl){
        MessageBox(_T("Hello, ATL/WTL"));
    }

    void OnMenuExit(UINT uNotifyCode, int nID, HWND hWndCtl){
        PostMessage(WM_CLOSE);
    }
};
			

 まず、CMyWindowクラスの基底クラスをCUpdateUIクラスから CDynamicUpdateUIクラスに変更します。

 次に、UI更新ハンドラマップを用意しますが、 今回は対象となるリソースIDとUIタイプを動的に設定するので、 UI更新ハンドラマップには何も含みません。

 次に、メッセージマップにCDynamicUpdateUIクラスへのチェーンを追加し、 OnCreate()UIAddUpdateElement()を呼び出してリソースIDとUIタイプを設定します。

 このように、CDynamicUpdateUIクラスを使用すると、 動的にUI更新ハンドラのエントリを追加することができます。 また、CDynamicUpdateUIクラスのメンバ関数であるUIRemoveUpdateElement()を呼び出すことで動的にエントリを削除することができます。