vc mfc listctrl使用虚拟列表 虚拟列表用法

note

• 虚拟列表可有效加载大量数据
• 需要处理listctrl的 LVN_GETDISPINFO 消息
• 使用虚拟列表 不能 使用 insert的方法插入数据，而是告诉listctrl 当前要显示多少行
• 使用SetItemCount函数告诉listctrl当前显示多少行
• 使用虚拟列表需要自己维护数据源

使用

• 添加list ctrl 控件
• 将其Owner Data 属性 设置为 True
  
  
• 添加listctrl的 LVN_GETDISPINFO 的消息
  
  

范例

• 初始化 listctrl, list_ctrl是自己添加的控件变量

		LONG lStyle;
		lStyle = GetWindowLong(list_ctrl.m_hWnd , GWL_STYLE);//获取当前窗口style
		lStyle &= ~LVS_TYPEMASK; //清除显示方式位
		lStyle |= LVS_REPORT; //设置style
		SetWindowLong(list_ctrl.m_hWnd , GWL_STYLE , lStyle);//设置style
		DWORD dwStyle = list_ctrl.GetExtendedStyle();
		dwStyle |= LVS_EX_FULLROWSELECT;//选中某行使整行高亮（只适用与report风格的listctrl）
		dwStyle |= LVS_EX_GRIDLINES;//网格线（只适用与report风格的listctrl）
		dwStyle |= LVS_EX_CHECKBOXES;//item前生成checkbox控件
		dwStyle	 |= LVS_EX_DOUBLEBUFFER;
		list_ctrl.SetExtendedStyle(dwStyle); //设置扩展风格

• 这里创建了2列

		list_ctrl.InsertColumn(0 , L"ID" , LVCFMT_LEFT , 40);//插入列
		list_ctrl.InsertColumn(1 , L"NAME" , LVCFMT_LEFT , 50);

• 添加LVN_GETDISPINFO消息处理函数

void CMFCApplication1Dlg::OnLvnGetdispinfoList1(NMHDR *pNMHDR , LRESULT *pResult)
{
	NMLVDISPINFO *pDispInfo = reinterpret_cast<NMLVDISPINFO*>(pNMHDR);

	*pResult = 0;
}

• 该函数用于显示 行的每一列，函数体实现如下

void CMFCApplication1Dlg::OnLvnGetdispinfoList1(NMHDR *pNMHDR , LRESULT *pResult)
{
	NMLVDISPINFO *pDispInfo = reinterpret_cast<NMLVDISPINFO*>(pNMHDR);
	if (nullptr == pDispInfo)
	{
		*pResult = 0;
		return;
	}

	LV_ITEM* pItem= &(pDispInfo)->item;
	if (nullptr == pItem)
	{
		*pResult = 0;
		return;
	}

	/// 自己维护的数据源中没有数据
	if (0 >= map_list_item_.size())
	{
		*pResult = 0;
		return;
	}

	/// 当前请求显示的是第几行
	int cur_row_index			= pItem->iItem;

	if (LVIF_TEXT & pItem->mask) //字符串缓冲区有效
	{
		/// 当前请求显示的是第几列
		int cur_column_index	= pItem->iSubItem;

		switch (cur_column_index)
		{
			/// 第一列
			case 0:
			{

				CString str_id;
				/// 将id转为字符串
				str_id.Format(L"%d", map_list_item_[cur_row_index].id_);
				/// 显示第一列
				lstrcpy(pItem->pszText, str_id);

			}
				break;

			/// 第二列
			case 1:
			{
				/// 显示第二列
				lstrcpy(pItem->pszText, map_list_item_[cur_row_index].name_);
			}
				break;

			default:
				break;
		}

	}

	*pResult = 0;
}

其中，map_list_item_是我自己维护的数据源，其定义如下

	/// <id列，name列>
	std::map<int, list_ctrl_item> map_list_item_;

用作测试使用，list_ctrl_item的定义如下：

struct st_list_item_
{
	int		id_	= 0;
	CString name_ = _T("");

