]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/listctrl.tex
Small changes
[wxWidgets.git] / docs / latex / wx / listctrl.tex
... / ...
CommitLineData
1\section{\class{wxListCtrl}}\label{wxlistctrl}
2
3A list control presents lists in a number of formats: list view, report view, icon view
4and small icon view. Elements are numbered from zero.
5
6To intercept events from a list control, use the event table macros described in \helpref{wxListEvent}{wxlistevent}.
7
8\wxheading{Derived from}
9
10\helpref{wxControl}{wxcontrol}\\
11\helpref{wxWindow}{wxwindow}\\
12\helpref{wxEvtHandler}{wxevthandler}\\
13\helpref{wxObject}{wxobject}
14
15\wxheading{Include files}
16
17<wx/listctrl.h>
18
19\wxheading{Window styles}
20
21\twocolwidtha{5cm}
22\begin{twocollist}\itemsep=0pt
23\twocolitem{\windowstyle{wxLC\_LIST}}{multicolumn list view, with optional small icons.
24Columns are computed automatically, i.e. you don't set columns as in wxLC\_REPORT. In other words,
25the list wraps, unlike a wxListBox.}
26\twocolitem{\windowstyle{wxLC\_REPORT}}{single or multicolumn report view, with optional header.}
27\twocolitem{\windowstyle{wxLC\_ICON}}{Large icon view, with optional labels.}
28\twocolitem{\windowstyle{wxLC\_SMALL\_ICON}}{Small icon view, with optional labels.}
29\twocolitem{\windowstyle{wxLC\_ALIGN\_TOP}}{Icons align to the top. Win32 default, Win32 only. }
30\twocolitem{\windowstyle{wxLC\_ALIGN\_LEFT}}{Icons align to the left. }
31\twocolitem{\windowstyle{wxLC\_AUTOARRANGE}}{Icons arrange themselves. Win32 only. }
32\twocolitem{\windowstyle{wxLC\_USER\_TEXT}}{The application provides label text on demand, except for column headers. Win32 only. }
33\twocolitem{\windowstyle{wxLC\_EDIT\_LABELS}}{Labels are editable: the application will be notified when editing starts.}
34\twocolitem{\windowstyle{wxLC\_NO\_HEADER}}{No header in report mode. Win32 only. }
35\twocolitem{\windowstyle{wxLC\_SINGLE\_SEL}}{Single selection.}
36\twocolitem{\windowstyle{wxLC\_SORT\_ASCENDING}}{Sort in ascending order (must still supply a comparison callback in SortItems.}
37\twocolitem{\windowstyle{wxLC\_SORT\_DESCENDING}}{Sort in descending order (must still supply a comparison callback in SortItems.}
38\end{twocollist}
39
40See also \helpref{window styles overview}{windowstyles}.
41
42\wxheading{Event handling}
43
44To process input from a list control, use these event handler macros to direct input to member
45functions that take a \helpref{wxListEvent}{wxlistevent} argument.
46
47\twocolwidtha{7cm}
48\begin{twocollist}\itemsep=0pt
49\twocolitem{{\bf EVT\_LIST\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
50\twocolitem{{\bf EVT\_LIST\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
51\twocolitem{{\bf EVT\_LIST\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
52\twocolitem{{\bf EVT\_LIST\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
53\twocolitem{{\bf EVT\_LIST\_DELETE\_ITEM(id, func)}}{Delete an item.}
54\twocolitem{{\bf EVT\_LIST\_DELETE\_ALL\_ITEMS(id, func)}}{Delete all items.}
55\twocolitem{{\bf EVT\_LIST\_GET\_INFO(id, func)}}{Request information from the application, usually the item text.}
56\twocolitem{{\bf EVT\_LIST\_SET\_INFO(id, func)}}{Information is being supplied (not implemented).}
57\twocolitem{{\bf EVT\_LIST\_ITEM\_SELECTED(id, func)}}{The item has been selected.}
58\twocolitem{{\bf EVT\_LIST\_ITEM\_DESELECTED(id, func)}}{The item has been deselected.}
59\twocolitem{{\bf EVT\_LIST\_ITEM\_ACTIVATED(id, func)}}{The item has been activated (ENTER or double click).}
60\twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.}
61\twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.}
62\twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.}
63\end{twocollist}%
64
65\wxheading{See also}
66
67\helpref{wxListCtrl overview}{wxlistctrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxTreeCtrl}{wxtreectrl},\rtfsp
68\helpref{wxImageList}{wximagelist}, \helpref{wxListEvent}{wxlistevent}
69
70\latexignore{\rtfignore{\wxheading{Members}}}
71
72\membersection{wxListCtrl::wxListCtrl}\label{wxlistctrlconstr}
73
74\func{}{wxListCtrl}{\void}
75
76Default constructor.
77
78\func{}{wxListCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
79\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
80\param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
81
82Constructor, creating and showing a list control.
83
84\wxheading{Parameters}
85
86\docparam{parent}{Parent window. Must not be NULL.}
87
88\docparam{id}{Window identifier. A value of -1 indicates a default value.}
89
90\docparam{pos}{Window position.}
91
92\docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
93appropriately.}
94
95\docparam{style}{Window style. See \helpref{wxListCtrl}{wxlistctrl}.}
96
97\docparam{validator}{Window validator.}
98
99\docparam{name}{Window name.}
100
101\wxheading{See also}
102
103\helpref{wxListCtrl::Create}{wxlistctrlcreate}, \helpref{wxValidator}{wxvalidator}
104
105\membersection{wxListCtrl::\destruct{wxListCtrl}}
106
107\func{void}{\destruct{wxListCtrl}}{\void}
108
109Destructor, destroying the list control.
110
111\membersection{wxListCtrl::Arrange}\label{wxlistctrlarrange}
112
113\func{bool}{Arrange}{\param{int }{flag = wxLIST\_ALIGN\_DEFAULT}}
114
115Arranges the items in icon or small icon view. This only has effect on Win32. {\it flag} is one of:
116
117\twocolwidtha{5cm}
118\begin{twocollist}\itemsep=0pt
119\twocolitem{wxLIST\_ALIGN\_DEFAULT}{Default alignment.}
120\twocolitem{wxLIST\_ALIGN\_LEFT}{Align to the left side of the control.}
121\twocolitem{wxLIST\_ALIGN\_TOP}{Align to the top side of the control.}
122\twocolitem{wxLIST\_ALIGN\_SNAP\_TO\_GRID}{Snap to grid.}
123\end{twocollist}
124
125\membersection{wxListCtrl::Create}\label{wxlistctrlcreate}
126
127\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
128\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
129\param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
130
131Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details.
132
133\membersection{wxListCtrl::ClearAll}\label{wxlistctrlclearall}
134
135\func{void}{ClearAll}{}
136
137Deletes all items and all columns.
138
139\membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem}
140
141\func{bool}{DeleteItem}{\param{long }{item}}
142
143Deletes the specified item. This function sends the
144{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event for the item being deleted.
145
146See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
147
148\membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems}
149
150\func{bool}{DeleteAllItems}{}
151
152Deletes all the items in the list control.
153
154{\bf NB:} This function does {\it not} send the
155{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items
156from the control would be too slow then (unlike
157 \helpref{DeleteItem}{wxlistctrldeleteitem})
158
159\membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn}
160
161\func{bool}{DeleteColumn}{\param{int }{col}}
162
163Deletes a column.
164
165\membersection{wxListCtrl::EditLabel}\label{wxlistctrledit}
166
167\func{void}{EditLabel}{\param{long }{item}}
168
169Starts editing the label of the given item. This function generates a
170EVT\_LIST\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no
171text control will appear for in-place editing.
172
173If the user changed the label (i.e. s/he does not press ESC or leave
174the text control without changes, a EVT\_LIST\_END\_LABEL\_EDIT event
175will be sent which can be vetoed as well.
176
177\membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible}
178
179\func{bool}{EnsureVisible}{\param{long }{item}}
180
181Ensures this item is visible.
182
183\membersection{wxListCtrl::FindItem}\label{wxlistctrlfinditem}
184
185\func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = FALSE}}
186
187Find an item whose label matches this string, starting from the item after {\it start} or
188the beginning if {\it start} is -1.
189
190\func{long}{FindItem}{\param{long }{start}, \param{long }{data}}
191
192Find an item whose data matches this data, starting from the item after {\it start} or
193the beginning if 'start' is -1.
194
195\func{long}{FindItem}{\param{long }{start}, \param{const wxPoint\& }{pt}, \param{int }{direction}}
196
197Find an item nearest this position in the specified direction, starting from
198the item after {\it start} or the beginning if {\it start} is -1.
199
200\pythonnote{In place of a single overloaded method name, wxPython
201implements the following methods:\par
202\indented{2cm}{\begin{twocollist}
203\twocolitem{{\bf FindItem(start, str, partial=FALSE)}}{}
204\twocolitem{{\bf FindItemData(start, data)}}{}
205\twocolitem{{\bf FindItemAtPos(start, point, direction)}}{}
206\end{twocollist}}
207}
208
209\membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn}
210
211\constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
212
213Gets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
214information.
215
216\membersection{wxListCtrl::GetColumnWidth}\label{wxlistctrlgetcolumnwidth}
217
218\constfunc{int}{GetColumnWidth}{\param{int }{col}}
219
220Gets the column width (report view only).
221
222\membersection{wxListCtrl::GetCountPerPage}\label{wxlistctrlgetcountperpage}
223
224\constfunc{int}{GetCountPerPage}{\void}
225
226Gets the number of items that can fit vertically in the
227visible area of the list control (list or report view)
228or the total number of items in the list control (icon
229or small icon view).
230
231\membersection{wxListCtrl::GetEditControl}\label{wxlistctrlgeteditcontrol}
232
233\constfunc{wxTextCtrl\&}{GetEditControl}{\void}
234
235Gets the edit control for editing labels.
236
237\membersection{wxListCtrl::GetImageList}\label{wxlistctrlgetimagelist}
238
239\constfunc{wxImageList*}{GetImageList}{\param{int }{which}}
240
241Returns the specified image list. {\it which} may be one of:
242
243\twocolwidtha{5cm}
244\begin{twocollist}\itemsep=0pt
245\twocolitem{\windowstyle{wxIMAGE\_LIST\_NORMAL}}{The normal (large icon) image list.}
246\twocolitem{\windowstyle{wxIMAGE\_LIST\_SMALL}}{The small icon image list.}
247\twocolitem{\windowstyle{wxIMAGE\_LIST\_STATE}}{The user-defined state image list (unimplemented).}
248\end{twocollist}
249
250\membersection{wxListCtrl::GetItem}\label{wxlistctrlgetitem}
251
252\constfunc{bool}{GetItem}{\param{wxListItem\& }{info}}
253
254Gets information about the item. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
255information.
256
257\pythonnote{The wxPython version of this method takes an integer parameter
258for the item ID, and returns the wxListItem object.
259}
260
261\membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata}
262
263\constfunc{long}{GetItemData}{\param{long }{item}}
264
265Gets the application-defined data associated with this item.
266
267\membersection{wxListCtrl::GetItemPosition}\label{wxlistctrlgetitemposition}
268
269\constfunc{bool}{GetItemPosition}{\param{long }{item}, \param{wxPoint\& }{pos}}
270
271Returns the position of the item, in icon or small icon view.
272
273\pythonnote{The wxPython version of this method accepts only the item
274ID and returns the wxPoint.}
275
276\membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect}
277
278\constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}}
279
280Returns the rectangle representing the item's size and position, in client coordinates.
281
282{\it code} is one of wxLIST\_RECT\_BOUNDS, wxLIST\_RECT\_ICON, wxLIST\_RECT\_LABEL.
283
284\pythonnote{The wxPython version of this method accepts only the item
285ID and returns the wxRect.}
286
287\membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
288
289\constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}}
290
291Gets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
292
293The {\bf stateMask} indicates which state flags are of interest.
294
295\membersection{wxListCtrl::GetItemCount}\label{wxlistctrlgetitemcount}
296
297\constfunc{int}{GetItemCount}{\void}
298
299Returns the number of items in the list control.
300
301\membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing}
302
303\constfunc{int}{GetItemSpacing}{\param{bool }{isSmall}}
304
305Retrieves the spacing between icons in pixels.
306If {\it small} is TRUE, gets the spacing for the small icon
307view, otherwise the large icon view.
308
309\membersection{wxListCtrl::GetItemText}\label{wxlistctrlgetitemtext}
310
311\constfunc{wxString}{GetItemText}{\param{long }{item}}
312
313Gets the item text for this item.
314
315\membersection{wxListCtrl::GetNextItem}\label{wxlistctrlgetnextitem}
316
317\constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}}
318
319Searches for an item with the given goemetry or state, starting from {\it item}. {\it item} can be -1
320to find the first item that matches the specified flags.
321
322Returns the item or -1 if unsuccessful.
323
324{\it geometry} can be one of:
325
326\twocolwidtha{5cm}
327\begin{twocollist}\itemsep=0pt
328\twocolitem{wxLIST\_NEXT\_ABOVE}{Searches for an item above the specified item.}
329\twocolitem{wxLIST\_NEXT\_ALL}{Searches for subsequent item by index.}
330\twocolitem{wxLIST\_NEXT\_BELOW}{Searches for an item below the specified item.}
331\twocolitem{wxLIST\_NEXT\_LEFT}{Searches for an item to the left of the specified item.}
332\twocolitem{wxLIST\_NEXT\_RIGHT}{Searches for an item to the right of the specified item.}
333\end{twocollist}
334
335{\it state} can be a bitlist of the following:
336
337\twocolwidtha{5cm}
338\begin{twocollist}\itemsep=0pt
339\twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is.}
340\twocolitem{wxLIST\_STATE\_DROPHILITED}{The item indicates it is a drop target.}
341\twocolitem{wxLIST\_STATE\_FOCUSED}{The item has the focus.}
342\twocolitem{wxLIST\_STATE\_SELECTED}{The item is selected.}
343\twocolitem{wxLIST\_STATE\_CUT}{The item is selected as part of a cut and paste operation.}
344\end{twocollist}
345
346\membersection{wxListCtrl::GetSelectedItemCount}\label{wxlistctrlgetselecteditemcount}
347
348\constfunc{int}{GetSelectedItemCount}{\void}
349
350Returns the number of selected items in the list control.
351
352\membersection{wxListCtrl::GetTextColour}\label{wxlistctrlgettextcolour}
353
354\constfunc{wxColour}{GetTextColour}{\void}
355
356Gets the text colour of the list control.
357
358\membersection{wxListCtrl::GetTopItem}\label{wxlistctrlgettopitem}
359
360\constfunc{long}{GetTopItem}{\void}
361
362Gets the index of the topmost visible item when in
363list or report view.
364
365\membersection{wxListCtrl::HitTest}\label{wxlistctrlhittest}
366
367\func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
368
369Determines which item (if any) is at the specified point,
370giving details in {\it flags}. {\it flags} will be a combination of the following flags:
371
372\twocolwidtha{5cm}
373\begin{twocollist}\itemsep=0pt
374\twocolitem{wxLIST\_HITTEST\_ABOVE}{Above the client area.}
375\twocolitem{wxLIST\_HITTEST\_BELOW}{Below the client area.}
376\twocolitem{wxLIST\_HITTEST\_NOWHERE}{In the client area but below the last item.}
377\twocolitem{wxLIST\_HITTEST\_ONITEMICON}{On the bitmap associated with an item.}
378\twocolitem{wxLIST\_HITTEST\_ONITEMLABEL}{On the label (string) associated with an item.}
379\twocolitem{wxLIST\_HITTEST\_ONITEMRIGHT}{In the area to the right of an item.}
380\twocolitem{wxLIST\_HITTEST\_ONITEMSTATEICON}{On the state icon for a tree view item that is in a user-defined state.}
381\twocolitem{wxLIST\_HITTEST\_TOLEFT}{To the right of the client area.}
382\twocolitem{wxLIST\_HITTEST\_TORIGHT}{To the left of the client area.}
383\twocolitem{wxLIST\_HITTEST\_ONITEM}{Combination of wxLIST\_HITTEST\_ONITEMICON, wxLIST\_HITTEST\_ONITEMLABEL,
384wxLIST\_HITTEST\_ONITEMSTATEICON.}
385\end{twocollist}
386
387\pythonnote{A tuple of values is returned in the wxPython version of
388thsi method. The first value is the item id and the second is the
389flags value mentioned above.}
390
391\membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
392
393\func{long}{InsertColumn}{\param{long }{col}, \param{wxListItem\& }{info}}
394
395For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
396
397\func{long}{InsertColumn}{\param{long }{col}, \param{const wxString\& }{heading}, \param{int }{format = wxLIST\_FORMAT\_LEFT},\rtfsp
398\param{int }{width = -1}}
399
400For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
401
402\pythonnote{In place of a single overloaded method name, wxPython
403implements the following methods:\par
404\indented{2cm}{\begin{twocollist}
405\twocolitem{{\bf InsertColumn(col, heading, format=wxLIST\_FORMAT\_LEFT,
406width=-1)}}{Creates a column using a header string only.}
407\twocolitem{{\bf InsertColumnInfo(col, item)}}{Creates a column using a
408wxListInfo.}
409\end{twocollist}}
410}
411
412\membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem}
413
414\func{long}{InsertItem}{\param{wxListItem\& }{info}}
415
416Inserts an item, returning the index of the new item if successful,
417-1 otherwise.
418
419\func{long}{InsertItem}{\param{long }{index}, \param{const wxString\& }{label}}
420
421Inserts a string item.
422
423\func{long}{InsertItem}{\param{long }{index}, \param{int }{imageIndex}}
424
425Inserts an image item.
426
427\func{long}{InsertItem}{\param{long }{index}, \param{const wxString\& }{label}, \param{int }{imageIndex}}
428
429Insert an image/string item.
430
431\wxheading{Parameters}
432
433\docparam{info}{wxListItem object}
434
435\docparam{index}{Index of the new item, supplied by the application}
436
437\docparam{label}{String label}
438
439\docparam{imageIndex}{index into the image list associated with this control and view style}
440
441\pythonnote{In place of a single overloaded method name, wxPython
442implements the following methods:\par
443\indented{2cm}{\begin{twocollist}
444\twocolitem{{\bf InsertItem(item)}}{Inserts an item using a wxListItem.}
445\twocolitem{{\bf InsertStringItem(index, label)}}{Inserts a string item.}
446\twocolitem{{\bf InsertImageItem(index, imageIndex)}}{Inserts an image item.}
447\twocolitem{{\bf InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.}
448\end{twocollist}}
449}
450
451\membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist}
452
453\func{bool}{ScrollList}{\param{int }{dx}, \param{int }{dy}}
454
455Scrolls the list control. If in icon, small icon or report view mode,
456dx specifies the number of pixels to scroll. If in list view mode, dx
457specifies the number of columns to scroll.
458
459If in icon, small icon or list view mode, dy specifies the number of pixels
460to scroll. If in report view mode, dy specifies the number of lines to scroll.
461
462\membersection{wxListCtrl::SetBackgroundColour}\label{wxlistctrlsetbackgroundcolour}
463
464\func{void}{SetBackgroundColour}{\param{const wxColour\& }{col}}
465
466Sets the background colour (GetBackgroundColour already implicit in
467wxWindow class).
468
469\membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn}
470
471\func{bool}{SetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
472
473Sets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
474information.
475
476\membersection{wxListCtrl::SetColumnWidth}\label{wxlistctrlsetcolumnwidth}
477
478\func{bool}{SetColumnWidth}{\param{int }{col}, \param{int }{width}}
479
480Sets the column width.
481
482{\it width} can be a width in pixels or wxLIST\_AUTOSIZE (-1) or wxLIST\_AUTOSIZE\_USEHEADER (-2).
483wxLIST\_AUTOSIZE will resize the column to the length of its longest item. wxLIST\_AUTOSIZE\_USEHEADER
484will resize the column to the length of the header (Win32) or 80 pixels (other platforms).
485
486In small or normal icon view, {\it col} must be -1, and the column width is set for all columns.
487
488\membersection{wxListCtrl::SetImageList}\label{wxlistctrlsetimagelist}
489
490\func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}}
491
492Sets the image list associated with the control. {\it which} is one of
493wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is unimplemented).
494
495\membersection{wxListCtrl::SetItem}\label{wxlistctrlsetitem}
496
497\func{bool}{SetItem}{\param{wxListItem\& }{info}}
498
499Sets information about the item.
500
501wxListItem is a class with the following members:
502
503\twocolwidtha{5cm}
504\begin{twocollist}\itemsep=0pt
505\twocolitem{long m\_mask}{Indicates which fields are valid. See the list of valid mask flags below.}
506\twocolitem{long m\_itemId}{The zero-based item position.}
507\twocolitem{int m\_col}{Zero-based column, if in report mode.}
508\twocolitem{long m\_state}{The state of the item. See the list of valid state flags below.}
509\twocolitem{long m\_stateMask}{A mask indicating which state flags are valid. See the list of valid state flags below.}
510\twocolitem{wxString m\_text}{The label/header text.}
511\twocolitem{int m\_image}{The zero-based index into an image list.}
512\twocolitem{long m\_data}{Application-defined data.}
513\twocolitem{int m\_format}{For columns only: the format. Can be wxLIST\_FORMAT\_LEFT, wxLIST\_FORMAT\_RIGHT or
514wxLIST\_FORMAT\_CENTRE.}
515\twocolitem{int m\_width}{For columns only: the column width.}
516\end{twocollist}
517
518The {\bf m\_mask} member contains a bitlist specifying which of the other fields are valid. The flags are:
519
520\twocolwidtha{5cm}
521\begin{twocollist}\itemsep=0pt
522\twocolitem{wxLIST\_MASK\_STATE}{The {\bf m\_state} field is valid.}
523\twocolitem{wxLIST\_MASK\_TEXT}{The {\bf m\_text} field is valid.}
524\twocolitem{wxLIST\_MASK\_IMAGE}{The {\bf m\_image} field is valid.}
525\twocolitem{wxLIST\_MASK\_DATA}{The {\bf m\_data} field is valid.}
526\twocolitem{wxLIST\_MASK\_WIDTH}{The {\bf m\_width} field is valid.}
527\twocolitem{wxLIST\_MASK\_FORMAT}{The {\bf m\_format} field is valid.}
528\end{twocollist}
529
530The {\bf m\_stateMask} and {\bf m\_state} members take flags from the following:
531
532The wxListItem object can also contain item-specific colour and font
533information: for this you need to call one of SetTextColour(),
534SetBackgroundColour() or SetFont() functions on it passing it the colour/font
535to use. If the colour/font is not specified, the default list control
536colour/font is used.
537
538\twocolwidtha{5cm}
539\begin{twocollist}\itemsep=0pt
540\twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is. Win32 only. }
541\twocolitem{wxLIST\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event. Win32 only. }
542\twocolitem{wxLIST\_STATE\_FOCUSED}{The item has the focus.}
543\twocolitem{wxLIST\_STATE\_SELECTED}{The item is selected.}
544\twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state. Win32 only. }
545\end{twocollist}
546
547\func{long}{SetItem}{\param{long }{index}, \param{int }{col}, \param{const wxString\& }{label}, \param{int }{imageId = -1}}
548
549Sets a string field at a particular column.
550
551\pythonnote{In place of a single overloaded method name, wxPython
552implements the following methods:\par
553\indented{2cm}{\begin{twocollist}
554\twocolitem{{\bf SetItem(item)}}{Sets information about the given wxListItem.}
555\twocolitem{{\bf SetStringItem(index, col, label, imageId)}}{Sets a
556string or image at a given location.}
557\end{twocollist}}
558}
559
560
561\membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata}
562
563\func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}}
564
565Associates application-defined data with this item.
566
567\membersection{wxListCtrl::SetItemImage}\label{wxlistctrlsetitemimage}
568
569\func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}, \param{int }{selImage}}
570
571Sets the unselected and selected images associated with the item. The images are indices into the
572image list associated with the list control.
573
574\membersection{wxListCtrl::SetItemPosition}\label{wxlistctrlsetitemposition}
575
576\func{bool}{SetItemPosition}{\param{long }{item}, \param{const wxPoint\& }{pos}}
577
578Sets the position of the item, in icon or small icon view.
579
580\membersection{wxListCtrl::SetItemState}\label{wxlistctrlsetitemstate}
581
582\func{bool}{SetItemState}{\param{long }{item}, \param{long }{state}, \param{long }{stateMask}}
583
584Sets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
585
586The {\bf stateMask} indicates which state flags are valid.
587
588\membersection{wxListCtrl::SetItemText}\label{wxlistctrlsetitemtext}
589
590\func{void}{SetItemText}{\param{long }{item}, \param{const wxString\& }{text}}
591
592Sets the item text for this item.
593
594\membersection{wxListCtrl::SetSingleStyle}\label{wxlistctrlsetsinglestyle}
595
596\func{void}{SetSingleStyle}{\param{long }{style}, \param{const bool }{add = TRUE}}
597
598Adds or removes a single window style.
599
600\membersection{wxListCtrl::SetTextColour}\label{wxlistctrlsettextcolour}
601
602\func{void}{SetTextColour}{\param{const wxColour\& }{col}}
603
604Sets the text colour of the list control.
605
606\membersection{wxListCtrl::SetWindowStyleFlag}\label{wxlistctrlsetwindowstyleflag}
607
608\func{void}{SetWindowStyleFlag}{\param{long }{style}}
609
610Sets the whole window style.
611
612\membersection{wxListCtrl::SortItems}\label{wxlistctrlsortitems}
613
614\func{bool}{SortItems}{\param{wxListCtrlCompare }{fn}, \param{long }{data}}
615
616Sorts the items in the list control.
617
618fn is a function which takes 3 long arguments: item1, item2, data.
619
620item1 is the long data associated with a first item (NOT the index).
621
622item2 is the long data associated with a second item (NOT the index).
623
624data is the same value as passed to SortItems.
625
626The return value is a negative number if the first item should precede the second
627item, a positive number of the second item should precede the first,
628or zero if the two items are equivalent.
629
630data is arbitrary data to be passed to the sort function.
631