1 \section{\class{wxListCtrl
}}\label{wxlistctrl
}
3 A list control presents lists in a number of formats: list view,
report view, icon view
4 and small icon view. Elements are numbered from zero.
6 To intercept events from a list control, use the event table macros described in
\helpref{wxListEvent
}{wxlistevent
}.
8 \wxheading{Derived from
}
10 \helpref{wxControl
}{wxcontrol
}\\
11 \helpref{wxWindow
}{wxwindow
}\\
12 \helpref{wxEvtHandler
}{wxevthandler
}\\
13 \helpref{wxObject
}{wxobject
}
15 \wxheading{Window styles
}
18 \begin{twocollist
}\itemsep=
0pt
19 \twocolitem{\windowstyle{wxLC
\_LIST}}{multicolumn list view, with optional small icons.
20 Columns are computed automatically, i.e. you don't set columns as in wxLC
\_REPORT. In other words,
21 the list wraps, unlike a wxListBox.
}
22 \twocolitem{\windowstyle{wxLC
\_REPORT}}{single or multicolumn
report view, with optional header.
}
23 \twocolitem{\windowstyle{wxLC
\_ICON}}{Large icon view, with optional labels.
}
24 \twocolitem{\windowstyle{wxLC
\_SMALL\_ICON}}{Small icon view, with optional labels.
}
25 \twocolitem{\windowstyle{wxLC
\_ALIGN\_TOP}}{Icons align to the top (default).
}
26 \twocolitem{\windowstyle{wxLC
\_ALIGN\_LEFT}}{Icons align to the left.
}
27 \twocolitem{\windowstyle{wxLC
\_AUTOARRANGE}}{Icons arrange themselves.
}
28 \twocolitem{\windowstyle{wxLC
\_USER\_TEXT}}{The application provides label text on demand, except for column headers.
}
29 \twocolitem{\windowstyle{wxLC
\_EDIT\_LABELS}}{Labels are editable: the application will be notified when editing starts.
}
30 \twocolitem{\windowstyle{wxLC
\_NO\_HEADER}}{No header in
report mode.
}
31 \twocolitem{\windowstyle{wxLC
\_SINGLE\_SEL}}{Single selection.
}
32 \twocolitem{\windowstyle{wxLC
\_SORT\_ASCENDING}}{Sort in ascending order (must still supply a comparison callback in SortItems.
}
33 \twocolitem{\windowstyle{wxLC
\_SORT\_DESCENDING}}{Sort in descending order (must still supply a comparison callback in SortItems.
}
36 See also
\helpref{window styles overview
}{windowstyles
}.
40 \helpref{wxListCtrl overview
}{wxlistctrloverview
},
\helpref{wxListBox
}{wxlistbox
},
\helpref{wxTreeCtrl
}{wxtreectrl
},
\rtfsp
41 \helpref{wxImageList
}{wximagelist
},
\helpref{wxListEvent
}{wxlistevent
}
43 \latexignore{\rtfignore{\wxheading{Members
}}}
45 \membersection{wxListCtrl::wxListCtrl
}\label{wxlistctrlconstr
}
47 \func{}{wxListCtrl
}{\void}
51 \func{}{wxListCtrl
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{ id
},
\rtfsp
52 \param{const wxPoint\&
}{ pos = wxDefaultPosition
},
\param{const wxSize\&
}{ size = wxDefaultSize
},
\rtfsp
53 \param{long
}{ style = wxLC
\_ICON},
\param{const wxValidator\&
}{validator = wxDefaultValidator
},
\param{const wxString\&
}{name = ``listCtrl"
}}
55 Constructor, creating and showing a list control.
57 \wxheading{Parameters
}
59 \docparam{parent
}{Parent window. Must not be NULL.
}
61 \docparam{id
}{Window identifier. A value of -
1 indicates a default value.
}
63 \docparam{pos
}{Window position.
}
65 \docparam{size
}{Window size. If the default size (-
1, -
1) is specified then the window is sized
68 \docparam{style
}{Window style. See
\helpref{wxListCtrl
}{wxlistctrl
}.
}
70 \docparam{validator
}{Window validator.
}
72 \docparam{name
}{Window name.
}
76 \helpref{wxListCtrl::Create
}{wxlistctrlcreate
},
\helpref{wxValidator
}{wxvalidator
}
78 \membersection{wxListCtrl::
\destruct{wxListCtrl
}}
80 \func{void
}{\destruct{wxListCtrl
}}{\void}
82 Destructor, destroying the list control.
84 \membersection{wxListCtrl::Arrange
}\label{wxlistctrlarrange
}
86 \func{bool
}{Arrange
}{\param{int
}{flag = wxLIST
\_ALIGN\_DEFAULT}}
88 Arranges the items in icon or small icon view.
{\it flag
} is one of:
91 \begin{twocollist
}\itemsep=
0pt
92 \twocolitem{wxLIST
\_ALIGN\_DEFAULT}{Default alignment.
}
93 \twocolitem{wxLIST
\_ALIGN\_LEFT}{Align to the left side of the control.
}
94 \twocolitem{wxLIST
\_ALIGN\_TOP}{Align to the top side of the control.
}
95 \twocolitem{wxLIST
\_ALIGN\_SNAP\_TO\_GRID}{Snap to grid.
}
98 \membersection{wxListCtrl::Create
}\label{wxlistctrlcreate
}
100 \func{bool
}{Create
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{ id
},
\rtfsp
101 \param{const wxPoint\&
}{ pos = wxDefaultPosition
},
\param{const wxSize\&
}{ size = wxDefaultSize
},
\rtfsp
102 \param{long
}{ style = wxLC
\_ICON},
\param{const wxValidator\&
}{validator = wxDefaultValidator
},
\param{const wxString\&
}{name = ``listCtrl"
}}
104 Creates the list control. See
\helpref{wxListCtrl::wxListCtrl
}{wxlistctrlconstr
} for further details.
106 \membersection{wxListCtrl::DeleteItem
}\label{wxlistctrldeleteitem
}
108 \func{bool
}{DeleteItem
}{\param{long
}{item
}}
110 Deletes the specified item.
112 \membersection{wxListCtrl::DeleteAllItems
}\label{wxlistctrldeleteallitems
}
114 \func{bool
}{DeleteAllItems
}{\void}
116 Deletes all the items in the list control.
118 \membersection{wxListCtrl::DeleteColumn
}\label{wxlistctrldeletecolumn
}
120 \func{bool
}{DeleteColumn
}{\param{int
}{col
}}
124 \membersection{wxListCtrl::Edit
}\label{wxlistctrledit
}
126 \func{wxTextCtrl\&
}{Edit
}{\param{long
}{item
}}
128 Starts editing a label.
130 \membersection{wxListCtrl::EnsureVisible
}\label{wxlistctrlensurevisible
}
132 \func{bool
}{EnsureVisible
}{\param{long
}{item
}}
134 Ensures this item is visible.
136 \membersection{wxListCtrl::FindItem
}\label{wxlistctrlfinditem
}
138 \func{long
}{FindItem
}{\param{long
}{start
},
\param{const wxString\&
}{str
},
\param{const bool
}{partial = FALSE
}}
140 Find an item whose label matches this string, starting from the item after
{\it start
} or
141 the beginning if
{\it start
} is -
1.
143 \func{long
}{FindItem
}{\param{long
}{start
},
\param{long
}{data
}}
145 Find an item whose data matches this data, starting from the item after
{\it start
} or
146 the beginning if 'start' is -
1.
148 \func{long
}{FindItem
}{\param{long
}{start
},
\param{const wxPoint\&
}{pt
},
\param{int
}{direction
}}
150 Find an item nearest this position in the specified direction, starting from
151 the item after
{\it start
} or the beginning if
{\it start
} is -
1.
153 \membersection{wxListCtrl::GetColumn
}\label{wxlistctrlgetcolumn
}
155 \constfunc{bool
}{GetColumn
}{\param{int
}{col
},
\param{wxListItem\&
}{item
}}
157 Gets information about this column. See
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
} for more
160 \membersection{wxListCtrl::GetColumnWidth
}\label{wxlistctrlgetcolumnwidth
}
162 \constfunc{int
}{GetColumnWidth
}{\param{int
}{col
}}
164 Gets the column width (
report view only).
166 \membersection{wxListCtrl::GetCountPerPage
}\label{wxlistctrlgetcountperpage
}
168 \constfunc{int
}{GetCountPerPage
}{\void}
170 Gets the number of items that can fit vertically in the
171 visible area of the list control (list or
report view)
172 or the total number of items in the list control (icon
175 \membersection{wxListCtrl::GetEditControl
}\label{wxlistctrlgeteditcontrol
}
177 \constfunc{wxTextCtrl\&
}{GetEditControl
}{\void}
179 Gets the edit control for editing labels.
181 \membersection{wxListCtrl::GetImageList
}\label{wxlistctrlgetimagelist
}
183 \constfunc{wxImageList*
}{GetImageList
}{\param{int
}{which
}}
185 Returns the specified image list.
{\it which
} may be one of:
188 \begin{twocollist
}\itemsep=
0pt
189 \twocolitem{\windowstyle{wxIMAGE
\_LIST\_NORMAL}}{The normal (large icon) image list.
}
190 \twocolitem{\windowstyle{wxIMAGE
\_LIST\_SMALL}}{The small icon image list.
}
191 \twocolitem{\windowstyle{wxIMAGE
\_LIST\_STATE}}{The user-defined state image list (unimplemented).
}
194 \membersection{wxListCtrl::GetItem
}\label{wxlistctrlgetitem
}
196 \constfunc{bool
}{GetItem
}{\param{wxListItem\&
}{info
}}
198 Gets information about the item. See
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
} for more
201 \membersection{wxListCtrl::GetItemData
}\label{wxlistctrlgetitemdata
}
203 \constfunc{long
}{GetItemData
}{\param{long
}{item
}}
205 Gets the application-defined data associated with this item.
207 \membersection{wxListCtrl::GetItemPosition
}\label{wxlistctrlgetitemposition
}
209 \constfunc{bool
}{GetItemPosition
}{\param{long
}{item
},
\param{wxPoint\&
}{pos
}}
211 Returns the position of the item, in icon or small icon view.
213 \membersection{wxListCtrl::GetItemRect
}\label{wxlistctrlgetitemrect
}
215 \constfunc{bool
}{GetItemRect
}{\param{long
}{item
},
\param{wxRect\&
}{rect
},
\param{int
}{code = wxLIST
\_RECT\_BOUNDS}}
217 Returns the rectangle representing the item's size and position, in client coordinates.
219 {\it code
} is one of wxLIST
\_RECT\_BOUNDS, wxLIST
\_RECT\_ICON, wxLIST
\_RECT\_LABEL.
221 \membersection{wxListCtrl::GetItemState
}\label{wxlistctrlgetitemstate
}
223 \constfunc{int
}{GetItemState
}{\param{long
}{item
},
\param{long
}{stateMask
}}
225 Gets the item state. For a list of state flags, see
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
}.
227 The
{\bf stateMask
} indicates which state flags are of interest.
229 \membersection{wxListCtrl::GetItemCount
}\label{wxlistctrlgetitemcount
}
231 \constfunc{int
}{GetItemCount
}{\void}
233 Returns the number of items in the list control.
235 \membersection{wxListCtrl::GetItemSpacing
}\label{wxlistctrlgetitemspacing
}
237 \constfunc{int
}{GetItemSpacing
}{\param{bool
}{isSmall
}}
239 Retrieves the spacing between icons in pixels.
240 If
{\it small
} is TRUE, gets the spacing for the small icon
241 view, otherwise the large icon view.
243 \membersection{wxListCtrl::GetItemText
}\label{wxlistctrlgetitemtext
}
245 \constfunc{wxString
}{GetItemText
}{\param{long
}{item
}}
247 Gets the item text for this item.
249 \membersection{wxListCtrl::GetNextItem
}\label{wxlistctrlgetnextitem
}
251 \constfunc{long
}{GetNextItem
}{\param{long
}{item
},
\param{int
}{geometry = wxLIST
\_NEXT\_ALL},
\param{int
}{state = wxLIST
\_STATE\_DONTCARE}}
253 Searches for an item with the given goemetry or state, starting from
{\it item
}.
{\it item
} can be -
1
254 to find the first item that matches the specified flags.
256 Returns the item or -
1 if unsuccessful.
258 {\it geometry
} can be one of:
261 \begin{twocollist
}\itemsep=
0pt
262 \twocolitem{wxLIST
\_NEXT\_ABOVE}{Searches for an item above the specified item.
}
263 \twocolitem{wxLIST
\_NEXT\_ALL}{Searches for subsequent item by index.
}
264 \twocolitem{wxLIST
\_NEXT\_BELOW}{Searches for an item below the specified item.
}
265 \twocolitem{wxLIST
\_NEXT\_LEFT}{Searches for an item to the left of the specified item.
}
266 \twocolitem{wxLIST
\_NEXT\_RIGHT}{Searches for an item to the right of the specified item.
}
269 {\it state
} can be a bitlist of the following:
272 \begin{twocollist
}\itemsep=
0pt
273 \twocolitem{wxLIST
\_STATE\_DONTCARE}{Don't care what the state is.
}
274 \twocolitem{wxLIST
\_STATE\_DROPHILITED}{The item indicates it is a drop target.
}
275 \twocolitem{wxLIST
\_STATE\_FOCUSED}{The item has the focus.
}
276 \twocolitem{wxLIST
\_STATE\_SELECTED}{The item is selected.
}
277 \twocolitem{wxLIST
\_STATE\_CUT}{The item is selected as part of a cut and paste operation.
}
280 \membersection{wxListCtrl::GetSelectedItemCount
}\label{wxlistctrlgetselecteditemcount
}
282 \constfunc{int
}{GetSelectedItemCount
}{\void}
284 Returns the number of selected items in the list control.
286 \membersection{wxListCtrl::GetTextColour
}\label{wxlistctrlgettextcolour
}
288 \constfunc{wxColour
}{GetTextColour
}{\void}
290 Gets the text colour of the list control.
292 \membersection{wxListCtrl::GetTopItem
}\label{wxlistctrlgettopitem
}
294 \constfunc{long
}{GetTopItem
}{\void}
296 Gets the index of the topmost visible item when in
299 \membersection{wxListCtrl::HitTest
}\label{wxlistctrlhittest
}
301 \func{long
}{HitTest
}{\param{const wxPoint\&
}{point
},
\param{int\&
}{flags
}}
303 Determines which item (if any) is at the specified point,
304 giving details in
{\it flags
}.
{\it flags
} will be a combination of the following flags:
307 \begin{twocollist
}\itemsep=
0pt
308 \twocolitem{wxLIST
\_HITTEST\_ABOVE}{Above the client area.
}
309 \twocolitem{wxLIST
\_HITTEST\_BELOW}{Below the client area.
}
310 \twocolitem{wxLIST
\_HITTEST\_NOWHERE}{In the client area but below the last item.
}
311 \twocolitem{wxLIST
\_HITTEST\_ONITEMICON}{On the bitmap associated with an item.
}
312 \twocolitem{wxLIST
\_HITTEST\_ONITEMLABEL}{On the label (string) associated with an item.
}
313 \twocolitem{wxLIST
\_HITTEST\_ONITEMRIGHT}{In the area to the right of an item.
}
314 \twocolitem{wxLIST
\_HITTEST\_ONITEMSTATEICON}{On the state icon for a tree view item that is in a user-defined state.
}
315 \twocolitem{wxLIST
\_HITTEST\_TOLEFT}{To the right of the client area.
}
316 \twocolitem{wxLIST
\_HITTEST\_TORIGHT}{To the left of the client area.
}
317 \twocolitem{wxLIST
\_HITTEST\_ONITEM}{Combination of wxLIST
\_HITTEST\_ONITEMICON, wxLIST
\_HITTEST\_ONITEMLABEL,
318 wxLIST
\_HITTEST\_ONITEMSTATEICON.
}
321 \membersection{wxListCtrl::InsertColumn
}\label{wxlistctrlinsertcolumn
}
323 \func{long
}{InsertColumn
}{\param{long
}{col
},
\param{wxListItem\&
}{info
}}
325 For list view mode (only), inserts a column. For more details, see
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
}.
327 \func{long
}{InsertColumn
}{\param{long
}{col
},
\param{const wxString\&
}{heading
},
\param{int
}{format = wxLIST
\_FORMAT\_LEFT},
\rtfsp
328 \param{int
}{width = -
1}}
330 For list view mode (only), inserts a column. For more details, see
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
}.
332 \membersection{wxListCtrl::InsertItem
}\label{wxlistctrlinsertitem
}
334 \func{long
}{InsertItem
}{\param{wxListItem\&
}{info
}}
336 Inserts an item, returning the index of the new item if successful,
339 \func{long
}{InsertItem
}{\param{long
}{index
},
\param{const wxString\&
}{label
}}
341 Inserts a string item.
343 \func{long
}{InsertItem
}{\param{long
}{index
},
\param{int
}{imageIndex
}}
345 Inserts an image item.
347 \func{long
}{InsertItem
}{\param{long
}{index
},
\param{const wxString\&
}{label
},
\param{int
}{imageIndex
}}
349 Insert an image/string item.
351 \membersection{wxListCtrl::ScrollList
}\label{wxlistctrlscrolllist
}
353 \func{bool
}{ScrollList
}{\param{int
}{dx
},
\param{int
}{dy
}}
355 Scrolls the list control. If in icon, small icon or
report view mode,
356 dx specifies the number of pixels to scroll. If in list view mode, dx
357 specifies the number of columns to scroll.
359 If in icon, small icon or list view mode, dy specifies the number of pixels
360 to scroll. If in
report view mode, dy specifies the number of lines to scroll.
362 \membersection{wxListCtrl::SetBackgroundColour
}\label{wxlistctrlsetbackgroundcolour
}
364 \func{void
}{SetBackgroundColour
}{\param{const wxColour\&
}{col
}}
366 Sets the background colour (GetBackgroundColour already implicit in
369 \membersection{wxListCtrl::SetColumn
}\label{wxlistctrlsetcolumn
}
371 \func{bool
}{SetColumn
}{\param{int
}{col
},
\param{wxListItem\&
}{item
}}
373 Sets information about this column. See
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
} for more
376 \membersection{wxListCtrl::SetColumnWidth
}\label{wxlistctrlsetcolumnwidth
}
378 \func{bool
}{SetColumnWidth
}{\param{int
}{col
},
\param{int
}{width
}}
380 Sets the column width (
report view only).
382 {\it width
} can be a width in pixels or wxLIST
\_AUTOSIZE (-
1) or wxLIST
\_AUTOSIZE\_USEHEADER (-
2).
384 \membersection{wxListCtrl::SetImageList
}\label{wxlistctrlsetimagelist
}
386 \func{void
}{SetImageList
}{\param{wxImageList*
}{ imageList
},
\param{int
}{which
}}
388 Sets the image list associated with the control.
{\it which
} is one of
389 wxIMAGE
\_LIST\_NORMAL, wxIMAGE
\_LIST\_SMALL, wxIMAGE
\_LIST\_STATE (the last is unimplemented).
391 \membersection{wxListCtrl::SetItem
}\label{wxlistctrlsetitem
}
393 \func{bool
}{SetItem
}{\param{wxListItem\&
}{info
}}
395 Sets information about the item.
397 wxListItem is a class with the following members:
400 \begin{twocollist
}\itemsep=
0pt
401 \twocolitem{long m
\_mask}{Indicates which fields are valid. See the list of valid mask flags below.
}
402 \twocolitem{long m
\_itemId}{The zero-based item position.
}
403 \twocolitem{int m
\_col}{Zero-based column, if in
report mode.
}
404 \twocolitem{long m
\_state}{The state of the item. See the list of valid state flags below.
}
405 \twocolitem{long m
\_stateMask}{A mask indicating which state flags are valid. See the list of valid state flags below.
}
406 \twocolitem{wxString m
\_text}{The label/header text.
}
407 \twocolitem{int m
\_image}{The zero-based index into an image list.
}
408 \twocolitem{long m
\_data}{Application-defined data.
}
409 \twocolitem{int m
\_format}{For columns only: the format. Can be wxLIST
\_FORMAT\_LEFT, wxLIST
\_FORMAT\_RIGHT or
410 wxLIST
\_FORMAT\_CENTRE.
}
411 \twocolitem{int m
\_width}{For columns only: the column width.
}
414 The
{\bf m
\_mask} member contains a bitlist specifying which of the other fields are valid. The flags are:
417 \begin{twocollist
}\itemsep=
0pt
418 \twocolitem{wxLIST
\_MASK\_STATE}{The
{\bf m
\_state} field is valid.
}
419 \twocolitem{wxLIST
\_MASK\_TEXT}{The
{\bf m
\_text} field is valid.
}
420 \twocolitem{wxLIST
\_MASK\_IMAGE}{The
{\bf m
\_image} field is valid.
}
421 \twocolitem{wxLIST
\_MASK\_DATA}{The
{\bf m
\_data} field is valid.
}
422 \twocolitem{wxLIST
\_MASK\_WIDTH}{The
{\bf m
\_width} field is valid.
}
423 \twocolitem{wxLIST
\_MASK\_FORMAT}{The
{\bf m
\_format} field is valid.
}
426 The
{\bf m
\_stateMask} and
{\bf m
\_state} members take flags from the following:
429 \begin{twocollist
}\itemsep=
0pt
430 \twocolitem{wxLIST
\_STATE\_DONTCARE}{Don't care what the state is.
}
431 \twocolitem{wxLIST
\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event.
}
432 \twocolitem{wxLIST
\_STATE\_FOCUSED}{The item has the focus.
}
433 \twocolitem{wxLIST
\_STATE\_SELECTED}{The item is selected.
}
434 \twocolitem{wxLIST
\_STATE\_CUT}{The item is in the cut state.
}
437 \func{long
}{SetItem
}{\param{long
}{index
},
\param{int
}{col
},
\param{const wxString\&
}{label
},
\param{int
}{imageId = -
1}}
439 Sets a string field at a particular column.
441 \membersection{wxListCtrl::SetItemData
}\label{wxlistctrlsetitemdata
}
443 \func{bool
}{SetItemData
}{\param{long
}{item
},
\param{long
}{data
}}
445 Associates application-defined data with this item.
447 \membersection{wxListCtrl::SetItemImage
}\label{wxlistctrlsetitemimage
}
449 \func{bool
}{SetItemImage
}{\param{long
}{item
},
\param{int
}{image
},
\param{int
}{selImage
}}
451 Sets the unselected and selected images associated with the item. The images are indices into the
452 image list associated with the list control.
454 \membersection{wxListCtrl::SetItemPosition
}\label{wxlistctrlsetitemposition
}
456 \func{bool
}{SetItemPosition
}{\param{long
}{item
},
\param{const wxPoint\&
}{pos
}}
458 Sets the position of the item, in icon or small icon view.
460 \membersection{wxListCtrl::SetItemState
}\label{wxlistctrlsetitemstate
}
462 \func{bool
}{SetItemState
}{\param{long
}{item
},
\param{long
}{state
},
\param{long
}{stateMask
}}
464 Sets the item state. For a list of state flags, see
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
}.
466 The
{\bf stateMask
} indicates which state flags are valid.
468 \membersection{wxListCtrl::SetItemText
}\label{wxlistctrlsetitemtext
}
470 \func{void
}{SetItemText
}{\param{long
}{item
},
\param{const wxString\&
}{text
}}
472 Sets the item text for this item.
474 \membersection{wxListCtrl::SetSingleStyle
}\label{wxlistctrlsetsinglestyle
}
476 \func{void
}{SetSingleStyle
}{\param{long
}{style
},
\param{const bool
}{add = TRUE
}}
478 Adds or removes a single window style.
480 \membersection{wxListCtrl::SetTextColour
}\label{wxlistctrlsettextcolour
}
482 \func{void
}{SetTextColour
}{\param{const wxColour\&
}{col
}}
484 Sets the text colour of the list control.
486 \membersection{wxListCtrl::SetWindowStyleFlag
}\label{wxlistctrlsetwindowstyleflag
}
488 \func{void
}{SetWindowStyleFlag
}{\param{long
}{style
}}
490 Sets the whole window style.
492 \membersection{wxListCtrl::SortItems
}\label{wxlistctrlsortitems
}
494 \func{bool
}{SortItems
}{\param{wxListCtrlCompare
}{fn
},
\param{long
}{data
}}
496 Sorts the items in the list control.
498 fn is a function which takes
3 long arguments: item1, item2, data.
500 item1 is the long data associated with a first item (NOT the index).
502 item2 is the long data associated with a second item (NOT the index).
504 data is the same value as passed to SortItems.
506 The return value is a negative number if the first item should precede the second
507 item, a positive number of the second item should precede the first,
508 or zero if the two items are equivalent.
510 data is arbitrary data to be passed to the sort function.