ホーム ATL/WTL
チェックリストビュー
ドキュメント種別 ATL/WTL に関する文書
最終更新日 2007/03/25
PR
 チェックリストビューは、チェックボックス付きのリストビューコントロールです。 WTLはチェックリストビューを作成するためにCCheckListViewCtrlというクラスを用意しています。

CCheckListViewCtrlクラスはCListViewCtrlクラスから派生しており、 デフォルトでLVS_EX_CHECKBOXESスタイルが設定されています。 以下に示すのは、CCheckListViewCtrlクラスを使用する例です。 ボタンを押すと、チェックされているアイテムの個数をメッセージボックスで表示します。


プロジェクトファイル ダウンロード
// stdafx.h
#pragma once

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

#include <atlcrack.h>
#include <atlmisc.h>
#include <atlctrls.h>
#include <atlctrlx.h>  // CCheckListViewCtrlを使用するため
			

// MainDlg.h
#pragma once

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

    CCheckListViewCtrl m_list_dir;     // チェックリストビュー

    BEGIN_MSG_MAP(CMainDlg)
        MSG_WM_INITDIALOG(OnInitDialog)
        COMMAND_ID_HANDLER_EX(IDC_BUTTON_COUNT, OnButtonCount)
        COMMAND_ID_HANDLER_EX(IDOK, OnOK)
        COMMAND_ID_HANDLER_EX(IDCANCEL, OnCancel)
    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_list_dir.SubclassWindow(GetDlgItem(IDC_LIST_DIR));

        // チェックリストビューにカラム設定
        CRect rcList;
        m_list_dir.GetWindowRect(rcList);
        int nScrollWidth = GetSystemMetrics(SM_CXVSCROLL);
        int n3DEdge = GetSystemMetrics(SM_CXEDGE);
        m_list_dir.InsertColumn(0, _T("名前"), LVCFMT_LEFT,
            rcList.Width() - nScrollWidth - n3DEdge * 2, -1);

        // チェックリストビューにアイテム追加
        CFindFile find;
        if(find.FindFile()){
            do{
                if(!find.IsDots()){
                    int nIndex = m_list_dir.GetItemCount();
                    m_list_dir.AddItem(nIndex, 0, find.GetFileName());
                }
            }while(find.FindNextFile());
        }

        return TRUE;
    }

    void OnButtonCount(UINT uNotifyCode, int nID, CWindow wndCtl){
        int nCheckedCount = 0;
        int nCount = m_list_dir.GetItemCount();
        for(int i=0; i<nCount; i++){
            if(m_list_dir.GetCheckState(i))
                nCheckedCount++;
        }
        CString strMsg;
        strMsg.Format(_T("チェックされたアイテム数:%d"), nCheckedCount);
        MessageBox(strMsg);
    }

    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_WIN95_CLASSES);

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

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

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

    return nRet;
}
			

 まず、リソースを作成します。ダイアログにリストビューコントロールとボタンコントロールを配置し、 それぞれの[Caption]と[ID]を次のように設定します。 なお、リストビューコントロールの[プロパティ]では[View]を[レポート]に設定し、 [Always Show Selection]を[True]に設定します。

コントロール名 Caption ID
リストビュー - IDC_LIST_DIR
ボタン チェックされたアイテム数を取得 IDC_BUTTON_COUNT

 次に、stdafx.hヘッダでは、CCheckListViewCtrlクラスを使用するためにatlctrls.hヘッダとatlctrlx.hヘッダをインクルードします。 なお、atlctrls.hヘッダを先にインクルードする必要があります。

 CMainDlgクラスでは、まず、 CCheckListViewCtrlクラスのインスタンスをメンバ変数として宣言します。 これを使うためには、WM_INITDIALOGメッセージハンドラでサブクラス化する必要があります。

 次に、WM_INITDIALOGメッセージハンドラでは、 チェックリストビューにカレントディレクトリ内のフォルダとファイルをアイテムとして追加します。

 次に、リソースIDがIDC_BUTTON_COUNTWM_COMMANDメッセージハンドラとして、 OnButtonCount()を追加します。 このハンドラ関数では、チェックリストビューの中でチェックされているアイテム数をカウントし、 それをメッセージボックスで表示します。

 最後に_tWinMain()で、引数にICC_WIN95_CLASSESを指定してAtlInitCommonControls()を呼び出します。

 ところで、今回の例ではチェックリストビューを作成するために、 ダイアログ上にコントロールリソースを配置してサブクラス化しましたが、 Create()を呼び出して作成することもできます。

