オーナードロー

ホーム

WTL Mobile

オーナードロー

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

　オーナードローを利用すると、コントロールの外観を独自に描画することができます。 WTLはオーナードローをサポートするためにCOwnerDrawクラステンプレートを用意しています。

　次に示すのは、COwnerDrawクラステンプレートを使用する例です。青と赤のプッシュボタンを作成します。

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

// stdafx.h
#pragma once

#define WINVER 0x0420
#include <atlbase.h>
#if _ATL_VER == 0x900
#define _SECURE_ATL 1
#endif

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

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

#include <atlcrack.h>
#include <atlmisc.h>
#include <atlframe.h>
#include <atlctrls.h>
#define _WTL_CE_NO_ZOOMSCROLL
#define _WTL_CE_NO_FULLSCREEN
#include <atlwince.h>

// SampleProjectDialog.h
#pragma once

class CSampleProjectDialog : 
    public CAppStdDialogImpl<CSampleProjectDialog>,
    public CUpdateUI<CSampleProjectDialog>,
    public CMessageFilter, public CIdleHandler, 
    public COwnerDraw<CSampleProjectDialog>
{
public:
    DECLARE_APP_DLG_CLASS(NULL, IDR_MAINFRAME, L"Software\\WTL")

    enum { IDD = IDD_MAINDLG };

    virtual BOOL PreTranslateMessage(MSG* pMsg){
        return CWindow::IsDialogMessage(pMsg);
    }

    virtual BOOL OnIdle(){
        return FALSE;
    }

    BEGIN_UPDATE_UI_MAP(CSampleProjectDialog)
    END_UPDATE_UI_MAP()

    BEGIN_MSG_MAP(CSampleProjectDialog)
        MSG_WM_INITDIALOG(OnInitDialog)
        MSG_WM_DESTROY(OnDestroy)
        CHAIN_MSG_MAP(CUpdateUI<CSampleProjectDialog>)
        CHAIN_MSG_MAP(CAppStdDialogImpl<CSampleProjectDialog>)
        CHAIN_MSG_MAP(COwnerDraw<CSampleProjectDialog>)    // COwnerDrawへチェイン
    END_MSG_MAP()

    void DrawItem(LPDRAWITEMSTRUCT lpdis){
        if(lpdis->CtlType == ODT_BUTTON){
            switch(lpdis->CtlID){
            case IDC_BUTTON_BLUE:
                DrawButton(lpdis, RGB(255, 255, 255), RGB(0, 0, 255));
                break;
            case IDC_BUTTON_RED:
                DrawButton(lpdis, RGB(255, 255, 255), RGB(255, 0, 0));
                break;
            default:
                break;
            }
        }
    }

    void DrawButton(LPDRAWITEMSTRUCT lpdis, COLORREF clrText, COLORREF clrBg){
        CDCHandle dc = lpdis->hDC;
        dc.SaveDC();
 
        // ボタン描画
        CPen pen;
        CBrush brushBg;
        if(lpdis->itemState & ODS_SELECTED){
            pen.CreatePen(PS_SOLID, 4, RGB(0, 0, 0));
            brushBg.CreateSolidBrush(RGB(0, 0, 0));
        }else if(lpdis->itemState & ODS_FOCUS){
            pen.CreatePen(PS_SOLID, 4, RGB(0, 0, 0));
            brushBg.CreateSolidBrush(clrBg);
        }else{
            pen.CreatePen(PS_SOLID, 2, RGB(0, 0, 0));
            brushBg.CreateSolidBrush(clrBg);
        }
        HPEN hOldPen = dc.SelectPen(pen);
        HBRUSH hOldBrush = dc.SelectBrush(brushBg);
        dc.Rectangle(&lpdis->rcItem);
        dc.SelectBrush(hOldBrush);
        dc.SelectPen(hOldPen);

        // キャプション描画
        dc.SetTextColor(clrText);
        dc.SetBkMode(TRANSPARENT);
        dc.DrawText(_T("オーナードローボタン"), -1,
            &lpdis->rcItem, DT_SINGLELINE | DT_CENTER | DT_VCENTER);

        dc.RestoreDC(-1);
    }

    BOOL OnInitDialog(CWindow wndFocus, LPARAM lInitParam){
        AtlCreateEmptyMenuBar(m_hWnd);

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

        SetMsgHandled(false);

        return TRUE;
    }

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

// SampleProject.cpp
#include "stdafx.h"
#include "resourceppc.h"
#include "SampleProjectDialog.h"

CAppModule _Module;

int WINAPI _tWinMain(HINSTANCE hInstance,
    HINSTANCE /*hPrevInstance*/, LPTSTR lpstrCmdLine, int nCmdShow)
{
    HRESULT hRes =
        CSampleProjectDialog::ActivatePreviousInstance(hInstance, lpstrCmdLine);

    if(FAILED(hRes) || S_FALSE == hRes){
        return hRes;
    }

    hRes = ::CoInitializeEx(NULL, COINIT_MULTITHREADED);
    ATLASSERT(SUCCEEDED(hRes));

    AtlInitCommonControls(ICC_DATE_CLASSES);
    SHInitExtraControls();

    hRes = _Module.Init(NULL, hInstance);
    ATLASSERT(SUCCEEDED(hRes));

    int nRet = CSampleProjectDialog::AppRun(lpstrCmdLine, nCmdShow);

    _Module.Term();
    ::CoUninitialize();

    return nRet;
}

　まず、リソースを作成します。ダイアログに各ボタンコントロールを配置し、それぞれの［ID］と［Caption］を次のように設定します。なお、ボタンコントロールの［プロパティ］では［Owner Draw］を［True］に設定します。

コントロール名	ID	Caption
ボタン	IDC_BUTTON_BLUE
ボタン	IDC_BUTTON_RED

　次に、CSampleProjectDialogクラスでは、基底クラスにCOwnerDrawを追加し、メッセージマップにCOwnerDrawへチェインを追加します。 COwnerDrawは、内部に次のようなメッセージマップを用意しています。

// COwnerDrawのメッセージマップ
BEGIN_MSG_MAP(COwnerDraw< T >)
    MESSAGE_HANDLER(WM_DRAWITEM, OnDrawItem)
    MESSAGE_HANDLER(WM_MEASUREITEM, OnMeasureItem)
    MESSAGE_HANDLER(WM_COMPAREITEM, OnCompareItem)
    MESSAGE_HANDLER(WM_DELETEITEM, OnDeleteItem)
ALT_MSG_MAP(1)  // メッセージリフレクション用代替メッセージマップ
    MESSAGE_HANDLER(OCM_DRAWITEM, OnDrawItem)
    MESSAGE_HANDLER(OCM_MEASUREITEM, OnMeasureItem)
    MESSAGE_HANDLER(OCM_COMPAREITEM, OnCompareItem)
    MESSAGE_HANDLER(OCM_DELETEITEM, OnDeleteItem)
END_MSG_MAP()

このメッセージマップでマッピングされる4種類のハンドラ関数は、それぞれ次に示すオーバーライド可能なメンバ関数を呼び出します。

メッセージハンドラ名	オーバーライド可能なメンバ関数名
OnDrawItem	DrawItem
OnMeasureItem	MeasureItem
OnCompareItem	CompareItem
OnDeleteItem	DeleteItem

COwnerDrawへのチェインにより、オーナードローが必要なタイミングでメッセージがCOwnerDrawのメッセージマップへ送られ、これらのオーバーライド可能なメンバ関数が呼び出されます。 COwnerDrawの派生クラス（今回の例ではCSampleProjectDialogクラス）では、これらのメンバ関数をオーバーライドすることによって、コントロールに独自の外観を与えます。

今回の例では、CSampleProjectDialogクラスでDrawItem()をオーバーライドし、コントロールのID別に独自のプッシュボタンを描画します。

　ところで、COwnerDrawのメッセージマップは、メッセージリフレクション用の代替メッセージマップも用意しています。次に示すのはメッセージリフレクションを使ったオーナードローの方法です。

メッセージリフレクションによるオーナードロー

　メッセージリフレクションを利用することによって、コントロール自身にオーナードローさせることができるため、再使用可能なコントロールクラスを記述しやすくなります。次に示すのは、COwnerDrawクラステンプレートとメッセージリフレクションを利用して、色変更が可能なボタンを定義する例です。プロジェクトにColorButton.hというヘッダファイルを追加し、そこにCColorButtonというクラスを定義します。

// ColorButton.h
#pragma once

class CColorButton : public CWindowImpl<CColorButton>, public COwnerDraw<CColorButton>
{
public:
    DECLARE_WND_SUPERCLASS(_T("ColorButton"), _T("BUTTON"))

    COLORREF m_clrText;
    COLORREF m_clrBg;

    CColorButton() : m_clrText(RGB(0, 0, 0)), m_clrBg(RGB(255, 255, 255))
    {}

    BEGIN_MSG_MAP(CColorButton)
        CHAIN_MSG_MAP_ALT(COwnerDraw<CColorButton>, 1)
        DEFAULT_REFLECTION_HANDLER()
    END_MSG_MAP()

    void DrawItem(LPDRAWITEMSTRUCT lpdis){
        CDCHandle dc = lpdis->hDC;
        dc.SaveDC();

        // ボタン描画
        CPen pen;
        CBrush brushBg;
        if(lpdis->itemState & ODS_SELECTED){
            pen.CreatePen(PS_SOLID, 4, RGB(0, 0, 0));
            brushBg.CreateSolidBrush(RGB(0, 0, 0));
        }else if(lpdis->itemState & ODS_FOCUS){
            pen.CreatePen(PS_SOLID, 4, RGB(0, 0, 0));
            brushBg.CreateSolidBrush(m_clrBg);
        }else{
            pen.CreatePen(PS_SOLID, 2, RGB(0, 0, 0));
            brushBg.CreateSolidBrush(m_clrBg);
        }
        HPEN hOldPen = dc.SelectPen(pen);
        HBRUSH hOldBrush = dc.SelectBrush(brushBg);
        dc.Rectangle(&lpdis->rcItem);
        dc.SelectBrush(hOldBrush);
        dc.SelectPen(hOldPen);

        // キャプション描画
        dc.SetTextColor(m_clrText);
        dc.SetBkMode(TRANSPARENT);
        dc.DrawText(_T("オーナードローボタン"), -1,
            &lpdis->rcItem, DT_SINGLELINE | DT_CENTER | DT_VCENTER);

        dc.RestoreDC(-1);
    }

    void SetColor(COLORREF clrText, COLORREF clrBg){
        m_clrText = clrText;
        m_clrBg = clrBg;
    }
};

CColorButtonクラスは CWindowImplとCOwnerDrawから派生しており、返送されたオーナードロー用メッセージを、チェインによってCOwnerDrawの代替メッセージマップへ送ります。代替メッセージマップには前述のように4種類のメッセージハンドラが用意されており、 CColorButtonクラスはその中のOnDrawItem() が呼び出すDrawItem()をオーバーライドしてボタンを描画します。

　次に示すのは、CColorButtonクラスを使用する例です。

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

// stdafx.h
#pragma once

#define WINVER 0x0420
#include <atlbase.h>
#if _ATL_VER == 0x900
#define _SECURE_ATL 1
#endif

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

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

#include <atlcrack.h>
#include <atlmisc.h>
#include <atlframe.h>
#include <atlctrls.h>
#define _WTL_CE_NO_ZOOMSCROLL
#define _WTL_CE_NO_FULLSCREEN
#include <atlwince.h>

// SampleProjectDialog.h
#pragma once

class CSampleProjectDialog : 
    public CAppStdDialogImpl<CSampleProjectDialog>,
    public CUpdateUI<CSampleProjectDialog>,
    public CMessageFilter, public CIdleHandler
{
public:
    DECLARE_APP_DLG_CLASS(NULL, IDR_MAINFRAME, L"Software\\WTL")

    enum { IDD = IDD_MAINDLG };

    CColorButton m_button_blue;
    CColorButton m_button_red;

    virtual BOOL PreTranslateMessage(MSG* pMsg){
        return CWindow::IsDialogMessage(pMsg);
    }

    virtual BOOL OnIdle(){
        return FALSE;
    }

    BEGIN_UPDATE_UI_MAP(CSampleProjectDialog)
    END_UPDATE_UI_MAP()

    BEGIN_MSG_MAP(CSampleProjectDialog)
        MSG_WM_INITDIALOG(OnInitDialog)
        MSG_WM_DESTROY(OnDestroy)
        CHAIN_MSG_MAP(CUpdateUI<CSampleProjectDialog>)
        CHAIN_MSG_MAP(CAppStdDialogImpl<CSampleProjectDialog>)
        REFLECT_NOTIFICATIONS()
    END_MSG_MAP()

    BOOL OnInitDialog(CWindow wndFocus, LPARAM lInitParam){
        AtlCreateEmptyMenuBar(m_hWnd);

        // コントロール設定
        m_button_blue.SubclassWindow(GetDlgItem(IDC_BUTTON_BLUE));
        m_button_blue.SetColor(RGB(255, 255, 255), RGB(0, 0, 255));

        m_button_red.SubclassWindow(GetDlgItem(IDC_BUTTON_RED));
        m_button_red.SetColor(RGB(255, 255, 255), RGB(255, 0, 0));

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

        SetMsgHandled(false);

        return TRUE;
    }

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

// SampleProject.cpp
#include "stdafx.h"
#include "resourceppc.h"
#include "ColorButton.h"
#include "SampleProjectDialog.h"

CAppModule _Module;

int WINAPI _tWinMain(HINSTANCE hInstance,
    HINSTANCE /*hPrevInstance*/, LPTSTR lpstrCmdLine, int nCmdShow)
{
    HRESULT hRes =
        CSampleProjectDialog::ActivatePreviousInstance(hInstance, lpstrCmdLine);

    if(FAILED(hRes) || S_FALSE == hRes){
        return hRes;
    }

    hRes = ::CoInitializeEx(NULL, COINIT_MULTITHREADED);
    ATLASSERT(SUCCEEDED(hRes));

    AtlInitCommonControls(ICC_DATE_CLASSES);
    SHInitExtraControls();

    hRes = _Module.Init(NULL, hInstance);
    ATLASSERT(SUCCEEDED(hRes));

    int nRet = CSampleProjectDialog::AppRun(lpstrCmdLine, nCmdShow);

    _Module.Term();
    ::CoUninitialize();

    return nRet;
}

　まず、CSampleProjectDialogクラスにCColorButtonクラスのインスタンスをメンバ変数として2つ宣言します。これらを使うためには、WM_INITDIALOGメッセージハンドラでそれぞれサブクラス化し、 SetColor()を呼び出してボタンの文字色と背景色を設定します。メッセージマップにはメッセージリフレクションを利用するためにREFLECT_NOTIFICATIONSマクロを追加します。

　最後に、SampleProject.cppファイルでSampleProjectDialog.hヘッダの前にColorButton.hヘッダをインクルードします。