]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/_treectrl.i
Docstrings
[wxWidgets.git] / wxPython / src / _treectrl.i
CommitLineData
d14a1e28
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: _treectrl.i
3// Purpose: SWIG interface file for wxTreeCtrl and related classes
4//
5// Author: Robin Dunn
6//
7// Created: 10-June-1998
8// RCS-ID: $Id$
9// Copyright: (c) 2002 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
13// Not a %module
14
15
16//---------------------------------------------------------------------------
17
18%{
19#include <wx/treectrl.h>
20#include "wx/wxPython/pytree.h"
d14a1e28 21%}
b2dc1044
RD
22
23MAKE_CONST_WXSTRING2(TreeCtrlNameStr, _T("wxTreeCtrl"));
d14a1e28
RD
24
25//---------------------------------------------------------------------------
26%newgroup
27
28
29// wxTreeCtrl flags
30enum {
31 wxTR_NO_BUTTONS,
32 wxTR_HAS_BUTTONS,
33 wxTR_NO_LINES,
34 wxTR_LINES_AT_ROOT,
35
36 wxTR_SINGLE,
37 wxTR_MULTIPLE,
38 wxTR_EXTENDED,
39 wxTR_HAS_VARIABLE_ROW_HEIGHT,
40
41 wxTR_EDIT_LABELS,
42 wxTR_HIDE_ROOT,
43 wxTR_ROW_LINES,
44
45 wxTR_FULL_ROW_HIGHLIGHT,
46 wxTR_DEFAULT_STYLE,
47
48 wxTR_TWIST_BUTTONS,
49 wxTR_MAC_BUTTONS,
50 wxTR_AQUA_BUTTONS,
51};
52
53
54enum wxTreeItemIcon
55{
56 wxTreeItemIcon_Normal, // not selected, not expanded
57 wxTreeItemIcon_Selected, // selected, not expanded
58 wxTreeItemIcon_Expanded, // not selected, expanded
59 wxTreeItemIcon_SelectedExpanded, // selected, expanded
60 wxTreeItemIcon_Max
61};
62
63
64// constants for HitTest
65enum {
66 wxTREE_HITTEST_ABOVE,
67 wxTREE_HITTEST_BELOW,
68 wxTREE_HITTEST_NOWHERE,
69 wxTREE_HITTEST_ONITEMBUTTON,
70 wxTREE_HITTEST_ONITEMICON,
71 wxTREE_HITTEST_ONITEMINDENT,
72 wxTREE_HITTEST_ONITEMLABEL,
73 wxTREE_HITTEST_ONITEMRIGHT,
74 wxTREE_HITTEST_ONITEMSTATEICON,
75 wxTREE_HITTEST_TOLEFT,
76 wxTREE_HITTEST_TORIGHT,
77 wxTREE_HITTEST_ONITEMUPPERPART,
78 wxTREE_HITTEST_ONITEMLOWERPART,
79 wxTREE_HITTEST_ONITEM
80};
81
82//---------------------------------------------------------------------------
83%newgroup
84
d14a1e28
RD
85
86// wxTreeItemId identifies an element of the tree. In this implementation, it's
87// just a trivial wrapper around Win32 HTREEITEM or a pointer to some private
88// data structure in the generic version. It's opaque for the application and
89// the only method which can be used by user code is IsOk().
90class wxTreeItemId {
91public:
92 wxTreeItemId();
93 ~wxTreeItemId();
94
95 // is this a valid tree item?
96 bool IsOk() const;
97
98 %extend {
22faec7d
RD
99 bool __eq__(const wxTreeItemId* other) { return other ? (*self == *other) : False; }
100 bool __ne__(const wxTreeItemId* other) { return other ? (*self != *other) : True; }
d14a1e28
RD
101 }
102
5d895c0b 103 void* m_pItem;
d14a1e28
RD
104
105
106 %pythoncode {
107 Ok = IsOk
108 def __nonzero__(self): return self.IsOk() }
109};
110
111
112
113
114// wxTreeItemData is some (arbitrary) user data associated with some tree
115// item. The Python version is just a simple wrapper around a Python object
116// that knows how to handle references properly. Using this class directly in
117// Python code should rarely be neccessary. Just use the GetItemPyData and
118// SetItemPyData tree methods instead of the GetItemData and SetItemData
119// methods.
120%name(TreeItemData) class wxPyTreeItemData {
121public:
122 wxPyTreeItemData(PyObject* obj = NULL);
123
124 PyObject* GetData();
125 void SetData(PyObject* obj);
126
127 const wxTreeItemId& GetId();
128 void SetId(const wxTreeItemId& id);
129
130 %extend { void Destroy() { delete self; } }
131};
132
133
134
135#if 0 // it's not currently used anywhere...
136
137// wxTreeItemAttr: a structure containing the visual attributes of an item
138class wxTreeItemAttr
139{
140public:
141 // ctors
142 //wxTreeItemAttr() { }
143 wxTreeItemAttr(const wxColour& colText = wxNullColour,
144 const wxColour& colBack = wxNullColour,
145 const wxFont& font = wxNullFont);
146
147 // setters
148 void SetTextColour(const wxColour& colText);
149 void SetBackgroundColour(const wxColour& colBack);
150 void SetFont(const wxFont& font);
151
152 // accessors
153 bool HasTextColour();
154 bool HasBackgroundColour();
155 bool HasFont();
156
157 wxColour GetTextColour();
158 wxColour GetBackgroundColour();
159 wxFont GetFont();
160
161 %extend { void Destroy() { delete self; } }
162};
163
164#endif
165
166
167//---------------------------------------------------------------------------
168%newgroup
169
170/* Tree control event types */
171%constant wxEventType wxEVT_COMMAND_TREE_BEGIN_DRAG;
172%constant wxEventType wxEVT_COMMAND_TREE_BEGIN_RDRAG;
173%constant wxEventType wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
174%constant wxEventType wxEVT_COMMAND_TREE_END_LABEL_EDIT;
175%constant wxEventType wxEVT_COMMAND_TREE_DELETE_ITEM;
176%constant wxEventType wxEVT_COMMAND_TREE_GET_INFO;
177%constant wxEventType wxEVT_COMMAND_TREE_SET_INFO;
178%constant wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDED;
179%constant wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDING;
180%constant wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
181%constant wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
182%constant wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED;
183%constant wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING;
184%constant wxEventType wxEVT_COMMAND_TREE_KEY_DOWN;
185%constant wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED;
186%constant wxEventType wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
187%constant wxEventType wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK;
188%constant wxEventType wxEVT_COMMAND_TREE_END_DRAG;
189%constant wxEventType wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
3f0ff538 190%constant wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;
d14a1e28
RD
191
192
193%pythoncode {
194
195EVT_TREE_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG , 1)
196EVT_TREE_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG , 1)
197EVT_TREE_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT , 1)
198EVT_TREE_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_LABEL_EDIT , 1)
199EVT_TREE_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_TREE_DELETE_ITEM , 1)
200EVT_TREE_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_GET_INFO , 1)
201EVT_TREE_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_SET_INFO , 1)
202EVT_TREE_ITEM_EXPANDED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDED , 1)
203EVT_TREE_ITEM_EXPANDING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDING , 1)
204EVT_TREE_ITEM_COLLAPSED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSED , 1)
205EVT_TREE_ITEM_COLLAPSING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSING , 1)
206EVT_TREE_SEL_CHANGED = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGED , 1)
207EVT_TREE_SEL_CHANGING = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGING , 1)
208EVT_TREE_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_TREE_KEY_DOWN , 1)
209EVT_TREE_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_ACTIVATED , 1)
210EVT_TREE_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK , 1)
211EVT_TREE_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 1)
212EVT_TREE_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG , 1)
213EVT_TREE_STATE_IMAGE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 1)
3f0ff538 214EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, 1)
d14a1e28
RD
215}
216
217
218
219// wxTreeEvent is a special class for all events associated with tree controls
220//
221// NB: note that not all accessors make sense for all events, see the event
222// descriptions below
223class wxTreeEvent : public wxNotifyEvent {
224public:
225 wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
226
227 // get the item on which the operation was performed or the newly
228 // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
229 wxTreeItemId GetItem() const;
230 void SetItem(const wxTreeItemId& item);
231
232 // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
233 // selected item
234 wxTreeItemId GetOldItem() const;
235 void SetOldItem(const wxTreeItemId& item);
236
237 // the point where the mouse was when the drag operation started (for
238 // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
239 wxPoint GetPoint() const;
240 void SetPoint(const wxPoint& pt);
241
242 // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
243 const wxKeyEvent& GetKeyEvent() const;
244 int GetKeyCode() const;
245 void SetKeyEvent(const wxKeyEvent& evt);
246
247 // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
248 const wxString& GetLabel() const;
249 void SetLabel(const wxString& label);
250
251 // edit cancel flag (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
252 bool IsEditCancelled() const;
253 void SetEditCanceled(bool editCancelled);
254
3f0ff538
RD
255 // Set the tooltip for the item (for EVT_TREE_ITEM_GETTOOLTIP events)
256 void SetToolTip(const wxString& toolTip);
d14a1e28
RD
257};
258
259//---------------------------------------------------------------------------
260%newgroup
261
262%{ // C++ version of Python aware wxTreeCtrl
263class wxPyTreeCtrl : public wxTreeCtrl {
264 DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl);
265public:
266 wxPyTreeCtrl() : wxTreeCtrl() {}
267 wxPyTreeCtrl(wxWindow *parent, wxWindowID id,
268 const wxPoint& pos,
269 const wxSize& size,
270 long style,
271 const wxValidator& validator,
272 const wxString& name) :
273 wxTreeCtrl(parent, id, pos, size, style, validator, name) {}
274
275 bool Create(wxWindow *parent, wxWindowID id,
276 const wxPoint& pos,
277 const wxSize& size,
278 long style,
279 const wxValidator& validator,
280 const wxString& name) {
281 return wxTreeCtrl::Create(parent, id, pos, size, style, validator, name);
282 }
283
284
285 int OnCompareItems(const wxTreeItemId& item1,
286 const wxTreeItemId& item2) {
287 int rval = 0;
288 bool found;
da32eb53 289 bool blocked = wxPyBeginBlockThreads();
d14a1e28 290 if ((found = wxPyCBH_findCallback(m_myInst, "OnCompareItems"))) {
dd9f7fea
RD
291 PyObject *o1 = wxPyConstructObject((void*)&item1, wxT("wxTreeItemId"), False);
292 PyObject *o2 = wxPyConstructObject((void*)&item2, wxT("wxTreeItemId"), False);
d14a1e28
RD
293 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)",o1,o2));
294 Py_DECREF(o1);
295 Py_DECREF(o2);
296 }
da32eb53 297 wxPyEndBlockThreads(blocked);
d14a1e28
RD
298 if (! found)
299 rval = wxTreeCtrl::OnCompareItems(item1, item2);
300 return rval;
301 }
302 PYPRIVATE;
303};
304
305IMPLEMENT_ABSTRACT_CLASS(wxPyTreeCtrl, wxTreeCtrl);
306
307%}
308
309
310
311
312%name(TreeCtrl)class wxPyTreeCtrl : public wxControl {
313public:
2b9048c5
RD
314 %pythonAppend wxPyTreeCtrl "self._setOORInfo(self);self._setCallbackInfo(self, TreeCtrl)"
315 %pythonAppend wxPyTreeCtrl() ""
d14a1e28
RD
316
317 wxPyTreeCtrl(wxWindow *parent, wxWindowID id = -1,
318 const wxPoint& pos = wxDefaultPosition,
319 const wxSize& size = wxDefaultSize,
320 long style = wxTR_DEFAULT_STYLE,
321 const wxValidator& validator = wxDefaultValidator,
b2dc1044 322 const wxString& name = wxPyTreeCtrlNameStr);
d14a1e28
RD
323 %name(PreTreeCtrl)wxPyTreeCtrl();
324
325 bool Create(wxWindow *parent, wxWindowID id = -1,
326 const wxPoint& pos = wxDefaultPosition,
327 const wxSize& size = wxDefaultSize,
328 long style = wxTR_DEFAULT_STYLE,
329 const wxValidator& validator = wxDefaultValidator,
b2dc1044 330 const wxString& name = wxPyTreeCtrlNameStr);
d14a1e28
RD
331
332 void _setCallbackInfo(PyObject* self, PyObject* _class);
333
334
335 // get the total number of items in the control
336 size_t GetCount() const;
337
338 // indent is the number of pixels the children are indented relative to
339 // the parents position. SetIndent() also redraws the control
340 // immediately.
341 unsigned int GetIndent() const;
342 void SetIndent(unsigned int indent);
343
344 // spacing is the number of pixels between the start and the Text
345 // not implemented under wxMSW
346 unsigned int GetSpacing() const;
347 void SetSpacing(unsigned int spacing);
348
349
350 // image list: these functions allow to associate an image list with
351 // the control and retrieve it. Note that the control does _not_ delete
352 // the associated image list when it's deleted in order to allow image
353 // lists to be shared between different controls.
354 //
355 // The normal image list is for the icons which correspond to the
356 // normal tree item state (whether it is selected or not).
357 // Additionally, the application might choose to show a state icon
358 // which corresponds to an app-defined item state (for example,
359 // checked/unchecked) which are taken from the state image list.
360 wxImageList *GetImageList() const;
361 wxImageList *GetStateImageList() const;
362
363 void SetImageList(wxImageList *imageList);
364 void SetStateImageList(wxImageList *imageList);
365
8668c242 366 %apply SWIGTYPE *DISOWN { wxImageList *imageList };
d14a1e28
RD
367 void AssignImageList(wxImageList *imageList);
368 void AssignStateImageList(wxImageList *imageList);
8668c242 369 %clear wxImageList *imageList;
d14a1e28
RD
370
371
372 // retrieve items label
373 wxString GetItemText(const wxTreeItemId& item) const;
374
375 // get one of the images associated with the item (normal by default)
376 int GetItemImage(const wxTreeItemId& item,
377 wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
378
379 %extend {
380 // get the wxPyTreeItemData associated with the tree item
381 wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
382 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
383 if (data == NULL) {
384 data = new wxPyTreeItemData();
385 data->SetId(item); // set the id
386 self->SetItemData(item, data);
387 }
388 return data;
389 }
390 // Get the Python object associated with the tree item
391 PyObject* GetItemPyData(const wxTreeItemId& item) {
392 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
393 if (data == NULL) {
394 data = new wxPyTreeItemData();
395 data->SetId(item); // set the id
396 self->SetItemData(item, data);
397 }
398 return data->GetData();
399 }
400 }
401 %pythoncode { GetPyData = GetItemPyData }
402
403
404 // get the item's text colour
405 wxColour GetItemTextColour(const wxTreeItemId& item) const;
406
407 // get the item's background colour
408 wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
409
410 // get the item's font
411 wxFont GetItemFont(const wxTreeItemId& item) const;
412
413
414
415 // set items label
416 void SetItemText(const wxTreeItemId& item, const wxString& text);
417
418 // get one of the images associated with the item (normal by default)
419 void SetItemImage(const wxTreeItemId& item, int image,
420 wxTreeItemIcon which = wxTreeItemIcon_Normal);
421
422 %extend {
423 // associate a wxPyTreeItemData with the tree item
424 void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
425 data->SetId(item); // set the id
426 self->SetItemData(item, data);
427 }
428
429 // associate a Python object with the tree item
430 void SetItemPyData(const wxTreeItemId& item, PyObject* obj) {
431 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
432 if (data == NULL) {
433 data = new wxPyTreeItemData(obj);
434 data->SetId(item); // set the id
435 self->SetItemData(item, data);
436 } else
437 data->SetData(obj);
438 }
439 }
440 %pythoncode { SetPyData = SetItemPyData }
441
442
443 // force appearance of [+] button near the item. This is useful to
444 // allow the user to expand the items which don't have any children now
445 // - but instead add them only when needed, thus minimizing memory
446 // usage and loading time.
dd9f7fea 447 void SetItemHasChildren(const wxTreeItemId& item, bool has = True);
d14a1e28
RD
448
449 // the item will be shown in bold
dd9f7fea 450 void SetItemBold(const wxTreeItemId& item, bool bold = True);
d14a1e28
RD
451
452#ifdef __WXMSW__
453 // the item will be shown with a drop highlight
dd9f7fea 454 void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = True);
d14a1e28
RD
455#endif
456
457 // set the items text colour
458 void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
459
460 // set the items background colour
461 void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
462
463 // set the items font (should be of the same height for all items)
464 void SetItemFont(const wxTreeItemId& item, const wxFont& font);
465
466
467 // is the item visible (it might be outside the view or not expanded)?
468 bool IsVisible(const wxTreeItemId& item) const;
469
470 // does the item has any children?
471 bool ItemHasChildren(const wxTreeItemId& item) const;
472
473 // is the item expanded (only makes sense if HasChildren())?
474 bool IsExpanded(const wxTreeItemId& item) const;
475
476 // is this item currently selected (the same as has focus)?
477 bool IsSelected(const wxTreeItemId& item) const;
478
479 // is item text in bold font?
480 bool IsBold(const wxTreeItemId& item) const;
481
482
dd9f7fea 483 // if 'recursively' is False, only immediate children count, otherwise
d14a1e28
RD
484 // the returned number is the number of all items in this branch
485 size_t GetChildrenCount(const wxTreeItemId& item,
dd9f7fea 486 bool recursively = True) /*const*/;
d14a1e28
RD
487
488
489
490 // get the root tree item
dd9f7fea 491 // wxTreeItemId.IsOk() will return False if there is no such item
d14a1e28
RD
492 wxTreeItemId GetRootItem() const;
493
494 // get the item currently selected
dd9f7fea 495 // wxTreeItemId.IsOk() will return False if there is no such item
d14a1e28
RD
496 wxTreeItemId GetSelection() const;
497
498 %extend {
499 // get the items currently selected, return the number of such item
500 //
501 // NB: this operation is expensive and can take a long time for a
502 // control with a lot of items (~ O(number of items)).
503 PyObject* GetSelections() {
da32eb53 504 bool blocked = wxPyBeginBlockThreads();
d14a1e28
RD
505 PyObject* rval = PyList_New(0);
506 wxArrayTreeItemIds array;
507 size_t num, x;
508 num = self->GetSelections(array);
509 for (x=0; x < num; x++) {
510 wxTreeItemId *tii = new wxTreeItemId(array.Item(x));
dd9f7fea 511 PyObject* item = wxPyConstructObject((void*)tii, wxT("wxTreeItemId"), True);
d14a1e28 512 PyList_Append(rval, item);
ad411ab2 513 Py_DECREF(item);
d14a1e28 514 }
da32eb53 515 wxPyEndBlockThreads(blocked);
d14a1e28
RD
516 return rval;
517 }
518 }
519
520 // get the parent of this item
dd9f7fea 521 // wxTreeItemId.IsOk() will return False if there is no such item
d14a1e28
RD
522 wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
523
524
525 %extend {
526 // Get the first child of this item. Returns a wxTreeItemId and an
527 // opaque "cookie" value that should be passed to GetNextChild in
528 // order to continue the search.
529 PyObject* GetFirstChild(const wxTreeItemId& item) {
5d895c0b
RD
530 void* cookie = 0;
531 wxTreeItemId* ritem = new wxTreeItemId(self->GetFirstChild(item, cookie));
da32eb53 532 bool blocked = wxPyBeginBlockThreads();
d14a1e28 533 PyObject* tup = PyTuple_New(2);
5d895c0b
RD
534 PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), True));
535 PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
da32eb53 536 wxPyEndBlockThreads(blocked);
d14a1e28
RD
537 return tup;
538 }
539
540
541 // Get the next child of this item. The cookie parameter is the 2nd
542 // value returned from GetFirstChild or the previous GetNextChild.
543 // Returns a wxTreeItemId and an opaque "cookie" value that should be
544 // passed to GetNextChild in order to continue the search.
5d895c0b
RD
545 PyObject* GetNextChild(const wxTreeItemId& item, void* cookie) {
546 wxTreeItemId* ritem = new wxTreeItemId(self->GetNextChild(item, cookie));
da32eb53 547 bool blocked = wxPyBeginBlockThreads();
d14a1e28 548 PyObject* tup = PyTuple_New(2);
5d895c0b
RD
549 PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), True));
550 PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
da32eb53 551 wxPyEndBlockThreads(blocked);
d14a1e28
RD
552 return tup;
553 }
554 }
555
556 // get the last child of this item
557 wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
558
559 // get the next sibling of this item
560 wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
561
562 // get the previous sibling
563 wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
564
565 // get first visible item
566 wxTreeItemId GetFirstVisibleItem() const;
567
568 // get the next visible item: item must be visible itself!
569 // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
570 wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
571
572 // get the previous visible item: item must be visible itself!
573 wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
574
575
576
577 // add the root node to the tree
578 wxTreeItemId AddRoot(const wxString& text,
579 int image = -1, int selectedImage = -1,
580 wxPyTreeItemData *data = NULL);
581
582 // insert a new item in as the first child of the parent
583 wxTreeItemId PrependItem(const wxTreeItemId& parent,
584 const wxString& text,
585 int image = -1, int selectedImage = -1,
586 wxPyTreeItemData *data = NULL);
587
588 // insert a new item after a given one
589 wxTreeItemId InsertItem(const wxTreeItemId& parent,
590 const wxTreeItemId& idPrevious,
591 const wxString& text,
592 int image = -1, int selectedImage = -1,
593 wxPyTreeItemData *data = NULL);
594
595 // insert a new item before the one with the given index
596 %name(InsertItemBefore)
597 wxTreeItemId InsertItem(const wxTreeItemId& parent,
598 size_t index,
599 const wxString& text,
600 int image = -1, int selectedImage = -1,
601 wxPyTreeItemData *data = NULL);
602
603 // insert a new item in as the last child of the parent
604 wxTreeItemId AppendItem(const wxTreeItemId& parent,
605 const wxString& text,
606 int image = -1, int selectedImage = -1,
607 wxPyTreeItemData *data = NULL);
608
609
610
611 // delete this item and associated data if any
612 void Delete(const wxTreeItemId& item);
613
614 // delete all children (but don't delete the item itself)
615 // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
616 void DeleteChildren(const wxTreeItemId& item);
617
618 // delete all items from the tree
619 // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
620 void DeleteAllItems();
621
622
623 // expand this item
624 void Expand(const wxTreeItemId& item);
625
626 // collapse the item without removing its children
627 void Collapse(const wxTreeItemId& item);
628
629 // collapse the item and remove all children
630 void CollapseAndReset(const wxTreeItemId& item);
631
632 // toggles the current state
633 void Toggle(const wxTreeItemId& item);
634
635
636 // remove the selection from currently selected item (if any)
637 void Unselect();
638
b159c5c4
RD
639 // remove the selection from the given one (multiselect mode only)
640 void UnselectItem(const wxTreeItemId& item);
641
d14a1e28
RD
642 // unselect all items (only makes sense for multiple selection control)
643 void UnselectAll();
644
645 // select this item
b159c5c4
RD
646 void SelectItem(const wxTreeItemId& item, bool select = True);
647
648 // toggle the item selection
649 void ToggleItemSelection(const wxTreeItemId& item);
d14a1e28 650
b159c5c4 651
d14a1e28
RD
652 // make sure this item is visible (expanding the parent item and/or
653 // scrolling to this item if necessary)
654 void EnsureVisible(const wxTreeItemId& item);
655
656 // scroll to this item (but don't expand its parent)
657 void ScrollTo(const wxTreeItemId& item);
658
659
660
661 // start editing the item label: this (temporarily) replaces the item
662 // with a one line edit control. The item will be selected if it hadn't
663 // been before.
664 /**wxTextCtrl* */ void EditLabel(const wxTreeItemId& item);
665
666 // returns the same pointer as StartEdit() if the item is being edited,
667 // NULL otherwise (it's assumed that no more than one item may be
668 // edited simultaneously)
669 wxTextCtrl* GetEditControl() const;
670
671#ifdef __WXMSW__
672 // end editing and accept or discard the changes to item label
dd9f7fea 673 void EndEditLabel(const wxTreeItemId& item, bool discardChanges = False);
d14a1e28
RD
674#endif
675
676
677 // Sort the children of this item using OnCompareItems, a member function
678 // that is called to compare 2 items and should return -1, 0 or +1 if the
679 // first item is less than, equal to or greater than the second one. The
680 // base class version performs alphabetic comparaison of item labels
681 // (GetText)
682 void SortChildren(const wxTreeItemId& item);
683
684
685
322913ce
RD
686 DocDeclAStr(
687 wxTreeItemId, HitTest(const wxPoint& point, int& OUTPUT),
688 "HitTest(Point point) -> (item, where)",
d07d2bc9
RD
689 "Determine which item (if any) belongs the given point. The coordinates
690specified are relative to the client area of tree ctrl and the where return
691value is set to a bitmask of wxTREE_HITTEST_xxx constants.
692", "");
d14a1e28
RD
693
694
695 %extend {
696 // get the bounding rectangle of the item (or of its label only)
dd9f7fea 697 PyObject* GetBoundingRect(const wxTreeItemId& item, bool textOnly = False) {
d14a1e28
RD
698 wxRect rect;
699 if (self->GetBoundingRect(item, rect, textOnly)) {
da32eb53 700 bool blocked = wxPyBeginBlockThreads();
d14a1e28 701 wxRect* r = new wxRect(rect);
dd9f7fea 702 PyObject* val = wxPyConstructObject((void*)r, wxT("wxRect"), True);
da32eb53 703 wxPyEndBlockThreads(blocked);
d14a1e28
RD
704 return val;
705 }
706 else
707 RETURN_NONE();
708 }
709 }
710
711
174051f6
RD
712 static wxVisualAttributes
713 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
d14a1e28
RD
714};
715
716
717//---------------------------------------------------------------------------
718%init %{
719 // Map renamed classes back to their common name for OOR
720 wxPyPtrTypeMap_Add("wxTreeItemData", "wxPyTreeItemData");
721 wxPyPtrTypeMap_Add("wxTreeCtrl", "wxPyTreeCtrl");
722%}
723//---------------------------------------------------------------------------