オーナードロー

ホーム

ATL/WTL

オーナードロー

ドキュメント種別	ATL/WTL に関する文書
最終更新日	2007/03/18
PR

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

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

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

// stdafx.h
#pragma once

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

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

// MainDlg.h
#pragma once

class CMainDlg : public CDialogImpl<CMainDlg>, public COwnerDraw<CMainDlg>
{
public:
    enum { IDD = IDD_MAINDLG };

    BEGIN_MSG_MAP(CMainDlg)
        MSG_WM_INITDIALOG(OnInitDialog)
        COMMAND_ID_HANDLER_EX(IDOK, OnOK)
        COMMAND_ID_HANDLER_EX(IDCANCEL, OnCancel)
        CHAIN_MSG_MAP(COwnerDraw<CMainDlg>)    // 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();
 
        // キャプション表示領域を初期化
        CRect rcCaptionArea = lpdis->rcItem;
        rcCaptionArea.OffsetRect(0, -1);

        // 背景色描画
        CBrush brushBg;
        brushBg.CreateSolidBrush(clrBg);
        dc.FillRect(&lpdis->rcItem, brushBg);

        // 3D縁描画
        if(lpdis->itemState & ODS_SELECTED){
            dc.DrawEdge(&lpdis->rcItem, EDGE_SUNKEN, BF_RECT);

            // キャプション矩形調整
            rcCaptionArea.OffsetRect(1, 1);
        }else{
            dc.DrawEdge(&lpdis->rcItem, EDGE_RAISED, BF_RECT);
        }

        // フォーカス矩形描画
        if(lpdis->itemState & ODS_FOCUS){
            CRect rcFocus = lpdis->rcItem;
            rcFocus.DeflateRect(4, 4);
            dc.DrawFocusRect(rcFocus);
        }

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

        dc.RestoreDC(-1);
    }

    BOOL OnInitDialog(CWindow wndFocus, LPARAM lInitParam){
        // スクリーンの中央に配置
        CenterWindow();

        // 大きいアイコン設定
        HICON hIcon = AtlLoadIconImage(IDR_MAINFRAME, LR_DEFAULTCOLOR,
            ::GetSystemMetrics(SM_CXICON), ::GetSystemMetrics(SM_CYICON));
        SetIcon(hIcon, TRUE);
        
        // 小さいアイコン設定
        HICON hIconSmall = AtlLoadIconImage(IDR_MAINFRAME, LR_DEFAULTCOLOR,
            ::GetSystemMetrics(SM_CXSMICON), ::GetSystemMetrics(SM_CYSMICON));
        SetIcon(hIconSmall, FALSE);

        return TRUE;
    }

    void OnOK(UINT uNotifyCode, int nID, CWindow wndCtl){
        EndDialog(nID);
    }

    void OnCancel(UINT uNotifyCode, int nID, CWindow wndCtl){
        EndDialog(nID);
    }
};

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

CAppModule _Module;

int WINAPI _tWinMain(HINSTANCE hInstance, 
    HINSTANCE /*hPrevInstance*/, LPTSTR /*lpstrCmdLine*/, int /*nCmdShow*/)
{
    HRESULT hRes = ::CoInitialize(NULL);
    ATLASSERT(SUCCEEDED(hRes));

    ::DefWindowProc(NULL, 0, 0, 0L);

    AtlInitCommonControls(ICC_BAR_CLASSES);

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

    CMainDlg dlg;
    int nRet = (int) dlg.DoModal();

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

    return nRet;
}

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

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

　次に、stdafx.hヘッダではCOwnerDrawクラステンプレートを使用するためにatlframe.hヘッダをインクルードします。

　CMainDlgクラスでは、基底クラスに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の派生クラス（今回の例ではCMainDlgクラス）では、これらのメンバ関数をオーバーライドすることによって、コントロールに独自の外観を与えます。

今回の例では、CMainDlgクラスで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();
 
        // キャプション表示領域を初期化
        CRect rcCaptionArea = lpdis->rcItem;
        rcCaptionArea.OffsetRect(0, -1);

        // 背景色描画
        CBrush brushBg;
        brushBg.CreateSolidBrush(m_clrBg);
        dc.FillRect(&lpdis->rcItem, brushBg);

        // 3D縁描画
        if(lpdis->itemState & ODS_SELECTED){
            dc.DrawEdge(&lpdis->rcItem, EDGE_SUNKEN, BF_RECT);

            // キャプション矩形調整
            rcCaptionArea.OffsetRect(1, 1);
        }else{
            dc.DrawEdge(&lpdis->rcItem, EDGE_RAISED, BF_RECT);
        }

        // フォーカス矩形描画
        if(lpdis->itemState & ODS_FOCUS){
            CRect rcFocus = lpdis->rcItem;
            rcFocus.DeflateRect(4, 4);
            dc.DrawFocusRect(rcFocus);
        }

        // キャプション描画
        dc.SetTextColor(m_clrText);
        dc.SetBkMode(TRANSPARENT);
        dc.DrawText(_T("オーナードローボタン"), -1,
            rcCaptionArea, 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

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

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

// MainDlg.h
#pragma once

class CMainDlg : public CDialogImpl<CMainDlg>
{
public:
    enum { IDD = IDD_MAINDLG };

    CColorButton m_button_blue;
    CColorButton m_button_red;

    BEGIN_MSG_MAP(CMainDlg)
        MSG_WM_INITDIALOG(OnInitDialog)
        COMMAND_ID_HANDLER_EX(IDOK, OnOK)
        COMMAND_ID_HANDLER_EX(IDCANCEL, OnCancel)
        REFLECT_NOTIFICATIONS()
    END_MSG_MAP()

    BOOL OnInitDialog(CWindow wndFocus, LPARAM lInitParam){
        // スクリーンの中央に配置
        CenterWindow();

        // 大きいアイコン設定
        HICON hIcon = AtlLoadIconImage(IDR_MAINFRAME, LR_DEFAULTCOLOR,
            ::GetSystemMetrics(SM_CXICON), ::GetSystemMetrics(SM_CYICON));
        SetIcon(hIcon, TRUE);
        
        // 小さいアイコン設定
        HICON hIconSmall = AtlLoadIconImage(IDR_MAINFRAME, LR_DEFAULTCOLOR,
            ::GetSystemMetrics(SM_CXSMICON), ::GetSystemMetrics(SM_CYSMICON));
        SetIcon(hIconSmall, FALSE);

        // コントロール設定
        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));

        return TRUE;
    }

    void OnOK(UINT uNotifyCode, int nID, CWindow wndCtl){
        EndDialog(nID);
    }

    void OnCancel(UINT uNotifyCode, int nID, CWindow wndCtl){
        EndDialog(nID);
    }
};

// SampleProject.cpp
#include "stdafx.h"
#include "resource.h"
#include "ColorButton.h"
#include "MainDlg.h"

CAppModule _Module;

int WINAPI _tWinMain(HINSTANCE hInstance, 
    HINSTANCE /*hPrevInstance*/, LPTSTR /*lpstrCmdLine*/, int /*nCmdShow*/)
{
    HRESULT hRes = ::CoInitialize(NULL);
    ATLASSERT(SUCCEEDED(hRes));

    ::DefWindowProc(NULL, 0, 0, 0L);

    AtlInitCommonControls(ICC_BAR_CLASSES);

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

    CMainDlg dlg;
    int nRet = (int) dlg.DoModal();

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

    return nRet;
}

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

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