]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/_treectrl.i
Removed some old, outdated, unfinished, or unstarted docs and the
[wxWidgets.git] / wxPython / src / _treectrl.i
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"
21 %}
22
23 MAKE_CONST_WXSTRING2(TreeCtrlNameStr, _T("wxTreeCtrl"));
24
25 //---------------------------------------------------------------------------
26 %newgroup
27
28
29 // wxTreeCtrl flags
30 enum {
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
54 enum 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
65 enum {
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
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().
90 class wxTreeItemId {
91 public:
92 wxTreeItemId();
93 ~wxTreeItemId();
94
95 // is this a valid tree item?
96 bool IsOk() const;
97
98 %extend {
99 bool __eq__(const wxTreeItemId* other) { return other ? (*self == *other) : False; }
100 bool __ne__(const wxTreeItemId* other) { return other ? (*self != *other) : True; }
101 }
102
103 void* m_pItem;
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 {
121 public:
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
138 class wxTreeItemAttr
139 {
140 public:
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;
190 %constant wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;
191
192
193 %pythoncode {
194
195 EVT_TREE_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG , 1)
196 EVT_TREE_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG , 1)
197 EVT_TREE_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT , 1)
198 EVT_TREE_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_LABEL_EDIT , 1)
199 EVT_TREE_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_TREE_DELETE_ITEM , 1)
200 EVT_TREE_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_GET_INFO , 1)
201 EVT_TREE_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_SET_INFO , 1)
202 EVT_TREE_ITEM_EXPANDED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDED , 1)
203 EVT_TREE_ITEM_EXPANDING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDING , 1)
204 EVT_TREE_ITEM_COLLAPSED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSED , 1)
205 EVT_TREE_ITEM_COLLAPSING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSING , 1)
206 EVT_TREE_SEL_CHANGED = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGED , 1)
207 EVT_TREE_SEL_CHANGING = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGING , 1)
208 EVT_TREE_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_TREE_KEY_DOWN , 1)
209 EVT_TREE_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_ACTIVATED , 1)
210 EVT_TREE_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK , 1)
211 EVT_TREE_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 1)
212 EVT_TREE_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG , 1)
213 EVT_TREE_STATE_IMAGE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 1)
214 EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, 1)
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
223 class wxTreeEvent : public wxNotifyEvent {
224 public:
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
255 // Set the tooltip for the item (for EVT_TREE_ITEM_GETTOOLTIP events)
256 void SetToolTip(const wxString& toolTip);
257 };
258
259 //---------------------------------------------------------------------------
260 %newgroup
261
262 %{ // C++ version of Python aware wxTreeCtrl
263 class wxPyTreeCtrl : public wxTreeCtrl {
264 DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl);
265 public:
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;
289 bool blocked = wxPyBeginBlockThreads();
290 if ((found = wxPyCBH_findCallback(m_myInst, "OnCompareItems"))) {
291 PyObject *o1 = wxPyConstructObject((void*)&item1, wxT("wxTreeItemId"), False);
292 PyObject *o2 = wxPyConstructObject((void*)&item2, wxT("wxTreeItemId"), False);
293 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)",o1,o2));
294 Py_DECREF(o1);
295 Py_DECREF(o2);
296 }
297 wxPyEndBlockThreads(blocked);
298 if (! found)
299 rval = wxTreeCtrl::OnCompareItems(item1, item2);
300 return rval;
301 }
302 PYPRIVATE;
303 };
304
305 IMPLEMENT_ABSTRACT_CLASS(wxPyTreeCtrl, wxTreeCtrl);
306
307 %}
308
309
310
311
312 %name(TreeCtrl)class wxPyTreeCtrl : public wxControl {
313 public:
314 %pythonAppend wxPyTreeCtrl "self._setOORInfo(self);self._setCallbackInfo(self, TreeCtrl)"
315 %pythonAppend wxPyTreeCtrl() ""
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,
322 const wxString& name = wxPyTreeCtrlNameStr);
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,
330 const wxString& name = wxPyTreeCtrlNameStr);
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
366 %apply SWIGTYPE *DISOWN { wxImageList *imageList };
367 void AssignImageList(wxImageList *imageList);
368 void AssignStateImageList(wxImageList *imageList);
369 %clear wxImageList *imageList;
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.
447 void SetItemHasChildren(const wxTreeItemId& item, bool has = True);
448
449 // the item will be shown in bold
450 void SetItemBold(const wxTreeItemId& item, bool bold = True);
451
452 #ifdef __WXMSW__
453 // the item will be shown with a drop highlight
454 void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = True);
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
483 // if 'recursively' is False, only immediate children count, otherwise
484 // the returned number is the number of all items in this branch
485 size_t GetChildrenCount(const wxTreeItemId& item,
486 bool recursively = True) /*const*/;
487
488
489
490 // get the root tree item
491 // wxTreeItemId.IsOk() will return False if there is no such item
492 wxTreeItemId GetRootItem() const;
493
494 // get the item currently selected
495 // wxTreeItemId.IsOk() will return False if there is no such item
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() {
504 bool blocked = wxPyBeginBlockThreads();
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));
511 PyObject* item = wxPyConstructObject((void*)tii, wxT("wxTreeItemId"), True);
512 PyList_Append(rval, item);
513 }
514 wxPyEndBlockThreads(blocked);
515 return rval;
516 }
517 }
518
519 // get the parent of this item
520 // wxTreeItemId.IsOk() will return False if there is no such item
521 wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
522
523
524 %extend {
525 // Get the first child of this item. Returns a wxTreeItemId and an
526 // opaque "cookie" value that should be passed to GetNextChild in
527 // order to continue the search.
528 PyObject* GetFirstChild(const wxTreeItemId& item) {
529 void* cookie = 0;
530 wxTreeItemId* ritem = new wxTreeItemId(self->GetFirstChild(item, cookie));
531 bool blocked = wxPyBeginBlockThreads();
532 PyObject* tup = PyTuple_New(2);
533 PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), True));
534 PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
535 wxPyEndBlockThreads(blocked);
536 return tup;
537 }
538
539
540 // Get the next child of this item. The cookie parameter is the 2nd
541 // value returned from GetFirstChild or the previous GetNextChild.
542 // Returns a wxTreeItemId and an opaque "cookie" value that should be
543 // passed to GetNextChild in order to continue the search.
544 PyObject* GetNextChild(const wxTreeItemId& item, void* cookie) {
545 wxTreeItemId* ritem = new wxTreeItemId(self->GetNextChild(item, cookie));
546 bool blocked = wxPyBeginBlockThreads();
547 PyObject* tup = PyTuple_New(2);
548 PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), True));
549 PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
550 wxPyEndBlockThreads(blocked);
551 return tup;
552 }
553 }
554
555 // get the last child of this item
556 wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
557
558 // get the next sibling of this item
559 wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
560
561 // get the previous sibling
562 wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
563
564 // get first visible item
565 wxTreeItemId GetFirstVisibleItem() const;
566
567 // get the next visible item: item must be visible itself!
568 // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
569 wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
570
571 // get the previous visible item: item must be visible itself!
572 wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
573
574
575
576 // add the root node to the tree
577 wxTreeItemId AddRoot(const wxString& text,
578 int image = -1, int selectedImage = -1,
579 wxPyTreeItemData *data = NULL);
580
581 // insert a new item in as the first child of the parent
582 wxTreeItemId PrependItem(const wxTreeItemId& parent,
583 const wxString& text,
584 int image = -1, int selectedImage = -1,
585 wxPyTreeItemData *data = NULL);
586
587 // insert a new item after a given one
588 wxTreeItemId InsertItem(const wxTreeItemId& parent,
589 const wxTreeItemId& idPrevious,
590 const wxString& text,
591 int image = -1, int selectedImage = -1,
592 wxPyTreeItemData *data = NULL);
593
594 // insert a new item before the one with the given index
595 %name(InsertItemBefore)
596 wxTreeItemId InsertItem(const wxTreeItemId& parent,
597 size_t index,
598 const wxString& text,
599 int image = -1, int selectedImage = -1,
600 wxPyTreeItemData *data = NULL);
601
602 // insert a new item in as the last child of the parent
603 wxTreeItemId AppendItem(const wxTreeItemId& parent,
604 const wxString& text,
605 int image = -1, int selectedImage = -1,
606 wxPyTreeItemData *data = NULL);
607
608
609
610 // delete this item and associated data if any
611 void Delete(const wxTreeItemId& item);
612
613 // delete all children (but don't delete the item itself)
614 // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
615 void DeleteChildren(const wxTreeItemId& item);
616
617 // delete all items from the tree
618 // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
619 void DeleteAllItems();
620
621
622 // expand this item
623 void Expand(const wxTreeItemId& item);
624
625 // collapse the item without removing its children
626 void Collapse(const wxTreeItemId& item);
627
628 // collapse the item and remove all children
629 void CollapseAndReset(const wxTreeItemId& item);
630
631 // toggles the current state
632 void Toggle(const wxTreeItemId& item);
633
634
635 // remove the selection from currently selected item (if any)
636 void Unselect();
637
638 // remove the selection from the given one (multiselect mode only)
639 void UnselectItem(const wxTreeItemId& item);
640
641 // unselect all items (only makes sense for multiple selection control)
642 void UnselectAll();
643
644 // select this item
645 void SelectItem(const wxTreeItemId& item, bool select = True);
646
647 // toggle the item selection
648 void ToggleItemSelection(const wxTreeItemId& item);
649
650
651 // make sure this item is visible (expanding the parent item and/or
652 // scrolling to this item if necessary)
653 void EnsureVisible(const wxTreeItemId& item);
654
655 // scroll to this item (but don't expand its parent)
656 void ScrollTo(const wxTreeItemId& item);
657
658
659
660 // start editing the item label: this (temporarily) replaces the item
661 // with a one line edit control. The item will be selected if it hadn't
662 // been before.
663 /**wxTextCtrl* */ void EditLabel(const wxTreeItemId& item);
664
665 // returns the same pointer as StartEdit() if the item is being edited,
666 // NULL otherwise (it's assumed that no more than one item may be
667 // edited simultaneously)
668 wxTextCtrl* GetEditControl() const;
669
670 #ifdef __WXMSW__
671 // end editing and accept or discard the changes to item label
672 void EndEditLabel(const wxTreeItemId& item, bool discardChanges = False);
673 #endif
674
675
676 // Sort the children of this item using OnCompareItems, a member function
677 // that is called to compare 2 items and should return -1, 0 or +1 if the
678 // first item is less than, equal to or greater than the second one. The
679 // base class version performs alphabetic comparaison of item labels
680 // (GetText)
681 void SortChildren(const wxTreeItemId& item);
682
683
684
685 DocDeclAStr(
686 wxTreeItemId, HitTest(const wxPoint& point, int& OUTPUT),
687 "HitTest(Point point) -> (item, where)",
688 "Determine which item (if any) belongs the given point. The\n"
689 "coordinates specified are relative to the client area of tree ctrl\n"
690 "and the where return value is set to a bitmask of wxTREE_HITTEST_xxx\n"
691 "constants.\n");
692
693
694 %extend {
695 // get the bounding rectangle of the item (or of its label only)
696 PyObject* GetBoundingRect(const wxTreeItemId& item, bool textOnly = False) {
697 wxRect rect;
698 if (self->GetBoundingRect(item, rect, textOnly)) {
699 bool blocked = wxPyBeginBlockThreads();
700 wxRect* r = new wxRect(rect);
701 PyObject* val = wxPyConstructObject((void*)r, wxT("wxRect"), True);
702 wxPyEndBlockThreads(blocked);
703 return val;
704 }
705 else
706 RETURN_NONE();
707 }
708 }
709
710
711 };
712
713
714 //---------------------------------------------------------------------------
715 %init %{
716 // Map renamed classes back to their common name for OOR
717 wxPyPtrTypeMap_Add("wxTreeItemData", "wxPyTreeItemData");
718 wxPyPtrTypeMap_Add("wxTreeCtrl", "wxPyTreeCtrl");
719 %}
720 //---------------------------------------------------------------------------