UI更新ハンドラ - ポップアップメニューアイテム

ホーム

WTL Mobile

ドキュメント種別	ATL/WTL に関する文書
最終更新日	2009/07/04
PR

　UI更新ハンドラとは、適切なタイミング（アイドル時やWM_INITMENUPOPUPメッセージが送られてきた時など）に UIの状態を更新するための仕組みです。例えば、メニューアイテムにチェックマークを入れたり、ツールバーボタンを使用不可にするときなどに使用します。UI更新ハンドラはWTLのCUpdateUIクラステンプレートによって実現します。

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

	プロジェクトファイルダウンロード

// stdafx.h
#pragma once

#define WINVER _WIN32_WCE
#define _SECURE_ATL 1

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

#include <aygshell.h>
#pragma comment(lib, "aygshell.lib")

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

// MainWindow.h
#pragma once

class CMainWindow : public CFrameWindowImpl<CMainWindow>,
    public CMessageFilter, public CIdleHandler, public CUpdateUI<CMainWindow>
{
public:
    // ウィンドウクラス名、共通リソースID、スタイル、背景色を登録
    DECLARE_FRAME_WND_CLASS_EX(_T("SampleProject"), IDR_MAINFRAME,
        CS_HREDRAW | CS_VREDRAW, COLOR_WINDOW)

    virtual BOOL PreTranslateMessage(MSG* pMsg){
        // 基底クラスのPreTranslateMessageを呼び出す
        return CFrameWindowImpl<CMainWindow>::PreTranslateMessage(pMsg);
    }

    virtual BOOL OnIdle(){
        return FALSE;
    }

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

    BEGIN_MSG_MAP(CMainWindow)
        MSG_WM_PAINT(OnPaint)
        MSG_WM_CREATE(OnCreate)
        MSG_WM_DESTROY(OnDestroy)
        COMMAND_ID_HANDLER_EX(ID_RMENU_STATUSBAR, OnRMenuStatusbar)
        COMMAND_ID_HANDLER_EX(ID_RMENU_VERSION, OnRMenuVersion)
        COMMAND_ID_HANDLER_EX(ID_LMENU_CLOSE, OnLMenuClose)
        CHAIN_MSG_MAP(CUpdateUI<CMainWindow>)         // CUpdateUIへチェイン
        CHAIN_MSG_MAP(CFrameWindowImpl<CMainWindow>)  // CFrameWindowImplへチェイン
    END_MSG_MAP()

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

    int OnCreate(LPCREATESTRUCT lpCreateStruct){
        // メニューバー作成
        CreateSimpleCEMenuBar(IDR_MAINFRAME, SHCMBF_HMENU);

        // ツールバー作成
        CreateSimpleCEToolBar();

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

        // [ステータスバー表示]メニューのチェックマーク設定
        UISetCheck(ID_RMENU_STATUSBAR, true);

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

    void OnDestroy(){
        // メッセージループからメッセージフィルタとアイドルハンドラを削除
        CMessageLoop* pLoop = _Module.GetMessageLoop();
        pLoop->RemoveMessageFilter(this);
        pLoop->RemoveIdleHandler(this);
        SetMsgHandled(false);
    }

    void OnRMenuStatusbar(UINT uNotifyCode, int nID, CWindow wndCtl){
        bool bVisible = !::IsWindowVisible(m_hWndStatusBar);
        ::ShowWindow(m_hWndStatusBar, bVisible ? SW_SHOWNOACTIVATE : SW_HIDE);
        UpdateLayout();
        UISetCheck(ID_RMENU_STATUSBAR, bVisible);
    }

    void OnRMenuVersion(UINT uNotifyCode, int nID, CWindow wndCtl){
        MessageBox(_T("SampleProject"));
    }

    void OnLMenuClose(UINT uNotifyCode, int nID, CWindow wndCtl){
        PostMessage(WM_CLOSE);
    }
};

// SampleProject.cpp
#include "stdafx.h"
#include "resource.h"
#include "MainWindow.h"

CAppModule _Module;

int APIENTRY _tWinMain(HINSTANCE hInstance, 
                       HINSTANCE hPrevInstance, 
                       LPTSTR    lpCmdLine, 
                       int       nCmdShow)
{
    UNREFERENCED_PARAMETER(hPrevInstance);
    UNREFERENCED_PARAMETER(lpCmdLine);

    TCHAR szAppName[] = _T("SampleProject");

    HWND hWnd = FindWindow(szAppName, szAppName);    
    if(hWnd){
        SetForegroundWindow((HWND)((ULONG) hWnd | 0x00000001));
        return 0;
    }

    _Module.Init(NULL, hInstance);

    CMessageLoop theLoop;
    _Module.AddMessageLoop(&theLoop);

    CMainWindow wnd;
    wnd.CreateEx();
    wnd.ShowWindow(nCmdShow);

    int nRet = theLoop.Run();

    _Module.RemoveMessageLoop();

    _Module.Term();

    return nRet;
}

　まず、メニューバーにメニューアイテムを追加し、［ID］と［Caption］を次のように設定します。

リソース名	ID	Caption
メニューアイテム	ID_RMENU_STATUSBAR	ステータスバー表示

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

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

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

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

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

　次に、リソースIDがID_RMENU_STATUSBARのWM_COMMANDメッセージハンドラとして OnRMenuStatusbar()を追加します。このハンドラ関数では、IsWindowVisible()を呼び出してステータスバーの表示状態を取得し、 UISetCheck()を呼び出してチェックマークの付加と消去を切り替えます。

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

ダイナミックUI更新ハンドラ

前述の例では、リソースIDとUIタイプをUI更新ハンドラマップ（BEGIN_UPDATE_UI_MAP/END_UPDATE_UI_MAP）の中で静的に設定していましたが、 CDynamicUpdateUIクラステンプレートを使うとリソースIDとUIタイプを動的に設定することができます。

以下に示すのは、前述のプログラムのCUpdateUIを CDynamicUpdateUIに変更して、ダイナミックUI更新ハンドラを使用する例です。

	プロジェクトファイルダウンロード

// MainWindow.h
#pragma once

class CMainWindow : public CFrameWindowImpl<CMainWindow>,
    public CMessageFilter, public CIdleHandler, public CDynamicUpdateUI<CMainWindow>
{
public:
    // ウィンドウクラス名、共通リソースID、スタイル、背景色を登録
    DECLARE_FRAME_WND_CLASS_EX(_T("SampleProject"), IDR_MAINFRAME,
        CS_HREDRAW | CS_VREDRAW, COLOR_WINDOW)

    virtual BOOL PreTranslateMessage(MSG* pMsg){
        // 基底クラスのPreTranslateMessageを呼び出す
        return CFrameWindowImpl<CMainWindow>::PreTranslateMessage(pMsg);
    }

    virtual BOOL OnIdle(){
        return FALSE;
    }

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

    BEGIN_MSG_MAP(CMainWindow)
        MSG_WM_PAINT(OnPaint)
        MSG_WM_CREATE(OnCreate)
        MSG_WM_DESTROY(OnDestroy)
        COMMAND_ID_HANDLER_EX(ID_RMENU_STATUSBAR, OnRMenuStatusbar)
        COMMAND_ID_HANDLER_EX(ID_RMENU_VERSION, OnRMenuVersion)
        COMMAND_ID_HANDLER_EX(ID_LMENU_CLOSE, OnLMenuClose)
        CHAIN_MSG_MAP(CDynamicUpdateUI<CMainWindow>)  // CDynamicUpdateUIへチェイン
        CHAIN_MSG_MAP(CFrameWindowImpl<CMainWindow>)  // CFrameWindowImplへチェイン
    END_MSG_MAP()

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

    int OnCreate(LPCREATESTRUCT lpCreateStruct){
        // メニューバー作成
        CreateSimpleCEMenuBar(IDR_MAINFRAME, SHCMBF_HMENU);

        // ツールバー作成
        CreateSimpleCEToolBar();

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

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

        // [ステータスバー表示]メニューのチェックマーク設定
        UISetCheck(ID_RMENU_STATUSBAR, true);

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

    void OnDestroy(){
        // メッセージループからメッセージフィルタとアイドルハンドラを削除
        CMessageLoop* pLoop = _Module.GetMessageLoop();
        pLoop->RemoveMessageFilter(this);
        pLoop->RemoveIdleHandler(this);
        SetMsgHandled(false);
    }

    void OnRMenuStatusbar(UINT uNotifyCode, int nID, CWindow wndCtl){
        bool bVisible = !::IsWindowVisible(m_hWndStatusBar);
        ::ShowWindow(m_hWndStatusBar, bVisible ? SW_SHOWNOACTIVATE : SW_HIDE);
        UpdateLayout();
        UISetCheck(ID_RMENU_STATUSBAR, bVisible);
    }

    void OnRMenuVersion(UINT uNotifyCode, int nID, CWindow wndCtl){
        MessageBox(_T("SampleProject"));
    }

    void OnLMenuClose(UINT uNotifyCode, int nID, CWindow wndCtl){
        PostMessage(WM_CLOSE);
    }
};

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

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

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

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