]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/controls2.i
corrected comments (should not be C++ style!)
[wxWidgets.git] / wxPython / src / controls2.i
CommitLineData
7bf85405
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: controls2.i
3// Purpose: More control (widget) classes for wxPython
4//
5// Author: Robin Dunn
6//
7// Created: 6/10/98
8// RCS-ID: $Id$
9// Copyright: (c) 1998 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
03e9bead 13%module controls2
7bf85405 14
03e9bead 15%{
7bf85405 16#include "helpers.h"
2f90df85
RD
17#ifdef __WXMSW__
18#include <windows.h>
19#endif
7bf85405
RD
20#include <wx/listctrl.h>
21#include <wx/treectrl.h>
9416aa89 22#include <wx/imaglist.h>
68320e40 23#include <wx/dirctrl.h>
7bf85405
RD
24%}
25
26//----------------------------------------------------------------------
27
28%include typemaps.i
29%include my_typemaps.i
30
31// Import some definitions of other classes, etc.
32%import _defs.i
33%import misc.i
34%import windows.i
35%import gdi.i
36%import events.i
37%import controls.i
38
b8b8dda7 39%pragma(python) code = "import wx"
9c039d08 40
c7e7022c
RD
41
42//----------------------------------------------------------------------
137b5242
RD
43%{
44 // Put some wx default wxChar* values into wxStrings.
45 const wxChar* wxListCtrlNameStr = _T("wxListCtrl");
46 DECLARE_DEF_STRING(ListCtrlNameStr);
47
9a74fcaf 48 const wxChar* wx_TreeCtrlNameStr = _T("wxTreeCtrl");
137b5242
RD
49 DECLARE_DEF_STRING(_TreeCtrlNameStr);
50 DECLARE_DEF_STRING(DirDialogDefaultFolderStr);
51
52 static const wxString wxPyEmptyString(wxT(""));
53%}
54
0815db26
RD
55
56%{
57 static const long longzero = 0;
58%}
59
7bf85405
RD
60//----------------------------------------------------------------------
61
c7e7022c
RD
62enum {
63 /* List control event types */
64 wxEVT_COMMAND_LIST_BEGIN_DRAG,
65 wxEVT_COMMAND_LIST_BEGIN_RDRAG,
66 wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT,
67 wxEVT_COMMAND_LIST_END_LABEL_EDIT,
68 wxEVT_COMMAND_LIST_DELETE_ITEM,
69 wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS,
70 wxEVT_COMMAND_LIST_GET_INFO,
71 wxEVT_COMMAND_LIST_SET_INFO,
72 wxEVT_COMMAND_LIST_ITEM_SELECTED,
73 wxEVT_COMMAND_LIST_ITEM_DESELECTED,
74 wxEVT_COMMAND_LIST_KEY_DOWN,
75 wxEVT_COMMAND_LIST_INSERT_ITEM,
76 wxEVT_COMMAND_LIST_COL_CLICK,
77 wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK,
78 wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK,
79 wxEVT_COMMAND_LIST_ITEM_ACTIVATED,
80 wxEVT_COMMAND_LIST_CACHE_HINT,
6d19860f
RD
81 wxEVT_COMMAND_LIST_COL_RIGHT_CLICK,
82 wxEVT_COMMAND_LIST_COL_BEGIN_DRAG,
83 wxEVT_COMMAND_LIST_COL_DRAGGING,
84 wxEVT_COMMAND_LIST_COL_END_DRAG,
d8200036 85 wxEVT_COMMAND_LIST_ITEM_FOCUSED,
c7e7022c
RD
86};
87
88
89%pragma(python) code = "
90def EVT_LIST_BEGIN_DRAG(win, id, func):
91 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_DRAG, func)
92
93def EVT_LIST_BEGIN_RDRAG(win, id, func):
94 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_RDRAG, func)
95
96def EVT_LIST_BEGIN_LABEL_EDIT(win, id, func):
97 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, func)
98
99def EVT_LIST_END_LABEL_EDIT(win, id, func):
100 win.Connect(id, -1, wxEVT_COMMAND_LIST_END_LABEL_EDIT, func)
101
102def EVT_LIST_DELETE_ITEM(win, id, func):
103 win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ITEM, func)
104
105def EVT_LIST_DELETE_ALL_ITEMS(win, id, func):
106 win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, func)
107
108def EVT_LIST_GET_INFO(win, id, func):
109 win.Connect(id, -1, wxEVT_COMMAND_LIST_GET_INFO, func)
110
111def EVT_LIST_SET_INFO(win, id, func):
112 win.Connect(id, -1, wxEVT_COMMAND_LIST_SET_INFO, func)
113
114def EVT_LIST_ITEM_SELECTED(win, id, func):
115 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_SELECTED, func)
116
117def EVT_LIST_ITEM_DESELECTED(win, id, func):
118 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_DESELECTED, func)
119
120def EVT_LIST_KEY_DOWN(win, id, func):
121 win.Connect(id, -1, wxEVT_COMMAND_LIST_KEY_DOWN, func)
122
123def EVT_LIST_INSERT_ITEM(win, id, func):
124 win.Connect(id, -1, wxEVT_COMMAND_LIST_INSERT_ITEM, func)
125
126def EVT_LIST_COL_CLICK(win, id, func):
127 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_CLICK, func)
128
6d19860f
RD
129def EVT_LIST_COL_RIGHT_CLICK(win, id, func):
130 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_RIGHT_CLICK, func)
131
132def EVT_LIST_COL_BEGIN_DRAG(win, id, func):
133 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_BEGIN_DRAG, func)
134
135def EVT_LIST_COL_DRAGGING(win, id, func):
136 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_DRAGGING, func)
137
138def EVT_LIST_COL_END_DRAG(win, id, func):
139 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_END_DRAG, func)
140
c7e7022c
RD
141def EVT_LIST_ITEM_RIGHT_CLICK(win, id, func):
142 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, func)
143
144def EVT_LIST_ITEM_MIDDLE_CLICK(win, id, func):
145 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, func)
146
147def EVT_LIST_ITEM_ACTIVATED(win, id, func):
148 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_ACTIVATED, func)
149
150def EVT_LIST_CACHE_HINT(win, id, func):
151 win.Connect(id, -1, wxEVT_COMMAND_LIST_CACHE_HINT, func)
d8200036
RD
152
153def EVT_LIST_ITEM_FOCUSED(win, id, func):
154 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_FOCUSED, func)
c7e7022c
RD
155"
156
7bf85405 157
af309447 158enum {
c7e7022c
RD
159 /* Style flags */
160 wxLC_VRULES,
161 wxLC_HRULES,
162
163 wxLC_ICON,
164 wxLC_SMALL_ICON,
165 wxLC_LIST,
166 wxLC_REPORT,
167
168 wxLC_ALIGN_TOP,
169 wxLC_ALIGN_LEFT,
170 wxLC_AUTOARRANGE,
171 wxLC_VIRTUAL,
172 wxLC_EDIT_LABELS,
173 wxLC_NO_HEADER,
174 wxLC_NO_SORT_HEADER,
175 wxLC_SINGLE_SEL,
176 wxLC_SORT_ASCENDING,
177 wxLC_SORT_DESCENDING,
178
179 wxLC_MASK_TYPE,
180 wxLC_MASK_ALIGN,
181 wxLC_MASK_SORT,
182
6d19860f 183 wxLC_USER_TEXT,
c7e7022c
RD
184};
185
186
187enum {
188 // Mask flags
189 wxLIST_MASK_STATE,
af309447
RD
190 wxLIST_MASK_TEXT,
191 wxLIST_MASK_IMAGE,
192 wxLIST_MASK_DATA,
c7e7022c 193 wxLIST_SET_ITEM,
af309447
RD
194 wxLIST_MASK_WIDTH,
195 wxLIST_MASK_FORMAT,
c7e7022c
RD
196
197 // State flags
af309447
RD
198 wxLIST_STATE_DONTCARE,
199 wxLIST_STATE_DROPHILITED,
200 wxLIST_STATE_FOCUSED,
201 wxLIST_STATE_SELECTED,
202 wxLIST_STATE_CUT,
c7e7022c
RD
203
204 // Hit test flags
af309447
RD
205 wxLIST_HITTEST_ABOVE,
206 wxLIST_HITTEST_BELOW,
207 wxLIST_HITTEST_NOWHERE,
208 wxLIST_HITTEST_ONITEMICON,
209 wxLIST_HITTEST_ONITEMLABEL,
210 wxLIST_HITTEST_ONITEMRIGHT,
211 wxLIST_HITTEST_ONITEMSTATEICON,
212 wxLIST_HITTEST_TOLEFT,
213 wxLIST_HITTEST_TORIGHT,
214 wxLIST_HITTEST_ONITEM,
c7e7022c
RD
215
216 // Flags for GetNextItem
af309447
RD
217 wxLIST_NEXT_ABOVE,
218 wxLIST_NEXT_ALL,
219 wxLIST_NEXT_BELOW,
220 wxLIST_NEXT_LEFT,
221 wxLIST_NEXT_RIGHT,
c7e7022c
RD
222
223 // Alignment flags
af309447
RD
224 wxLIST_ALIGN_DEFAULT,
225 wxLIST_ALIGN_LEFT,
226 wxLIST_ALIGN_TOP,
227 wxLIST_ALIGN_SNAP_TO_GRID,
c7e7022c
RD
228
229 // Autosize values for SetColumnWidth
230 wxLIST_AUTOSIZE = -1,
231 wxLIST_AUTOSIZE_USEHEADER = -2,
232
233 // Flag values for GetItemRect
af309447
RD
234 wxLIST_RECT_BOUNDS,
235 wxLIST_RECT_ICON,
236 wxLIST_RECT_LABEL,
c7e7022c
RD
237
238 // Flag values for FindItem (MSW only)
af309447
RD
239 wxLIST_FIND_UP,
240 wxLIST_FIND_DOWN,
241 wxLIST_FIND_LEFT,
242 wxLIST_FIND_RIGHT,
c7e7022c
RD
243
244
af309447
RD
245};
246
247
c7e7022c 248
f6bcfd97
BP
249enum wxListColumnFormat
250{
251 wxLIST_FORMAT_LEFT,
252 wxLIST_FORMAT_RIGHT,
253 wxLIST_FORMAT_CENTRE,
254 wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
255};
256
257
1b62f00d
RD
258
259
f6bcfd97
BP
260class wxListItemAttr
261{
262public:
263 // ctors
c7e7022c
RD
264 //wxListItemAttr();
265 wxListItemAttr(const wxColour& colText = wxNullColour,
266 const wxColour& colBack = wxNullColour,
267 const wxFont& font = wxNullFont);
268
f6bcfd97
BP
269
270 // setters
271 void SetTextColour(const wxColour& colText);
272 void SetBackgroundColour(const wxColour& colBack);
273 void SetFont(const wxFont& font);
274
275 // accessors
276 bool HasTextColour();
277 bool HasBackgroundColour();
278 bool HasFont();
279
c5943253
RD
280 wxColour GetTextColour();
281 wxColour GetBackgroundColour();
282 wxFont GetFont();
f6bcfd97
BP
283};
284
285
9416aa89 286class wxListItem : public wxObject {
7bf85405 287public:
f6bcfd97
BP
288 wxListItem();
289 ~wxListItem();
290
291 // resetting
292 void Clear();
293 void ClearAttributes();
294
295 // setters
296 void SetMask(long mask);
297 void SetId(long id);
298 void SetColumn(int col);
299 void SetState(long state);
300 void SetStateMask(long stateMask);
301 void SetText(const wxString& text);
302 void SetImage(int image);
303 void SetData(long data);
304
305 void SetWidth(int width);
306 void SetAlign(wxListColumnFormat align);
307
308 void SetTextColour(const wxColour& colText);
309 void SetBackgroundColour(const wxColour& colBack);
310 void SetFont(const wxFont& font);
311
312 // accessors
313 long GetMask();
314 long GetId();
315 int GetColumn();
316 long GetState();
317 const wxString& GetText();
318 int GetImage();
319 long GetData();
320
321 int GetWidth();
322 wxListColumnFormat GetAlign();
323
324 wxListItemAttr *GetAttributes();
325 bool HasAttributes();
326
327 wxColour GetTextColour() const;
328 wxColour GetBackgroundColour() const;
329 wxFont GetFont() const;
330
331 // these members are public for compatibility
7bf85405
RD
332 long m_mask; // Indicates what fields are valid
333 long m_itemId; // The zero-based item position
334 int m_col; // Zero-based column, if in report mode
335 long m_state; // The state of the item
f6bcfd97 336 long m_stateMask;// Which flags of m_state are valid (uses same flags)
7bf85405
RD
337 wxString m_text; // The label/header text
338 int m_image; // The zero-based index into an image list
339 long m_data; // App-defined data
7bf85405
RD
340
341 // For columns only
342 int m_format; // left, right, centre
343 int m_width; // width of column
344
7bf85405
RD
345};
346
f6bcfd97 347
c368d904 348class wxListEvent: public wxNotifyEvent {
7bf85405 349public:
6d19860f
RD
350 wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
351
b7fc54be 352%readonly
7bf85405 353 int m_code;
ebf4302c 354 long m_oldItemIndex;
7bf85405 355 long m_itemIndex;
7bf85405 356 int m_col;
7bf85405
RD
357 wxPoint m_pointDrag;
358 wxListItem m_item;
b7fc54be 359%readwrite
7bf85405 360
64c06a50
RD
361 int GetKeyCode();
362 %pragma(python) addtoclass = "GetCode = GetKeyCode"
f6bcfd97 363 long GetIndex();
f6bcfd97 364 int GetColumn();
f6bcfd97
BP
365 wxPoint GetPoint();
366 const wxString& GetLabel();
367 const wxString& GetText();
368 int GetImage();
369 long GetData();
370 long GetMask();
371 const wxListItem& GetItem();
6d19860f
RD
372
373 long GetCacheFrom();
374 long GetCacheTo();
f6bcfd97 375};
7bf85405
RD
376
377
09f3d4e6 378%{ // C++ Version of a Python aware class
c7e7022c
RD
379class wxPyListCtrl : public wxListCtrl {
380 DECLARE_ABSTRACT_CLASS(wxPyListCtrl);
7bf85405 381public:
09f3d4e6 382 wxPyListCtrl() : wxListCtrl() {}
c7e7022c
RD
383 wxPyListCtrl(wxWindow* parent, wxWindowID id,
384 const wxPoint& pos,
385 const wxSize& size,
386 long style,
387 const wxValidator& validator,
137b5242 388 const wxString& name) :
c7e7022c
RD
389 wxListCtrl(parent, id, pos, size, style, validator, name) {}
390
09f3d4e6
RD
391 bool Create(wxWindow* parent, wxWindowID id,
392 const wxPoint& pos,
393 const wxSize& size,
394 long style,
395 const wxValidator& validator,
137b5242 396 const wxString& name) {
09f3d4e6
RD
397 return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
398 }
399
c7e7022c
RD
400 DEC_PYCALLBACK_STRING_LONGLONG(OnGetItemText);
401 DEC_PYCALLBACK_INT_LONG(OnGetItemImage);
402 DEC_PYCALLBACK_LISTATTR_LONG(OnGetItemAttr);
403
404 PYPRIVATE;
405};
406
407IMPLEMENT_ABSTRACT_CLASS(wxPyListCtrl, wxListCtrl);
7bf85405 408
c7e7022c
RD
409IMP_PYCALLBACK_STRING_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemText);
410IMP_PYCALLBACK_INT_LONG(wxPyListCtrl, wxListCtrl, OnGetItemImage);
411IMP_PYCALLBACK_LISTATTR_LONG(wxPyListCtrl, wxListCtrl, OnGetItemAttr);
412%}
413
414
cdf14688 415
c7e7022c
RD
416%name(wxListCtrl)class wxPyListCtrl : public wxControl {
417public:
418 wxPyListCtrl(wxWindow* parent, wxWindowID id = -1,
419 const wxPoint& pos = wxDefaultPosition,
420 const wxSize& size = wxDefaultSize,
421 long style = wxLC_ICON,
422 const wxValidator& validator = wxDefaultValidator,
137b5242 423 const wxString& name = wxPyListCtrlNameStr);
09f3d4e6
RD
424 %name(wxPreListCtrl)wxPyListCtrl();
425
426 bool Create(wxWindow* parent, wxWindowID id = -1,
427 const wxPoint& pos = wxDefaultPosition,
428 const wxSize& size = wxDefaultSize,
429 long style = wxLC_ICON,
430 const wxValidator& validator = wxDefaultValidator,
137b5242 431 const wxString& name = wxPyListCtrlNameStr);
c7e7022c 432
0122b7e3
RD
433 void _setCallbackInfo(PyObject* self, PyObject* _class);
434 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxListCtrl)"
9c039d08 435
0122b7e3 436 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
17c0e08c 437 %pragma(python) addtomethod = "wxPreListCtrl:val._setOORInfo(val)"
7bf85405 438
c7e7022c
RD
439 // Set the control colours
440 bool SetForegroundColour(const wxColour& col);
441 bool SetBackgroundColour(const wxColour& col);
442
443 // Gets information about this column
14afa2cb
RD
444 // bool GetColumn(int col, wxListItem& item) const;
445 %addmethods {
446 %new wxListItem* GetColumn(int col) {
447 wxListItem item;
be13a6af 448 item.SetMask(0xFFFF);
14afa2cb
RD
449 if (self->GetColumn(col, item))
450 return new wxListItem(item);
451 else
452 return NULL;
453 }
e4ed5de1 454 } // The OOR typemaps don't know what to do with the %new, so fix it up.
14afa2cb 455 %pragma(python) addtoclass = "
e4ed5de1 456 def GetColumn(self, *_args, **_kwargs):
14afa2cb
RD
457 val = apply(controls2c.wxListCtrl_GetColumn,(self,) + _args, _kwargs)
458 if val is not None: val.thisown = 1
459 return val
460 "
c7e7022c
RD
461
462 // Sets information about this column
463 bool SetColumn(int col, wxListItem& item) ;
464
465 // Gets the column width
466 int GetColumnWidth(int col) const;
467
468 // Sets the column width
469 bool SetColumnWidth(int col, int width) ;
470
471 // Gets the number of items that can fit vertically in the
472 // visible area of the list control (list or report view)
473 // or the total number of items in the list control (icon
474 // or small icon view)
475 int GetCountPerPage() const;
476
cd096152 477#ifdef __WXMSW__
c7e7022c
RD
478 // Gets the edit control for editing labels.
479 wxTextCtrl* GetEditControl() const;
cd096152 480#endif
c7e7022c
RD
481
482 //bool GetItem(wxListItem& info) const ;
7bf85405 483 %addmethods {
c7e7022c 484 // Gets information about the item
e166644c 485 %new wxListItem* GetItem(long itemId, int col=0) {
7bf85405 486 wxListItem* info = new wxListItem;
0699c864 487 info->m_itemId = itemId;
e166644c 488 info->m_col = col;
f17fee68 489 info->m_mask = 0xFFFF;
7bf85405
RD
490 self->GetItem(*info);
491 return info;
492 }
5597b61e
RD
493 } // The OOR typemaps don't know what to do with the %new, so fix it up.
494 %pragma(python) addtoclass = "
495 def GetItem(self, *_args, **_kwargs):
496 val = apply(controls2c.wxListCtrl_GetItem,(self,) + _args, _kwargs)
e4ed5de1 497 if val is not None: val.thisown = 1
5597b61e
RD
498 return val
499 "
500
c7e7022c
RD
501
502 // Sets information about the item
503 bool SetItem(wxListItem& info) ;
504
505 // Sets a string field at a particular column
506 %name(SetStringItem)long SetItem(long index, int col, const wxString& label, int imageId = -1);
507
508 // Gets the item state
509 int GetItemState(long item, long stateMask) const ;
510
511 // Sets the item state
512 bool SetItemState(long item, long state, long stateMask) ;
513
514 // Sets the item image
515 bool SetItemImage(long item, int image, int selImage) ;
516
517 // Gets the item text
518 wxString GetItemText(long item) const ;
519
520 // Sets the item text
521 void SetItemText(long item, const wxString& str) ;
522
523 // Gets the item data
524 long GetItemData(long item) const ;
525
526 // Sets the item data
527 bool SetItemData(long item, long data) ;
528
529
530 //bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
531 //bool GetItemPosition(long item, wxPoint& pos) const ;
00b6c4e3
RD
532
533 // Gets the item position
5597b61e 534 %addmethods {
7bf85405
RD
535 %new wxPoint* GetItemPosition(long item) {
536 wxPoint* pos = new wxPoint;
537 self->GetItemPosition(item, *pos);
538 return pos;
539 }
c7e7022c 540 // Gets the item rectangle
7bf85405
RD
541 %new wxRect* GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
542 wxRect* rect= new wxRect;
543 self->GetItemRect(item, *rect, code);
544 return rect;
545 }
546 }
547
c7e7022c
RD
548
549 // Sets the item position
550 bool SetItemPosition(long item, const wxPoint& pos) ;
551
552 // Gets the number of items in the list control
553 int GetItemCount() const;
554
555 // Gets the number of columns in the list control
9d37f964 556 int GetColumnCount() const;
c7e7022c
RD
557
558 // Retrieves the spacing between icons in pixels.
559 // If small is TRUE, gets the spacing for the small icon
560 // view, otherwise the large icon view.
561 int GetItemSpacing(bool isSmall) const;
562
563 // Gets the number of selected items in the list control
564 int GetSelectedItemCount() const;
565
566 // Gets the text colour of the listview
567 wxColour GetTextColour() const;
568
569 // Sets the text colour of the listview
4f22cf8d 570 void SetTextColour(const wxColour& col);
c7e7022c
RD
571
572 // Gets the index of the topmost visible item when in
573 // list or report view
574 long GetTopItem() const ;
575
576 // Add or remove a single window style
577 void SetSingleStyle(long style, bool add = TRUE) ;
578
579 // Set the whole window style
580 void SetWindowStyleFlag(long style) ;
581
582 // Searches for an item, starting from 'item'.
583 // item can be -1 to find the first item that matches the
584 // specified flags.
585 // Returns the item or -1 if unsuccessful.
586 long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
587
588 // Gets one of the three image lists
589 wxImageList *GetImageList(int which) const ;
590
591 // Sets the image list
592 void SetImageList(wxImageList *imageList, int which) ;
593 void AssignImageList(wxImageList *imageList, int which) ;
594 %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
595
596 // returns true if it is a virtual list control
597 bool IsVirtual() const;
598
599 // refresh items selectively (only useful for virtual list controls)
600 void RefreshItem(long item);
601 void RefreshItems(long itemFrom, long itemTo);
602
c7e7022c
RD
603 // Arranges the items
604 bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
605
606 // Deletes an item
607 bool DeleteItem(long item);
608
609 // Deletes all items
610 bool DeleteAllItems() ;
611
612 // Deletes a column
613 bool DeleteColumn(int col);
614
615 // Deletes all columns
616 bool DeleteAllColumns();
617
618 // Clears items, and columns if there are any.
619 void ClearAll();
620
cd096152 621#ifdef __WXMSW__
c7e7022c
RD
622 // Edit the label
623 wxTextCtrl* EditLabel(long item /*, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)*/);
624
625 // End label editing, optionally cancelling the edit
626 bool EndEditLabel(bool cancel);
cd096152 627#endif
c7e7022c
RD
628
629 // Ensures this item is visible
630 bool EnsureVisible(long item) ;
631
632 // Find an item whose label matches this string, starting from the item after 'start'
633 // or the beginning if 'start' is -1.
634 long FindItem(long start, const wxString& str, bool partial = FALSE);
635
636 // Find an item whose data matches this data, starting from the item after 'start'
637 // or the beginning if 'start' is -1.
638 %name(FindItemData)long FindItem(long start, long data);
639
640 // Find an item nearest this position in the specified direction, starting from
641 // the item after 'start' or the beginning if 'start' is -1.
642 %name(FindItemAtPos)long FindItem(long start, const wxPoint& pt, int direction);
643
644 // Determines which item (if any) is at the specified point,
645 // giving details in the second return value (see wxLIST_HITTEST_... flags above)
7bf85405 646 long HitTest(const wxPoint& point, int& OUTPUT);
c7e7022c
RD
647
648 // Inserts an item, returning the index of the new item if successful,
649 // -1 otherwise.
650 long InsertItem(wxListItem& info);
651
652 // Insert a string item
653 %name(InsertStringItem)long InsertItem(long index, const wxString& label);
654
655 // Insert an image item
656 %name(InsertImageItem)long InsertItem(long index, int imageIndex);
657
658 // Insert an image/string item
659 %name(InsertImageStringItem)long InsertItem(long index, const wxString& label, int imageIndex);
660
661 // For list view mode (only), inserts a column.
c368d904 662 %name(InsertColumnInfo)long InsertColumn(long col, wxListItem& info);
c7e7022c
RD
663
664 long InsertColumn(long col,
665 const wxString& heading,
7bf85405
RD
666 int format = wxLIST_FORMAT_LEFT,
667 int width = -1);
668
c7e7022c
RD
669 // set the number of items in a virtual list control
670 void SetItemCount(long count);
7bf85405 671
c7e7022c
RD
672 // Scrolls the list control. If in icon, small icon or report view mode,
673 // x specifies the number of pixels to scroll. If in list view mode, x
674 // specifies the number of columns to scroll.
675 // If in icon, small icon or list view mode, y specifies the number of pixels
676 // to scroll. If in report view mode, y specifies the number of lines to scroll.
7bf85405 677 bool ScrollList(int dx, int dy);
dcd38683 678
3bd1e033
RD
679 void SetItemTextColour( long item, const wxColour& col);
680 wxColour GetItemTextColour( long item ) const;
681 void SetItemBackgroundColour( long item, const wxColour &col);
682 wxColour GetItemBackgroundColour( long item ) const;
683
c7e7022c 684
6d19860f
RD
685 %pragma(python) addtoclass = "
686 # Some helpers...
687
43097598 688 def Select(self, idx, on=1):
6d19860f
RD
689 '''[de]select an item'''
690 if on: state = wxLIST_STATE_SELECTED
691 else: state = 0
692 self.SetItemState(idx, state, wxLIST_STATE_SELECTED)
693
694 def Focus(self, idx):
695 '''Focus and show the given item'''
696 self.SetItemState(idx, wxLIST_STATE_FOCUSED, wxLIST_STATE_FOCUSED)
697 self.EnsureVisible(idx)
698
699 def GetFocusedItem(self):
700 '''get the currently focused item or -1 if none'''
701 return self.GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED)
702
703 def IsSelected(self, idx):
704 '''return TRUE if the item is selected'''
705 return self.GetItemState(idx, wxLIST_STATE_SELECTED) != 0
706
707 def SetColumnImage(self, col, image):
708 item = wxListItem()
709 item.SetMask(wxLIST_MASK_IMAGE)
710 item.SetImage(image)
711 self.SetColumn(col, item)
712
713 def ClearColumnImage(self, col):
714 self.SetColumnImage(col, -1)
44536514
RD
715
716 def Append(self, entry):
717 '''Append an item to the list control. The entry parameter should be a
718 sequence with an item for each column'''
719 if len(entry):
720 pos = self.GetItemCount()
721 self.InsertStringItem(pos, str(entry[0]))
722 for i in range(1, len(entry)):
723 self.SetStringItem(pos, i, str(entry[i]))
724 return pos
6d19860f 725 "
3bd1e033
RD
726
727
728 // bool SortItems(wxListCtrlCompare fn, long data);
729 %addmethods {
730 // Sort items.
731 // func is a function which takes 2 long arguments: item1, item2.
732 // item1 is the long data associated with a first item (NOT the index).
733 // item2 is the long data associated with a second item (NOT the index).
734 // The return value is a negative number if the first item should precede the second
735 // item, a positive number of the second item should precede the first,
736 // or zero if the two items are equivalent.
737 bool SortItems(PyObject* func) {
738 if (!PyCallable_Check(func))
739 return FALSE;
740 return self->SortItems(wxPyListCtrl_SortItems, (long)func);
741 }
742 }
6af85fcd
RD
743
744
745 %addmethods {
746 wxWindow* GetMainWindow() {
747 #ifdef __WXMSW__
748 return self;
749 #else
2b760f0e 750 return (wxWindow*)self->m_mainWin;
6af85fcd
RD
751 #endif
752 }
753 }
7bf85405
RD
754};
755
c7e7022c
RD
756
757
6d19860f 758%{ // Python aware sorting function for wxPyListCtrl
f6bcfd97 759 int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
dcd38683
RD
760 int retval = 0;
761 PyObject* func = (PyObject*)funcPtr;
4268f798 762 wxPyBeginBlockThreads();
7bf85405 763
dcd38683
RD
764 PyObject* args = Py_BuildValue("(ii)", item1, item2);
765 PyObject* result = PyEval_CallObject(func, args);
766 Py_DECREF(args);
767 if (result) {
768 retval = PyInt_AsLong(result);
769 Py_DECREF(result);
770 }
771
4268f798 772 wxPyEndBlockThreads();
dcd38683
RD
773 return retval;
774 }
775
776%}
7bf85405 777
6d19860f
RD
778//----------------------------------------------------------------------
779
780class wxListView : public wxPyListCtrl
781{
782public:
783 wxListView( wxWindow *parent,
784 wxWindowID id = -1,
785 const wxPoint& pos = wxDefaultPosition,
786 const wxSize& size = wxDefaultSize,
787 long style = wxLC_REPORT,
788 const wxValidator& validator = wxDefaultValidator,
137b5242 789 const wxString& name = wxPyListCtrlNameStr);
6d19860f
RD
790 %name(wxPreListView)wxListView();
791
792 bool Create( wxWindow *parent,
793 wxWindowID id = -1,
794 const wxPoint& pos = wxDefaultPosition,
795 const wxSize& size = wxDefaultSize,
796 long style = wxLC_REPORT,
797 const wxValidator& validator = wxDefaultValidator,
137b5242 798 const wxString& name = wxPyListCtrlNameStr);
6d19860f 799
0122b7e3 800 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
17c0e08c 801 %pragma(python) addtomethod = "wxPreListView:val._setOORInfo(val)"
6d19860f
RD
802
803 // [de]select an item
804 void Select(long n, bool on = TRUE);
805
806 // focus and show the given item
807 void Focus(long index);
808
809 // get the currently focused item or -1 if none
810 long GetFocusedItem() const;
811
812 // get first and subsequent selected items, return -1 when no more
813 long GetNextSelected(long item) const;
814 long GetFirstSelected() const;
815
816 // return TRUE if the item is selected
817 bool IsSelected(long index);
818
819 void SetColumnImage(int col, int image);
820 void ClearColumnImage(int col);
821};
822
823
7bf85405
RD
824//----------------------------------------------------------------------
825
00b6c4e3
RD
826// wxTreeCtrl flags
827enum {
828 wxTR_NO_BUTTONS,
829 wxTR_HAS_BUTTONS,
830 wxTR_TWIST_BUTTONS,
831 wxTR_NO_LINES,
832 wxTR_MAC_BUTTONS,
b5a5d647 833 wxTR_AQUA_BUTTONS,
00b6c4e3
RD
834
835 wxTR_SINGLE,
836 wxTR_MULTIPLE,
837 wxTR_EXTENDED,
b5a5d647 838 wxTR_FULL_ROW_HIGHLIGHT,
00b6c4e3
RD
839
840 wxTR_EDIT_LABELS,
841 wxTR_LINES_AT_ROOT,
842 wxTR_HIDE_ROOT,
843 wxTR_ROW_LINES,
844 wxTR_HAS_VARIABLE_ROW_HEIGHT,
845
846 wxTR_DEFAULT_STYLE,
847};
848
694759cf
RD
849enum wxTreeItemIcon
850{
851 wxTreeItemIcon_Normal, // not selected, not expanded
852 wxTreeItemIcon_Selected, // selected, not expanded
853 wxTreeItemIcon_Expanded, // not selected, expanded
854 wxTreeItemIcon_SelectedExpanded, // selected, expanded
855 wxTreeItemIcon_Max
856};
857
7bf85405 858
164b735b
RD
859// constants for HitTest
860enum {
861 wxTREE_HITTEST_ABOVE,
862 wxTREE_HITTEST_BELOW,
863 wxTREE_HITTEST_NOWHERE,
864 wxTREE_HITTEST_ONITEMBUTTON,
865 wxTREE_HITTEST_ONITEMICON,
866 wxTREE_HITTEST_ONITEMINDENT,
867 wxTREE_HITTEST_ONITEMLABEL,
868 wxTREE_HITTEST_ONITEMRIGHT,
869 wxTREE_HITTEST_ONITEMSTATEICON,
870 wxTREE_HITTEST_TOLEFT,
871 wxTREE_HITTEST_TORIGHT,
872 wxTREE_HITTEST_ONITEMUPPERPART,
873 wxTREE_HITTEST_ONITEMLOWERPART,
874 wxTREE_HITTEST_ONITEM
875};
876
877
1b62f00d
RD
878enum {
879 /* Tree control event types */
880 wxEVT_COMMAND_TREE_BEGIN_DRAG,
881 wxEVT_COMMAND_TREE_BEGIN_RDRAG,
882 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
883 wxEVT_COMMAND_TREE_END_LABEL_EDIT,
884 wxEVT_COMMAND_TREE_DELETE_ITEM,
885 wxEVT_COMMAND_TREE_GET_INFO,
886 wxEVT_COMMAND_TREE_SET_INFO,
887 wxEVT_COMMAND_TREE_ITEM_EXPANDED,
888 wxEVT_COMMAND_TREE_ITEM_EXPANDING,
889 wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
890 wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
891 wxEVT_COMMAND_TREE_SEL_CHANGED,
892 wxEVT_COMMAND_TREE_SEL_CHANGING,
893 wxEVT_COMMAND_TREE_KEY_DOWN,
894 wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
895 wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK,
896 wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK,
d1679124 897 wxEVT_COMMAND_TREE_END_DRAG,
1b62f00d
RD
898};
899
900
00b6c4e3
RD
901%pragma(python) code = "
902# wxTreeCtrl events
903def EVT_TREE_BEGIN_DRAG(win, id, func):
904 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_DRAG, func)
905
906def EVT_TREE_BEGIN_RDRAG(win, id, func):
907 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_RDRAG, func)
908
909def EVT_TREE_END_DRAG(win, id, func):
910 win.Connect(id, -1, wxEVT_COMMAND_TREE_END_DRAG, func)
911
912def EVT_TREE_BEGIN_LABEL_EDIT(win, id, func):
913 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, func)
914
915def EVT_TREE_END_LABEL_EDIT(win, id, func):
916 win.Connect(id, -1, wxEVT_COMMAND_TREE_END_LABEL_EDIT, func)
917
918def EVT_TREE_GET_INFO(win, id, func):
919 win.Connect(id, -1, wxEVT_COMMAND_TREE_GET_INFO, func)
920
921def EVT_TREE_SET_INFO(win, id, func):
922 win.Connect(id, -1, wxEVT_COMMAND_TREE_SET_INFO, func)
923
924def EVT_TREE_ITEM_EXPANDED(win, id, func):
925 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_EXPANDED, func)
926
927def EVT_TREE_ITEM_EXPANDING(win, id, func):
928 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_EXPANDING, func)
929
930def EVT_TREE_ITEM_COLLAPSED(win, id, func):
931 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_COLLAPSED, func)
932
933def EVT_TREE_ITEM_COLLAPSING(win, id, func):
934 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_COLLAPSING, func)
935
936def EVT_TREE_SEL_CHANGED(win, id, func):
937 win.Connect(id, -1, wxEVT_COMMAND_TREE_SEL_CHANGED, func)
938
939def EVT_TREE_SEL_CHANGING(win, id, func):
940 win.Connect(id, -1, wxEVT_COMMAND_TREE_SEL_CHANGING, func)
941
942def EVT_TREE_KEY_DOWN(win, id, func):
943 win.Connect(id, -1, wxEVT_COMMAND_TREE_KEY_DOWN, func)
944
945def EVT_TREE_DELETE_ITEM(win, id, func):
946 win.Connect(id, -1, wxEVT_COMMAND_TREE_DELETE_ITEM, func)
947
948def EVT_TREE_ITEM_ACTIVATED(win, id, func):
949 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_ACTIVATED, func)
950
951def EVT_TREE_ITEM_RIGHT_CLICK(win, id, func):
952 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, func)
953
954def EVT_TREE_ITEM_MIDDLE_CLICK(win, id, func):
955 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, func)
956"
957
958
959class wxTreeItemAttr
960{
961public:
962 // ctors
963 //wxTreeItemAttr() { }
964 wxTreeItemAttr(const wxColour& colText = wxNullColour,
965 const wxColour& colBack = wxNullColour,
966 const wxFont& font = wxNullFont);
967
968 // setters
969 void SetTextColour(const wxColour& colText);
970 void SetBackgroundColour(const wxColour& colBack);
971 void SetFont(const wxFont& font);
972
973 // accessors
974 bool HasTextColour();
975 bool HasBackgroundColour();
976 bool HasFont();
977
c5943253
RD
978 wxColour GetTextColour();
979 wxColour GetBackgroundColour();
980 wxFont GetFont();
00b6c4e3
RD
981};
982
983
d5c9047a
RD
984class wxTreeItemId {
985public:
986 wxTreeItemId();
987 ~wxTreeItemId();
bb0054cd 988 bool IsOk();
78e8819c 989 %pragma(python) addtoclass = "Ok = IsOk"
d5c9047a 990
f6bcfd97
BP
991 %addmethods {
992 int __cmp__(wxTreeItemId* other) {
c368d904 993 if (! other) return -1;
f6bcfd97
BP
994 return *self != *other;
995 }
996 }
d5c9047a
RD
997};
998
999
1000
cf694132
RD
1001%{
1002class wxPyTreeItemData : public wxTreeItemData {
d5c9047a 1003public:
cf694132 1004 wxPyTreeItemData(PyObject* obj = NULL) {
c368d904 1005 if (obj == NULL)
cf694132 1006 obj = Py_None;
c368d904
RD
1007 Py_INCREF(obj);
1008 m_obj = obj;
cf694132 1009 }
d5c9047a 1010
cf694132 1011 ~wxPyTreeItemData() {
4268f798 1012 wxPyBeginBlockThreads();
c368d904 1013 Py_DECREF(m_obj);
4268f798 1014 wxPyEndBlockThreads();
cf694132
RD
1015 }
1016
1017 PyObject* GetData() {
1018 Py_INCREF(m_obj);
1019 return m_obj;
1020 }
1021
1022 void SetData(PyObject* obj) {
4268f798 1023 wxPyBeginBlockThreads();
cf694132 1024 Py_DECREF(m_obj);
4268f798 1025 wxPyEndBlockThreads();
cf694132
RD
1026 m_obj = obj;
1027 Py_INCREF(obj);
1028 }
1029
1030 PyObject* m_obj;
d5c9047a 1031};
cf694132 1032%}
d5c9047a
RD
1033
1034
1035
9416aa89 1036%name(wxTreeItemData) class wxPyTreeItemData : public wxObject {
cf694132
RD
1037public:
1038 wxPyTreeItemData(PyObject* obj = NULL);
1039
1040 PyObject* GetData();
1041 void SetData(PyObject* obj);
1042
1043 const wxTreeItemId& GetId();
1044 void SetId(const wxTreeItemId& id);
1045};
1046
1047
d5c9047a 1048
8bf5d46e 1049class wxTreeEvent : public wxNotifyEvent {
d5c9047a 1050public:
00b6c4e3
RD
1051 wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
1052
d5c9047a
RD
1053 wxTreeItemId GetItem();
1054 wxTreeItemId GetOldItem();
1055 wxPoint GetPoint();
ecc08ead 1056 const wxKeyEvent& GetKeyEvent();
64c06a50
RD
1057 int GetKeyCode();
1058 %pragma(python) addtoclass = "GetCode = GetKeyCode"
8bf5d46e 1059 const wxString& GetLabel();
d5c9047a
RD
1060};
1061
1062
f6bcfd97 1063
09f3d4e6 1064%{ // C++ version of Python aware wxTreeCtrl
f6bcfd97 1065class wxPyTreeCtrl : public wxTreeCtrl {
3b36695d 1066 DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl);
f6bcfd97 1067public:
09f3d4e6 1068 wxPyTreeCtrl() : wxTreeCtrl() {}
f6bcfd97
BP
1069 wxPyTreeCtrl(wxWindow *parent, wxWindowID id,
1070 const wxPoint& pos,
1071 const wxSize& size,
1072 long style,
1073 const wxValidator& validator,
137b5242 1074 const wxString& name) :
f6bcfd97
BP
1075 wxTreeCtrl(parent, id, pos, size, style, validator, name) {}
1076
09f3d4e6
RD
1077 bool Create(wxWindow *parent, wxWindowID id,
1078 const wxPoint& pos,
1079 const wxSize& size,
1080 long style,
1081 const wxValidator& validator,
137b5242 1082 const wxString& name) {
09f3d4e6
RD
1083 return wxTreeCtrl::Create(parent, id, pos, size, style, validator, name);
1084 }
1085
1086
f6bcfd97
BP
1087 int OnCompareItems(const wxTreeItemId& item1,
1088 const wxTreeItemId& item2) {
1089 int rval = 0;
19a97bd6 1090 bool found;
4268f798 1091 wxPyBeginBlockThreads();
a66212dc
RD
1092 if ((found = m_myInst.findCallback("OnCompareItems"))) {
1093 PyObject *o1 = wxPyConstructObject((void*)&item1, "wxTreeItemId");
1094 PyObject *o2 = wxPyConstructObject((void*)&item2, "wxTreeItemId");
1095 rval = m_myInst.callCallback(Py_BuildValue("(OO)",o1,o2));
1096 Py_DECREF(o1);
1097 Py_DECREF(o2);
1098 }
4268f798 1099 wxPyEndBlockThreads();
19a97bd6 1100 if (! found)
f6bcfd97 1101 rval = wxTreeCtrl::OnCompareItems(item1, item2);
f6bcfd97
BP
1102 return rval;
1103 }
1104 PYPRIVATE;
1105};
1106
3b36695d
RD
1107IMPLEMENT_ABSTRACT_CLASS(wxPyTreeCtrl, wxTreeCtrl);
1108
f6bcfd97
BP
1109%}
1110
d5c9047a
RD
1111// These are for the GetFirstChild/GetNextChild methods below
1112%typemap(python, in) long& INOUT = long* INOUT;
1113%typemap(python, argout) long& INOUT = long* INOUT;
1114
1115
f6bcfd97 1116%name(wxTreeCtrl)class wxPyTreeCtrl : public wxControl {
d5c9047a 1117public:
f6bcfd97 1118 wxPyTreeCtrl(wxWindow *parent, wxWindowID id = -1,
b68dc582
RD
1119 const wxPoint& pos = wxDefaultPosition,
1120 const wxSize& size = wxDefaultSize,
d5c9047a 1121 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
b68dc582 1122 const wxValidator& validator = wxDefaultValidator,
137b5242 1123 const wxString& name = wxPy_TreeCtrlNameStr);
09f3d4e6
RD
1124 %name(wxPreTreeCtrl)wxPyTreeCtrl();
1125
1126 bool Create(wxWindow *parent, wxWindowID id = -1,
1127 const wxPoint& pos = wxDefaultPosition,
1128 const wxSize& size = wxDefaultSize,
1129 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
1130 const wxValidator& validator = wxDefaultValidator,
137b5242 1131 const wxString& name = wxPy_TreeCtrlNameStr);
d5c9047a 1132
0122b7e3
RD
1133 void _setCallbackInfo(PyObject* self, PyObject* _class);
1134 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTreeCtrl)"
1135
1136 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
17c0e08c 1137 %pragma(python) addtomethod = "wxPreTreeCtrl:val._setOORInfo(val)"
d5c9047a
RD
1138
1139 size_t GetCount();
1140 unsigned int GetIndent();
1141 void SetIndent(unsigned int indent);
1142 wxImageList *GetImageList();
1143 wxImageList *GetStateImageList();
1b62f00d 1144 void SetImageList(wxImageList *imageList);
d5c9047a 1145 void SetStateImageList(wxImageList *imageList);
00b6c4e3
RD
1146 void AssignImageList(wxImageList* imageList);
1147 %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
1148 void AssignStateImageList(wxImageList* imageList);
1149 %pragma(python) addtomethod = "AssignStateImageList:_args[0].thisown = 0"
d5c9047a 1150
b1462dfa
RD
1151 unsigned int GetSpacing();
1152 void SetSpacing(unsigned int spacing);
1153
d5c9047a 1154 wxString GetItemText(const wxTreeItemId& item);
694759cf
RD
1155 int GetItemImage(const wxTreeItemId& item,
1156 wxTreeItemIcon which = wxTreeItemIcon_Normal);
d5c9047a 1157 int GetItemSelectedImage(const wxTreeItemId& item);
d5c9047a
RD
1158
1159 void SetItemText(const wxTreeItemId& item, const wxString& text);
694759cf
RD
1160 void SetItemImage(const wxTreeItemId& item, int image,
1161 wxTreeItemIcon which = wxTreeItemIcon_Normal);
d5c9047a 1162 void SetItemSelectedImage(const wxTreeItemId& item, int image);
08127323 1163 void SetItemHasChildren(const wxTreeItemId& item, bool hasChildren = TRUE);
d5c9047a 1164
cf694132 1165 %addmethods {
c368d904
RD
1166 // [Get|Set]ItemData substitutes. Automatically create wxPyTreeItemData
1167 // if needed.
cf694132
RD
1168 wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
1169 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1170 if (data == NULL) {
1171 data = new wxPyTreeItemData();
f6bcfd97 1172 data->SetId(item); // set the id
cf694132
RD
1173 self->SetItemData(item, data);
1174 }
1175 return data;
1176 }
1177
1178 void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
f6bcfd97
BP
1179 data->SetId(item); // set the id
1180 self->SetItemData(item, data);
c368d904 1181 }
cf694132 1182
c368d904
RD
1183 // [Get|Set]PyData are short-cuts. Also made somewhat crash-proof by
1184 // automatically creating data classes.
1185 PyObject* GetPyData(const wxTreeItemId& item) {
cf694132
RD
1186 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1187 if (data == NULL) {
1188 data = new wxPyTreeItemData();
f6bcfd97 1189 data->SetId(item); // set the id
cf694132
RD
1190 self->SetItemData(item, data);
1191 }
1192 return data->GetData();
c368d904 1193 }
cf694132
RD
1194
1195 void SetPyData(const wxTreeItemId& item, PyObject* obj) {
1196 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1197 if (data == NULL) {
1198 data = new wxPyTreeItemData(obj);
f6bcfd97 1199 data->SetId(item); // set the id
cf694132
RD
1200 self->SetItemData(item, data);
1201 } else
1202 data->SetData(obj);
c368d904 1203 }
cf694132
RD
1204 }
1205
1206
d5c9047a
RD
1207 bool IsVisible(const wxTreeItemId& item);
1208 bool ItemHasChildren(const wxTreeItemId& item);
1209 bool IsExpanded(const wxTreeItemId& item);
1210 bool IsSelected(const wxTreeItemId& item);
1211
1212 wxTreeItemId GetRootItem();
1213 wxTreeItemId GetSelection();
eb715945 1214 %name(GetItemParent) wxTreeItemId GetParent(const wxTreeItemId& item);
d426c97e
RD
1215 //size_t GetSelections(wxArrayTreeItemIds& selection);
1216 %addmethods {
1217 PyObject* GetSelections() {
4268f798 1218 wxPyBeginBlockThreads();
d426c97e
RD
1219 PyObject* rval = PyList_New(0);
1220 wxArrayTreeItemIds array;
1221 size_t num, x;
1222 num = self->GetSelections(array);
1223 for (x=0; x < num; x++) {
c368d904
RD
1224 wxTreeItemId *tii = new wxTreeItemId(array.Item(x));
1225 PyObject* item = wxPyConstructObject((void*)tii, "wxTreeItemId", TRUE);
d426c97e
RD
1226 PyList_Append(rval, item);
1227 }
4268f798 1228 wxPyEndBlockThreads();
d426c97e
RD
1229 return rval;
1230 }
1231 }
1232
1233
d5c9047a 1234
bb0054cd
RD
1235 size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
1236
0815db26 1237 wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT = longzero);
d5c9047a
RD
1238 wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
1239 wxTreeItemId GetNextSibling(const wxTreeItemId& item);
1240 wxTreeItemId GetPrevSibling(const wxTreeItemId& item);
1241 wxTreeItemId GetFirstVisibleItem();
1242 wxTreeItemId GetNextVisible(const wxTreeItemId& item);
1243 wxTreeItemId GetPrevVisible(const wxTreeItemId& item);
d426c97e
RD
1244 wxTreeItemId GetLastChild(const wxTreeItemId& item);
1245
d5c9047a
RD
1246
1247
1248 wxTreeItemId AddRoot(const wxString& text,
1249 int image = -1, int selectedImage = -1,
cf694132 1250 wxPyTreeItemData *data = NULL);
d5c9047a
RD
1251 wxTreeItemId PrependItem(const wxTreeItemId& parent,
1252 const wxString& text,
1253 int image = -1, int selectedImage = -1,
cf694132 1254 wxPyTreeItemData *data = NULL);
d5c9047a
RD
1255 wxTreeItemId InsertItem(const wxTreeItemId& parent,
1256 const wxTreeItemId& idPrevious,
1257 const wxString& text,
1258 int image = -1, int selectedImage = -1,
cf694132 1259 wxPyTreeItemData *data = NULL);
f6bcfd97
BP
1260 %name(InsertItemBefore)
1261 wxTreeItemId InsertItem(const wxTreeItemId& parent,
1262 size_t before,
1263 const wxString& text,
1264 int image = -1, int selectedImage = -1,
3999941a 1265 wxPyTreeItemData *data = NULL);
d5c9047a
RD
1266 wxTreeItemId AppendItem(const wxTreeItemId& parent,
1267 const wxString& text,
1268 int image = -1, int selectedImage = -1,
cf694132 1269 wxPyTreeItemData *data = NULL);
d5c9047a
RD
1270
1271 void Delete(const wxTreeItemId& item);
08127323 1272 void DeleteChildren(const wxTreeItemId& item);
d5c9047a
RD
1273 void DeleteAllItems();
1274
1275 void Expand(const wxTreeItemId& item);
1276 void Collapse(const wxTreeItemId& item);
1277 void CollapseAndReset(const wxTreeItemId& item);
1278 void Toggle(const wxTreeItemId& item);
1279
1280 void Unselect();
8bf5d46e 1281 void UnselectAll();
d5c9047a
RD
1282 void SelectItem(const wxTreeItemId& item);
1283 void EnsureVisible(const wxTreeItemId& item);
1284 void ScrollTo(const wxTreeItemId& item);
8bf5d46e 1285#ifdef __WXMSW__
d5c9047a 1286 wxTextCtrl* EditLabel(const wxTreeItemId& item);
d5c9047a 1287 wxTextCtrl* GetEditControl();
b1462dfa 1288 void EndEditLabel(const wxTreeItemId& item, int discardChanges = FALSE);
8bf5d46e
RD
1289#else
1290 void EditLabel(const wxTreeItemId& item);
1291#endif
d5c9047a 1292
d426c97e 1293 void SortChildren(const wxTreeItemId& item);
d5c9047a 1294
b1462dfa 1295 void SetItemBold(const wxTreeItemId& item, int bold = TRUE);
b8b8dda7 1296 bool IsBold(const wxTreeItemId& item) const;
164b735b 1297 wxTreeItemId HitTest(const wxPoint& point, int& OUTPUT);
c127177f 1298
f6bcfd97
BP
1299
1300
b7e72427
RD
1301 void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
1302 void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
1303 void SetItemFont(const wxTreeItemId& item, const wxFont& font);
1304
4120ef2b 1305#ifdef __WXMSW__
b1462dfa 1306 void SetItemDropHighlight(const wxTreeItemId& item, int highlight = TRUE);
74bcba0e 1307#endif
b1462dfa 1308
d426c97e
RD
1309 //bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, int textOnly = FALSE)
1310 %addmethods {
1311 PyObject* GetBoundingRect(const wxTreeItemId& item, int textOnly = FALSE) {
1312 wxRect rect;
164b735b 1313 if (self->GetBoundingRect(item, rect, textOnly)) {
4268f798 1314 wxPyBeginBlockThreads();
164b735b
RD
1315 wxRect* r = new wxRect(rect);
1316 PyObject* val = wxPyConstructObject((void*)r, "wxRect");
4268f798 1317 wxPyEndBlockThreads();
164b735b
RD
1318 return val;
1319 }
d426c97e
RD
1320 else {
1321 Py_INCREF(Py_None);
1322 return Py_None;
1323 }
1324 }
1325 }
74bcba0e 1326
d426c97e 1327
c127177f 1328%pragma(python) addtoclass = "
f6bcfd97
BP
1329 # Redefine some methods that SWIG gets a bit confused on...
1330 def GetFirstChild(self, *_args, **_kwargs):
1331 val1,val2 = apply(controls2c.wxTreeCtrl_GetFirstChild,(self,) + _args, _kwargs)
1332 val1 = wxTreeItemIdPtr(val1)
1333 val1.thisown = 1
1334 return (val1,val2)
1335 def GetNextChild(self, *_args, **_kwargs):
1336 val1,val2 = apply(controls2c.wxTreeCtrl_GetNextChild,(self,) + _args, _kwargs)
c127177f
RD
1337 val1 = wxTreeItemIdPtr(val1)
1338 val1.thisown = 1
1339 return (val1,val2)
f6bcfd97
BP
1340 def HitTest(self, *_args, **_kwargs):
1341 val1, val2 = apply(controls2c.wxTreeCtrl_HitTest,(self,) + _args, _kwargs)
c127177f
RD
1342 val1 = wxTreeItemIdPtr(val1)
1343 val1.thisown = 1
1344 return (val1,val2)
1345"
74bcba0e 1346
d5c9047a
RD
1347};
1348
d5c9047a 1349
7bf85405
RD
1350//----------------------------------------------------------------------
1351
68320e40
RD
1352
1353enum {
1354 wxDIRCTRL_DIR_ONLY,
1355 wxDIRCTRL_SELECT_FIRST,
1356 wxDIRCTRL_SHOW_FILTERS,
1357 wxDIRCTRL_3D_INTERNAL,
7cdaed0b 1358 wxDIRCTRL_EDIT_LABELS,
db0ff83e
RD
1359
1360 wxID_TREECTRL,
1361 wxID_FILTERLISTCTRL,
68320e40
RD
1362};
1363
1364
1365class wxDirItemData : public wxObject // wxTreeItemData
1366{
1367public:
1368 wxDirItemData(const wxString& path, const wxString& name, bool isDir);
1369// ~wxDirItemDataEx();
1370 void SetNewDirName( wxString path );
1371 wxString m_path, m_name;
1372 bool m_isHidden;
1373 bool m_isExpanded;
1374 bool m_isDir;
1375};
1376
1377
1378class wxGenericDirCtrl: public wxControl
1379{
1380public:
1381 wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = -1,
137b5242 1382 const wxString& dir = wxPyDirDialogDefaultFolderStr,
68320e40
RD
1383 const wxPoint& pos = wxDefaultPosition,
1384 const wxSize& size = wxDefaultSize,
1385 long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
137b5242 1386 const wxString& filter = wxPyEmptyString,
68320e40 1387 int defaultFilter = 0,
137b5242 1388 const wxString& name = wxPy_TreeCtrlNameStr);
68320e40
RD
1389 %name(wxPreGenericDirCtrl)wxGenericDirCtrl();
1390
1391 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1392 %pragma(python) addtomethod = "wxPreGenericDirCtrl:val._setOORInfo(val)"
1393
1394 bool Create(wxWindow *parent, const wxWindowID id = -1,
137b5242 1395 const wxString& dir = wxPyDirDialogDefaultFolderStr,
68320e40
RD
1396 const wxPoint& pos = wxDefaultPosition,
1397 const wxSize& size = wxDefaultSize,
1398 long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
137b5242 1399 const wxString& filter = wxPyEmptyString,
68320e40 1400 int defaultFilter = 0,
137b5242 1401 const wxString& name = wxPy_TreeCtrlNameStr);
68320e40
RD
1402
1403
1404 // Try to expand as much of the given path as possible.
1405 bool ExpandPath(const wxString& path);
1406
1407 // Accessors
1408
1409 inline wxString GetDefaultPath() const;
1410 void SetDefaultPath(const wxString& path);
1411
1412 // Get dir or filename
1413 wxString GetPath() const ;
1414
1415 // Get selected filename path only (else empty string).
1416 // I.e. don't count a directory as a selection
1417 wxString GetFilePath() const ;
1418 void SetPath(const wxString& path) ;
1419
1420 void ShowHidden( bool show );
1421 bool GetShowHidden();
1422
1423 wxString GetFilter() const;
1424 void SetFilter(const wxString& filter);
1425
1426 int GetFilterIndex() const;
1427 void SetFilterIndex(int n) ;
1428
1429 wxTreeItemId GetRootId();
1430
1431 wxTreeCtrl* GetTreeCtrl() const;
1432 wxDirFilterListCtrl* GetFilterListCtrl() const;
1433
1434// //// Helpers
1435// void SetupSections();
1436// // Parse the filter into an array of filters and an array of descriptions
1437// int ParseFilter(const wxString& filterStr, wxArrayString& filters, wxArrayString& descriptions);
1438// // Find the child that matches the first part of 'path'.
1439// // E.g. if a child path is "/usr" and 'path' is "/usr/include"
1440// // then the child for /usr is returned.
1441// // If the path string has been used (we're at the leaf), done is set to TRUE
1442// wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);
1443};
1444
1445
1446class wxDirFilterListCtrl: public wxChoice
1447{
1448public:
1449 wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = -1,
1450 const wxPoint& pos = wxDefaultPosition,
1451 const wxSize& size = wxDefaultSize,
1452 long style = 0);
1453 %name(wxPreDirFilterListCtrl)wxDirFilterListCtrl();
1454
1455 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1456 %pragma(python) addtomethod = "wxPreDirFilterListCtrl:val._setOORInfo(val)"
1457
1458 bool Create(wxGenericDirCtrl* parent, const wxWindowID id = -1,
1459 const wxPoint& pos = wxDefaultPosition,
1460 const wxSize& size = wxDefaultSize,
1461 long style = 0);
1462
1463//// Operations
1464 void FillFilterList(const wxString& filter, int defaultFilter);
1465};
1466
1467
1468//----------------------------------------------------------------------
1469//----------------------------------------------------------------------
1470
9416aa89 1471%init %{
a3fbed81 1472 // Map renamed classes back to their common name for OOR
9416aa89
RD
1473 wxPyPtrTypeMap_Add("wxTreeItemData", "wxPyTreeItemData");
1474 wxPyPtrTypeMap_Add("wxTreeCtrl", "wxPyTreeCtrl");
a3fbed81 1475 wxPyPtrTypeMap_Add("wxListCtrl", "wxPyListCtrl");
9416aa89
RD
1476%}
1477
1478//----------------------------------------------------------------------
1479
7bf85405 1480