CListCtrl::SortItems関数の書式

この関数の書式は、以下のようになる。

BOOL SortItems( PFNLVCOMPARE pfnCompare, DWORD dwData );

１番目の引数には、比較関数のアドレスを指定する。
２番目の引数には、比較関数へ渡す値を指定する（必要なければ何でもよい）。

比較関数の定義

CListCtrl::SortItems関数を使う場合、比較関数を用意しなければならない。比較関数は次のような形式になる。

int CALLBACK CompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort);

引数lParam1とlParam2には、比較される２つのアイテムのインデックスが渡される。
引数lParamSortには、CListCtrl::SortItems関数の２番目の引数で指定した値が渡される。

また、この関数の戻り値は以下のようになる。
　−１： lParam1のアイテムがlParam2のアイテムより前になる場合
　　０： lParam1のアイテムがlParam2のアイテムと等しい場合
　　１： lParam1のアイテムがlParam2のアイテムより後になる場合

注意したいのは、この関数はコールバック関数であるため、システムから呼ばれることになることである。 直接、この関数を呼ぶようなことはしない。 また比較関数は、クラスの静的（static）メンバ関数として定義するか、 あるいはどのクラスにも属さない関数として定義しなければならない。

ここでは、以下のようなデータがダイアログ上のリストビューに表示されているものとし、 ダイアログ上の「発売日順」ボタンを１回押すとこれを発売日の古い順（昇順）に並べ替えるものとする。 また、もう１回押すと発売日の新しい順（降順）に並べ替えるものとし、 以後押すたびに昇順、降順交互に並べ替えるものとする。

型番	発売日
PC-01	1999.04.13
PC-01X	1999.11.15
PC-02	1999.09.10

まず、必要な関数のヘッダを用意する。リストビューコントロールを貼り付けたダイアログのヘッダファイルに、 以下の処理を記述する。比較関数は、ここではダイアログクラスのstaticメンバ関数として定義する。

	// ヘッダファイルでの記述 --------------------
	class CMyDlg : public CDialog
	{
	// 構築
	public:
		static int CALLBACK CompareFunc(LPARAM param1, LPARAM param2, LPARAM param3);
		void RenumberItem();
		……
	};

	// ソースファイルでの記述 --------------------
	int CALLBACK CMyDlg::CompareFunc(LPARAM param1, LPARAM param2, LPARAM param3)
	{
		// staticメンバ関数なので、GetParent()で親ウィンドウを取得することはできない
		CMyDlg* pDlg = (CMyDlg*)AfxGetMainWnd();

		// 比較される２つのアイテムから「発売日」の文字列を取得する
		CString str1 = pDlg->m_list1.GetItemText(param1, 1);
		CString str2 = pDlg->m_list1.GetItemText(param2, 1);

		// strcmpを使うなら、降順の場合はstr1とstr2を逆にしなければならない
		int iReturn;
		if( !param3 )
			iReturn = strcmp( str1, str2 );		// 昇順
		else
			iReturn = strcmp( str2, str1 );		// 降順

		return iReturn;
	}

比較関数ができたので、あとはSortItems関数でこれを呼べばよいのだが、実はそれだけでは正しくソートできない。 SortItems関数を呼ぶ前には、必ずアイテムに対しそれが並んでいる順番に番号をつけていかなければならないのである。 この処理は、ヘッダの部分で定義したRenumberItem関数がその役目を果たす。以下のように実装する。

	// ソースファイルでの記述 --------------------
	void CMyDlg::RenumberItem()
	{
		LV_ITEM lvItem;

		// m_list1はCListCtrl型のDDX変数で、ソートを行うリストビューコントロールのオブジェクトであるものとする
		for( int i = 0; i < m_list1.GetItemCount(); i++ ) {
			lvItem.iItem = i;
			lvItem.iSubItem = 0;
			lvItem.mask = LVIF_PARAM;
			lvItem.lParam = i;		// ここで番号をアイテムに指定する
			m_list1.SetItem(&lvItem);
		}
	}

	// ソースファイルでの記述 --------------------
	void CMyDlg::OnButton1() 
	{
		// TODO: この位置にコントロール通知ハンドラ用のコードを追加してください

		RenumberItem();				// SortItems関数を呼び出す前には必ず実行

		static BOOL bSort = FALSE;			// staticで定義すること
		m_list1.SortItems(CompareFunc, bSort);
		bSort = !bSort;				// bSortがFALSEならTRUE、TRUEならFALSEにする
	}

目次へ