	void zero_()
	{
		id_	= 0;
		name_ = _T("");
	}
	st_list_item_()
	{
		zero_();
	}
};

using list_ctrl_item = st_list_item_;

• OnInitDialog() 函数中对数据源做了添加

		/// 插入数据
		auto insert_item = [&](int index)
		{
			list_ctrl_item item;
			item.id_	= index;
			item.name_.Format(L"%d", index);

			map_list_item_.insert(std::make_pair(index, item));
		};

		insert_item(0);
		insert_item(1);
		insert_item(2);
		insert_item(3);

• 自己用了定时器， 定时告诉list_ctrl刷新数据

void CMFCApplication1Dlg::OnTimer(UINT_PTR nIDEvent)
{
	if (nIDEvent == ktimer_id)
	{
		list_ctrl.SetItemCount(map_list_item_.size());
		list_ctrl.Invalidate();
	}

	CDialogEx::OnTimer(nIDEvent);
}

效果

完整源码

头文件

// MFCApplication1Dlg.h : 头文件
//

#pragma once
#include "afxcmn.h"

#include "list_ctrl_ex.h"

#include <map>

struct st_list_item_
{
	int		id_	= 0;
	CString name_ = _T("");

	void zero_()
	{
		id_	= 0;
		name_ = _T("");
	}
	st_list_item_()
	{
		zero_();
	}
};

using list_ctrl_item = st_list_item_;

// CMFCApplication1Dlg 对话框
class CMFCApplication1Dlg : public CDialogEx
{

	enum
	{
		ktimer_id	= 1000,
		kinterval	= 500,
	};

// 构造
public:
	CMFCApplication1Dlg(CWnd* pParent = NULL);	// 标准构造函数

// 对话框数据
#ifdef AFX_DESIGN_TIME
	enum { IDD = IDD_MFCAPPLICATION1_DIALOG };
#endif

	protected:
	virtual void DoDataExchange(CDataExchange* pDX);	// DDX/DDV 支持

	UINT_PTR timer_id	= 0;

	void uninit_();

	/// <id列，name列>
	std::map<int, list_ctrl_item> map_list_item_;

// 实现
protected:
	HICON m_hIcon;

	// 生成的消息映射函数
	virtual BOOL OnInitDialog();
	afx_msg void OnSysCommand(UINT nID, LPARAM lParam);
	afx_msg void OnPaint();
	afx_msg void OnTimer(UINT_PTR nIDEvent);
	afx_msg HCURSOR OnQueryDragIcon();
	DECLARE_MESSAGE_MAP()
public:
	list_ctrl_ex list_ctrl;
	afx_msg void OnLvnGetdispinfoList1(NMHDR *pNMHDR , LRESULT *pResult);
	afx_msg void OnLvnOdfinditemList1(NMHDR *pNMHDR , LRESULT *pResult);
	afx_msg void OnLvnOdcachehintList1(NMHDR *pNMHDR , LRESULT *pResult);
};

cpp

// MFCApplication1Dlg.cpp : 实现文件
//

#include "stdafx.h"
#include "MFCApplication1.h"
#include "MFCApplication1Dlg.h"
#include "afxdialogex.h"
#include <windowsx.h>

#ifdef _DEBUG
#define new DEBUG_NEW
#endif

// 用于应用程序“关于”菜单项的 CAboutDlg 对话框

class CAboutDlg : public CDialogEx
{
public:
	CAboutDlg();

// 对话框数据
#ifdef AFX_DESIGN_TIME
	enum { IDD = IDD_ABOUTBOX };
#endif

	protected:
	virtual void DoDataExchange(CDataExchange* pDX);    // DDX/DDV 支持

// 实现
protected:
	DECLARE_MESSAGE_MAP()
};

CAboutDlg::CAboutDlg() : CDialogEx(IDD_ABOUTBOX)
{
}

void CAboutDlg::DoDataExchange(CDataExchange* pDX)
{
	CDialogEx::DoDataExchange(pDX);
}