m_list_dir.Create(m_hWnd, CRect(0, 0, 200, 100), NULL, 0, 0, IDC_LIST_DIR);
			

この時、Create()の第4引数にはウィンドウスタイル、 第5引数には拡張ウィンドウスタイルを指定しますが、 これらの引数に 0 を指定した場合は、デフォルトのウィンドウ特徴としてCCheckListViewCtrlTraitsクラスが使用されます。 CCheckListViewCtrlTraitsクラスはatlctrlx.hヘッダで次のように宣言されています。

template <DWORD t_dwStyle, DWORD t_dwExStyle, DWORD t_dwExListViewStyle>
class CCheckListViewCtrlImplTraits
{
public:
    static DWORD GetWndStyle(DWORD dwStyle)
    {
        return (dwStyle == 0) ? t_dwStyle : dwStyle;
    }

    static DWORD GetWndExStyle(DWORD dwExStyle)
    {
        return (dwExStyle == 0) ? t_dwExStyle : dwExStyle;
    }

    static DWORD GetExtendedLVStyle()
    {
        return t_dwExListViewStyle;
    }
};

typedef CCheckListViewCtrlImplTraits<WS_CHILD | WS_VISIBLE |
    LVS_REPORT | LVS_SHOWSELALWAYS, WS_EX_CLIENTEDGE,
    LVS_EX_CHECKBOXES | LVS_EX_FULLROWSELECT>  CCheckListViewCtrlTraits;
			

CCheckListViewCtrlImplTraitsクラステンプレートはATLのCWinTraitsクラステンプレートと違い、 ウィンドウスタイル、拡張ウィンドウスタイルに加えて拡張リストビュースタイルも設定します。

CCheckListViewCtrlクラスは次のように定義されています。

// atlctrlx.h
template <class T, class TBase = CListViewCtrl,
    class TWinTraits = CCheckListViewCtrlTraits>
class ATL_NO_VTABLE CCheckListViewCtrlImpl : 
    public ATL::CWindowImpl<T, TBase, TWinTraits>
{
    ...
    ...
};

class CCheckListViewCtrl : public CCheckListViewCtrlImpl<CCheckListViewCtrl>
{
public:
    DECLARE_WND_SUPERCLASS(_T("WTL_CheckListView"), GetWndClassName())
};
			

このため、カスタマイズしたウィンドウ特徴クラスをCCheckListViewCtrlImplクラステンプレートの第3テンプレート引数に指定することで、 独自のスタイルのチェックリストビューを作成することができます。 次に示すのは、拡張リストビュースタイルとしてLVS_EX_INFOTIPスタイルを持った 独自のチェックリストビュークラスを定義する例です。

typedef CCheckListViewCtrlImplTraits<WS_CHILD | WS_VISIBLE |
    LVS_REPORT | LVS_SHOWSELALWAYS, WS_EX_CLIENTEDGE,
    LVS_EX_CHECKBOXES | LVS_EX_FULLROWSELECT | LVS_EX_INFOTIP>  CMyTraits;

class CMyCheckListViewCtrl : 
    public CCheckListViewCtrlImpl<CMyCheckListViewCtrl, CListViewCtrl, CMyTraits>
{
public:
    DECLARE_WND_SUPERCLASS(_T("MyCheckListView"), GetWndClassName())
};
			

なお、LVS_EX_INFOTIPのような拡張リストビュースタイルを変更するならば、 SetExtendedListViewStyle()を使用することもできます。 その場合、チェックリストビューで必須のLVS_EX_CHECKBOXES スタイルも同時に指定します。

CCheckListViewCtrl m_list;
...
...
m_list.SetExtendedListViewStyle(
    LVS_EX_CHECKBOXES | LVS_EX_FULLROWSELECT | LVS_EX_INFOTIP);