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 //----------------------------------------------------------------------
44 // Put some wx default wxChar* values into wxStrings.
45 const wxChar* wxListCtrlNameStr = _T("wxListCtrl");
46 DECLARE_DEF_STRING(ListCtrlNameStr);
48 const wxChar* wx_TreeCtrlNameStr = _T("wxTreeCtrl");
49 DECLARE_DEF_STRING(_TreeCtrlNameStr);
50 DECLARE_DEF_STRING(DirDialogDefaultFolderStr);
52 static const wxString wxPyEmptyString(wxT(""));
57 static const long longzero = 0;
60 //----------------------------------------------------------------------
63 /* List control event types */
64 wxEVT_COMMAND_LIST_BEGIN_DRAG,
65 wxEVT_COMMAND_LIST_BEGIN_RDRAG,
66 wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT,
67 wxEVT_COMMAND_LIST_END_LABEL_EDIT,
68 wxEVT_COMMAND_LIST_DELETE_ITEM,
69 wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS,
70 wxEVT_COMMAND_LIST_GET_INFO,
71 wxEVT_COMMAND_LIST_SET_INFO,
72 wxEVT_COMMAND_LIST_ITEM_SELECTED,
73 wxEVT_COMMAND_LIST_ITEM_DESELECTED,
74 wxEVT_COMMAND_LIST_KEY_DOWN,
75 wxEVT_COMMAND_LIST_INSERT_ITEM,
76 wxEVT_COMMAND_LIST_COL_CLICK,
77 wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK,
78 wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK,
79 wxEVT_COMMAND_LIST_ITEM_ACTIVATED,
80 wxEVT_COMMAND_LIST_CACHE_HINT,
81 wxEVT_COMMAND_LIST_COL_RIGHT_CLICK,
82 wxEVT_COMMAND_LIST_COL_BEGIN_DRAG,
83 wxEVT_COMMAND_LIST_COL_DRAGGING,
84 wxEVT_COMMAND_LIST_COL_END_DRAG,
85 wxEVT_COMMAND_LIST_ITEM_FOCUSED,
89 %pragma(python) code = "
90 def EVT_LIST_BEGIN_DRAG(win, id, func):
91 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_DRAG, func)
93 def EVT_LIST_BEGIN_RDRAG(win, id, func):
94 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_RDRAG, func)
96 def EVT_LIST_BEGIN_LABEL_EDIT(win, id, func):
97 win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, func)
99 def EVT_LIST_END_LABEL_EDIT(win, id, func):
100 win.Connect(id, -1, wxEVT_COMMAND_LIST_END_LABEL_EDIT, func)
102 def EVT_LIST_DELETE_ITEM(win, id, func):
103 win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ITEM, func)
105 def EVT_LIST_DELETE_ALL_ITEMS(win, id, func):
106 win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, func)
108 def EVT_LIST_GET_INFO(win, id, func):
109 win.Connect(id, -1, wxEVT_COMMAND_LIST_GET_INFO, func)
111 def EVT_LIST_SET_INFO(win, id, func):
112 win.Connect(id, -1, wxEVT_COMMAND_LIST_SET_INFO, func)
114 def EVT_LIST_ITEM_SELECTED(win, id, func):
115 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_SELECTED, func)
117 def EVT_LIST_ITEM_DESELECTED(win, id, func):
118 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_DESELECTED, func)
120 def EVT_LIST_KEY_DOWN(win, id, func):
121 win.Connect(id, -1, wxEVT_COMMAND_LIST_KEY_DOWN, func)
123 def EVT_LIST_INSERT_ITEM(win, id, func):
124 win.Connect(id, -1, wxEVT_COMMAND_LIST_INSERT_ITEM, func)
126 def EVT_LIST_COL_CLICK(win, id, func):
127 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_CLICK, func)
129 def EVT_LIST_COL_RIGHT_CLICK(win, id, func):
130 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_RIGHT_CLICK, func)
132 def EVT_LIST_COL_BEGIN_DRAG(win, id, func):
133 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_BEGIN_DRAG, func)
135 def EVT_LIST_COL_DRAGGING(win, id, func):
136 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_DRAGGING, func)
138 def EVT_LIST_COL_END_DRAG(win, id, func):
139 win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_END_DRAG, func)
141 def EVT_LIST_ITEM_RIGHT_CLICK(win, id, func):
142 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, func)
144 def EVT_LIST_ITEM_MIDDLE_CLICK(win, id, func):
145 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, func)
147 def EVT_LIST_ITEM_ACTIVATED(win, id, func):
148 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_ACTIVATED, func)
150 def EVT_LIST_CACHE_HINT(win, id, func):
151 win.Connect(id, -1, wxEVT_COMMAND_LIST_CACHE_HINT, func)
153 def EVT_LIST_ITEM_FOCUSED(win, id, func):
154 win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_FOCUSED, func)
177 wxLC_SORT_DESCENDING,
198 wxLIST_STATE_DONTCARE,
199 wxLIST_STATE_DROPHILITED,
200 wxLIST_STATE_FOCUSED,
201 wxLIST_STATE_SELECTED,
205 wxLIST_HITTEST_ABOVE,
206 wxLIST_HITTEST_BELOW,
207 wxLIST_HITTEST_NOWHERE,
208 wxLIST_HITTEST_ONITEMICON,
209 wxLIST_HITTEST_ONITEMLABEL,
210 wxLIST_HITTEST_ONITEMRIGHT,
211 wxLIST_HITTEST_ONITEMSTATEICON,
212 wxLIST_HITTEST_TOLEFT,
213 wxLIST_HITTEST_TORIGHT,
214 wxLIST_HITTEST_ONITEM,
216 // Flags for GetNextItem
224 wxLIST_ALIGN_DEFAULT,
227 wxLIST_ALIGN_SNAP_TO_GRID,
229 // Autosize values for SetColumnWidth
230 wxLIST_AUTOSIZE = -1,
231 wxLIST_AUTOSIZE_USEHEADER = -2,
233 // Flag values for GetItemRect
238 // Flag values for FindItem (MSW only)
249 enum wxListColumnFormat
253 wxLIST_FORMAT_CENTRE,
254 wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
265 wxListItemAttr(const wxColour& colText = wxNullColour,
266 const wxColour& colBack = wxNullColour,
267 const wxFont& font = wxNullFont);
271 void SetTextColour(const wxColour& colText);
272 void SetBackgroundColour(const wxColour& colBack);
273 void SetFont(const wxFont& font);
276 bool HasTextColour();
277 bool HasBackgroundColour();
280 wxColour GetTextColour();
281 wxColour GetBackgroundColour();
286 class wxListItem : public wxObject {
293 void ClearAttributes();
296 void SetMask(long mask);
298 void SetColumn(int col);
299 void SetState(long state);
300 void SetStateMask(long stateMask);
301 void SetText(const wxString& text);
302 void SetImage(int image);
303 void SetData(long data);
305 void SetWidth(int width);
306 void SetAlign(wxListColumnFormat align);
308 void SetTextColour(const wxColour& colText);
309 void SetBackgroundColour(const wxColour& colBack);
310 void SetFont(const wxFont& font);
317 const wxString& GetText();
322 wxListColumnFormat GetAlign();
324 wxListItemAttr *GetAttributes();
325 bool HasAttributes();
327 wxColour GetTextColour() const;
328 wxColour GetBackgroundColour() const;
329 wxFont GetFont() const;
331 // these members are public for compatibility
332 long m_mask; // Indicates what fields are valid
333 long m_itemId; // The zero-based item position
334 int m_col; // Zero-based column, if in report mode
335 long m_state; // The state of the item
336 long m_stateMask;// Which flags of m_state are valid (uses same flags)
337 wxString m_text; // The label/header text
338 int m_image; // The zero-based index into an image list
339 long m_data; // App-defined data
342 int m_format; // left, right, centre
343 int m_width; // width of column
348 class wxListEvent: public wxNotifyEvent {
350 wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
362 %pragma(python) addtoclass = "GetCode = GetKeyCode"
366 const wxString& GetLabel();
367 const wxString& GetText();
371 const wxListItem& GetItem();
378 %{ // C++ Version of a Python aware class
379 class wxPyListCtrl : public wxListCtrl {
380 DECLARE_ABSTRACT_CLASS(wxPyListCtrl);
382 wxPyListCtrl() : wxListCtrl() {}
383 wxPyListCtrl(wxWindow* parent, wxWindowID id,
387 const wxValidator& validator,
388 const wxString& name) :
389 wxListCtrl(parent, id, pos, size, style, validator, name) {}
391 bool Create(wxWindow* parent, wxWindowID id,
395 const wxValidator& validator,
396 const wxString& name) {
397 return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
400 DEC_PYCALLBACK_STRING_LONGLONG(OnGetItemText);
401 DEC_PYCALLBACK_INT_LONG(OnGetItemImage);
402 DEC_PYCALLBACK_LISTATTR_LONG(OnGetItemAttr);
407 IMPLEMENT_ABSTRACT_CLASS(wxPyListCtrl, wxListCtrl);
409 IMP_PYCALLBACK_STRING_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemText);
410 IMP_PYCALLBACK_INT_LONG(wxPyListCtrl, wxListCtrl, OnGetItemImage);
411 IMP_PYCALLBACK_LISTATTR_LONG(wxPyListCtrl, wxListCtrl, OnGetItemAttr);
416 %name(wxListCtrl)class wxPyListCtrl : public wxControl {
418 wxPyListCtrl(wxWindow* parent, wxWindowID id = -1,
419 const wxPoint& pos = wxDefaultPosition,
420 const wxSize& size = wxDefaultSize,
421 long style = wxLC_ICON,
422 const wxValidator& validator = wxDefaultValidator,
423 const wxString& name = wxPyListCtrlNameStr);
424 %name(wxPreListCtrl)wxPyListCtrl();
426 bool Create(wxWindow* parent, wxWindowID id = -1,
427 const wxPoint& pos = wxDefaultPosition,
428 const wxSize& size = wxDefaultSize,
429 long style = wxLC_ICON,
430 const wxValidator& validator = wxDefaultValidator,
431 const wxString& name = wxPyListCtrlNameStr);
433 void _setCallbackInfo(PyObject* self, PyObject* _class);
434 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxListCtrl)"
436 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
437 %pragma(python) addtomethod = "wxPreListCtrl:val._setOORInfo(val)"
439 // Set the control colours
440 bool SetForegroundColour(const wxColour& col);
441 bool SetBackgroundColour(const wxColour& col);
443 // Gets information about this column
444 // bool GetColumn(int col, wxListItem& item) const;
446 %new wxListItem* GetColumn(int col) {
448 item.SetMask(0xFFFF);
449 if (self->GetColumn(col, item))
450 return new wxListItem(item);
454 } // The OOR typemaps don't know what to do with the %new, so fix it up.
455 %pragma(python) addtoclass = "
456 def GetColumn(self, *_args, **_kwargs):
457 val = apply(controls2c.wxListCtrl_GetColumn,(self,) + _args, _kwargs)
458 if val is not None: val.thisown = 1
462 // Sets information about this column
463 bool SetColumn(int col, wxListItem& item) ;
465 // Gets the column width
466 int GetColumnWidth(int col) const;
468 // Sets the column width
469 bool SetColumnWidth(int col, int width) ;
471 // Gets the number of items that can fit vertically in the
472 // visible area of the list control (list or report view)
473 // or the total number of items in the list control (icon
474 // or small icon view)
475 int GetCountPerPage() const;
478 // Gets the edit control for editing labels.
479 wxTextCtrl* GetEditControl() const;
482 //bool GetItem(wxListItem& info) const ;
484 // Gets information about the item
485 %new wxListItem* GetItem(long itemId, int col=0) {
486 wxListItem* info = new wxListItem;
487 info->m_itemId = itemId;
489 info->m_mask = 0xFFFF;
490 self->GetItem(*info);
493 } // The OOR typemaps don't know what to do with the %new, so fix it up.
494 %pragma(python) addtoclass = "
495 def GetItem(self, *_args, **_kwargs):
496 val = apply(controls2c.wxListCtrl_GetItem,(self,) + _args, _kwargs)
497 if val is not None: val.thisown = 1
502 // Sets information about the item
503 bool SetItem(wxListItem& info) ;
505 // Sets a string field at a particular column
506 %name(SetStringItem)long SetItem(long index, int col, const wxString& label, int imageId = -1);
508 // Gets the item state
509 int GetItemState(long item, long stateMask) const ;
511 // Sets the item state
512 bool SetItemState(long item, long state, long stateMask) ;
514 // Sets the item image
515 bool SetItemImage(long item, int image, int selImage) ;
517 // Gets the item text
518 wxString GetItemText(long item) const ;
520 // Sets the item text
521 void SetItemText(long item, const wxString& str) ;
523 // Gets the item data
524 long GetItemData(long item) const ;
526 // Sets the item data
527 bool SetItemData(long item, long data) ;
530 //bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
531 //bool GetItemPosition(long item, wxPoint& pos) const ;
533 // Gets the item position
535 %new wxPoint* GetItemPosition(long item) {
536 wxPoint* pos = new wxPoint;
537 self->GetItemPosition(item, *pos);
540 // Gets the item rectangle
541 %new wxRect* GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
542 wxRect* rect= new wxRect;
543 self->GetItemRect(item, *rect, code);
549 // Sets the item position
550 bool SetItemPosition(long item, const wxPoint& pos) ;
552 // Gets the number of items in the list control
553 int GetItemCount() const;
555 // Gets the number of columns in the list control
556 int GetColumnCount() const;
558 // Retrieves the spacing between icons in pixels.
559 // If small is TRUE, gets the spacing for the small icon
560 // view, otherwise the large icon view.
561 int GetItemSpacing(bool isSmall) const;
563 // Gets the number of selected items in the list control
564 int GetSelectedItemCount() const;
566 // Gets the text colour of the listview
567 wxColour GetTextColour() const;
569 // Sets the text colour of the listview
570 void SetTextColour(const wxColour& col);
572 // Gets the index of the topmost visible item when in
573 // list or report view
574 long GetTopItem() const ;
576 // Add or remove a single window style
577 void SetSingleStyle(long style, bool add = TRUE) ;
579 // Set the whole window style
580 void SetWindowStyleFlag(long style) ;
582 // Searches for an item, starting from 'item'.
583 // item can be -1 to find the first item that matches the
585 // Returns the item or -1 if unsuccessful.
586 long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
588 // Gets one of the three image lists
589 wxImageList *GetImageList(int which) const ;
591 // Sets the image list
592 void SetImageList(wxImageList *imageList, int which) ;
593 void AssignImageList(wxImageList *imageList, int which) ;
594 %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
596 // returns true if it is a virtual list control
597 bool IsVirtual() const;
599 // refresh items selectively (only useful for virtual list controls)
600 void RefreshItem(long item);
601 void RefreshItems(long itemFrom, long itemTo);
603 // Arranges the items
604 bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
607 bool DeleteItem(long item);
610 bool DeleteAllItems() ;
613 bool DeleteColumn(int col);
615 // Deletes all columns
616 bool DeleteAllColumns();
618 // Clears items, and columns if there are any.
623 wxTextCtrl* EditLabel(long item /*, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)*/);
625 // End label editing, optionally cancelling the edit
626 bool EndEditLabel(bool cancel);
629 // Ensures this item is visible
630 bool EnsureVisible(long item) ;
632 // Find an item whose label matches this string, starting from the item after 'start'
633 // or the beginning if 'start' is -1.
634 long FindItem(long start, const wxString& str, bool partial = FALSE);
636 // Find an item whose data matches this data, starting from the item after 'start'
637 // or the beginning if 'start' is -1.
638 %name(FindItemData)long FindItem(long start, long data);
640 // Find an item nearest this position in the specified direction, starting from
641 // the item after 'start' or the beginning if 'start' is -1.
642 %name(FindItemAtPos)long FindItem(long start, const wxPoint& pt, int direction);
644 // Determines which item (if any) is at the specified point,
645 // giving details in the second return value (see wxLIST_HITTEST_... flags above)
646 long HitTest(const wxPoint& point, int& OUTPUT);
648 // Inserts an item, returning the index of the new item if successful,
650 long InsertItem(wxListItem& info);
652 // Insert a string item
653 %name(InsertStringItem)long InsertItem(long index, const wxString& label);
655 // Insert an image item
656 %name(InsertImageItem)long InsertItem(long index, int imageIndex);
658 // Insert an image/string item
659 %name(InsertImageStringItem)long InsertItem(long index, const wxString& label, int imageIndex);
661 // For list view mode (only), inserts a column.
662 %name(InsertColumnInfo)long InsertColumn(long col, wxListItem& info);
664 long InsertColumn(long col,
665 const wxString& heading,
666 int format = wxLIST_FORMAT_LEFT,
669 // set the number of items in a virtual list control
670 void SetItemCount(long count);
672 // Scrolls the list control. If in icon, small icon or report view mode,
673 // x specifies the number of pixels to scroll. If in list view mode, x
674 // specifies the number of columns to scroll.
675 // If in icon, small icon or list view mode, y specifies the number of pixels
676 // to scroll. If in report view mode, y specifies the number of lines to scroll.
677 bool ScrollList(int dx, int dy);
679 void SetItemTextColour( long item, const wxColour& col);
680 wxColour GetItemTextColour( long item ) const;
681 void SetItemBackgroundColour( long item, const wxColour &col);
682 wxColour GetItemBackgroundColour( long item ) const;
685 %pragma(python) addtoclass = "
688 def Select(self, idx, on=1):
689 '''[de]select an item'''
690 if on: state = wxLIST_STATE_SELECTED
692 self.SetItemState(idx, state, wxLIST_STATE_SELECTED)
694 def Focus(self, idx):
695 '''Focus and show the given item'''
696 self.SetItemState(idx, wxLIST_STATE_FOCUSED, wxLIST_STATE_FOCUSED)
697 self.EnsureVisible(idx)
699 def GetFocusedItem(self):
700 '''get the currently focused item or -1 if none'''
701 return self.GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED)
703 def IsSelected(self, idx):
704 '''return TRUE if the item is selected'''
705 return self.GetItemState(idx, wxLIST_STATE_SELECTED) != 0
707 def SetColumnImage(self, col, image):
709 item.SetMask(wxLIST_MASK_IMAGE)
711 self.SetColumn(col, item)
713 def ClearColumnImage(self, col):
714 self.SetColumnImage(col, -1)
716 def Append(self, entry):
717 '''Append an item to the list control. The entry parameter should be a
718 sequence with an item for each column'''
720 pos = self.GetItemCount()
721 self.InsertStringItem(pos, str(entry[0]))
722 for i in range(1, len(entry)):
723 self.SetStringItem(pos, i, str(entry[i]))
728 // bool SortItems(wxListCtrlCompare fn, long data);
731 // func is a function which takes 2 long arguments: item1, item2.
732 // item1 is the long data associated with a first item (NOT the index).
733 // item2 is the long data associated with a second item (NOT the index).
734 // The return value is a negative number if the first item should precede the second
735 // item, a positive number of the second item should precede the first,
736 // or zero if the two items are equivalent.
737 bool SortItems(PyObject* func) {
738 if (!PyCallable_Check(func))
740 return self->SortItems(wxPyListCtrl_SortItems, (long)func);
747 %{ // Python aware sorting function for wxPyListCtrl
748 int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
750 PyObject* func = (PyObject*)funcPtr;
751 wxPyBeginBlockThreads();
753 PyObject* args = Py_BuildValue("(ii)", item1, item2);
754 PyObject* result = PyEval_CallObject(func, args);
757 retval = PyInt_AsLong(result);
761 wxPyEndBlockThreads();
767 //----------------------------------------------------------------------
769 class wxListView : public wxPyListCtrl
772 wxListView( wxWindow *parent,
774 const wxPoint& pos = wxDefaultPosition,
775 const wxSize& size = wxDefaultSize,
776 long style = wxLC_REPORT,
777 const wxValidator& validator = wxDefaultValidator,
778 const wxString& name = wxPyListCtrlNameStr);
779 %name(wxPreListView)wxListView();
781 bool Create( wxWindow *parent,
783 const wxPoint& pos = wxDefaultPosition,
784 const wxSize& size = wxDefaultSize,
785 long style = wxLC_REPORT,
786 const wxValidator& validator = wxDefaultValidator,
787 const wxString& name = wxPyListCtrlNameStr);
789 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
790 %pragma(python) addtomethod = "wxPreListView:val._setOORInfo(val)"
792 // [de]select an item
793 void Select(long n, bool on = TRUE);
795 // focus and show the given item
796 void Focus(long index);
798 // get the currently focused item or -1 if none
799 long GetFocusedItem() const;
801 // get first and subsequent selected items, return -1 when no more
802 long GetNextSelected(long item) const;
803 long GetFirstSelected() const;
805 // return TRUE if the item is selected
806 bool IsSelected(long index);
808 void SetColumnImage(int col, int image);
809 void ClearColumnImage(int col);
813 //----------------------------------------------------------------------
827 wxTR_FULL_ROW_HIGHLIGHT,
833 wxTR_HAS_VARIABLE_ROW_HEIGHT,
840 wxTreeItemIcon_Normal, // not selected, not expanded
841 wxTreeItemIcon_Selected, // selected, not expanded
842 wxTreeItemIcon_Expanded, // not selected, expanded
843 wxTreeItemIcon_SelectedExpanded, // selected, expanded
848 // constants for HitTest
850 wxTREE_HITTEST_ABOVE,
851 wxTREE_HITTEST_BELOW,
852 wxTREE_HITTEST_NOWHERE,
853 wxTREE_HITTEST_ONITEMBUTTON,
854 wxTREE_HITTEST_ONITEMICON,
855 wxTREE_HITTEST_ONITEMINDENT,
856 wxTREE_HITTEST_ONITEMLABEL,
857 wxTREE_HITTEST_ONITEMRIGHT,
858 wxTREE_HITTEST_ONITEMSTATEICON,
859 wxTREE_HITTEST_TOLEFT,
860 wxTREE_HITTEST_TORIGHT,
861 wxTREE_HITTEST_ONITEMUPPERPART,
862 wxTREE_HITTEST_ONITEMLOWERPART,
863 wxTREE_HITTEST_ONITEM
868 /* Tree control event types */
869 wxEVT_COMMAND_TREE_BEGIN_DRAG,
870 wxEVT_COMMAND_TREE_BEGIN_RDRAG,
871 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
872 wxEVT_COMMAND_TREE_END_LABEL_EDIT,
873 wxEVT_COMMAND_TREE_DELETE_ITEM,
874 wxEVT_COMMAND_TREE_GET_INFO,
875 wxEVT_COMMAND_TREE_SET_INFO,
876 wxEVT_COMMAND_TREE_ITEM_EXPANDED,
877 wxEVT_COMMAND_TREE_ITEM_EXPANDING,
878 wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
879 wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
880 wxEVT_COMMAND_TREE_SEL_CHANGED,
881 wxEVT_COMMAND_TREE_SEL_CHANGING,
882 wxEVT_COMMAND_TREE_KEY_DOWN,
883 wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
884 wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK,
885 wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK,
886 wxEVT_COMMAND_TREE_END_DRAG,
890 %pragma(python) code = "
892 def EVT_TREE_BEGIN_DRAG(win, id, func):
893 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_DRAG, func)
895 def EVT_TREE_BEGIN_RDRAG(win, id, func):
896 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_RDRAG, func)
898 def EVT_TREE_END_DRAG(win, id, func):
899 win.Connect(id, -1, wxEVT_COMMAND_TREE_END_DRAG, func)
901 def EVT_TREE_BEGIN_LABEL_EDIT(win, id, func):
902 win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, func)
904 def EVT_TREE_END_LABEL_EDIT(win, id, func):
905 win.Connect(id, -1, wxEVT_COMMAND_TREE_END_LABEL_EDIT, func)
907 def EVT_TREE_GET_INFO(win, id, func):
908 win.Connect(id, -1, wxEVT_COMMAND_TREE_GET_INFO, func)
910 def EVT_TREE_SET_INFO(win, id, func):
911 win.Connect(id, -1, wxEVT_COMMAND_TREE_SET_INFO, func)
913 def EVT_TREE_ITEM_EXPANDED(win, id, func):
914 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_EXPANDED, func)
916 def EVT_TREE_ITEM_EXPANDING(win, id, func):
917 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_EXPANDING, func)
919 def EVT_TREE_ITEM_COLLAPSED(win, id, func):
920 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_COLLAPSED, func)
922 def EVT_TREE_ITEM_COLLAPSING(win, id, func):
923 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_COLLAPSING, func)
925 def EVT_TREE_SEL_CHANGED(win, id, func):
926 win.Connect(id, -1, wxEVT_COMMAND_TREE_SEL_CHANGED, func)
928 def EVT_TREE_SEL_CHANGING(win, id, func):
929 win.Connect(id, -1, wxEVT_COMMAND_TREE_SEL_CHANGING, func)
931 def EVT_TREE_KEY_DOWN(win, id, func):
932 win.Connect(id, -1, wxEVT_COMMAND_TREE_KEY_DOWN, func)
934 def EVT_TREE_DELETE_ITEM(win, id, func):
935 win.Connect(id, -1, wxEVT_COMMAND_TREE_DELETE_ITEM, func)
937 def EVT_TREE_ITEM_ACTIVATED(win, id, func):
938 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_ACTIVATED, func)
940 def EVT_TREE_ITEM_RIGHT_CLICK(win, id, func):
941 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, func)
943 def EVT_TREE_ITEM_MIDDLE_CLICK(win, id, func):
944 win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, func)
952 //wxTreeItemAttr() { }
953 wxTreeItemAttr(const wxColour& colText = wxNullColour,
954 const wxColour& colBack = wxNullColour,
955 const wxFont& font = wxNullFont);
958 void SetTextColour(const wxColour& colText);
959 void SetBackgroundColour(const wxColour& colBack);
960 void SetFont(const wxFont& font);
963 bool HasTextColour();
964 bool HasBackgroundColour();
967 wxColour GetTextColour();
968 wxColour GetBackgroundColour();
978 %pragma(python) addtoclass = "Ok = IsOk"
981 int __cmp__(wxTreeItemId* other) {
982 if (! other) return -1;
983 return *self != *other;
991 class wxPyTreeItemData : public wxTreeItemData {
993 wxPyTreeItemData(PyObject* obj = NULL) {
1000 ~wxPyTreeItemData() {
1001 wxPyBeginBlockThreads();
1003 wxPyEndBlockThreads();
1006 PyObject* GetData() {
1011 void SetData(PyObject* obj) {
1012 wxPyBeginBlockThreads();
1014 wxPyEndBlockThreads();
1025 %name(wxTreeItemData) class wxPyTreeItemData : public wxObject {
1027 wxPyTreeItemData(PyObject* obj = NULL);
1029 PyObject* GetData();
1030 void SetData(PyObject* obj);
1032 const wxTreeItemId& GetId();
1033 void SetId(const wxTreeItemId& id);
1038 class wxTreeEvent : public wxNotifyEvent {
1040 wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
1042 wxTreeItemId GetItem();
1043 wxTreeItemId GetOldItem();
1045 const wxKeyEvent& GetKeyEvent();
1047 %pragma(python) addtoclass = "GetCode = GetKeyCode"
1048 const wxString& GetLabel();
1053 %{ // C++ version of Python aware wxTreeCtrl
1054 class wxPyTreeCtrl : public wxTreeCtrl {
1055 DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl);
1057 wxPyTreeCtrl() : wxTreeCtrl() {}
1058 wxPyTreeCtrl(wxWindow *parent, wxWindowID id,
1062 const wxValidator& validator,
1063 const wxString& name) :
1064 wxTreeCtrl(parent, id, pos, size, style, validator, name) {}
1066 bool Create(wxWindow *parent, wxWindowID id,
1070 const wxValidator& validator,
1071 const wxString& name) {
1072 return wxTreeCtrl::Create(parent, id, pos, size, style, validator, name);
1076 int OnCompareItems(const wxTreeItemId& item1,
1077 const wxTreeItemId& item2) {
1080 wxPyBeginBlockThreads();
1081 if ((found = m_myInst.findCallback("OnCompareItems"))) {
1082 PyObject *o1 = wxPyConstructObject((void*)&item1, "wxTreeItemId");
1083 PyObject *o2 = wxPyConstructObject((void*)&item2, "wxTreeItemId");
1084 rval = m_myInst.callCallback(Py_BuildValue("(OO)",o1,o2));
1088 wxPyEndBlockThreads();
1090 rval = wxTreeCtrl::OnCompareItems(item1, item2);
1096 IMPLEMENT_ABSTRACT_CLASS(wxPyTreeCtrl, wxTreeCtrl);
1100 // These are for the GetFirstChild/GetNextChild methods below
1101 %typemap(python, in) long& INOUT = long* INOUT;
1102 %typemap(python, argout) long& INOUT = long* INOUT;
1105 %name(wxTreeCtrl)class wxPyTreeCtrl : public wxControl {
1107 wxPyTreeCtrl(wxWindow *parent, wxWindowID id = -1,
1108 const wxPoint& pos = wxDefaultPosition,
1109 const wxSize& size = wxDefaultSize,
1110 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
1111 const wxValidator& validator = wxDefaultValidator,
1112 const wxString& name = wxPy_TreeCtrlNameStr);
1113 %name(wxPreTreeCtrl)wxPyTreeCtrl();
1115 bool Create(wxWindow *parent, wxWindowID id = -1,
1116 const wxPoint& pos = wxDefaultPosition,
1117 const wxSize& size = wxDefaultSize,
1118 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
1119 const wxValidator& validator = wxDefaultValidator,
1120 const wxString& name = wxPy_TreeCtrlNameStr);
1122 void _setCallbackInfo(PyObject* self, PyObject* _class);
1123 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTreeCtrl)"
1125 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1126 %pragma(python) addtomethod = "wxPreTreeCtrl:val._setOORInfo(val)"
1129 unsigned int GetIndent();
1130 void SetIndent(unsigned int indent);
1131 wxImageList *GetImageList();
1132 wxImageList *GetStateImageList();
1133 void SetImageList(wxImageList *imageList);
1134 void SetStateImageList(wxImageList *imageList);
1135 void AssignImageList(wxImageList* imageList);
1136 %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
1137 void AssignStateImageList(wxImageList* imageList);
1138 %pragma(python) addtomethod = "AssignStateImageList:_args[0].thisown = 0"
1140 unsigned int GetSpacing();
1141 void SetSpacing(unsigned int spacing);
1143 wxString GetItemText(const wxTreeItemId& item);
1144 int GetItemImage(const wxTreeItemId& item,
1145 wxTreeItemIcon which = wxTreeItemIcon_Normal);
1146 int GetItemSelectedImage(const wxTreeItemId& item);
1148 void SetItemText(const wxTreeItemId& item, const wxString& text);
1149 void SetItemImage(const wxTreeItemId& item, int image,
1150 wxTreeItemIcon which = wxTreeItemIcon_Normal);
1151 void SetItemSelectedImage(const wxTreeItemId& item, int image);
1152 void SetItemHasChildren(const wxTreeItemId& item, bool hasChildren = TRUE);
1155 // [Get|Set]ItemData substitutes. Automatically create wxPyTreeItemData
1157 wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
1158 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1160 data = new wxPyTreeItemData();
1161 data->SetId(item); // set the id
1162 self->SetItemData(item, data);
1167 void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
1168 data->SetId(item); // set the id
1169 self->SetItemData(item, data);
1172 // [Get|Set]PyData are short-cuts. Also made somewhat crash-proof by
1173 // automatically creating data classes.
1174 PyObject* GetPyData(const wxTreeItemId& item) {
1175 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1177 data = new wxPyTreeItemData();
1178 data->SetId(item); // set the id
1179 self->SetItemData(item, data);
1181 return data->GetData();
1184 void SetPyData(const wxTreeItemId& item, PyObject* obj) {
1185 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1187 data = new wxPyTreeItemData(obj);
1188 data->SetId(item); // set the id
1189 self->SetItemData(item, data);
1196 bool IsVisible(const wxTreeItemId& item);
1197 bool ItemHasChildren(const wxTreeItemId& item);
1198 bool IsExpanded(const wxTreeItemId& item);
1199 bool IsSelected(const wxTreeItemId& item);
1201 wxTreeItemId GetRootItem();
1202 wxTreeItemId GetSelection();
1203 %name(GetItemParent) wxTreeItemId GetParent(const wxTreeItemId& item);
1204 //size_t GetSelections(wxArrayTreeItemIds& selection);
1206 PyObject* GetSelections() {
1207 wxPyBeginBlockThreads();
1208 PyObject* rval = PyList_New(0);
1209 wxArrayTreeItemIds array;
1211 num = self->GetSelections(array);
1212 for (x=0; x < num; x++) {
1213 wxTreeItemId *tii = new wxTreeItemId(array.Item(x));
1214 PyObject* item = wxPyConstructObject((void*)tii, "wxTreeItemId", TRUE);
1215 PyList_Append(rval, item);
1217 wxPyEndBlockThreads();
1224 size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
1226 wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT = longzero);
1227 wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
1228 wxTreeItemId GetNextSibling(const wxTreeItemId& item);
1229 wxTreeItemId GetPrevSibling(const wxTreeItemId& item);
1230 wxTreeItemId GetFirstVisibleItem();
1231 wxTreeItemId GetNextVisible(const wxTreeItemId& item);
1232 wxTreeItemId GetPrevVisible(const wxTreeItemId& item);
1233 wxTreeItemId GetLastChild(const wxTreeItemId& item);
1237 wxTreeItemId AddRoot(const wxString& text,
1238 int image = -1, int selectedImage = -1,
1239 wxPyTreeItemData *data = NULL);
1240 wxTreeItemId PrependItem(const wxTreeItemId& parent,
1241 const wxString& text,
1242 int image = -1, int selectedImage = -1,
1243 wxPyTreeItemData *data = NULL);
1244 wxTreeItemId InsertItem(const wxTreeItemId& parent,
1245 const wxTreeItemId& idPrevious,
1246 const wxString& text,
1247 int image = -1, int selectedImage = -1,
1248 wxPyTreeItemData *data = NULL);
1249 %name(InsertItemBefore)
1250 wxTreeItemId InsertItem(const wxTreeItemId& parent,
1252 const wxString& text,
1253 int image = -1, int selectedImage = -1,
1254 wxPyTreeItemData *data = NULL);
1255 wxTreeItemId AppendItem(const wxTreeItemId& parent,
1256 const wxString& text,
1257 int image = -1, int selectedImage = -1,
1258 wxPyTreeItemData *data = NULL);
1260 void Delete(const wxTreeItemId& item);
1261 void DeleteChildren(const wxTreeItemId& item);
1262 void DeleteAllItems();
1264 void Expand(const wxTreeItemId& item);
1265 void Collapse(const wxTreeItemId& item);
1266 void CollapseAndReset(const wxTreeItemId& item);
1267 void Toggle(const wxTreeItemId& item);
1271 void SelectItem(const wxTreeItemId& item);
1272 void EnsureVisible(const wxTreeItemId& item);
1273 void ScrollTo(const wxTreeItemId& item);
1275 wxTextCtrl* EditLabel(const wxTreeItemId& item);
1276 wxTextCtrl* GetEditControl();
1277 void EndEditLabel(const wxTreeItemId& item, int discardChanges = FALSE);
1279 void EditLabel(const wxTreeItemId& item);
1282 void SortChildren(const wxTreeItemId& item);
1284 void SetItemBold(const wxTreeItemId& item, int bold = TRUE);
1285 bool IsBold(const wxTreeItemId& item) const;
1286 wxTreeItemId HitTest(const wxPoint& point, int& OUTPUT);
1290 void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
1291 void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
1292 void SetItemFont(const wxTreeItemId& item, const wxFont& font);
1295 void SetItemDropHighlight(const wxTreeItemId& item, int highlight = TRUE);
1298 //bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, int textOnly = FALSE)
1300 PyObject* GetBoundingRect(const wxTreeItemId& item, int textOnly = FALSE) {
1302 if (self->GetBoundingRect(item, rect, textOnly)) {
1303 wxPyBeginBlockThreads();
1304 wxRect* r = new wxRect(rect);
1305 PyObject* val = wxPyConstructObject((void*)r, "wxRect");
1306 wxPyEndBlockThreads();
1317 %pragma(python) addtoclass = "
1318 # Redefine some methods that SWIG gets a bit confused on...
1319 def GetFirstChild(self, *_args, **_kwargs):
1320 val1,val2 = apply(controls2c.wxTreeCtrl_GetFirstChild,(self,) + _args, _kwargs)
1321 val1 = wxTreeItemIdPtr(val1)
1324 def GetNextChild(self, *_args, **_kwargs):
1325 val1,val2 = apply(controls2c.wxTreeCtrl_GetNextChild,(self,) + _args, _kwargs)
1326 val1 = wxTreeItemIdPtr(val1)
1329 def HitTest(self, *_args, **_kwargs):
1330 val1, val2 = apply(controls2c.wxTreeCtrl_HitTest,(self,) + _args, _kwargs)
1331 val1 = wxTreeItemIdPtr(val1)
1339 //----------------------------------------------------------------------
1344 wxDIRCTRL_SELECT_FIRST,
1345 wxDIRCTRL_SHOW_FILTERS,
1346 wxDIRCTRL_3D_INTERNAL,
1347 wxDIRCTRL_EDIT_LABELS,
1350 wxID_FILTERLISTCTRL,
1354 class wxDirItemData : public wxObject // wxTreeItemData
1357 wxDirItemData(const wxString& path, const wxString& name, bool isDir);
1358 // ~wxDirItemDataEx();
1359 void SetNewDirName( wxString path );
1360 wxString m_path, m_name;
1367 class wxGenericDirCtrl: public wxControl
1370 wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = -1,
1371 const wxString& dir = wxPyDirDialogDefaultFolderStr,
1372 const wxPoint& pos = wxDefaultPosition,
1373 const wxSize& size = wxDefaultSize,
1374 long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
1375 const wxString& filter = wxPyEmptyString,
1376 int defaultFilter = 0,
1377 const wxString& name = wxPy_TreeCtrlNameStr);
1378 %name(wxPreGenericDirCtrl)wxGenericDirCtrl();
1380 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1381 %pragma(python) addtomethod = "wxPreGenericDirCtrl:val._setOORInfo(val)"
1383 bool Create(wxWindow *parent, const wxWindowID id = -1,
1384 const wxString& dir = wxPyDirDialogDefaultFolderStr,
1385 const wxPoint& pos = wxDefaultPosition,
1386 const wxSize& size = wxDefaultSize,
1387 long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
1388 const wxString& filter = wxPyEmptyString,
1389 int defaultFilter = 0,
1390 const wxString& name = wxPy_TreeCtrlNameStr);
1393 // Try to expand as much of the given path as possible.
1394 bool ExpandPath(const wxString& path);
1398 inline wxString GetDefaultPath() const;
1399 void SetDefaultPath(const wxString& path);
1401 // Get dir or filename
1402 wxString GetPath() const ;
1404 // Get selected filename path only (else empty string).
1405 // I.e. don't count a directory as a selection
1406 wxString GetFilePath() const ;
1407 void SetPath(const wxString& path) ;
1409 void ShowHidden( bool show );
1410 bool GetShowHidden();
1412 wxString GetFilter() const;
1413 void SetFilter(const wxString& filter);
1415 int GetFilterIndex() const;
1416 void SetFilterIndex(int n) ;
1418 wxTreeItemId GetRootId();
1420 wxTreeCtrl* GetTreeCtrl() const;
1421 wxDirFilterListCtrl* GetFilterListCtrl() const;
1424 // void SetupSections();
1425 // // Parse the filter into an array of filters and an array of descriptions
1426 // int ParseFilter(const wxString& filterStr, wxArrayString& filters, wxArrayString& descriptions);
1427 // // Find the child that matches the first part of 'path'.
1428 // // E.g. if a child path is "/usr" and 'path' is "/usr/include"
1429 // // then the child for /usr is returned.
1430 // // If the path string has been used (we're at the leaf), done is set to TRUE
1431 // wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);
1435 class wxDirFilterListCtrl: public wxChoice
1438 wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = -1,
1439 const wxPoint& pos = wxDefaultPosition,
1440 const wxSize& size = wxDefaultSize,
1442 %name(wxPreDirFilterListCtrl)wxDirFilterListCtrl();
1444 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1445 %pragma(python) addtomethod = "wxPreDirFilterListCtrl:val._setOORInfo(val)"
1447 bool Create(wxGenericDirCtrl* parent, const wxWindowID id = -1,
1448 const wxPoint& pos = wxDefaultPosition,
1449 const wxSize& size = wxDefaultSize,
1453 void FillFilterList(const wxString& filter, int defaultFilter);
1457 //----------------------------------------------------------------------
1458 //----------------------------------------------------------------------
1461 // Map renamed classes back to their common name for OOR
1462 wxPyPtrTypeMap_Add("wxTreeItemData", "wxPyTreeItemData");
1463 wxPyPtrTypeMap_Add("wxTreeCtrl", "wxPyTreeCtrl");
1464 wxPyPtrTypeMap_Add("wxListCtrl", "wxPyListCtrl");
1467 //----------------------------------------------------------------------