BEGIN_MESSAGE_MAP(CAboutDlg, CDialogEx)
END_MESSAGE_MAP()

// CMFCApplication1Dlg 对话框

CMFCApplication1Dlg::CMFCApplication1Dlg(CWnd* pParent /*=NULL*/)
	: CDialogEx(IDD_MFCAPPLICATION1_DIALOG, pParent)
{
	m_hIcon = AfxGetApp()->LoadIcon(IDR_MAINFRAME);
}

void CMFCApplication1Dlg::DoDataExchange(CDataExchange* pDX)
{
	CDialogEx::DoDataExchange(pDX);
	DDX_Control(pDX , IDC_LIST1 , list_ctrl);
}

/// ----------------------------------------------------------------
/// @brief:
/// ----------------------------------------------------------------
void CMFCApplication1Dlg::uninit_()
{
	if (0 != timer_id)
	{
		KillTimer(timer_id);
		timer_id	= 0;
	}
}

BEGIN_MESSAGE_MAP(CMFCApplication1Dlg, CDialogEx)
	ON_WM_SYSCOMMAND()
	ON_WM_PAINT()
	ON_WM_QUERYDRAGICON()
	ON_WM_TIMER()
	ON_NOTIFY(LVN_GETDISPINFO , IDC_LIST1 , &CMFCApplication1Dlg::OnLvnGetdispinfoList1)
	ON_NOTIFY(LVN_ODFINDITEM , IDC_LIST1 , &CMFCApplication1Dlg::OnLvnOdfinditemList1)
	ON_NOTIFY(LVN_ODCACHEHINT , IDC_LIST1 , &CMFCApplication1Dlg::OnLvnOdcachehintList1)
END_MESSAGE_MAP()

// CMFCApplication1Dlg 消息处理程序

BOOL CMFCApplication1Dlg::OnInitDialog()
{
	CDialogEx::OnInitDialog();

	// 设置此对话框的图标。  当应用程序主窗口不是对话框时，框架将自动
	//  执行此操作
	SetIcon(m_hIcon, TRUE);			// 设置大图标
	SetIcon(m_hIcon, FALSE);		// 设置小图标

	{
		LONG lStyle;
		lStyle = GetWindowLong(list_ctrl.m_hWnd , GWL_STYLE);//获取当前窗口style
		lStyle &= ~LVS_TYPEMASK; //清除显示方式位
		lStyle |= LVS_REPORT; //设置style
		SetWindowLong(list_ctrl.m_hWnd , GWL_STYLE , lStyle);//设置style
		DWORD dwStyle = list_ctrl.GetExtendedStyle();
		dwStyle |= LVS_EX_FULLROWSELECT;//选中某行使整行高亮（只适用与report风格的listctrl）
		dwStyle |= LVS_EX_GRIDLINES;//网格线（只适用与report风格的listctrl）
		dwStyle |= LVS_EX_CHECKBOXES;//item前生成checkbox控件
		dwStyle	 |= LVS_EX_DOUBLEBUFFER;
		list_ctrl.SetExtendedStyle(dwStyle); //设置扩展风格
	}
	{
		list_ctrl.InsertColumn(0 , L"ID" , LVCFMT_LEFT , 40);//插入列
		list_ctrl.InsertColumn(1 , L"NAME" , LVCFMT_LEFT , 50);
	}

	{
		/// 插入数据
		auto insert_item = [&](int index)
		{
			list_ctrl_item item;
			item.id_	= index;
			item.name_.Format(L"%d", index);

			map_list_item_.insert(std::make_pair(index, item));
		};

		insert_item(0);
		insert_item(1);
		insert_item(2);
		insert_item(3);

	}

	{
		timer_id	= SetTimer(ktimer_id, kinterval, NULL);
	}

	return TRUE;  // 除非将焦点设置到控件，否则返回 TRUE
}

