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