Register a user defined function for an internal listview sorting callback function.
GUICtrlRegisterListViewSort ( controlID, "function" )
| controlID | The listview controlID for which the user function should proceed. |
| function | The name of the user function to call when the sorting callback runs. |
| Success: | 1. |
| Failure: | 0. |
!!! To make the user function workable you have to define it with maximum 4 function parameters otherwise the function won't be called !!!
i.e:
Func MySortFunction($nListViewID, $LParam1, $LParam2, $nColumn)
...
EndFunc
Or
Func MySortFunction($nListViewID, $LParam1, $LParam2)
...
EndFunc
When the user function is called then these 4 parameters have the following values:
| Position | Parameter | Meaning |
|---|---|---|
| 1 | controlID | The controlID of the listview control for which the callback function is used. |
| 2 | lParam1 | The lParam value of the first item (by default the item controlID). |
| 3 | lParam2 | The lParam value of the second item (by default the item controlID). |
| 4 | column | The column that was clicked for sorting (the first column number is 0). |
| Return value | Meaning |
|---|---|
| -1 | 1st item should precede the 2nd. |
| 0 | No Change. |
| 1 | 1st item should follow the 2nd. |
; sorting 3 column's different
#include <GUIConstantsEx.au3>
#include <ListViewConstants.au3>
Global $g_iCurCol = -1
Global $g_iSortDir = 1
Global $g_bSet = False
Global $g_iCol = -1
Example()
Func Example()
GUICreate("Test", 300, 200)
Local $idLv = GUICtrlCreateListView("Column1|Col2|Col3", 10, 10, 280, 180)
GUICtrlRegisterListViewSort(-1, "LVSort") ; Register the function "LVSort" for the sorting callback
GUICtrlCreateListViewItem("ABC|666|10.05.2004", $idLv)
GUICtrlSetImage(-1, "shell32.dll", 7)
GUICtrlCreateListViewItem("DEF|444|11.05.2005", $idLv)
GUICtrlSetImage(-1, "shell32.dll", 12)
GUICtrlCreateListViewItem("CDE|444|12.05.2004", $idLv)
GUICtrlSetImage(-1, "shell32.dll", 3)
GUISetState(@SW_SHOW)
Local $idMsg
; Loop until the user exits.
While 1
$idMsg = GUIGetMsg()
Switch $idMsg
Case $GUI_EVENT_CLOSE
ExitLoop
Case $idLv
$g_bSet = False
$g_iCurCol = $g_iCol
GUICtrlSendMsg($idLv, $LVM_SETSELECTEDCOLUMN, GUICtrlGetState($idLv), 0)
EndSwitch
WEnd
GUIDelete()
EndFunc ;==>Example
; Our sorting callback funtion
Func LVSort($hWnd, $nItem1, $nItem2, $iColumn)
Local $sVal1, $sVal2, $iResult
; Switch the sorting direction
If $iColumn = $g_iCurCol Then
If Not $g_bSet Then
$g_iSortDir = $g_iSortDir * -1
$g_bSet = True
EndIf
Else
$g_iSortDir = 1
EndIf
$g_iCol = $iColumn
$sVal1 = GetSubItemText($hWnd, $nItem1, $iColumn)
$sVal2 = GetSubItemText($hWnd, $nItem2, $iColumn)
; If it is the 3rd colum (column starts with 0) then compare the dates
If $iColumn = 2 Then
$sVal1 = StringRight($sVal1, 4) & StringMid($sVal1, 4, 2) & StringLeft($sVal1, 2)
$sVal2 = StringRight($sVal2, 4) & StringMid($sVal2, 4, 2) & StringLeft($sVal2, 2)
EndIf
$iResult = 0 ; No change of item1 and item2 positions
If $sVal1 < $sVal2 Then
$iResult = -1 ; Put item2 before item1
ElseIf $sVal1 > $sVal2 Then
$iResult = 1 ; Put item2 behind item1
EndIf
$iResult = $iResult * $g_iSortDir
Return $iResult
EndFunc ;==>LVSort
; Retrieve the text of a listview item in a specified column
Func GetSubItemText($idCtrl, $idItem, $iColumn)
Local $tLvfi = DllStructCreate("uint;ptr;int;int[2];int")
DllStructSetData($tLvfi, 1, $LVFI_PARAM)
DllStructSetData($tLvfi, 3, $idItem)
Local $tBuffer = DllStructCreate("char[260]")
Local $nIndex = GUICtrlSendMsg($idCtrl, $LVM_FINDITEM, -1, DllStructGetPtr($tLvfi)) ;
Local $tLvi = DllStructCreate("uint;int;int;uint;uint;ptr;int;int;int;int")
DllStructSetData($tLvi, 1, $LVIF_TEXT)
DllStructSetData($tLvi, 2, $nIndex)
DllStructSetData($tLvi, 3, $iColumn)
DllStructSetData($tLvi, 6, DllStructGetPtr($tBuffer))
DllStructSetData($tLvi, 7, 260)
GUICtrlSendMsg($idCtrl, $LVM_GETITEMA, 0, DllStructGetPtr($tLvi)) ;
Local $sItemText = DllStructGetData($tBuffer, 1)
Return $sItemText
EndFunc ;==>GetSubItemText
; sorting with selfcreated items by DllCall
#include <GUIConstantsEx.au3>
#include <ListViewConstants.au3>
Global $g_iCurCol = -1
Global $g_iSortDir = 1
Global $g_bSet = False
Global $g_iCol = -1
Example()
Func Example()
$g_iCurCol = -1
$g_iSortDir = 1
$g_bSet = False
$g_iCol = -1
Local $hGUI = GUICreate("Test", 300, 200)
Local $idLv = GUICtrlCreateListView("Column1|Col2|Col3", 10, 10, 280, 180)
GUICtrlRegisterListViewSort(-1, "LVSort2") ; Register the function "SortLV" for the sorting callback
MyGUICtrlCreateListViewItem("ABC|666|10.05.2004", $idLv, -1)
MyGUICtrlCreateListViewItem("DEF|444|11.05.2005", $idLv, -1)
MyGUICtrlCreateListViewItem("CDE|444|12.05.2004", $idLv, -1)
GUISetState(@SW_SHOW)
Local $idMsg
; Loop until the user exits.
While 1
$idMsg = GUIGetMsg()
Switch $idMsg
Case $GUI_EVENT_CLOSE
ExitLoop
Case $idLv
$g_bSet = False
$g_iCurCol = $g_iCol
GUICtrlSendMsg($idLv, $LVM_SETSELECTEDCOLUMN, GUICtrlGetState($idLv), 0)
DllCall("user32.dll", "int", "InvalidateRect", "hwnd", ControlGetHandle($hGUI, "", $idLv), "int", 0, "int", 1)
EndSwitch
WEnd
EndFunc ;==>Example
; Our sorting callback funtion
Func LVSort2($hWnd, $idItem1, $idItem2, $idColumn)
Local $sVal1, $sVal2, $iResult
; Switch the sorting direction
If $idColumn = $g_iCurCol Then
If Not $g_bSet Then
$g_iSortDir = $g_iSortDir * -1
$g_bSet = True
EndIf
Else
$g_iSortDir = 1
EndIf
$g_iCol = $idColumn
$sVal1 = GetSubItemText($hWnd, $idItem1, $idColumn)
$sVal2 = GetSubItemText($hWnd, $idItem2, $idColumn)
; If it is the 3rd colum (column starts with 0) then compare the dates
If $idColumn = 2 Then
$sVal1 = StringRight($sVal1, 4) & StringMid($sVal1, 4, 2) & StringLeft($sVal1, 2)
$sVal2 = StringRight($sVal2, 4) & StringMid($sVal2, 4, 2) & StringLeft($sVal2, 2)
EndIf
$iResult = 0 ; No change of item1 and item2 positions
If $sVal1 < $sVal2 Then
$iResult = -1 ; Put item2 before item1
ElseIf $sVal1 > $sVal2 Then
$iResult = 1 ; Put item2 behind item1
EndIf
$iResult = $iResult * $g_iSortDir
Return $iResult
EndFunc ;==>LVSort2
; Create and insert items directly into the listview
Func MyGUICtrlCreateListViewItem($sText, $idCtrl, $iIndex)
Local $tLvitem = DllStructCreate("uint;int;int;uint;uint;ptr;int;int;int;int;")
Local $tText = DllStructCreate("char[260]")
Local $aText = StringSplit($sText, "|")
If $iIndex = -1 Then $iIndex = GUICtrlSendMsg($idCtrl, $LVM_GETITEMCOUNT, 0, 0)
DllStructSetData($tText, 1, $aText[1]) ; Save the item text in the struct
DllStructSetData($tLvitem, 1, BitOR($LVIF_TEXT, $LVIF_PARAM))
DllStructSetData($tLvitem, 2, $iIndex)
DllStructSetData($tLvitem, 6, DllStructGetPtr($tText))
; Set the lParam of the struct to the line index - unique within the listview
DllStructSetData($tLvitem, 9, $iIndex)
$iIndex = GUICtrlSendMsg($idCtrl, $LVM_INSERTITEMA, 0, DllStructGetPtr($tLvitem))
If $iIndex > -1 Then
; Insert now the rest of the column text
For $i = 2 To $aText[0]
DllStructSetData($tText, 1, $aText[$i])
DllStructSetData($tLvitem, 3, $i - 1) ; Store the subitem index
GUICtrlSendMsg($idCtrl, $LVM_SETITEMTEXTA, $iIndex, DllStructGetPtr($tLvitem))
Next
EndIf
; Change the column width to fit the item text
For $i = 0 To 2
GUICtrlSendMsg($idCtrl, $LVM_SETCOLUMNWIDTH, $i, -1)
GUICtrlSendMsg($idCtrl, $LVM_SETCOLUMNWIDTH, $i, -2)
Next
EndFunc ;==>MyGUICtrlCreateListViewItem
; Retrieve the text of a listview item in a specified column
Func GetSubItemText($idCtrl, $idItem, $iColumn)
Local $tLvfi = DllStructCreate("uint;ptr;int;int[2];int")
DllStructSetData($tLvfi, 1, $LVFI_PARAM)
DllStructSetData($tLvfi, 3, $idItem)
Local $tBuffer = DllStructCreate("char[260]")
Local $iIndex = GUICtrlSendMsg($idCtrl, $LVM_FINDITEM, -1, DllStructGetPtr($tLvfi)) ;
Local $tLvi = DllStructCreate("uint;int;int;uint;uint;ptr;int;int;int;int")
DllStructSetData($tLvi, 1, $LVIF_TEXT)
DllStructSetData($tLvi, 2, $iIndex)
DllStructSetData($tLvi, 3, $iColumn)
DllStructSetData($tLvi, 6, DllStructGetPtr($tBuffer))
DllStructSetData($tLvi, 7, 260)
GUICtrlSendMsg($idCtrl, $LVM_GETITEMA, 0, DllStructGetPtr($tLvi)) ;
Local $sItemText = DllStructGetData($tBuffer, 1)
Return $sItemText
EndFunc ;==>GetSubItemText