void CMFCApplication1Dlg::OnSysCommand(UINT nID, LPARAM lParam)
{
	if ((nID & 0xFFF0) == IDM_ABOUTBOX)
	{
		CAboutDlg dlgAbout;
		dlgAbout.DoModal();
	}
	else
	{
		CDialogEx::OnSysCommand(nID, lParam);
	}
}

// 如果向对话框添加最小化按钮，则需要下面的代码
//  来绘制该图标。  对于使用文档/视图模型的 MFC 应用程序，
//  这将由框架自动完成。

void CMFCApplication1Dlg::OnPaint()
{
	if (IsIconic())
	{
		CPaintDC dc(this); // 用于绘制的设备上下文

		SendMessage(WM_ICONERASEBKGND, reinterpret_cast<WPARAM>(dc.GetSafeHdc()), 0);

		// 使图标在工作区矩形中居中
		int cxIcon = GetSystemMetrics(SM_CXICON);
		int cyIcon = GetSystemMetrics(SM_CYICON);
		CRect rect;
		GetClientRect(&rect);
		int x = (rect.Width() - cxIcon + 1) / 2;
		int y = (rect.Height() - cyIcon + 1) / 2;

		// 绘制图标
		dc.DrawIcon(x, y, m_hIcon);
	}
	else
	{
		CDialogEx::OnPaint();
	}
}

/// ----------------------------------------------------------------
/// @brief:
/// ----------------------------------------------------------------
void CMFCApplication1Dlg::OnTimer(UINT_PTR nIDEvent)
{
	if (nIDEvent == ktimer_id)
	{
		list_ctrl.SetItemCount(map_list_item_.size());
		list_ctrl.Invalidate();
	}

	CDialogEx::OnTimer(nIDEvent);
}

//当用户拖动最小化窗口时系统调用此函数取得光标
//显示。
HCURSOR CMFCApplication1Dlg::OnQueryDragIcon()
{
	return static_cast<HCURSOR>(m_hIcon);
}

void CMFCApplication1Dlg::OnLvnGetdispinfoList1(NMHDR *pNMHDR , LRESULT *pResult)
{
	NMLVDISPINFO *pDispInfo = reinterpret_cast<NMLVDISPINFO*>(pNMHDR);
	if (nullptr == pDispInfo)
	{
		*pResult = 0;
		return;
	}

	LV_ITEM* pItem= &(pDispInfo)->item;
	if (nullptr == pItem)
	{
		*pResult = 0;
		return;
	}

	/// 自己维护的数据源中没有数据
	if (0 >= map_list_item_.size())
	{
		*pResult = 0;
		return;
	}

	/// 当前请求显示的是第几行
	int cur_row_index			= pItem->iItem;

	if (LVIF_TEXT & pItem->mask) //字符串缓冲区有效
	{
		/// 当前请求显示的是第几列
		int cur_column_index	= pItem->iSubItem;

		switch (cur_column_index)
		{
			/// 第一列
			case 0:
			{

				CString str_id;
				/// 将id转为字符串
				str_id.Format(L"%d", map_list_item_[cur_row_index].id_);
				/// 显示第一列
				lstrcpy(pItem->pszText, str_id);

			}
				break;

			/// 第二列
			case 1:
			{
				/// 显示第二列
				lstrcpy(pItem->pszText, map_list_item_[cur_row_index].name_);
			}
				break;

			default:
				break;
		}

	}

	*pResult = 0;
}

void CMFCApplication1Dlg::OnLvnOdfinditemList1(NMHDR *pNMHDR , LRESULT *pResult)
{
	LPNMLVFINDITEM pFindInfo = reinterpret_cast<LPNMLVFINDITEM>(pNMHDR);
	// TODO: 在此添加控件通知处理程序代码
	*pResult = 0;
}

void CMFCApplication1Dlg::OnLvnOdcachehintList1(NMHDR *pNMHDR , LRESULT *pResult)
{
	LPNMLVCACHEHINT pCacheHint = reinterpret_cast<LPNMLVCACHEHINT>(pNMHDR);
	// TODO: 在此添加控件通知处理程序代码
	*pResult = 0;
}