オーナードロー

ホーム

ATL/WTL

オーナードロー

ドキュメント種別	ATL/WTL に関する文書
最終更新日	2004/02/27
PR

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

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

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

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

// maindlg.h内
class CMainDlg : public CDialogImpl<CMainDlg>, public COwnerDraw<CMainDlg>
{
public:
    enum { IDD = IDD_MAINDLG };

    // メッセージマップ
    BEGIN_MSG_MAP_EX(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.DeflateRect(2, 2);

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

        // 3D縁描画
        if(lpdis->itemState & ODS_SELECTED){
            rcCaptionArea.OffsetRect(1, 1);
            dc.DrawEdge(&lpdis->rcItem, EDGE_SUNKEN, BF_RECT);
        }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);
    }

    LRESULT OnInitDialog(HWND hWnd, LPARAM lParam){
        // スクリーンの中央に配置
        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, HWND hWndCtl){
        EndDialog(nID);
    }

    void OnCancel(UINT uNotifyCode, int nID, HWND hWndCtl){
        EndDialog(nID);
    }
};

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

#include "resource.h"

#include "maindlg.h"

CAppModule _Module;

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

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

    AtlInitCommonControls(ICC_COOL_CLASSES | ICC_WIN95_CLASSES);

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

    int nRet = 0;
    // BLOCK: アプリケーション実行
    {
        CMainDlg dlgMain;
        nRet = dlgMain.DoModal();
    }

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

    return nRet;
}

　まず、リソースを作成します。ダイアログにボタンコントロールを２つ配置し、リソースIDを次のように指定します。なお、両方のボタンコントロールの[スタイル]ではデフォルトに加え[オーナー描画]にチェックを入れます。

コントロール名	リソースID
プッシュボタン	IDC_BUTTON_BLUE
プッシュボタン	IDC_BUTTON_RED

　次に、COwnerDrawクラスを使用するためにstdafx.h内で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()

４つのメッセージハンドラはそれぞれ次のようなメンバ関数を呼び出します。

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

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

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

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

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

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

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

    // メッセージマップ
    BEGIN_MSG_MAP_EX(CColorButton)
        CHAIN_MSG_MAP_ALT(COwnerDraw<CColorButton>, 1)
        DEFAULT_REFLECTION_HANDLER()
    END_MSG_MAP()

    COLORREF m_clrText;
    COLORREF m_clrBg;

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

    void DrawItem(LPDRAWITEMSTRUCT lpdis){
        CDCHandle dc = lpdis->hDC;
        dc.SaveDC();
 
        // キャプション表示領域を初期化
        CRect rcCaptionArea = lpdis->rcItem;
        rcCaptionArea.DeflateRect(2, 2);

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

        // 3D縁描画
        if(lpdis->itemState & ODS_SELECTED){
            rcCaptionArea.OffsetRect(1, 1);
            dc.DrawEdge(&lpdis->rcItem, EDGE_SUNKEN, BF_RECT);
        }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クラスから派生しています。 CColorButtonクラスは、返送されたオーナードロー用メッセージを、チェーンによってCOwnerDrawクラスの代替メッセージマップへ送ります。代替メッセージマップには先述のように４つのメッセージハンドラが用意されており、 CColorButtonクラスはその中のOnDrawItem() が呼び出すDrawItem()をオーバーライドしてボタンを描画しています。

　次に、このCColorButtonクラスを使って、先のオーナードローボタンのプログラムを変更する例を示します。

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

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

// maindlg.h内
class CMainDlg : public CDialogImpl<CMainDlg>
{
public:
    enum { IDD = IDD_MAINDLG };

    CColorButton m_button_blue;
    CColorButton m_button_red;

    // メッセージマップ
    BEGIN_MSG_MAP_EX(CMainDlg)
        MSG_WM_INITDIALOG(OnInitDialog)
        COMMAND_ID_HANDLER_EX(IDOK, OnOK)
        COMMAND_ID_HANDLER_EX(IDCANCEL, OnCancel)
        REFLECT_NOTIFICATIONS()
    END_MSG_MAP()

    LRESULT OnInitDialog(HWND hWnd, LPARAM lParam){
        // スクリーンの中央に配置
        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, HWND hWndCtl){
        EndDialog(nID);
    }

    void OnCancel(UINT uNotifyCode, int nID, HWND hWndCtl){
        EndDialog(nID);
    }
};

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

#include "resource.h"

#include "ColorButton.h"
#include "maindlg.h"

CAppModule _Module;

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

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

    AtlInitCommonControls(ICC_COOL_CLASSES | ICC_WIN95_CLASSES);

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

    int nRet = 0;
    // BLOCK: アプリケーション実行
    {
        CMainDlg dlgMain;
        nRet = dlgMain.DoModal();
    }

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

    return nRet;
}

　まず、CMainDlgクラスにCColorButtonクラスのインスタンスをメンバ変数として２つ宣言します。これらはOnInitDialog()でサブクラス化します。サブクラス化した後にSetColor()によってそれぞれボタンの文字色と背景色を設定します。また、メッセージマップにはメッセージリフレクションのためにREFLECT_NOTIFICATIONSマクロを追加します。

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