1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: More control (widget) classes for wxPython
9 // Copyright: (c) 1998 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
20 #include <wx/listctrl.h>
21 #include <wx/treectrl.h>
22 #include <wx/imaglist.h>
23 #include <wx/dirctrl.h>
26 //----------------------------------------------------------------------
29 %include my_typemaps.i
31 // Import some definitions of other classes, etc.
39 %pragma(python) code = "import wx"
42 //----------------------------------------------------------------------
43 //----------------------------------------------------------------------
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,
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,
68 wxEVT_COMMAND_LIST_ITEM_FOCUSED,
72 %pragma(python) code = "
73 def EVT_LIST_BEGIN_DRAG(win, id, func):
74 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_DRAG, func)
76 def EVT_LIST_BEGIN_RDRAG(win, id, func):
77 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_RDRAG, func)
79 def EVT_LIST_BEGIN_LABEL_EDIT(win, id, func):
80 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, func)
82 def EVT_LIST_END_LABEL_EDIT(win, id, func):
83 win.Connect(id, -1, wxEVT_COMMAND_LIST_END_LABEL_EDIT, func)
85 def EVT_LIST_DELETE_ITEM(win, id, func):
86 win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ITEM, func)
88 def EVT_LIST_DELETE_ALL_ITEMS(win, id, func):
89 win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, func)
91 def EVT_LIST_GET_INFO(win, id, func):
92 win.Connect(id, -1, wxEVT_COMMAND_LIST_GET_INFO, func)
94 def EVT_LIST_SET_INFO(win, id, func):
95 win.Connect(id, -1, wxEVT_COMMAND_LIST_SET_INFO, func)
97 def EVT_LIST_ITEM_SELECTED(win, id, func):
98 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_SELECTED, func)
100 def EVT_LIST_ITEM_DESELECTED(win, id, func):
101 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_DESELECTED, func)
103 def EVT_LIST_KEY_DOWN(win, id, func):
104 win.Connect(id, -1, wxEVT_COMMAND_LIST_KEY_DOWN, func)
106 def EVT_LIST_INSERT_ITEM(win, id, func):
107 win.Connect(id, -1, wxEVT_COMMAND_LIST_INSERT_ITEM, func)
109 def EVT_LIST_COL_CLICK(win, id, func):
110 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_CLICK, func)
112 def EVT_LIST_COL_RIGHT_CLICK(win, id, func):
113 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_RIGHT_CLICK, func)
115 def EVT_LIST_COL_BEGIN_DRAG(win, id, func):
116 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_BEGIN_DRAG, func)
118 def EVT_LIST_COL_DRAGGING(win, id, func):
119 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_DRAGGING, func)
121 def EVT_LIST_COL_END_DRAG(win, id, func):
122 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_END_DRAG, func)
124 def EVT_LIST_ITEM_RIGHT_CLICK(win, id, func):
125 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, func)
127 def EVT_LIST_ITEM_MIDDLE_CLICK(win, id, func):
128 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, func)
130 def EVT_LIST_ITEM_ACTIVATED(win, id, func):
131 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_ACTIVATED, func)
133 def EVT_LIST_CACHE_HINT(win, id, func):
134 win.Connect(id, -1, wxEVT_COMMAND_LIST_CACHE_HINT, func)
136 def EVT_LIST_ITEM_FOCUSED(win, id, func):
137 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_FOCUSED, func)
160 wxLC_SORT_DESCENDING,
181 wxLIST_STATE_DONTCARE,
182 wxLIST_STATE_DROPHILITED,
183 wxLIST_STATE_FOCUSED,
184 wxLIST_STATE_SELECTED,
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,
199 // Flags for GetNextItem
207 wxLIST_ALIGN_DEFAULT,
210 wxLIST_ALIGN_SNAP_TO_GRID,
212 // Autosize values for SetColumnWidth
213 wxLIST_AUTOSIZE = -1,
214 wxLIST_AUTOSIZE_USEHEADER = -2,
216 // Flag values for GetItemRect
221 // Flag values for FindItem (MSW only)
232 enum wxListColumnFormat
236 wxLIST_FORMAT_CENTRE,
237 wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
248 wxListItemAttr(const wxColour& colText = wxNullColour,
249 const wxColour& colBack = wxNullColour,
250 const wxFont& font = wxNullFont);
254 void SetTextColour(const wxColour& colText);
255 void SetBackgroundColour(const wxColour& colBack);
256 void SetFont(const wxFont& font);
259 bool HasTextColour();
260 bool HasBackgroundColour();
263 wxColour GetTextColour();
264 wxColour GetBackgroundColour();
269 class wxListItem : public wxObject {
276 void ClearAttributes();
279 void SetMask(long mask);
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);
288 void SetWidth(int width);
289 void SetAlign(wxListColumnFormat align);
291 void SetTextColour(const wxColour& colText);
292 void SetBackgroundColour(const wxColour& colBack);
293 void SetFont(const wxFont& font);
300 const wxString& GetText();
305 wxListColumnFormat GetAlign();
307 wxListItemAttr *GetAttributes();
308 bool HasAttributes();
310 wxColour GetTextColour() const;
311 wxColour GetBackgroundColour() const;
312 wxFont GetFont() const;
314 // these members are public for compatibility
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
319 long m_stateMask;// Which flags of m_state are valid (uses same flags)
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
325 int m_format; // left, right, centre
326 int m_width; // width of column
331 class wxListEvent: public wxNotifyEvent {
333 wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
346 const wxString& GetLabel();
347 const wxString& GetText();
351 const wxListItem& GetItem();
358 %{ // C++ Version of a Python aware class
359 class wxPyListCtrl : public wxListCtrl {
360 DECLARE_ABSTRACT_CLASS(wxPyListCtrl);
362 wxPyListCtrl() : wxListCtrl() {}
363 wxPyListCtrl(wxWindow* parent, wxWindowID id,
367 const wxValidator& validator,
369 wxListCtrl(parent, id, pos, size, style, validator, name) {}
371 bool Create(wxWindow* parent, wxWindowID id,
375 const wxValidator& validator,
377 return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
380 DEC_PYCALLBACK_STRING_LONGLONG(OnGetItemText);
381 DEC_PYCALLBACK_INT_LONG(OnGetItemImage);
382 DEC_PYCALLBACK_LISTATTR_LONG(OnGetItemAttr);
387 IMPLEMENT_ABSTRACT_CLASS(wxPyListCtrl, wxListCtrl);
389 IMP_PYCALLBACK_STRING_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemText);
390 IMP_PYCALLBACK_INT_LONG(wxPyListCtrl, wxListCtrl, OnGetItemImage);
391 IMP_PYCALLBACK_LISTATTR_LONG(wxPyListCtrl, wxListCtrl, OnGetItemAttr);
396 %name(wxListCtrl)class wxPyListCtrl : public wxControl {
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");
404 %name(wxPreListCtrl)wxPyListCtrl();
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");
413 void _setCallbackInfo(PyObject* self, PyObject* _class);
414 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxListCtrl)"
416 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
417 %pragma(python) addtomethod = "wxPreListCtrl:val._setOORInfo(val)"
419 // Set the control colours
420 bool SetForegroundColour(const wxColour& col);
421 bool SetBackgroundColour(const wxColour& col);
423 // Gets information about this column
424 bool GetColumn(int col, wxListItem& item) const;
426 // Sets information about this column
427 bool SetColumn(int col, wxListItem& item) ;
429 // Gets the column width
430 int GetColumnWidth(int col) const;
432 // Sets the column width
433 bool SetColumnWidth(int col, int width) ;
435 // Gets the number of items that can fit vertically in the
436 // visible area of the list control (list or report view)
437 // or the total number of items in the list control (icon
438 // or small icon view)
439 int GetCountPerPage() const;
442 // Gets the edit control for editing labels.
443 wxTextCtrl* GetEditControl() const;
446 //bool GetItem(wxListItem& info) const ;
448 // Gets information about the item
449 %new wxListItem* GetItem(long itemId, int col=0) {
450 wxListItem* info = new wxListItem;
451 info->m_itemId = itemId;
453 info->m_mask = 0xFFFF;
454 self->GetItem(*info);
457 } // The OOR typemaps don't know what to do with the %new, so fix it up.
458 %pragma(python) addtoclass = "
459 def GetItem(self, *_args, **_kwargs):
460 val = apply(controls2c.wxListCtrl_GetItem,(self,) + _args, _kwargs)
466 // Sets information about the item
467 bool SetItem(wxListItem& info) ;
469 // Sets a string field at a particular column
470 %name(SetStringItem)long SetItem(long index, int col, const wxString& label, int imageId = -1);
472 // Gets the item state
473 int GetItemState(long item, long stateMask) const ;
475 // Sets the item state
476 bool SetItemState(long item, long state, long stateMask) ;
478 // Sets the item image
479 bool SetItemImage(long item, int image, int selImage) ;
481 // Gets the item text
482 wxString GetItemText(long item) const ;
484 // Sets the item text
485 void SetItemText(long item, const wxString& str) ;
487 // Gets the item data
488 long GetItemData(long item) const ;
490 // Sets the item data
491 bool SetItemData(long item, long data) ;
494 //bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
495 //bool GetItemPosition(long item, wxPoint& pos) const ;
497 // Gets the item position
499 %new wxPoint* GetItemPosition(long item) {
500 wxPoint* pos = new wxPoint;
501 self->GetItemPosition(item, *pos);
504 // Gets the item rectangle
505 %new wxRect* GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
506 wxRect* rect= new wxRect;
507 self->GetItemRect(item, *rect, code);
513 // Sets the item position
514 bool SetItemPosition(long item, const wxPoint& pos) ;
516 // Gets the number of items in the list control
517 int GetItemCount() const;
519 // Gets the number of columns in the list control
520 int GetColumnCount() const;
522 // Retrieves the spacing between icons in pixels.
523 // If small is TRUE, gets the spacing for the small icon
524 // view, otherwise the large icon view.
525 int GetItemSpacing(bool isSmall) const;
527 // Gets the number of selected items in the list control
528 int GetSelectedItemCount() const;
530 // Gets the text colour of the listview
531 wxColour GetTextColour() const;
533 // Sets the text colour of the listview
534 void SetTextColour(const wxColour& col);
536 // Gets the index of the topmost visible item when in
537 // list or report view
538 long GetTopItem() const ;
540 // Add or remove a single window style
541 void SetSingleStyle(long style, bool add = TRUE) ;
543 // Set the whole window style
544 void SetWindowStyleFlag(long style) ;
546 // Searches for an item, starting from 'item'.
547 // item can be -1 to find the first item that matches the
549 // Returns the item or -1 if unsuccessful.
550 long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
552 // Gets one of the three image lists
553 wxImageList *GetImageList(int which) const ;
555 // Sets the image list
556 void SetImageList(wxImageList *imageList, int which) ;
557 void AssignImageList(wxImageList *imageList, int which) ;
558 %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
560 // returns true if it is a virtual list control
561 bool IsVirtual() const;
563 // refresh items selectively (only useful for virtual list controls)
564 void RefreshItem(long item);
565 void RefreshItems(long itemFrom, long itemTo);
567 // Arranges the items
568 bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
571 bool DeleteItem(long item);
574 bool DeleteAllItems() ;
577 bool DeleteColumn(int col);
579 // Deletes all columns
580 bool DeleteAllColumns();
582 // Clears items, and columns if there are any.
587 wxTextCtrl* EditLabel(long item /*, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)*/);
589 // End label editing, optionally cancelling the edit
590 bool EndEditLabel(bool cancel);
593 // Ensures this item is visible
594 bool EnsureVisible(long item) ;
596 // Find an item whose label matches this string, starting from the item after 'start'
597 // or the beginning if 'start' is -1.
598 long FindItem(long start, const wxString& str, bool partial = FALSE);
600 // Find an item whose data matches this data, starting from the item after 'start'
601 // or the beginning if 'start' is -1.
602 %name(FindItemData)long FindItem(long start, long data);
604 // Find an item nearest this position in the specified direction, starting from
605 // the item after 'start' or the beginning if 'start' is -1.
606 %name(FindItemAtPos)long FindItem(long start, const wxPoint& pt, int direction);
608 // Determines which item (if any) is at the specified point,
609 // giving details in the second return value (see wxLIST_HITTEST_... flags above)
610 long HitTest(const wxPoint& point, int& OUTPUT);
612 // Inserts an item, returning the index of the new item if successful,
614 long InsertItem(wxListItem& info);
616 // Insert a string item
617 %name(InsertStringItem)long InsertItem(long index, const wxString& label);
619 // Insert an image item
620 %name(InsertImageItem)long InsertItem(long index, int imageIndex);
622 // Insert an image/string item
623 %name(InsertImageStringItem)long InsertItem(long index, const wxString& label, int imageIndex);
625 // For list view mode (only), inserts a column.
626 %name(InsertColumnInfo)long InsertColumn(long col, wxListItem& info);
628 long InsertColumn(long col,
629 const wxString& heading,
630 int format = wxLIST_FORMAT_LEFT,
633 // set the number of items in a virtual list control
634 void SetItemCount(long count);
636 // Scrolls the list control. If in icon, small icon or report view mode,
637 // x specifies the number of pixels to scroll. If in list view mode, x
638 // specifies the number of columns to scroll.
639 // If in icon, small icon or list view mode, y specifies the number of pixels
640 // to scroll. If in report view mode, y specifies the number of lines to scroll.
641 bool ScrollList(int dx, int dy);
643 // bool SortItems(wxListCtrlCompare fn, long data);
646 // func is a function which takes 2 long arguments: item1, item2.
647 // item1 is the long data associated with a first item (NOT the index).
648 // item2 is the long data associated with a second item (NOT the index).
649 // The return value is a negative number if the first item should precede the second
650 // item, a positive number of the second item should precede the first,
651 // or zero if the two items are equivalent.
652 bool SortItems(PyObject* func) {
653 if (!PyCallable_Check(func))
655 return self->SortItems(wxPyListCtrl_SortItems, (long)func);
659 %pragma(python) addtoclass = "
662 def Select(self, idx, on=1):
663 '''[de]select an item'''
664 if on: state = wxLIST_STATE_SELECTED
666 self.SetItemState(idx, state, wxLIST_STATE_SELECTED)
668 def Focus(self, idx):
669 '''Focus and show the given item'''
670 self.SetItemState(idx, wxLIST_STATE_FOCUSED, wxLIST_STATE_FOCUSED)
671 self.EnsureVisible(idx)
673 def GetFocusedItem(self):
674 '''get the currently focused item or -1 if none'''
675 return self.GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED)
677 def IsSelected(self, idx):
678 '''return TRUE if the item is selected'''
679 return self.GetItemState(idx, wxLIST_STATE_SELECTED) != 0
681 def SetColumnImage(self, col, image):
683 item.SetMask(wxLIST_MASK_IMAGE)
685 self.SetColumn(col, item)
687 def ClearColumnImage(self, col):
688 self.SetColumnImage(col, -1)
694 %{ // Python aware sorting function for wxPyListCtrl
695 int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
697 PyObject* func = (PyObject*)funcPtr;
698 wxPyBeginBlockThreads();
700 PyObject* args = Py_BuildValue("(ii)", item1, item2);
701 PyObject* result = PyEval_CallObject(func, args);
704 retval = PyInt_AsLong(result);
708 wxPyEndBlockThreads();
714 //----------------------------------------------------------------------
716 class wxListView : public wxPyListCtrl
719 wxListView( wxWindow *parent,
721 const wxPoint& pos = wxDefaultPosition,
722 const wxSize& size = wxDefaultSize,
723 long style = wxLC_REPORT,
724 const wxValidator& validator = wxDefaultValidator,
725 const wxString &name = "listctrl" );
726 %name(wxPreListView)wxListView();
728 bool Create( wxWindow *parent,
730 const wxPoint& pos = wxDefaultPosition,
731 const wxSize& size = wxDefaultSize,
732 long style = wxLC_REPORT,
733 const wxValidator& validator = wxDefaultValidator,
734 const wxString &name = "listctrl" );
736 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
737 %pragma(python) addtomethod = "wxPreListView:val._setOORInfo(val)"
739 // [de]select an item
740 void Select(long n, bool on = TRUE);
742 // focus and show the given item
743 void Focus(long index);
745 // get the currently focused item or -1 if none
746 long GetFocusedItem() const;
748 // get first and subsequent selected items, return -1 when no more
749 long GetNextSelected(long item) const;
750 long GetFirstSelected() const;
752 // return TRUE if the item is selected
753 bool IsSelected(long index);
755 void SetColumnImage(int col, int image);
756 void ClearColumnImage(int col);
760 //----------------------------------------------------------------------
774 wxTR_FULL_ROW_HIGHLIGHT,
780 wxTR_HAS_VARIABLE_ROW_HEIGHT,
787 wxTreeItemIcon_Normal, // not selected, not expanded
788 wxTreeItemIcon_Selected, // selected, not expanded
789 wxTreeItemIcon_Expanded, // not selected, expanded
790 wxTreeItemIcon_SelectedExpanded, // selected, expanded
795 // constants for HitTest
797 wxTREE_HITTEST_ABOVE,
798 wxTREE_HITTEST_BELOW,
799 wxTREE_HITTEST_NOWHERE,
800 wxTREE_HITTEST_ONITEMBUTTON,
801 wxTREE_HITTEST_ONITEMICON,
802 wxTREE_HITTEST_ONITEMINDENT,
803 wxTREE_HITTEST_ONITEMLABEL,
804 wxTREE_HITTEST_ONITEMRIGHT,
805 wxTREE_HITTEST_ONITEMSTATEICON,
806 wxTREE_HITTEST_TOLEFT,
807 wxTREE_HITTEST_TORIGHT,
808 wxTREE_HITTEST_ONITEMUPPERPART,
809 wxTREE_HITTEST_ONITEMLOWERPART,
810 wxTREE_HITTEST_ONITEM
815 /* Tree control event types */
816 wxEVT_COMMAND_TREE_BEGIN_DRAG,
817 wxEVT_COMMAND_TREE_BEGIN_RDRAG,
818 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
819 wxEVT_COMMAND_TREE_END_LABEL_EDIT,
820 wxEVT_COMMAND_TREE_DELETE_ITEM,
821 wxEVT_COMMAND_TREE_GET_INFO,
822 wxEVT_COMMAND_TREE_SET_INFO,
823 wxEVT_COMMAND_TREE_ITEM_EXPANDED,
824 wxEVT_COMMAND_TREE_ITEM_EXPANDING,
825 wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
826 wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
827 wxEVT_COMMAND_TREE_SEL_CHANGED,
828 wxEVT_COMMAND_TREE_SEL_CHANGING,
829 wxEVT_COMMAND_TREE_KEY_DOWN,
830 wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
831 wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK,
832 wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK,
833 wxEVT_COMMAND_TREE_END_DRAG,
837 %pragma(python) code = "
839 def EVT_TREE_BEGIN_DRAG(win, id, func):
840 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_DRAG, func)
842 def EVT_TREE_BEGIN_RDRAG(win, id, func):
843 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_RDRAG, func)
845 def EVT_TREE_END_DRAG(win, id, func):
846 win.Connect(id, -1, wxEVT_COMMAND_TREE_END_DRAG, func)
848 def EVT_TREE_BEGIN_LABEL_EDIT(win, id, func):
849 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, func)
851 def EVT_TREE_END_LABEL_EDIT(win, id, func):
852 win.Connect(id, -1, wxEVT_COMMAND_TREE_END_LABEL_EDIT, func)
854 def EVT_TREE_GET_INFO(win, id, func):
855 win.Connect(id, -1, wxEVT_COMMAND_TREE_GET_INFO, func)
857 def EVT_TREE_SET_INFO(win, id, func):
858 win.Connect(id, -1, wxEVT_COMMAND_TREE_SET_INFO, func)
860 def EVT_TREE_ITEM_EXPANDED(win, id, func):
861 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_EXPANDED, func)
863 def EVT_TREE_ITEM_EXPANDING(win, id, func):
864 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_EXPANDING, func)
866 def EVT_TREE_ITEM_COLLAPSED(win, id, func):
867 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_COLLAPSED, func)
869 def EVT_TREE_ITEM_COLLAPSING(win, id, func):
870 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_COLLAPSING, func)
872 def EVT_TREE_SEL_CHANGED(win, id, func):
873 win.Connect(id, -1, wxEVT_COMMAND_TREE_SEL_CHANGED, func)
875 def EVT_TREE_SEL_CHANGING(win, id, func):
876 win.Connect(id, -1, wxEVT_COMMAND_TREE_SEL_CHANGING, func)
878 def EVT_TREE_KEY_DOWN(win, id, func):
879 win.Connect(id, -1, wxEVT_COMMAND_TREE_KEY_DOWN, func)
881 def EVT_TREE_DELETE_ITEM(win, id, func):
882 win.Connect(id, -1, wxEVT_COMMAND_TREE_DELETE_ITEM, func)
884 def EVT_TREE_ITEM_ACTIVATED(win, id, func):
885 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_ACTIVATED, func)
887 def EVT_TREE_ITEM_RIGHT_CLICK(win, id, func):
888 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, func)
890 def EVT_TREE_ITEM_MIDDLE_CLICK(win, id, func):
891 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, func)
899 //wxTreeItemAttr() { }
900 wxTreeItemAttr(const wxColour& colText = wxNullColour,
901 const wxColour& colBack = wxNullColour,
902 const wxFont& font = wxNullFont);
905 void SetTextColour(const wxColour& colText);
906 void SetBackgroundColour(const wxColour& colBack);
907 void SetFont(const wxFont& font);
910 bool HasTextColour();
911 bool HasBackgroundColour();
914 wxColour GetTextColour();
915 wxColour GetBackgroundColour();
925 %pragma(python) addtoclass = "Ok = IsOk"
928 int __cmp__(wxTreeItemId* other) {
929 if (! other) return -1;
930 return *self != *other;
938 class wxPyTreeItemData : public wxTreeItemData {
940 wxPyTreeItemData(PyObject* obj = NULL) {
947 ~wxPyTreeItemData() {
948 wxPyBeginBlockThreads();
950 wxPyEndBlockThreads();
953 PyObject* GetData() {
958 void SetData(PyObject* obj) {
959 wxPyBeginBlockThreads();
961 wxPyEndBlockThreads();
972 %name(wxTreeItemData) class wxPyTreeItemData : public wxObject {
974 wxPyTreeItemData(PyObject* obj = NULL);
977 void SetData(PyObject* obj);
979 const wxTreeItemId& GetId();
980 void SetId(const wxTreeItemId& id);
985 class wxTreeEvent : public wxNotifyEvent {
987 wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
989 wxTreeItemId GetItem();
990 wxTreeItemId GetOldItem();
992 const wxKeyEvent& GetKeyEvent();
994 const wxString& GetLabel();
999 %{ // C++ version of Python aware wxTreeCtrl
1000 class wxPyTreeCtrl : public wxTreeCtrl {
1001 DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl);
1003 wxPyTreeCtrl() : wxTreeCtrl() {}
1004 wxPyTreeCtrl(wxWindow *parent, wxWindowID id,
1008 const wxValidator& validator,
1010 wxTreeCtrl(parent, id, pos, size, style, validator, name) {}
1012 bool Create(wxWindow *parent, wxWindowID id,
1016 const wxValidator& validator,
1018 return wxTreeCtrl::Create(parent, id, pos, size, style, validator, name);
1022 int OnCompareItems(const wxTreeItemId& item1,
1023 const wxTreeItemId& item2) {
1026 wxPyBeginBlockThreads();
1027 if ((found = m_myInst.findCallback("OnCompareItems")))
1028 rval = m_myInst.callCallback(Py_BuildValue(
1030 wxPyConstructObject((void*)&item1, "wxTreeItemId"),
1031 wxPyConstructObject((void*)&item2, "wxTreeItemId")));
1032 wxPyEndBlockThreads();
1034 rval = wxTreeCtrl::OnCompareItems(item1, item2);
1040 IMPLEMENT_ABSTRACT_CLASS(wxPyTreeCtrl, wxTreeCtrl);
1044 // These are for the GetFirstChild/GetNextChild methods below
1045 %typemap(python, in) long& INOUT = long* INOUT;
1046 %typemap(python, argout) long& INOUT = long* INOUT;
1049 %name(wxTreeCtrl)class wxPyTreeCtrl : public wxControl {
1051 wxPyTreeCtrl(wxWindow *parent, wxWindowID id = -1,
1052 const wxPoint& pos = wxDefaultPosition,
1053 const wxSize& size = wxDefaultSize,
1054 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
1055 const wxValidator& validator = wxDefaultValidator,
1056 char* name = "wxTreeCtrl");
1057 %name(wxPreTreeCtrl)wxPyTreeCtrl();
1059 bool Create(wxWindow *parent, wxWindowID id = -1,
1060 const wxPoint& pos = wxDefaultPosition,
1061 const wxSize& size = wxDefaultSize,
1062 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
1063 const wxValidator& validator = wxDefaultValidator,
1064 char* name = "wxTreeCtrl");
1066 void _setCallbackInfo(PyObject* self, PyObject* _class);
1067 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTreeCtrl)"
1069 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1070 %pragma(python) addtomethod = "wxPreTreeCtrl:val._setOORInfo(val)"
1073 unsigned int GetIndent();
1074 void SetIndent(unsigned int indent);
1075 wxImageList *GetImageList();
1076 wxImageList *GetStateImageList();
1077 void SetImageList(wxImageList *imageList);
1078 void SetStateImageList(wxImageList *imageList);
1079 void AssignImageList(wxImageList* imageList);
1080 %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
1081 void AssignStateImageList(wxImageList* imageList);
1082 %pragma(python) addtomethod = "AssignStateImageList:_args[0].thisown = 0"
1084 unsigned int GetSpacing();
1085 void SetSpacing(unsigned int spacing);
1087 wxString GetItemText(const wxTreeItemId& item);
1088 int GetItemImage(const wxTreeItemId& item,
1089 wxTreeItemIcon which = wxTreeItemIcon_Normal);
1090 int GetItemSelectedImage(const wxTreeItemId& item);
1092 void SetItemText(const wxTreeItemId& item, const wxString& text);
1093 void SetItemImage(const wxTreeItemId& item, int image,
1094 wxTreeItemIcon which = wxTreeItemIcon_Normal);
1095 void SetItemSelectedImage(const wxTreeItemId& item, int image);
1096 void SetItemHasChildren(const wxTreeItemId& item, bool hasChildren = TRUE);
1099 // [Get|Set]ItemData substitutes. Automatically create wxPyTreeItemData
1101 wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
1102 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1104 data = new wxPyTreeItemData();
1105 data->SetId(item); // set the id
1106 self->SetItemData(item, data);
1111 void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
1112 data->SetId(item); // set the id
1113 self->SetItemData(item, data);
1116 // [Get|Set]PyData are short-cuts. Also made somewhat crash-proof by
1117 // automatically creating data classes.
1118 PyObject* GetPyData(const wxTreeItemId& item) {
1119 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1121 data = new wxPyTreeItemData();
1122 data->SetId(item); // set the id
1123 self->SetItemData(item, data);
1125 return data->GetData();
1128 void SetPyData(const wxTreeItemId& item, PyObject* obj) {
1129 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1131 data = new wxPyTreeItemData(obj);
1132 data->SetId(item); // set the id
1133 self->SetItemData(item, data);
1140 bool IsVisible(const wxTreeItemId& item);
1141 bool ItemHasChildren(const wxTreeItemId& item);
1142 bool IsExpanded(const wxTreeItemId& item);
1143 bool IsSelected(const wxTreeItemId& item);
1145 wxTreeItemId GetRootItem();
1146 wxTreeItemId GetSelection();
1147 %name(GetItemParent) wxTreeItemId GetParent(const wxTreeItemId& item);
1148 //size_t GetSelections(wxArrayTreeItemIds& selection);
1150 PyObject* GetSelections() {
1151 wxPyBeginBlockThreads();
1152 PyObject* rval = PyList_New(0);
1153 wxArrayTreeItemIds array;
1155 num = self->GetSelections(array);
1156 for (x=0; x < num; x++) {
1157 wxTreeItemId *tii = new wxTreeItemId(array.Item(x));
1158 PyObject* item = wxPyConstructObject((void*)tii, "wxTreeItemId", TRUE);
1159 PyList_Append(rval, item);
1161 wxPyEndBlockThreads();
1168 size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
1170 wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT);
1171 wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
1172 wxTreeItemId GetNextSibling(const wxTreeItemId& item);
1173 wxTreeItemId GetPrevSibling(const wxTreeItemId& item);
1174 wxTreeItemId GetFirstVisibleItem();
1175 wxTreeItemId GetNextVisible(const wxTreeItemId& item);
1176 wxTreeItemId GetPrevVisible(const wxTreeItemId& item);
1177 wxTreeItemId GetLastChild(const wxTreeItemId& item);
1181 wxTreeItemId AddRoot(const wxString& text,
1182 int image = -1, int selectedImage = -1,
1183 wxPyTreeItemData *data = NULL);
1184 wxTreeItemId PrependItem(const wxTreeItemId& parent,
1185 const wxString& text,
1186 int image = -1, int selectedImage = -1,
1187 wxPyTreeItemData *data = NULL);
1188 wxTreeItemId InsertItem(const wxTreeItemId& parent,
1189 const wxTreeItemId& idPrevious,
1190 const wxString& text,
1191 int image = -1, int selectedImage = -1,
1192 wxPyTreeItemData *data = NULL);
1193 %name(InsertItemBefore)
1194 wxTreeItemId InsertItem(const wxTreeItemId& parent,
1196 const wxString& text,
1197 int image = -1, int selectedImage = -1,
1198 wxTreeItemData *data = NULL);
1199 wxTreeItemId AppendItem(const wxTreeItemId& parent,
1200 const wxString& text,
1201 int image = -1, int selectedImage = -1,
1202 wxPyTreeItemData *data = NULL);
1204 void Delete(const wxTreeItemId& item);
1205 void DeleteChildren(const wxTreeItemId& item);
1206 void DeleteAllItems();
1208 void Expand(const wxTreeItemId& item);
1209 void Collapse(const wxTreeItemId& item);
1210 void CollapseAndReset(const wxTreeItemId& item);
1211 void Toggle(const wxTreeItemId& item);
1215 void SelectItem(const wxTreeItemId& item);
1216 void EnsureVisible(const wxTreeItemId& item);
1217 void ScrollTo(const wxTreeItemId& item);
1219 wxTextCtrl* EditLabel(const wxTreeItemId& item);
1220 wxTextCtrl* GetEditControl();
1221 void EndEditLabel(const wxTreeItemId& item, int discardChanges = FALSE);
1223 void EditLabel(const wxTreeItemId& item);
1226 void SortChildren(const wxTreeItemId& item);
1228 void SetItemBold(const wxTreeItemId& item, int bold = TRUE);
1229 bool IsBold(const wxTreeItemId& item) const;
1230 wxTreeItemId HitTest(const wxPoint& point, int& OUTPUT);
1234 void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
1235 void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
1236 void SetItemFont(const wxTreeItemId& item, const wxFont& font);
1239 void SetItemDropHighlight(const wxTreeItemId& item, int highlight = TRUE);
1242 //bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, int textOnly = FALSE)
1244 PyObject* GetBoundingRect(const wxTreeItemId& item, int textOnly = FALSE) {
1246 if (self->GetBoundingRect(item, rect, textOnly)) {
1247 wxPyBeginBlockThreads();
1248 wxRect* r = new wxRect(rect);
1249 PyObject* val = wxPyConstructObject((void*)r, "wxRect");
1250 wxPyEndBlockThreads();
1261 %pragma(python) addtoclass = "
1262 # Redefine some methods that SWIG gets a bit confused on...
1263 def GetFirstChild(self, *_args, **_kwargs):
1264 val1,val2 = apply(controls2c.wxTreeCtrl_GetFirstChild,(self,) + _args, _kwargs)
1265 val1 = wxTreeItemIdPtr(val1)
1268 def GetNextChild(self, *_args, **_kwargs):
1269 val1,val2 = apply(controls2c.wxTreeCtrl_GetNextChild,(self,) + _args, _kwargs)
1270 val1 = wxTreeItemIdPtr(val1)
1273 def HitTest(self, *_args, **_kwargs):
1274 val1, val2 = apply(controls2c.wxTreeCtrl_HitTest,(self,) + _args, _kwargs)
1275 val1 = wxTreeItemIdPtr(val1)
1283 //----------------------------------------------------------------------
1288 wxDIRCTRL_SELECT_FIRST,
1289 wxDIRCTRL_SHOW_FILTERS,
1290 wxDIRCTRL_3D_INTERNAL,
1294 class wxDirItemData : public wxObject // wxTreeItemData
1297 wxDirItemData(const wxString& path, const wxString& name, bool isDir);
1298 // ~wxDirItemDataEx();
1299 void SetNewDirName( wxString path );
1300 wxString m_path, m_name;
1307 class wxGenericDirCtrl: public wxControl
1310 wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = -1,
1311 const char* dir = wxDirDialogDefaultFolderStr,
1312 const wxPoint& pos = wxDefaultPosition,
1313 const wxSize& size = wxDefaultSize,
1314 long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
1315 const char* filter = wxEmptyString,
1316 int defaultFilter = 0,
1317 const char* name = "dirCtrl" );
1318 %name(wxPreGenericDirCtrl)wxGenericDirCtrl();
1320 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1321 %pragma(python) addtomethod = "wxPreGenericDirCtrl:val._setOORInfo(val)"
1323 bool Create(wxWindow *parent, const wxWindowID id = -1,
1324 const char* dir = wxDirDialogDefaultFolderStr,
1325 const wxPoint& pos = wxDefaultPosition,
1326 const wxSize& size = wxDefaultSize,
1327 long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
1328 const char* filter = wxEmptyString,
1329 int defaultFilter = 0,
1330 const char* name = "dirCtrl" );
1333 // Try to expand as much of the given path as possible.
1334 bool ExpandPath(const wxString& path);
1338 inline wxString GetDefaultPath() const;
1339 void SetDefaultPath(const wxString& path);
1341 // Get dir or filename
1342 wxString GetPath() const ;
1344 // Get selected filename path only (else empty string).
1345 // I.e. don't count a directory as a selection
1346 wxString GetFilePath() const ;
1347 void SetPath(const wxString& path) ;
1349 void ShowHidden( bool show );
1350 bool GetShowHidden();
1352 wxString GetFilter() const;
1353 void SetFilter(const wxString& filter);
1355 int GetFilterIndex() const;
1356 void SetFilterIndex(int n) ;
1358 wxTreeItemId GetRootId();
1360 wxTreeCtrl* GetTreeCtrl() const;
1361 wxDirFilterListCtrl* GetFilterListCtrl() const;
1364 // void SetupSections();
1365 // // Parse the filter into an array of filters and an array of descriptions
1366 // int ParseFilter(const wxString& filterStr, wxArrayString& filters, wxArrayString& descriptions);
1367 // // Find the child that matches the first part of 'path'.
1368 // // E.g. if a child path is "/usr" and 'path' is "/usr/include"
1369 // // then the child for /usr is returned.
1370 // // If the path string has been used (we're at the leaf), done is set to TRUE
1371 // wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);
1375 class wxDirFilterListCtrl: public wxChoice
1378 wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = -1,
1379 const wxPoint& pos = wxDefaultPosition,
1380 const wxSize& size = wxDefaultSize,
1382 %name(wxPreDirFilterListCtrl)wxDirFilterListCtrl();
1384 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1385 %pragma(python) addtomethod = "wxPreDirFilterListCtrl:val._setOORInfo(val)"
1387 bool Create(wxGenericDirCtrl* parent, const wxWindowID id = -1,
1388 const wxPoint& pos = wxDefaultPosition,
1389 const wxSize& size = wxDefaultSize,
1393 void FillFilterList(const wxString& filter, int defaultFilter);
1397 //----------------------------------------------------------------------
1398 //----------------------------------------------------------------------
1401 // Map renamed classes back to their common name for OOR
1402 wxPyPtrTypeMap_Add("wxTreeItemData", "wxPyTreeItemData");
1403 wxPyPtrTypeMap_Add("wxTreeCtrl", "wxPyTreeCtrl");
1404 wxPyPtrTypeMap_Add("wxListCtrl", "wxPyListCtrl");
1407 //----------------------------------------------------------------------