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{Include files
}
19 \wxheading{Window styles
}
22 \begin{twocollist
}\itemsep=
0pt
23 \twocolitem{\windowstyle{wxLC
\_LIST}}{multicolumn list view, with optional small icons.
24 Columns are computed automatically, i.e. you don't set columns as in wxLC
\_REPORT. In other words,
25 the 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.
}
40 See also
\helpref{window styles overview
}{windowstyles
}.
42 \wxheading{Event handling
}
44 To process input from a list control, use these event handler macros to direct input to member
45 functions that take a
\helpref{wxListEvent
}{wxlistevent
} argument.
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.
}
52 \twocolitem{{\bf EVT
\_LIST\_END\_LABEL\_EDIT(id, func)
}}{Finish editing a label.
}
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\_KEY\_DOWN(id, func)
}}{A key has been pressed.
}
60 \twocolitem{{\bf EVT
\_LIST\_INSERT\_ITEM(id, func)
}}{An item has been inserted.
}
61 \twocolitem{{\bf EVT
\_LIST\_COL\_CLICK(id, func)
}}{A column (
{\bf m
\_col}) has been left-clicked.
}
66 \helpref{wxListCtrl overview
}{wxlistctrloverview
},
\helpref{wxListBox
}{wxlistbox
},
\helpref{wxTreeCtrl
}{wxtreectrl
},
\rtfsp
67 \helpref{wxImageList
}{wximagelist
},
\helpref{wxListEvent
}{wxlistevent
}
69 \latexignore{\rtfignore{\wxheading{Members
}}}
71 \membersection{wxListCtrl::wxListCtrl
}\label{wxlistctrlconstr
}
73 \func{}{wxListCtrl
}{\void}
77 \func{}{wxListCtrl
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{ id
},
\rtfsp
78 \param{const wxPoint\&
}{ pos = wxDefaultPosition
},
\param{const wxSize\&
}{ size = wxDefaultSize
},
\rtfsp
79 \param{long
}{ style = wxLC
\_ICON},
\param{const wxValidator\&
}{validator = wxDefaultValidator
},
\param{const wxString\&
}{name = ``listCtrl"
}}
81 Constructor, creating and showing a list control.
83 \wxheading{Parameters
}
85 \docparam{parent
}{Parent window. Must not be NULL.
}
87 \docparam{id
}{Window identifier. A value of -
1 indicates a default value.
}
89 \docparam{pos
}{Window position.
}
91 \docparam{size
}{Window size. If the default size (-
1, -
1) is specified then the window is sized
94 \docparam{style
}{Window style. See
\helpref{wxListCtrl
}{wxlistctrl
}.
}
96 \docparam{validator
}{Window validator.
}
98 \docparam{name
}{Window name.
}
102 \helpref{wxListCtrl::Create
}{wxlistctrlcreate
},
\helpref{wxValidator
}{wxvalidator
}
104 \membersection{wxListCtrl::
\destruct{wxListCtrl
}}
106 \func{void
}{\destruct{wxListCtrl
}}{\void}
108 Destructor, destroying the list control.
110 \membersection{wxListCtrl::Arrange
}\label{wxlistctrlarrange
}
112 \func{bool
}{Arrange
}{\param{int
}{flag = wxLIST
\_ALIGN\_DEFAULT}}
114 Arranges the items in icon or small icon view. This only has effect on Win32.
{\it flag
} is one of:
117 \begin{twocollist
}\itemsep=
0pt
118 \twocolitem{wxLIST
\_ALIGN\_DEFAULT}{Default alignment.
}
119 \twocolitem{wxLIST
\_ALIGN\_LEFT}{Align to the left side of the control.
}
120 \twocolitem{wxLIST
\_ALIGN\_TOP}{Align to the top side of the control.
}
121 \twocolitem{wxLIST
\_ALIGN\_SNAP\_TO\_GRID}{Snap to grid.
}
124 \membersection{wxListCtrl::Create
}\label{wxlistctrlcreate
}
126 \func{bool
}{Create
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{ id
},
\rtfsp
127 \param{const wxPoint\&
}{ pos = wxDefaultPosition
},
\param{const wxSize\&
}{ size = wxDefaultSize
},
\rtfsp
128 \param{long
}{ style = wxLC
\_ICON},
\param{const wxValidator\&
}{validator = wxDefaultValidator
},
\param{const wxString\&
}{name = ``listCtrl"
}}
130 Creates the list control. See
\helpref{wxListCtrl::wxListCtrl
}{wxlistctrlconstr
} for further details.
132 \membersection{wxListCtrl::DeleteItem
}\label{wxlistctrldeleteitem
}
134 \func{bool
}{DeleteItem
}{\param{long
}{item
}}
136 Deletes the specified item.
138 \membersection{wxListCtrl::DeleteAllItems
}\label{wxlistctrldeleteallitems
}
140 \func{bool
}{DeleteAllItems
}{\void}
142 Deletes all the items in the list control.
144 \membersection{wxListCtrl::DeleteColumn
}\label{wxlistctrldeletecolumn
}
146 \func{bool
}{DeleteColumn
}{\param{int
}{col
}}
150 \membersection{wxListCtrl::Edit
}\label{wxlistctrledit
}
152 \func{wxTextCtrl\&
}{Edit
}{\param{long
}{item
}}
154 Starts editing a label.
156 \membersection{wxListCtrl::EnsureVisible
}\label{wxlistctrlensurevisible
}
158 \func{bool
}{EnsureVisible
}{\param{long
}{item
}}
160 Ensures this item is visible.
162 \membersection{wxListCtrl::FindItem
}\label{wxlistctrlfinditem
}
164 \func{long
}{FindItem
}{\param{long
}{start
},
\param{const wxString\&
}{str
},
\param{const bool
}{partial = FALSE
}}
166 Find an item whose label matches this string, starting from the item after
{\it start
} or
167 the beginning if
{\it start
} is -
1.
169 \func{long
}{FindItem
}{\param{long
}{start
},
\param{long
}{data
}}
171 Find an item whose data matches this data, starting from the item after
{\it start
} or
172 the beginning if 'start' is -
1.
174 \func{long
}{FindItem
}{\param{long
}{start
},
\param{const wxPoint\&
}{pt
},
\param{int
}{direction
}}
176 Find an item nearest this position in the specified direction, starting from
177 the item after
{\it start
} or the beginning if
{\it start
} is -
1.
179 \pythonnote{In place of a single overloaded method name, wxPython
180 implements the following methods:
\par
181 \indented{2cm
}{\begin{twocollist
}
182 \twocolitem{\bf{FindItem(start, str, partial=FALSE)
}}{}
183 \twocolitem{\bf{FindItemData(start, data)
}}{}
184 \twocolitem{\bf{FindItemAtPos(start, point, direction)
}}{}
188 \membersection{wxListCtrl::GetColumn
}\label{wxlistctrlgetcolumn
}
190 \constfunc{bool
}{GetColumn
}{\param{int
}{col
},
\param{wxListItem\&
}{item
}}
192 Gets information about this column. See
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
} for more
195 \membersection{wxListCtrl::GetColumnWidth
}\label{wxlistctrlgetcolumnwidth
}
197 \constfunc{int
}{GetColumnWidth
}{\param{int
}{col
}}
199 Gets the column width (
report view only).
201 \membersection{wxListCtrl::GetCountPerPage
}\label{wxlistctrlgetcountperpage
}
203 \constfunc{int
}{GetCountPerPage
}{\void}
205 Gets the number of items that can fit vertically in the
206 visible area of the list control (list or
report view)
207 or the total number of items in the list control (icon
210 \membersection{wxListCtrl::GetEditControl
}\label{wxlistctrlgeteditcontrol
}
212 \constfunc{wxTextCtrl\&
}{GetEditControl
}{\void}
214 Gets the edit control for editing labels.
216 \membersection{wxListCtrl::GetImageList
}\label{wxlistctrlgetimagelist
}
218 \constfunc{wxImageList*
}{GetImageList
}{\param{int
}{which
}}
220 Returns the specified image list.
{\it which
} may be one of:
223 \begin{twocollist
}\itemsep=
0pt
224 \twocolitem{\windowstyle{wxIMAGE
\_LIST\_NORMAL}}{The normal (large icon) image list.
}
225 \twocolitem{\windowstyle{wxIMAGE
\_LIST\_SMALL}}{The small icon image list.
}
226 \twocolitem{\windowstyle{wxIMAGE
\_LIST\_STATE}}{The user-defined state image list (unimplemented).
}
229 \membersection{wxListCtrl::GetItem
}\label{wxlistctrlgetitem
}
231 \constfunc{bool
}{GetItem
}{\param{wxListItem\&
}{info
}}
233 Gets information about the item. See
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
} for more
236 \pythonnote{The wxPython version of this method takes a parameter
237 representing the item ID, and returns the wxListItem object.
240 \membersection{wxListCtrl::GetItemData
}\label{wxlistctrlgetitemdata
}
242 \constfunc{long
}{GetItemData
}{\param{long
}{item
}}
244 Gets the application-defined data associated with this item.
246 \membersection{wxListCtrl::GetItemPosition
}\label{wxlistctrlgetitemposition
}
248 \constfunc{bool
}{GetItemPosition
}{\param{long
}{item
},
\param{wxPoint\&
}{pos
}}
250 Returns the position of the item, in icon or small icon view.
252 \pythonnote{The wxPython version of this method accempts only the item
253 ID and returns the wxPoint.
}
255 \membersection{wxListCtrl::GetItemRect
}\label{wxlistctrlgetitemrect
}
257 \constfunc{bool
}{GetItemRect
}{\param{long
}{item
},
\param{wxRect\&
}{rect
},
\param{int
}{code = wxLIST
\_RECT\_BOUNDS}}
259 Returns the rectangle representing the item's size and position, in client coordinates.
261 {\it code
} is one of wxLIST
\_RECT\_BOUNDS, wxLIST
\_RECT\_ICON, wxLIST
\_RECT\_LABEL.
263 \pythonnote{The wxPython version of this method accempts only the item
264 ID and returns the wxRect.
}
266 \membersection{wxListCtrl::GetItemState
}\label{wxlistctrlgetitemstate
}
268 \constfunc{int
}{GetItemState
}{\param{long
}{item
},
\param{long
}{stateMask
}}
270 Gets the item state. For a list of state flags, see
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
}.
272 The
{\bf stateMask
} indicates which state flags are of interest.
274 \membersection{wxListCtrl::GetItemCount
}\label{wxlistctrlgetitemcount
}
276 \constfunc{int
}{GetItemCount
}{\void}
278 Returns the number of items in the list control.
280 \membersection{wxListCtrl::GetItemSpacing
}\label{wxlistctrlgetitemspacing
}
282 \constfunc{int
}{GetItemSpacing
}{\param{bool
}{isSmall
}}
284 Retrieves the spacing between icons in pixels.
285 If
{\it small
} is TRUE, gets the spacing for the small icon
286 view, otherwise the large icon view.
288 \membersection{wxListCtrl::GetItemText
}\label{wxlistctrlgetitemtext
}
290 \constfunc{wxString
}{GetItemText
}{\param{long
}{item
}}
292 Gets the item text for this item.
294 \membersection{wxListCtrl::GetNextItem
}\label{wxlistctrlgetnextitem
}
296 \constfunc{long
}{GetNextItem
}{\param{long
}{item
},
\param{int
}{geometry = wxLIST
\_NEXT\_ALL},
\param{int
}{state = wxLIST
\_STATE\_DONTCARE}}
298 Searches for an item with the given goemetry or state, starting from
{\it item
}.
{\it item
} can be -
1
299 to find the first item that matches the specified flags.
301 Returns the item or -
1 if unsuccessful.
303 {\it geometry
} can be one of:
306 \begin{twocollist
}\itemsep=
0pt
307 \twocolitem{wxLIST
\_NEXT\_ABOVE}{Searches for an item above the specified item.
}
308 \twocolitem{wxLIST
\_NEXT\_ALL}{Searches for subsequent item by index.
}
309 \twocolitem{wxLIST
\_NEXT\_BELOW}{Searches for an item below the specified item.
}
310 \twocolitem{wxLIST
\_NEXT\_LEFT}{Searches for an item to the left of the specified item.
}
311 \twocolitem{wxLIST
\_NEXT\_RIGHT}{Searches for an item to the right of the specified item.
}
314 {\it state
} can be a bitlist of the following:
317 \begin{twocollist
}\itemsep=
0pt
318 \twocolitem{wxLIST
\_STATE\_DONTCARE}{Don't care what the state is.
}
319 \twocolitem{wxLIST
\_STATE\_DROPHILITED}{The item indicates it is a drop target.
}
320 \twocolitem{wxLIST
\_STATE\_FOCUSED}{The item has the focus.
}
321 \twocolitem{wxLIST
\_STATE\_SELECTED}{The item is selected.
}
322 \twocolitem{wxLIST
\_STATE\_CUT}{The item is selected as part of a cut and paste operation.
}
325 \membersection{wxListCtrl::GetSelectedItemCount
}\label{wxlistctrlgetselecteditemcount
}
327 \constfunc{int
}{GetSelectedItemCount
}{\void}
329 Returns the number of selected items in the list control.
331 \membersection{wxListCtrl::GetTextColour
}\label{wxlistctrlgettextcolour
}
333 \constfunc{wxColour
}{GetTextColour
}{\void}
335 Gets the text colour of the list control.
337 \membersection{wxListCtrl::GetTopItem
}\label{wxlistctrlgettopitem
}
339 \constfunc{long
}{GetTopItem
}{\void}
341 Gets the index of the topmost visible item when in
344 \membersection{wxListCtrl::HitTest
}\label{wxlistctrlhittest
}
346 \func{long
}{HitTest
}{\param{const wxPoint\&
}{point
},
\param{int\&
}{flags
}}
348 Determines which item (if any) is at the specified point,
349 giving details in
{\it flags
}.
{\it flags
} will be a combination of the following flags:
352 \begin{twocollist
}\itemsep=
0pt
353 \twocolitem{wxLIST
\_HITTEST\_ABOVE}{Above the client area.
}
354 \twocolitem{wxLIST
\_HITTEST\_BELOW}{Below the client area.
}
355 \twocolitem{wxLIST
\_HITTEST\_NOWHERE}{In the client area but below the last item.
}
356 \twocolitem{wxLIST
\_HITTEST\_ONITEMICON}{On the bitmap associated with an item.
}
357 \twocolitem{wxLIST
\_HITTEST\_ONITEMLABEL}{On the label (string) associated with an item.
}
358 \twocolitem{wxLIST
\_HITTEST\_ONITEMRIGHT}{In the area to the right of an item.
}
359 \twocolitem{wxLIST
\_HITTEST\_ONITEMSTATEICON}{On the state icon for a tree view item that is in a user-defined state.
}
360 \twocolitem{wxLIST
\_HITTEST\_TOLEFT}{To the right of the client area.
}
361 \twocolitem{wxLIST
\_HITTEST\_TORIGHT}{To the left of the client area.
}
362 \twocolitem{wxLIST
\_HITTEST\_ONITEM}{Combination of wxLIST
\_HITTEST\_ONITEMICON, wxLIST
\_HITTEST\_ONITEMLABEL,
363 wxLIST
\_HITTEST\_ONITEMSTATEICON.
}
366 \membersection{wxListCtrl::InsertColumn
}\label{wxlistctrlinsertcolumn
}
368 \func{long
}{InsertColumn
}{\param{long
}{col
},
\param{wxListItem\&
}{info
}}
370 For list view mode (only), inserts a column. For more details, see
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
}.
372 \func{long
}{InsertColumn
}{\param{long
}{col
},
\param{const wxString\&
}{heading
},
\param{int
}{format = wxLIST
\_FORMAT\_LEFT},
\rtfsp
373 \param{int
}{width = -
1}}
375 For list view mode (only), inserts a column. For more details, see
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
}.
377 \pythonnote{In place of a single overloaded method name, wxPython
378 implements the following methods:
\par
379 \indented{2cm
}{\begin{twocollist
}
380 \twocolitem{\bf{InsertColumn(col, heading, format=wxLIST_FORMAT_LEFT,
381 width=-
1)
}}{Creates a column using a header string only.
}
382 \twocolitem{\bf{InsertColumnInfo(col, item)
}}{Creates a column using a
387 \membersection{wxListCtrl::InsertItem
}\label{wxlistctrlinsertitem
}
389 \func{long
}{InsertItem
}{\param{wxListItem\&
}{info
}}
391 Inserts an item, returning the index of the new item if successful,
394 \func{long
}{InsertItem
}{\param{long
}{index
},
\param{const wxString\&
}{label
}}
396 Inserts a string item.
398 \func{long
}{InsertItem
}{\param{long
}{index
},
\param{int
}{imageIndex
}}
400 Inserts an image item.
402 \func{long
}{InsertItem
}{\param{long
}{index
},
\param{const wxString\&
}{label
},
\param{int
}{imageIndex
}}
404 Insert an image/string item.
406 \wxheading{Parameters
}
408 \docparam{info
}{wxListItem object
}
410 \docparam{index
}{Index of the new item, supplied by the application
}
412 \docparam{label
}{String label
}
414 \docparam{imageIndex
}{index into the image list associated with this control and view style
}
416 \pythonnote{In place of a single overloaded method name, wxPython
417 implements the following methods:
\par
418 \indented{2cm
}{\begin{twocollist
}
419 \twocolitem{\bf{InsertItem(item)
}}{Inserts an item using a wxListItem.
}
420 \twocolitem{\bf{InsertStringItem(index, label)
}}{Inserts a string item.
}
421 \twocolitem{\bf{InsertImageItem(index, imageIndex)
}}{Inserts an image item.
}
422 \twocolitem{\bf{InsertImageStringItem(index, label, imageIndex)
}}{Insert an image/string item.
}
426 \membersection{wxListCtrl::ScrollList
}\label{wxlistctrlscrolllist
}
428 \func{bool
}{ScrollList
}{\param{int
}{dx
},
\param{int
}{dy
}}
430 Scrolls the list control. If in icon, small icon or
report view mode,
431 dx specifies the number of pixels to scroll. If in list view mode, dx
432 specifies the number of columns to scroll.
434 If in icon, small icon or list view mode, dy specifies the number of pixels
435 to scroll. If in
report view mode, dy specifies the number of lines to scroll.
437 \membersection{wxListCtrl::SetBackgroundColour
}\label{wxlistctrlsetbackgroundcolour
}
439 \func{void
}{SetBackgroundColour
}{\param{const wxColour\&
}{col
}}
441 Sets the background colour (GetBackgroundColour already implicit in
444 \membersection{wxListCtrl::SetColumn
}\label{wxlistctrlsetcolumn
}
446 \func{bool
}{SetColumn
}{\param{int
}{col
},
\param{wxListItem\&
}{item
}}
448 Sets information about this column. See
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
} for more
451 \membersection{wxListCtrl::SetColumnWidth
}\label{wxlistctrlsetcolumnwidth
}
453 \func{bool
}{SetColumnWidth
}{\param{int
}{col
},
\param{int
}{width
}}
455 Sets the column width.
457 {\it width
} can be a width in pixels or wxLIST
\_AUTOSIZE (-
1) or wxLIST
\_AUTOSIZE\_USEHEADER (-
2).
458 wxLIST
\_AUTOSIZE will resize the column to the length of its longest item. wxLIST
\_AUTOSIZE\_USEHEADER
459 will resize the column to the length of the header (Win32) or
80 pixels (other platforms).
461 In small or normal icon view,
{\it col
} must be -
1, and the column width is set for all columns.
463 \membersection{wxListCtrl::SetImageList
}\label{wxlistctrlsetimagelist
}
465 \func{void
}{SetImageList
}{\param{wxImageList*
}{ imageList
},
\param{int
}{which
}}
467 Sets the image list associated with the control.
{\it which
} is one of
468 wxIMAGE
\_LIST\_NORMAL, wxIMAGE
\_LIST\_SMALL, wxIMAGE
\_LIST\_STATE (the last is unimplemented).
470 \membersection{wxListCtrl::SetItem
}\label{wxlistctrlsetitem
}
472 \func{bool
}{SetItem
}{\param{wxListItem\&
}{info
}}
474 Sets information about the item.
476 wxListItem is a class with the following members:
479 \begin{twocollist
}\itemsep=
0pt
480 \twocolitem{long m
\_mask}{Indicates which fields are valid. See the list of valid mask flags below.
}
481 \twocolitem{long m
\_itemId}{The zero-based item position.
}
482 \twocolitem{int m
\_col}{Zero-based column, if in
report mode.
}
483 \twocolitem{long m
\_state}{The state of the item. See the list of valid state flags below.
}
484 \twocolitem{long m
\_stateMask}{A mask indicating which state flags are valid. See the list of valid state flags below.
}
485 \twocolitem{wxString m
\_text}{The label/header text.
}
486 \twocolitem{int m
\_image}{The zero-based index into an image list.
}
487 \twocolitem{long m
\_data}{Application-defined data.
}
488 \twocolitem{int m
\_format}{For columns only: the format. Can be wxLIST
\_FORMAT\_LEFT, wxLIST
\_FORMAT\_RIGHT or
489 wxLIST
\_FORMAT\_CENTRE.
}
490 \twocolitem{int m
\_width}{For columns only: the column width.
}
493 The
{\bf m
\_mask} member contains a bitlist specifying which of the other fields are valid. The flags are:
496 \begin{twocollist
}\itemsep=
0pt
497 \twocolitem{wxLIST
\_MASK\_STATE}{The
{\bf m
\_state} field is valid.
}
498 \twocolitem{wxLIST
\_MASK\_TEXT}{The
{\bf m
\_text} field is valid.
}
499 \twocolitem{wxLIST
\_MASK\_IMAGE}{The
{\bf m
\_image} field is valid.
}
500 \twocolitem{wxLIST
\_MASK\_DATA}{The
{\bf m
\_data} field is valid.
}
501 \twocolitem{wxLIST
\_MASK\_WIDTH}{The
{\bf m
\_width} field is valid.
}
502 \twocolitem{wxLIST
\_MASK\_FORMAT}{The
{\bf m
\_format} field is valid.
}
505 The
{\bf m
\_stateMask} and
{\bf m
\_state} members take flags from the following:
508 \begin{twocollist
}\itemsep=
0pt
509 \twocolitem{wxLIST
\_STATE\_DONTCARE}{Don't care what the state is. Win32 only.
}
510 \twocolitem{wxLIST
\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event. Win32 only.
}
511 \twocolitem{wxLIST
\_STATE\_FOCUSED}{The item has the focus.
}
512 \twocolitem{wxLIST
\_STATE\_SELECTED}{The item is selected.
}
513 \twocolitem{wxLIST
\_STATE\_CUT}{The item is in the cut state. Win32 only.
}
516 \func{long
}{SetItem
}{\param{long
}{index
},
\param{int
}{col
},
\param{const wxString\&
}{label
},
\param{int
}{imageId = -
1}}
518 Sets a string field at a particular column.
520 \pythonnote{In place of a single overloaded method name, wxPython
521 implements the following methods:
\par
522 \indented{2cm
}{\begin{twocollist
}
523 \twocolitem{\bf{SetItem(item)
}}{Sets information about the given wxListItem.
}
524 \twocolitem{\bf{SetStringItem(index, col, label, imageId)
}}{Sets a
525 string or image at a given location.
}
530 \membersection{wxListCtrl::SetItemData
}\label{wxlistctrlsetitemdata
}
532 \func{bool
}{SetItemData
}{\param{long
}{item
},
\param{long
}{data
}}
534 Associates application-defined data with this item.
536 \membersection{wxListCtrl::SetItemImage
}\label{wxlistctrlsetitemimage
}
538 \func{bool
}{SetItemImage
}{\param{long
}{item
},
\param{int
}{image
},
\param{int
}{selImage
}}
540 Sets the unselected and selected images associated with the item. The images are indices into the
541 image list associated with the list control.
543 \membersection{wxListCtrl::SetItemPosition
}\label{wxlistctrlsetitemposition
}
545 \func{bool
}{SetItemPosition
}{\param{long
}{item
},
\param{const wxPoint\&
}{pos
}}
547 Sets the position of the item, in icon or small icon view.
549 \membersection{wxListCtrl::SetItemState
}\label{wxlistctrlsetitemstate
}
551 \func{bool
}{SetItemState
}{\param{long
}{item
},
\param{long
}{state
},
\param{long
}{stateMask
}}
553 Sets the item state. For a list of state flags, see
\helpref{wxListCtrl::SetItem
}{wxlistctrlsetitem
}.
555 The
{\bf stateMask
} indicates which state flags are valid.
557 \membersection{wxListCtrl::SetItemText
}\label{wxlistctrlsetitemtext
}
559 \func{void
}{SetItemText
}{\param{long
}{item
},
\param{const wxString\&
}{text
}}
561 Sets the item text for this item.
563 \membersection{wxListCtrl::SetSingleStyle
}\label{wxlistctrlsetsinglestyle
}
565 \func{void
}{SetSingleStyle
}{\param{long
}{style
},
\param{const bool
}{add = TRUE
}}
567 Adds or removes a single window style.
569 \membersection{wxListCtrl::SetTextColour
}\label{wxlistctrlsettextcolour
}
571 \func{void
}{SetTextColour
}{\param{const wxColour\&
}{col
}}
573 Sets the text colour of the list control.
575 \membersection{wxListCtrl::SetWindowStyleFlag
}\label{wxlistctrlsetwindowstyleflag
}
577 \func{void
}{SetWindowStyleFlag
}{\param{long
}{style
}}
579 Sets the whole window style.
581 \membersection{wxListCtrl::SortItems
}\label{wxlistctrlsortitems
}
583 \func{bool
}{SortItems
}{\param{wxListCtrlCompare
}{fn
},
\param{long
}{data
}}
585 Sorts the items in the list control.
587 fn is a function which takes
3 long arguments: item1, item2, data.
589 item1 is the long data associated with a first item (NOT the index).
591 item2 is the long data associated with a second item (NOT the index).
593 data is the same value as passed to SortItems.
595 The return value is a negative number if the first item should precede the second
596 item, a positive number of the second item should precede the first,
597 or zero if the two items are equivalent.
599 data is arbitrary data to be passed to the sort function.