]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/_listctrl.i
Added some info panels that show size and colour attributes about the widget
[wxWidgets.git] / wxPython / src / _listctrl.i
CommitLineData
d14a1e28
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: _listctrl.i
3// Purpose: SWIG interface file for wxListCtrl and related classes
4//
5// Author: Robin Dunn
6//
7// Created: 10-June-1998
8// RCS-ID: $Id$
9// Copyright: (c) 2002 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
13// Not a %module
14
15
16//---------------------------------------------------------------------------
17
18%{
19#include <wx/listctrl.h>
20
d14a1e28 21%}
b2dc1044 22MAKE_CONST_WXSTRING2(ListCtrlNameStr, _T("wxListCtrl"));
d14a1e28
RD
23
24//---------------------------------------------------------------------------
25%newgroup
26
27enum {
28 // style flags
29 wxLC_VRULES,
30 wxLC_HRULES,
31
32 wxLC_ICON,
33 wxLC_SMALL_ICON,
34 wxLC_LIST,
35 wxLC_REPORT,
36
37 wxLC_ALIGN_TOP,
38 wxLC_ALIGN_LEFT,
39 wxLC_AUTOARRANGE,
40 wxLC_VIRTUAL,
41 wxLC_EDIT_LABELS,
42 wxLC_NO_HEADER,
43 wxLC_NO_SORT_HEADER,
44 wxLC_SINGLE_SEL,
45 wxLC_SORT_ASCENDING,
46 wxLC_SORT_DESCENDING,
47
48 wxLC_MASK_TYPE,
49 wxLC_MASK_ALIGN,
50 wxLC_MASK_SORT
51};
52
53
54enum {
55 // Mask flags to tell app/GUI what fields of wxListItem are valid
56 wxLIST_MASK_STATE,
57 wxLIST_MASK_TEXT,
58 wxLIST_MASK_IMAGE,
59 wxLIST_MASK_DATA,
60 wxLIST_SET_ITEM,
61 wxLIST_MASK_WIDTH,
62 wxLIST_MASK_FORMAT,
63
64// State flags for indicating the state of an item
65 wxLIST_STATE_DONTCARE,
66 wxLIST_STATE_DROPHILITED,
67 wxLIST_STATE_FOCUSED,
68 wxLIST_STATE_SELECTED,
69 wxLIST_STATE_CUT,
70 wxLIST_STATE_DISABLED,
71 wxLIST_STATE_FILTERED,
72 wxLIST_STATE_INUSE,
73 wxLIST_STATE_PICKED,
74 wxLIST_STATE_SOURCE,
75
76// Hit test flags, used in HitTest
77 wxLIST_HITTEST_ABOVE,
78 wxLIST_HITTEST_BELOW,
79 wxLIST_HITTEST_NOWHERE,
80 wxLIST_HITTEST_ONITEMICON,
81 wxLIST_HITTEST_ONITEMLABEL,
82 wxLIST_HITTEST_ONITEMRIGHT,
83 wxLIST_HITTEST_ONITEMSTATEICON,
84 wxLIST_HITTEST_TOLEFT,
85 wxLIST_HITTEST_TORIGHT,
86 wxLIST_HITTEST_ONITEM,
87};
88
89
90// Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
91enum
92{
93 wxLIST_NEXT_ABOVE, // Searches for an item above the specified item
94 wxLIST_NEXT_ALL, // Searches for subsequent item by index
95 wxLIST_NEXT_BELOW, // Searches for an item below the specified item
96 wxLIST_NEXT_LEFT, // Searches for an item to the left of the specified item
97 wxLIST_NEXT_RIGHT // Searches for an item to the right of the specified item
98};
99
100// Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT)
101enum
102{
103 wxLIST_ALIGN_DEFAULT,
104 wxLIST_ALIGN_LEFT,
105 wxLIST_ALIGN_TOP,
106 wxLIST_ALIGN_SNAP_TO_GRID
107};
108
109// Column format (MSW only except wxLIST_FORMAT_LEFT)
110enum wxListColumnFormat
111{
112 wxLIST_FORMAT_LEFT,
113 wxLIST_FORMAT_RIGHT,
114 wxLIST_FORMAT_CENTRE,
115 wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
116};
117
118// Autosize values for SetColumnWidth
119enum
120{
121 wxLIST_AUTOSIZE = -1,
122 wxLIST_AUTOSIZE_USEHEADER = -2 // partly supported by generic version
123};
124
125// Flag values for GetItemRect
126enum
127{
128 wxLIST_RECT_BOUNDS,
129 wxLIST_RECT_ICON,
130 wxLIST_RECT_LABEL
131};
132
133// Flag values for FindItem (MSW only)
134enum
135{
136 wxLIST_FIND_UP,
137 wxLIST_FIND_DOWN,
138 wxLIST_FIND_LEFT,
139 wxLIST_FIND_RIGHT
140};
141
142
143
144//---------------------------------------------------------------------------
145%newgroup
146
147// wxListItemAttr: a structure containing the visual attributes of an item
148class wxListItemAttr
149{
150public:
151 // ctors
152 //wxListItemAttr();
153 wxListItemAttr(const wxColour& colText = wxNullColour,
154 const wxColour& colBack = wxNullColour,
155 const wxFont& font = wxNullFont);
156
157
158 // setters
159 void SetTextColour(const wxColour& colText);
160 void SetBackgroundColour(const wxColour& colBack);
161 void SetFont(const wxFont& font);
162
163 // accessors
164 bool HasTextColour();
165 bool HasBackgroundColour();
166 bool HasFont();
167
168 wxColour GetTextColour();
169 wxColour GetBackgroundColour();
170 wxFont GetFont();
171
172 %extend { void Destroy() { delete self; } }
173};
174
175
176
177
178//---------------------------------------------------------------------------
179%newgroup
180
dd9f7fea 181
d14a1e28
RD
182// wxListItem: the item or column info, used to exchange data with wxListCtrl
183class wxListItem : public wxObject {
184public:
185 wxListItem();
186 ~wxListItem();
187
188 // resetting
189 void Clear();
190 void ClearAttributes();
191
192 // setters
193 void SetMask(long mask);
194 void SetId(long id);
195 void SetColumn(int col);
196 void SetState(long state);
197 void SetStateMask(long stateMask);
198 void SetText(const wxString& text);
199 void SetImage(int image);
200 void SetData(long data);
201
202 void SetWidth(int width);
203 void SetAlign(wxListColumnFormat align);
204
205 void SetTextColour(const wxColour& colText);
206 void SetBackgroundColour(const wxColour& colBack);
207 void SetFont(const wxFont& font);
208
209 // accessors
210 long GetMask();
211 long GetId();
212 int GetColumn();
213 long GetState();
214 const wxString& GetText();
215 int GetImage();
216 long GetData();
217
218 int GetWidth();
219 wxListColumnFormat GetAlign();
220
221 wxListItemAttr *GetAttributes();
222 bool HasAttributes();
223
224 wxColour GetTextColour() const;
225 wxColour GetBackgroundColour() const;
226 wxFont GetFont() const;
227
228 // these members are public for compatibility
229 long m_mask; // Indicates what fields are valid
230 long m_itemId; // The zero-based item position
231 int m_col; // Zero-based column, if in report mode
232 long m_state; // The state of the item
233 long m_stateMask;// Which flags of m_state are valid (uses same flags)
234 wxString m_text; // The label/header text
235 int m_image; // The zero-based index into an image list
236 long m_data; // App-defined data
237
238 // For columns only
239 int m_format; // left, right, centre
240 int m_width; // width of column
241
242};
243
244
245//---------------------------------------------------------------------------
246%newgroup
247
248
249// wxListEvent - the event class for the wxListCtrl notifications
250class wxListEvent: public wxNotifyEvent {
251public:
252 wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
253
254 int m_code;
255 long m_oldItemIndex;
256 long m_itemIndex;
257 int m_col;
258 wxPoint m_pointDrag;
259 %immutable;
260 wxListItem m_item;
261 %mutable;
262
263 int GetKeyCode();
264 %pythoncode { GetCode = GetKeyCode }
265 long GetIndex();
266 int GetColumn();
267 wxPoint GetPoint();
bdcf3ef5 268 %pythoncode { GetPosition = GetPoint }
d14a1e28
RD
269 const wxString& GetLabel();
270 const wxString& GetText();
271 int GetImage();
272 long GetData();
273 long GetMask();
274 const wxListItem& GetItem();
275
276 long GetCacheFrom();
277 long GetCacheTo();
278
279 // was label editing canceled? (for wxEVT_COMMAND_LIST_END_LABEL_EDIT only)
280 bool IsEditCancelled() const;
281 void SetEditCanceled(bool editCancelled);
282};
283
284/* List control event types */
285%constant wxEventType wxEVT_COMMAND_LIST_BEGIN_DRAG;
286%constant wxEventType wxEVT_COMMAND_LIST_BEGIN_RDRAG;
287%constant wxEventType wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
288%constant wxEventType wxEVT_COMMAND_LIST_END_LABEL_EDIT;
289%constant wxEventType wxEVT_COMMAND_LIST_DELETE_ITEM;
290%constant wxEventType wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
291%constant wxEventType wxEVT_COMMAND_LIST_GET_INFO;
292%constant wxEventType wxEVT_COMMAND_LIST_SET_INFO;
293%constant wxEventType wxEVT_COMMAND_LIST_ITEM_SELECTED;
294%constant wxEventType wxEVT_COMMAND_LIST_ITEM_DESELECTED;
295%constant wxEventType wxEVT_COMMAND_LIST_KEY_DOWN;
296%constant wxEventType wxEVT_COMMAND_LIST_INSERT_ITEM;
297%constant wxEventType wxEVT_COMMAND_LIST_COL_CLICK;
298%constant wxEventType wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
299%constant wxEventType wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK;
300%constant wxEventType wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
301%constant wxEventType wxEVT_COMMAND_LIST_CACHE_HINT;
302%constant wxEventType wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
303%constant wxEventType wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
304%constant wxEventType wxEVT_COMMAND_LIST_COL_DRAGGING;
305%constant wxEventType wxEVT_COMMAND_LIST_COL_END_DRAG;
306%constant wxEventType wxEVT_COMMAND_LIST_ITEM_FOCUSED;
307
308
309
310%pythoncode {
311
312EVT_LIST_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_DRAG , 1)
313EVT_LIST_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_RDRAG , 1)
314EVT_LIST_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT , 1)
315EVT_LIST_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_END_LABEL_EDIT , 1)
316EVT_LIST_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ITEM , 1)
317EVT_LIST_DELETE_ALL_ITEMS = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS , 1)
318EVT_LIST_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_LIST_GET_INFO , 1)
319EVT_LIST_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_LIST_SET_INFO , 1)
320EVT_LIST_ITEM_SELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_SELECTED , 1)
321EVT_LIST_ITEM_DESELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_DESELECTED , 1)
322EVT_LIST_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_LIST_KEY_DOWN , 1)
323EVT_LIST_INSERT_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_INSERT_ITEM , 1)
324EVT_LIST_COL_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_CLICK , 1)
325EVT_LIST_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK , 1)
326EVT_LIST_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 1)
327EVT_LIST_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_ACTIVATED , 1)
328EVT_LIST_CACHE_HINT = wx.PyEventBinder(wxEVT_COMMAND_LIST_CACHE_HINT , 1)
329EVT_LIST_COL_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK , 1)
330EVT_LIST_COL_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG , 1)
331EVT_LIST_COL_DRAGGING = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_DRAGGING , 1)
332EVT_LIST_COL_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_END_DRAG , 1)
333EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED , 1)
334}
335
336//---------------------------------------------------------------------------
337%newgroup
338
339
340%{ // Python aware sorting function for wxPyListCtrl
341 static int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
342 int retval = 0;
343 PyObject* func = (PyObject*)funcPtr;
da32eb53 344 bool blocked = wxPyBeginBlockThreads();
d14a1e28
RD
345
346 PyObject* args = Py_BuildValue("(ii)", item1, item2);
347 PyObject* result = PyEval_CallObject(func, args);
348 Py_DECREF(args);
349 if (result) {
350 retval = PyInt_AsLong(result);
351 Py_DECREF(result);
352 }
353
da32eb53 354 wxPyEndBlockThreads(blocked);
d14a1e28
RD
355 return retval;
356 }
357%}
358
359
360
361%{ // C++ Version of a Python aware class
362class wxPyListCtrl : public wxListCtrl {
363 DECLARE_ABSTRACT_CLASS(wxPyListCtrl);
364public:
365 wxPyListCtrl() : wxListCtrl() {}
366 wxPyListCtrl(wxWindow* parent, wxWindowID id,
367 const wxPoint& pos,
368 const wxSize& size,
369 long style,
370 const wxValidator& validator,
371 const wxString& name) :
372 wxListCtrl(parent, id, pos, size, style, validator, name) {}
373
374 bool Create(wxWindow* parent, wxWindowID id,
375 const wxPoint& pos,
376 const wxSize& size,
377 long style,
378 const wxValidator& validator,
379 const wxString& name) {
380 return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
381 }
382
383 DEC_PYCALLBACK_STRING_LONGLONG(OnGetItemText);
384 DEC_PYCALLBACK_INT_LONG(OnGetItemImage);
385 DEC_PYCALLBACK_LISTATTR_LONG(OnGetItemAttr);
386
387 PYPRIVATE;
388};
389
390IMPLEMENT_ABSTRACT_CLASS(wxPyListCtrl, wxListCtrl);
391
392IMP_PYCALLBACK_STRING_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemText);
393IMP_PYCALLBACK_INT_LONG(wxPyListCtrl, wxListCtrl, OnGetItemImage);
394IMP_PYCALLBACK_LISTATTR_LONG(wxPyListCtrl, wxListCtrl, OnGetItemAttr);
395%}
396
397
398
399
400
401%name(ListCtrl)class wxPyListCtrl : public wxControl {
402public:
403
2b9048c5
RD
404 %pythonAppend wxPyListCtrl "self._setOORInfo(self);self._setCallbackInfo(self, ListCtrl)"
405 %pythonAppend wxPyListCtrl() ""
d14a1e28
RD
406
407 wxPyListCtrl(wxWindow* parent, wxWindowID id = -1,
408 const wxPoint& pos = wxDefaultPosition,
409 const wxSize& size = wxDefaultSize,
410 long style = wxLC_ICON,
411 const wxValidator& validator = wxDefaultValidator,
412 const wxString& name = wxPyListCtrlNameStr);
413 %name(PreListCtrl)wxPyListCtrl();
414
415 bool Create(wxWindow* parent, wxWindowID id = -1,
416 const wxPoint& pos = wxDefaultPosition,
417 const wxSize& size = wxDefaultSize,
418 long style = wxLC_ICON,
419 const wxValidator& validator = wxDefaultValidator,
420 const wxString& name = wxPyListCtrlNameStr);
421
422 void _setCallbackInfo(PyObject* self, PyObject* _class);
423
424
425 // Set the control colours
426 bool SetForegroundColour(const wxColour& col);
427 bool SetBackgroundColour(const wxColour& col);
428
429 // Gets information about this column
2b9048c5 430 %pythonAppend GetColumn "if val is not None: val.thisown = 1"; // %newobject doesn't work with OOR typemap
d14a1e28
RD
431 %extend {
432 wxListItem* GetColumn(int col) {
433 wxListItem item;
434 item.SetMask( wxLIST_MASK_STATE |
435 wxLIST_MASK_TEXT |
436 wxLIST_MASK_IMAGE |
437 wxLIST_MASK_DATA |
438 wxLIST_SET_ITEM |
439 wxLIST_MASK_WIDTH |
440 wxLIST_MASK_FORMAT
441 );
442 if (self->GetColumn(col, item))
443 return new wxListItem(item);
444 else
445 return NULL;
446 }
447 }
448
449 // Sets information about this column
450 bool SetColumn(int col, wxListItem& item) ;
451
452 // Gets the column width
453 int GetColumnWidth(int col) const;
454
455 // Sets the column width
456 bool SetColumnWidth(int col, int width) ;
457
458 // Gets the number of items that can fit vertically in the
459 // visible area of the list control (list or report view)
460 // or the total number of items in the list control (icon
461 // or small icon view)
462 int GetCountPerPage() const;
463
464 // return the total area occupied by all the items (icon/small icon only)
465 wxRect GetViewRect() const;
466
467#ifdef __WXMSW__
468 // Gets the edit control for editing labels.
469 wxTextCtrl* GetEditControl() const;
470#endif
471
472 // Gets information about the item
2b9048c5 473 %pythonAppend GetItem "if val is not None: val.thisown = 1"; // %newobject doesn't work with OOR typemap
d14a1e28
RD
474 %extend {
475 wxListItem* GetItem(long itemId, int col=0) {
476 wxListItem* info = new wxListItem;
477 info->m_itemId = itemId;
478 info->m_col = col;
479 info->m_mask = 0xFFFF;
480 self->GetItem(*info);
481 return info;
482 }
483 }
484
485 // Sets information about the item
486 bool SetItem(wxListItem& info) ;
487
488 // Sets a string field at a particular column
489 %name(SetStringItem)long SetItem(long index, int col, const wxString& label, int imageId = -1);
490
491 // Gets the item state
492 int GetItemState(long item, long stateMask) const ;
493
494 // Sets the item state
495 bool SetItemState(long item, long state, long stateMask) ;
496
497 // Sets the item image
498 bool SetItemImage(long item, int image, int selImage) ;
499
500 // Gets the item text
501 wxString GetItemText(long item) const ;
502
503 // Sets the item text
504 void SetItemText(long item, const wxString& str) ;
505
506 // Gets the item data
507 long GetItemData(long item) const ;
508
509 // Sets the item data
510 bool SetItemData(long item, long data) ;
511
512
513 //bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
514 //bool GetItemPosition(long item, wxPoint& pos) const ;
515
516 // Gets the item position
517 %extend {
518 wxPoint GetItemPosition(long item) {
519 wxPoint pos;
520 self->GetItemPosition(item, pos);
521 return pos;
522 }
523 // Gets the item rectangle
524 wxRect GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
525 wxRect rect;
526 self->GetItemRect(item, rect, code);
527 return rect;
528 }
529 }
530
531
532 // Sets the item position
533 bool SetItemPosition(long item, const wxPoint& pos) ;
534
535 // Gets the number of items in the list control
536 int GetItemCount() const;
537
538 // Gets the number of columns in the list control
539 int GetColumnCount() const;
540
541 // get the horizontal and vertical components of the item spacing
542 wxSize GetItemSpacing() const;
543
544#ifndef __WXMSW__
dd9f7fea 545 void SetItemSpacing( int spacing, bool isSmall = False );
d14a1e28
RD
546#endif
547
548 // Gets the number of selected items in the list control
549 int GetSelectedItemCount() const;
550
551 // Gets the text colour of the listview
552 wxColour GetTextColour() const;
553
554 // Sets the text colour of the listview
555 void SetTextColour(const wxColour& col);
556
557 // Gets the index of the topmost visible item when in
558 // list or report view
559 long GetTopItem() const ;
560
561 // Add or remove a single window style
dd9f7fea 562 void SetSingleStyle(long style, bool add = True) ;
d14a1e28
RD
563
564 // Set the whole window style
565 void SetWindowStyleFlag(long style) ;
566
567 // Searches for an item, starting from 'item'.
568 // item can be -1 to find the first item that matches the
569 // specified flags.
570 // Returns the item or -1 if unsuccessful.
571 long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
572
573 // Gets one of the three image lists
574 wxImageList *GetImageList(int which) const ;
575
576 // Sets the image list
577 void SetImageList(wxImageList *imageList, int which);
578
579 // is there a way to tell SWIG to disown this???
580
8668c242 581 %apply SWIGTYPE *DISOWN { wxImageList *imageList };
d14a1e28 582 void AssignImageList(wxImageList *imageList, int which);
8668c242
RD
583 %clear wxImageList *imageList;
584
6e7db3c8
RD
585 // are we in report mode?
586 bool InReportView() const;
587
dd9f7fea 588 // returns True if it is a virtual list control
d14a1e28
RD
589 bool IsVirtual() const;
590
591 // refresh items selectively (only useful for virtual list controls)
592 void RefreshItem(long item);
593 void RefreshItems(long itemFrom, long itemTo);
594
595 // Arranges the items
596 bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
597
598 // Deletes an item
599 bool DeleteItem(long item);
600
601 // Deletes all items
602 bool DeleteAllItems() ;
603
604 // Deletes a column
605 bool DeleteColumn(int col);
606
607 // Deletes all columns
608 bool DeleteAllColumns();
609
610 // Clears items, and columns if there are any.
611 void ClearAll();
612
613#ifdef __WXMSW__
614 // Edit the label
615 wxTextCtrl* EditLabel(long item /*, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)*/);
616
617 // End label editing, optionally cancelling the edit
618 bool EndEditLabel(bool cancel);
619#else
620 void EditLabel(long item);
621#endif
622
623 // Ensures this item is visible
624 bool EnsureVisible(long item) ;
625
626 // Find an item whose label matches this string, starting from the item after 'start'
627 // or the beginning if 'start' is -1.
dd9f7fea 628 long FindItem(long start, const wxString& str, bool partial = False);
d14a1e28
RD
629
630 // Find an item whose data matches this data, starting from the item after 'start'
631 // or the beginning if 'start' is -1.
632 %name(FindItemData) long FindItem(long start, long data);
633
634 // Find an item nearest this position in the specified direction, starting from
635 // the item after 'start' or the beginning if 'start' is -1.
636 %name(FindItemAtPos) long FindItem(long start, const wxPoint& pt, int direction);
637
322913ce
RD
638
639 DocDeclAStr(
640 long, HitTest(const wxPoint& point, int& OUTPUT),
641 "HitTest(Point point) -> (item, where)",
642 "Determines which item (if any) is at the specified point,\n"
643 "giving details in the second return value (see wxLIST_HITTEST_... flags.)");
d14a1e28
RD
644
645 // Inserts an item, returning the index of the new item if successful,
646 // -1 otherwise.
647 long InsertItem(wxListItem& info);
648
649 // Insert a string item
650 %name(InsertStringItem) long InsertItem(long index, const wxString& label);
651
652 // Insert an image item
653 %name(InsertImageItem) long InsertItem(long index, int imageIndex);
654
655 // Insert an image/string item
656 %name(InsertImageStringItem) long InsertItem(long index, const wxString& label, int imageIndex);
657
658 // For list view mode (only), inserts a column.
659 %name(InsertColumnInfo) long InsertColumn(long col, wxListItem& info);
660
661 long InsertColumn(long col,
662 const wxString& heading,
663 int format = wxLIST_FORMAT_LEFT,
664 int width = -1);
665
666 // set the number of items in a virtual list control
667 void SetItemCount(long count);
668
669 // Scrolls the list control. If in icon, small icon or report view mode,
670 // x specifies the number of pixels to scroll. If in list view mode, x
671 // specifies the number of columns to scroll.
672 // If in icon, small icon or list view mode, y specifies the number of pixels
673 // to scroll. If in report view mode, y specifies the number of lines to scroll.
674 bool ScrollList(int dx, int dy);
675
676 void SetItemTextColour( long item, const wxColour& col);
677 wxColour GetItemTextColour( long item ) const;
678 void SetItemBackgroundColour( long item, const wxColour &col);
679 wxColour GetItemBackgroundColour( long item ) const;
680
681
682 %pythoncode {
683 %#
684 %# Some helpers...
685 def Select(self, idx, on=1):
686 '''[de]select an item'''
dd9f7fea 687 if on: state = wx.LIST_STATE_SELECTED
d14a1e28 688 else: state = 0
dd9f7fea 689 self.SetItemState(idx, state, wx.LIST_STATE_SELECTED)
d14a1e28
RD
690
691 def Focus(self, idx):
692 '''Focus and show the given item'''
dd9f7fea 693 self.SetItemState(idx, wx.LIST_STATE_FOCUSED, wx.LIST_STATE_FOCUSED)
d14a1e28
RD
694 self.EnsureVisible(idx)
695
696 def GetFocusedItem(self):
697 '''get the currently focused item or -1 if none'''
dd9f7fea 698 return self.GetNextItem(-1, wx.LIST_NEXT_ALL, wx.LIST_STATE_FOCUSED)
d14a1e28
RD
699
700 def GetFirstSelected(self, *args):
701 '''return first selected item, or -1 when none'''
702 return self.GetNextSelected(-1)
703
704 def GetNextSelected(self, item):
705 '''return subsequent selected items, or -1 when no more'''
dd9f7fea 706 return self.GetNextItem(item, wx.LIST_NEXT_ALL, wx.LIST_STATE_SELECTED)
d14a1e28
RD
707
708 def IsSelected(self, idx):
dd9f7fea
RD
709 '''return True if the item is selected'''
710 return self.GetItemState(idx, wx.LIST_STATE_SELECTED) != 0
d14a1e28
RD
711
712 def SetColumnImage(self, col, image):
713 item = self.GetColumn(col)
dd9f7fea
RD
714 %# preserve all other attributes too
715 item.SetMask( wx.LIST_MASK_STATE |
716 wx.LIST_MASK_TEXT |
717 wx.LIST_MASK_IMAGE |
718 wx.LIST_MASK_DATA |
719 wx.LIST_SET_ITEM |
720 wx.LIST_MASK_WIDTH |
721 wx.LIST_MASK_FORMAT )
d14a1e28
RD
722 item.SetImage(image)
723 self.SetColumn(col, item)
724
725 def ClearColumnImage(self, col):
726 self.SetColumnImage(col, -1)
727
728 def Append(self, entry):
729 '''Append an item to the list control. The entry parameter should be a
730 sequence with an item for each column'''
731 if len(entry):
dd9f7fea 732 if wx.USE_UNICODE:
d14a1e28
RD
733 cvtfunc = unicode
734 else:
735 cvtfunc = str
736 pos = self.GetItemCount()
737 self.InsertStringItem(pos, cvtfunc(entry[0]))
738 for i in range(1, len(entry)):
739 self.SetStringItem(pos, i, cvtfunc(entry[i]))
740 return pos
741 }
742
743
744 // bool SortItems(wxListCtrlCompare fn, long data);
745 %extend {
746 // Sort items.
747 // func is a function which takes 2 long arguments: item1, item2.
748 // item1 is the long data associated with a first item (NOT the index).
749 // item2 is the long data associated with a second item (NOT the index).
750 // The return value is a negative number if the first item should precede the second
751 // item, a positive number of the second item should precede the first,
752 // or zero if the two items are equivalent.
753 bool SortItems(PyObject* func) {
754 if (!PyCallable_Check(func))
dd9f7fea 755 return False;
d14a1e28
RD
756 return self->SortItems((wxListCtrlCompare)wxPyListCtrl_SortItems, (long)func);
757 }
758 }
759
760
761 %extend {
762 wxWindow* GetMainWindow() {
763 #ifdef __WXMSW__
764 return self;
765 #else
766 return (wxWindow*)self->m_mainWin;
767 #endif
768 }
769 }
174051f6
RD
770
771 static wxVisualAttributes
772 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
d14a1e28
RD
773};
774
775
776
777//---------------------------------------------------------------------------
778%newgroup
779
780
781// wxListView: a class which provides a little better API for list control
782class wxListView : public wxPyListCtrl
783{
784public:
2b9048c5
RD
785 %pythonAppend wxListView "self._setOORInfo(self)"
786 %pythonAppend wxListView() ""
d14a1e28
RD
787
788 wxListView( wxWindow *parent,
789 wxWindowID id = -1,
790 const wxPoint& pos = wxDefaultPosition,
791 const wxSize& size = wxDefaultSize,
792 long style = wxLC_REPORT,
793 const wxValidator& validator = wxDefaultValidator,
794 const wxString& name = wxPyListCtrlNameStr);
795 %name(PreListView)wxListView();
796
797 bool Create( wxWindow *parent,
798 wxWindowID id = -1,
799 const wxPoint& pos = wxDefaultPosition,
800 const wxSize& size = wxDefaultSize,
801 long style = wxLC_REPORT,
802 const wxValidator& validator = wxDefaultValidator,
803 const wxString& name = wxPyListCtrlNameStr);
804
805 // [de]select an item
dd9f7fea 806 void Select(long n, bool on = True);
d14a1e28
RD
807
808 // focus and show the given item
809 void Focus(long index);
810
811 // get the currently focused item or -1 if none
812 long GetFocusedItem() const;
813
814 // get first and subsequent selected items, return -1 when no more
815 long GetNextSelected(long item) const;
816 long GetFirstSelected() const;
817
dd9f7fea 818 // return True if the item is selected
d14a1e28
RD
819 bool IsSelected(long index);
820
821 void SetColumnImage(int col, int image);
822 void ClearColumnImage(int col);
823};
824
825
826
827//---------------------------------------------------------------------------
828
829%init %{
830 // Map renamed classes back to their common name for OOR
831 wxPyPtrTypeMap_Add("wxListCtrl", "wxPyListCtrl");
832%}
833
834//---------------------------------------------------------------------------