]>
Commit | Line | Data |
---|---|---|
a660d684 KB |
1 | \section{\class{wxListCtrl}}\label{wxlistctrl} |
2 | ||
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. | |
5 | ||
6 | To 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 | ||
954b8ae6 JS |
15 | \wxheading{Include files} |
16 | ||
17 | <wx/listctrl.h> | |
18 | ||
a660d684 KB |
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. | |
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.} | |
0180dad6 RR |
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. } | |
a660d684 | 33 | \twocolitem{\windowstyle{wxLC\_EDIT\_LABELS}}{Labels are editable: the application will be notified when editing starts.} |
0180dad6 | 34 | \twocolitem{\windowstyle{wxLC\_NO\_HEADER}}{No header in report mode. Win32 only. } |
a660d684 KB |
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 | ||
40 | See also \helpref{window styles overview}{windowstyles}. | |
41 | ||
5de76427 JS |
42 | \wxheading{Event handling} |
43 | ||
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. | |
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.} | |
fd128b0c RR |
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}.} | |
5de76427 JS |
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.} | |
8b17ba72 | 59 | \twocolitem{{\bf EVT\_LIST\_ITEM\_ACTIVATED(id, func)}}{The item has been activated (ENTER or double click).} |
5de76427 JS |
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 | ||
a660d684 KB |
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 | ||
76 | Default constructor. | |
77 | ||
eaaa6a06 | 78 | \func{}{wxListCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp |
a660d684 | 79 | \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp |
eaaa6a06 | 80 | \param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}} |
a660d684 KB |
81 | |
82 | Constructor, 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 | |
93 | appropriately.} | |
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 | ||
109 | Destructor, destroying the list control. | |
110 | ||
111 | \membersection{wxListCtrl::Arrange}\label{wxlistctrlarrange} | |
112 | ||
eaaa6a06 | 113 | \func{bool}{Arrange}{\param{int }{flag = wxLIST\_ALIGN\_DEFAULT}} |
a660d684 | 114 | |
0180dad6 | 115 | Arranges the items in icon or small icon view. This only has effect on Win32. {\it flag} is one of: |
a660d684 KB |
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 | ||
eaaa6a06 | 127 | \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp |
a660d684 | 128 | \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp |
eaaa6a06 | 129 | \param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}} |
a660d684 KB |
130 | |
131 | Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details. | |
132 | ||
8b17ba72 RR |
133 | \membersection{wxListCtrl::ClearAll}\label{wxlistctrlclearall} |
134 | ||
135 | \func{void}{ClearAll}{} | |
136 | ||
137 | Deletes all items and all columns. | |
138 | ||
a660d684 KB |
139 | \membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem} |
140 | ||
eaaa6a06 | 141 | \func{bool}{DeleteItem}{\param{long }{item}} |
a660d684 | 142 | |
bffa1c77 VZ |
143 | Deletes the specified item. This function sends the |
144 | {\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event for the item being deleted. | |
145 | ||
146 | See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems} | |
a660d684 KB |
147 | |
148 | \membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems} | |
149 | ||
8b17ba72 | 150 | \func{bool}{DeleteAllItems}{} |
a660d684 KB |
151 | |
152 | Deletes all the items in the list control. | |
153 | ||
bffa1c77 VZ |
154 | {\bf NB:} This function does {\it not} send the |
155 | {\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items | |
156 | from the control would be too slow then (unlike | |
157 | \helpref{DeleteItem}{wxlistctrldeleteitem}) | |
158 | ||
a660d684 KB |
159 | \membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn} |
160 | ||
eaaa6a06 | 161 | \func{bool}{DeleteColumn}{\param{int }{col}} |
a660d684 KB |
162 | |
163 | Deletes a column. | |
164 | ||
86f975a8 | 165 | \membersection{wxListCtrl::EditLabel}\label{wxlistctrledit} |
a660d684 | 166 | |
fd128b0c | 167 | \func{void}{EditLabel}{\param{long }{item}} |
a660d684 | 168 | |
fd128b0c RR |
169 | Starts editing the label of the given item. This function generates a |
170 | EVT\_LIST\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no | |
171 | text control will appear for in-place editing. | |
86f975a8 | 172 | |
fd128b0c | 173 | If the user changed the label (i.e. s/he does not press ESC or leave |
76e1c2de | 174 | the text control without changes, a EVT\_LIST\_END\_LABEL\_EDIT event |
fd128b0c | 175 | will be sent which can be vetoed as well. |
a660d684 KB |
176 | |
177 | \membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible} | |
178 | ||
eaaa6a06 | 179 | \func{bool}{EnsureVisible}{\param{long }{item}} |
a660d684 KB |
180 | |
181 | Ensures this item is visible. | |
182 | ||
183 | \membersection{wxListCtrl::FindItem}\label{wxlistctrlfinditem} | |
184 | ||
eaaa6a06 | 185 | \func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = FALSE}} |
a660d684 KB |
186 | |
187 | Find an item whose label matches this string, starting from the item after {\it start} or | |
188 | the beginning if {\it start} is -1. | |
189 | ||
eaaa6a06 | 190 | \func{long}{FindItem}{\param{long }{start}, \param{long }{data}} |
a660d684 KB |
191 | |
192 | Find an item whose data matches this data, starting from the item after {\it start} or | |
193 | the beginning if 'start' is -1. | |
194 | ||
eaaa6a06 | 195 | \func{long}{FindItem}{\param{long }{start}, \param{const wxPoint\& }{pt}, \param{int }{direction}} |
a660d684 KB |
196 | |
197 | Find an item nearest this position in the specified direction, starting from | |
198 | the item after {\it start} or the beginning if {\it start} is -1. | |
199 | ||
21f280f4 RD |
200 | \pythonnote{In place of a single overloaded method name, wxPython |
201 | implements the following methods:\par | |
202 | \indented{2cm}{\begin{twocollist} | |
c9110876 VS |
203 | \twocolitem{{\bf FindItem(start, str, partial=FALSE)}}{} |
204 | \twocolitem{{\bf FindItemData(start, data)}}{} | |
205 | \twocolitem{{\bf FindItemAtPos(start, point, direction)}}{} | |
21f280f4 RD |
206 | \end{twocollist}} |
207 | } | |
208 | ||
a660d684 KB |
209 | \membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn} |
210 | ||
eaaa6a06 | 211 | \constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}} |
a660d684 KB |
212 | |
213 | Gets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more | |
214 | information. | |
215 | ||
216 | \membersection{wxListCtrl::GetColumnWidth}\label{wxlistctrlgetcolumnwidth} | |
217 | ||
eaaa6a06 | 218 | \constfunc{int}{GetColumnWidth}{\param{int }{col}} |
a660d684 KB |
219 | |
220 | Gets the column width (report view only). | |
221 | ||
222 | \membersection{wxListCtrl::GetCountPerPage}\label{wxlistctrlgetcountperpage} | |
223 | ||
224 | \constfunc{int}{GetCountPerPage}{\void} | |
225 | ||
226 | Gets the number of items that can fit vertically in the | |
227 | visible area of the list control (list or report view) | |
228 | or the total number of items in the list control (icon | |
229 | or small icon view). | |
230 | ||
231 | \membersection{wxListCtrl::GetEditControl}\label{wxlistctrlgeteditcontrol} | |
232 | ||
233 | \constfunc{wxTextCtrl\&}{GetEditControl}{\void} | |
234 | ||
235 | Gets the edit control for editing labels. | |
236 | ||
237 | \membersection{wxListCtrl::GetImageList}\label{wxlistctrlgetimagelist} | |
238 | ||
eaaa6a06 | 239 | \constfunc{wxImageList*}{GetImageList}{\param{int }{which}} |
a660d684 KB |
240 | |
241 | Returns 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 | ||
254 | Gets information about the item. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more | |
255 | information. | |
256 | ||
76e1c2de RD |
257 | \pythonnote{The wxPython version of this method takes an integer parameter |
258 | for the item ID, and returns the wxListItem object. | |
21f280f4 RD |
259 | } |
260 | ||
a660d684 KB |
261 | \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata} |
262 | ||
eaaa6a06 | 263 | \constfunc{long}{GetItemData}{\param{long }{item}} |
a660d684 KB |
264 | |
265 | Gets the application-defined data associated with this item. | |
266 | ||
267 | \membersection{wxListCtrl::GetItemPosition}\label{wxlistctrlgetitemposition} | |
268 | ||
eaaa6a06 | 269 | \constfunc{bool}{GetItemPosition}{\param{long }{item}, \param{wxPoint\& }{pos}} |
a660d684 KB |
270 | |
271 | Returns the position of the item, in icon or small icon view. | |
272 | ||
b456d571 | 273 | \pythonnote{The wxPython version of this method accepts only the item |
21f280f4 RD |
274 | ID and returns the wxPoint.} |
275 | ||
a660d684 KB |
276 | \membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect} |
277 | ||
eaaa6a06 | 278 | \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}} |
a660d684 KB |
279 | |
280 | Returns 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 | ||
b456d571 | 284 | \pythonnote{The wxPython version of this method accepts only the item |
21f280f4 RD |
285 | ID and returns the wxRect.} |
286 | ||
a660d684 KB |
287 | \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate} |
288 | ||
eaaa6a06 | 289 | \constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}} |
a660d684 KB |
290 | |
291 | Gets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. | |
292 | ||
293 | The {\bf stateMask} indicates which state flags are of interest. | |
294 | ||
295 | \membersection{wxListCtrl::GetItemCount}\label{wxlistctrlgetitemcount} | |
296 | ||
297 | \constfunc{int}{GetItemCount}{\void} | |
298 | ||
299 | Returns the number of items in the list control. | |
300 | ||
301 | \membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing} | |
302 | ||
303 | \constfunc{int}{GetItemSpacing}{\param{bool }{isSmall}} | |
304 | ||
305 | Retrieves the spacing between icons in pixels. | |
306 | If {\it small} is TRUE, gets the spacing for the small icon | |
307 | view, otherwise the large icon view. | |
308 | ||
309 | \membersection{wxListCtrl::GetItemText}\label{wxlistctrlgetitemtext} | |
310 | ||
eaaa6a06 | 311 | \constfunc{wxString}{GetItemText}{\param{long }{item}} |
a660d684 KB |
312 | |
313 | Gets the item text for this item. | |
314 | ||
315 | \membersection{wxListCtrl::GetNextItem}\label{wxlistctrlgetnextitem} | |
316 | ||
eaaa6a06 | 317 | \constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}} |
a660d684 | 318 | |
8e21d9ad VZ |
319 | Searches for an item with the given goemetry or state, starting from |
320 | {\it item} but excluding the {\it item} itself. If {\it item} is -1, | |
321 | the first item that matches the specified flags will be returned. | |
322 | ||
323 | Returns the first item with given state following {\it item} or -1 if | |
324 | no such item found. | |
325 | ||
326 | This function may be used to find all selected items in the control like this: | |
327 | \begin{verbatim} | |
328 | long item = -1; | |
329 | for ( ;; ) | |
330 | { | |
331 | item = listctrl->GetNextItem(item, | |
332 | wxLIST_NEXT_ALL, | |
333 | wxLIST_STATE_SELECTED); | |
334 | if ( item == -1 ) | |
335 | break; | |
336 | ||
337 | // this item is selected - do whatever is needed with it | |
338 | wxLogMessage("Item %ld is selected."), item); | |
339 | } | |
340 | \end{verbatim} | |
a660d684 KB |
341 | |
342 | {\it geometry} can be one of: | |
343 | ||
344 | \twocolwidtha{5cm} | |
345 | \begin{twocollist}\itemsep=0pt | |
346 | \twocolitem{wxLIST\_NEXT\_ABOVE}{Searches for an item above the specified item.} | |
347 | \twocolitem{wxLIST\_NEXT\_ALL}{Searches for subsequent item by index.} | |
348 | \twocolitem{wxLIST\_NEXT\_BELOW}{Searches for an item below the specified item.} | |
349 | \twocolitem{wxLIST\_NEXT\_LEFT}{Searches for an item to the left of the specified item.} | |
350 | \twocolitem{wxLIST\_NEXT\_RIGHT}{Searches for an item to the right of the specified item.} | |
351 | \end{twocollist} | |
352 | ||
8e21d9ad VZ |
353 | {\bf NB:} this parameters is only supported by wxMSW currently and ignored on |
354 | other platforms. | |
355 | ||
a660d684 KB |
356 | {\it state} can be a bitlist of the following: |
357 | ||
358 | \twocolwidtha{5cm} | |
359 | \begin{twocollist}\itemsep=0pt | |
360 | \twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is.} | |
361 | \twocolitem{wxLIST\_STATE\_DROPHILITED}{The item indicates it is a drop target.} | |
362 | \twocolitem{wxLIST\_STATE\_FOCUSED}{The item has the focus.} | |
363 | \twocolitem{wxLIST\_STATE\_SELECTED}{The item is selected.} | |
364 | \twocolitem{wxLIST\_STATE\_CUT}{The item is selected as part of a cut and paste operation.} | |
365 | \end{twocollist} | |
366 | ||
367 | \membersection{wxListCtrl::GetSelectedItemCount}\label{wxlistctrlgetselecteditemcount} | |
368 | ||
369 | \constfunc{int}{GetSelectedItemCount}{\void} | |
370 | ||
371 | Returns the number of selected items in the list control. | |
372 | ||
373 | \membersection{wxListCtrl::GetTextColour}\label{wxlistctrlgettextcolour} | |
374 | ||
375 | \constfunc{wxColour}{GetTextColour}{\void} | |
376 | ||
377 | Gets the text colour of the list control. | |
378 | ||
379 | \membersection{wxListCtrl::GetTopItem}\label{wxlistctrlgettopitem} | |
380 | ||
381 | \constfunc{long}{GetTopItem}{\void} | |
382 | ||
383 | Gets the index of the topmost visible item when in | |
384 | list or report view. | |
385 | ||
386 | \membersection{wxListCtrl::HitTest}\label{wxlistctrlhittest} | |
387 | ||
388 | \func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}} | |
389 | ||
390 | Determines which item (if any) is at the specified point, | |
391 | giving details in {\it flags}. {\it flags} will be a combination of the following flags: | |
392 | ||
393 | \twocolwidtha{5cm} | |
394 | \begin{twocollist}\itemsep=0pt | |
395 | \twocolitem{wxLIST\_HITTEST\_ABOVE}{Above the client area.} | |
396 | \twocolitem{wxLIST\_HITTEST\_BELOW}{Below the client area.} | |
397 | \twocolitem{wxLIST\_HITTEST\_NOWHERE}{In the client area but below the last item.} | |
398 | \twocolitem{wxLIST\_HITTEST\_ONITEMICON}{On the bitmap associated with an item.} | |
399 | \twocolitem{wxLIST\_HITTEST\_ONITEMLABEL}{On the label (string) associated with an item.} | |
400 | \twocolitem{wxLIST\_HITTEST\_ONITEMRIGHT}{In the area to the right of an item.} | |
401 | \twocolitem{wxLIST\_HITTEST\_ONITEMSTATEICON}{On the state icon for a tree view item that is in a user-defined state.} | |
402 | \twocolitem{wxLIST\_HITTEST\_TOLEFT}{To the right of the client area.} | |
403 | \twocolitem{wxLIST\_HITTEST\_TORIGHT}{To the left of the client area.} | |
404 | \twocolitem{wxLIST\_HITTEST\_ONITEM}{Combination of wxLIST\_HITTEST\_ONITEMICON, wxLIST\_HITTEST\_ONITEMLABEL, | |
405 | wxLIST\_HITTEST\_ONITEMSTATEICON.} | |
406 | \end{twocollist} | |
407 | ||
86e78222 RD |
408 | \pythonnote{A tuple of values is returned in the wxPython version of |
409 | thsi method. The first value is the item id and the second is the | |
410 | flags value mentioned above.} | |
411 | ||
a660d684 KB |
412 | \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn} |
413 | ||
eaaa6a06 | 414 | \func{long}{InsertColumn}{\param{long }{col}, \param{wxListItem\& }{info}} |
a660d684 KB |
415 | |
416 | For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. | |
417 | ||
eaaa6a06 JS |
418 | \func{long}{InsertColumn}{\param{long }{col}, \param{const wxString\& }{heading}, \param{int }{format = wxLIST\_FORMAT\_LEFT},\rtfsp |
419 | \param{int }{width = -1}} | |
a660d684 KB |
420 | |
421 | For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. | |
422 | ||
21f280f4 RD |
423 | \pythonnote{In place of a single overloaded method name, wxPython |
424 | implements the following methods:\par | |
425 | \indented{2cm}{\begin{twocollist} | |
c9110876 | 426 | \twocolitem{{\bf InsertColumn(col, heading, format=wxLIST\_FORMAT\_LEFT, |
21f280f4 | 427 | width=-1)}}{Creates a column using a header string only.} |
c9110876 | 428 | \twocolitem{{\bf InsertColumnInfo(col, item)}}{Creates a column using a |
21f280f4 RD |
429 | wxListInfo.} |
430 | \end{twocollist}} | |
431 | } | |
432 | ||
a660d684 KB |
433 | \membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem} |
434 | ||
435 | \func{long}{InsertItem}{\param{wxListItem\& }{info}} | |
436 | ||
437 | Inserts an item, returning the index of the new item if successful, | |
438 | -1 otherwise. | |
439 | ||
eaaa6a06 | 440 | \func{long}{InsertItem}{\param{long }{index}, \param{const wxString\& }{label}} |
a660d684 KB |
441 | |
442 | Inserts a string item. | |
443 | ||
eaaa6a06 | 444 | \func{long}{InsertItem}{\param{long }{index}, \param{int }{imageIndex}} |
a660d684 KB |
445 | |
446 | Inserts an image item. | |
447 | ||
eaaa6a06 | 448 | \func{long}{InsertItem}{\param{long }{index}, \param{const wxString\& }{label}, \param{int }{imageIndex}} |
a660d684 KB |
449 | |
450 | Insert an image/string item. | |
451 | ||
884360bc JS |
452 | \wxheading{Parameters} |
453 | ||
454 | \docparam{info}{wxListItem object} | |
455 | ||
456 | \docparam{index}{Index of the new item, supplied by the application} | |
457 | ||
458 | \docparam{label}{String label} | |
459 | ||
460 | \docparam{imageIndex}{index into the image list associated with this control and view style} | |
461 | ||
21f280f4 RD |
462 | \pythonnote{In place of a single overloaded method name, wxPython |
463 | implements the following methods:\par | |
464 | \indented{2cm}{\begin{twocollist} | |
c9110876 VS |
465 | \twocolitem{{\bf InsertItem(item)}}{Inserts an item using a wxListItem.} |
466 | \twocolitem{{\bf InsertStringItem(index, label)}}{Inserts a string item.} | |
467 | \twocolitem{{\bf InsertImageItem(index, imageIndex)}}{Inserts an image item.} | |
468 | \twocolitem{{\bf InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.} | |
21f280f4 RD |
469 | \end{twocollist}} |
470 | } | |
471 | ||
a660d684 KB |
472 | \membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist} |
473 | ||
eaaa6a06 | 474 | \func{bool}{ScrollList}{\param{int }{dx}, \param{int }{dy}} |
a660d684 KB |
475 | |
476 | Scrolls the list control. If in icon, small icon or report view mode, | |
477 | dx specifies the number of pixels to scroll. If in list view mode, dx | |
478 | specifies the number of columns to scroll. | |
479 | ||
480 | If in icon, small icon or list view mode, dy specifies the number of pixels | |
481 | to scroll. If in report view mode, dy specifies the number of lines to scroll. | |
482 | ||
483 | \membersection{wxListCtrl::SetBackgroundColour}\label{wxlistctrlsetbackgroundcolour} | |
484 | ||
485 | \func{void}{SetBackgroundColour}{\param{const wxColour\& }{col}} | |
486 | ||
487 | Sets the background colour (GetBackgroundColour already implicit in | |
488 | wxWindow class). | |
489 | ||
490 | \membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn} | |
491 | ||
eaaa6a06 | 492 | \func{bool}{SetColumn}{\param{int }{col}, \param{wxListItem\& }{item}} |
a660d684 KB |
493 | |
494 | Sets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more | |
495 | information. | |
496 | ||
497 | \membersection{wxListCtrl::SetColumnWidth}\label{wxlistctrlsetcolumnwidth} | |
498 | ||
eaaa6a06 | 499 | \func{bool}{SetColumnWidth}{\param{int }{col}, \param{int }{width}} |
a660d684 | 500 | |
884360bc | 501 | Sets the column width. |
a660d684 KB |
502 | |
503 | {\it width} can be a width in pixels or wxLIST\_AUTOSIZE (-1) or wxLIST\_AUTOSIZE\_USEHEADER (-2). | |
0180dad6 RR |
504 | wxLIST\_AUTOSIZE will resize the column to the length of its longest item. wxLIST\_AUTOSIZE\_USEHEADER |
505 | will resize the column to the length of the header (Win32) or 80 pixels (other platforms). | |
884360bc JS |
506 | |
507 | In small or normal icon view, {\it col} must be -1, and the column width is set for all columns. | |
a660d684 KB |
508 | |
509 | \membersection{wxListCtrl::SetImageList}\label{wxlistctrlsetimagelist} | |
510 | ||
eaaa6a06 | 511 | \func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}} |
a660d684 KB |
512 | |
513 | Sets the image list associated with the control. {\it which} is one of | |
514 | wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is unimplemented). | |
515 | ||
516 | \membersection{wxListCtrl::SetItem}\label{wxlistctrlsetitem} | |
517 | ||
518 | \func{bool}{SetItem}{\param{wxListItem\& }{info}} | |
519 | ||
520 | Sets information about the item. | |
521 | ||
522 | wxListItem is a class with the following members: | |
523 | ||
524 | \twocolwidtha{5cm} | |
525 | \begin{twocollist}\itemsep=0pt | |
526 | \twocolitem{long m\_mask}{Indicates which fields are valid. See the list of valid mask flags below.} | |
527 | \twocolitem{long m\_itemId}{The zero-based item position.} | |
528 | \twocolitem{int m\_col}{Zero-based column, if in report mode.} | |
529 | \twocolitem{long m\_state}{The state of the item. See the list of valid state flags below.} | |
530 | \twocolitem{long m\_stateMask}{A mask indicating which state flags are valid. See the list of valid state flags below.} | |
531 | \twocolitem{wxString m\_text}{The label/header text.} | |
532 | \twocolitem{int m\_image}{The zero-based index into an image list.} | |
533 | \twocolitem{long m\_data}{Application-defined data.} | |
534 | \twocolitem{int m\_format}{For columns only: the format. Can be wxLIST\_FORMAT\_LEFT, wxLIST\_FORMAT\_RIGHT or | |
535 | wxLIST\_FORMAT\_CENTRE.} | |
536 | \twocolitem{int m\_width}{For columns only: the column width.} | |
537 | \end{twocollist} | |
538 | ||
539 | The {\bf m\_mask} member contains a bitlist specifying which of the other fields are valid. The flags are: | |
540 | ||
541 | \twocolwidtha{5cm} | |
542 | \begin{twocollist}\itemsep=0pt | |
543 | \twocolitem{wxLIST\_MASK\_STATE}{The {\bf m\_state} field is valid.} | |
544 | \twocolitem{wxLIST\_MASK\_TEXT}{The {\bf m\_text} field is valid.} | |
545 | \twocolitem{wxLIST\_MASK\_IMAGE}{The {\bf m\_image} field is valid.} | |
546 | \twocolitem{wxLIST\_MASK\_DATA}{The {\bf m\_data} field is valid.} | |
547 | \twocolitem{wxLIST\_MASK\_WIDTH}{The {\bf m\_width} field is valid.} | |
548 | \twocolitem{wxLIST\_MASK\_FORMAT}{The {\bf m\_format} field is valid.} | |
549 | \end{twocollist} | |
550 | ||
551 | The {\bf m\_stateMask} and {\bf m\_state} members take flags from the following: | |
552 | ||
0530737d VZ |
553 | The wxListItem object can also contain item-specific colour and font |
554 | information: for this you need to call one of SetTextColour(), | |
555 | SetBackgroundColour() or SetFont() functions on it passing it the colour/font | |
556 | to use. If the colour/font is not specified, the default list control | |
557 | colour/font is used. | |
558 | ||
a660d684 KB |
559 | \twocolwidtha{5cm} |
560 | \begin{twocollist}\itemsep=0pt | |
0180dad6 RR |
561 | \twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is. Win32 only. } |
562 | \twocolitem{wxLIST\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event. Win32 only. } | |
a660d684 KB |
563 | \twocolitem{wxLIST\_STATE\_FOCUSED}{The item has the focus.} |
564 | \twocolitem{wxLIST\_STATE\_SELECTED}{The item is selected.} | |
0180dad6 | 565 | \twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state. Win32 only. } |
a660d684 KB |
566 | \end{twocollist} |
567 | ||
eaaa6a06 | 568 | \func{long}{SetItem}{\param{long }{index}, \param{int }{col}, \param{const wxString\& }{label}, \param{int }{imageId = -1}} |
a660d684 KB |
569 | |
570 | Sets a string field at a particular column. | |
571 | ||
21f280f4 RD |
572 | \pythonnote{In place of a single overloaded method name, wxPython |
573 | implements the following methods:\par | |
574 | \indented{2cm}{\begin{twocollist} | |
c9110876 VS |
575 | \twocolitem{{\bf SetItem(item)}}{Sets information about the given wxListItem.} |
576 | \twocolitem{{\bf SetStringItem(index, col, label, imageId)}}{Sets a | |
21f280f4 RD |
577 | string or image at a given location.} |
578 | \end{twocollist}} | |
579 | } | |
580 | ||
581 | ||
a660d684 KB |
582 | \membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata} |
583 | ||
eaaa6a06 | 584 | \func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}} |
a660d684 KB |
585 | |
586 | Associates application-defined data with this item. | |
587 | ||
588 | \membersection{wxListCtrl::SetItemImage}\label{wxlistctrlsetitemimage} | |
589 | ||
eaaa6a06 | 590 | \func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}, \param{int }{selImage}} |
a660d684 KB |
591 | |
592 | Sets the unselected and selected images associated with the item. The images are indices into the | |
593 | image list associated with the list control. | |
594 | ||
595 | \membersection{wxListCtrl::SetItemPosition}\label{wxlistctrlsetitemposition} | |
596 | ||
eaaa6a06 | 597 | \func{bool}{SetItemPosition}{\param{long }{item}, \param{const wxPoint\& }{pos}} |
a660d684 KB |
598 | |
599 | Sets the position of the item, in icon or small icon view. | |
600 | ||
601 | \membersection{wxListCtrl::SetItemState}\label{wxlistctrlsetitemstate} | |
602 | ||
eaaa6a06 | 603 | \func{bool}{SetItemState}{\param{long }{item}, \param{long }{state}, \param{long }{stateMask}} |
a660d684 KB |
604 | |
605 | Sets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. | |
606 | ||
607 | The {\bf stateMask} indicates which state flags are valid. | |
608 | ||
609 | \membersection{wxListCtrl::SetItemText}\label{wxlistctrlsetitemtext} | |
610 | ||
eaaa6a06 | 611 | \func{void}{SetItemText}{\param{long }{item}, \param{const wxString\& }{text}} |
a660d684 KB |
612 | |
613 | Sets the item text for this item. | |
614 | ||
615 | \membersection{wxListCtrl::SetSingleStyle}\label{wxlistctrlsetsinglestyle} | |
616 | ||
eaaa6a06 | 617 | \func{void}{SetSingleStyle}{\param{long }{style}, \param{const bool }{add = TRUE}} |
a660d684 KB |
618 | |
619 | Adds or removes a single window style. | |
620 | ||
621 | \membersection{wxListCtrl::SetTextColour}\label{wxlistctrlsettextcolour} | |
622 | ||
623 | \func{void}{SetTextColour}{\param{const wxColour\& }{col}} | |
624 | ||
625 | Sets the text colour of the list control. | |
626 | ||
627 | \membersection{wxListCtrl::SetWindowStyleFlag}\label{wxlistctrlsetwindowstyleflag} | |
628 | ||
eaaa6a06 | 629 | \func{void}{SetWindowStyleFlag}{\param{long }{style}} |
a660d684 KB |
630 | |
631 | Sets the whole window style. | |
632 | ||
633 | \membersection{wxListCtrl::SortItems}\label{wxlistctrlsortitems} | |
634 | ||
635 | \func{bool}{SortItems}{\param{wxListCtrlCompare }{fn}, \param{long }{data}} | |
636 | ||
637 | Sorts the items in the list control. | |
638 | ||
639 | fn is a function which takes 3 long arguments: item1, item2, data. | |
640 | ||
641 | item1 is the long data associated with a first item (NOT the index). | |
642 | ||
643 | item2 is the long data associated with a second item (NOT the index). | |
644 | ||
645 | data is the same value as passed to SortItems. | |
646 | ||
647 | The return value is a negative number if the first item should precede the second | |
648 | item, a positive number of the second item should precede the first, | |
649 | or zero if the two items are equivalent. | |
650 | ||
651 | data is arbitrary data to be passed to the sort function. | |
652 |