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>
24 //----------------------------------------------------------------------
27 %include my_typemaps.i
29 // Import some definitions of other classes, etc.
37 %pragma(python) code = "import wx"
39 //----------------------------------------------------------------------
49 wxLIST_STATE_DONTCARE,
50 wxLIST_STATE_DROPHILITED,
52 wxLIST_STATE_SELECTED,
56 wxLIST_HITTEST_NOWHERE,
57 wxLIST_HITTEST_ONITEMICON,
58 wxLIST_HITTEST_ONITEMLABEL,
59 wxLIST_HITTEST_ONITEMRIGHT,
60 wxLIST_HITTEST_ONITEMSTATEICON,
61 wxLIST_HITTEST_TOLEFT,
62 wxLIST_HITTEST_TORIGHT,
63 wxLIST_HITTEST_ONITEM,
72 wxLIST_ALIGN_SNAP_TO_GRID,
74 wxLIST_AUTOSIZE_USEHEADER,
85 enum wxListColumnFormat
90 wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
95 /* List control event types */
96 wxEVT_COMMAND_LIST_BEGIN_DRAG,
97 wxEVT_COMMAND_LIST_BEGIN_RDRAG,
98 wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT,
99 wxEVT_COMMAND_LIST_END_LABEL_EDIT,
100 wxEVT_COMMAND_LIST_DELETE_ITEM,
101 wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS,
102 wxEVT_COMMAND_LIST_GET_INFO,
103 wxEVT_COMMAND_LIST_SET_INFO,
104 wxEVT_COMMAND_LIST_ITEM_SELECTED,
105 wxEVT_COMMAND_LIST_ITEM_DESELECTED,
106 wxEVT_COMMAND_LIST_KEY_DOWN,
107 wxEVT_COMMAND_LIST_INSERT_ITEM,
108 wxEVT_COMMAND_LIST_COL_CLICK,
109 wxEVT_COMMAND_LIST_ITEM_ACTIVATED,
110 wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK,
111 wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK,
121 //wxListItemAttr(const wxColour& colText,
122 // const wxColour& colBack,
123 // const wxFont& font)
124 // : m_colText(colText), m_colBack(colBack), m_font(font) { }
127 void SetTextColour(const wxColour& colText);
128 void SetBackgroundColour(const wxColour& colBack);
129 void SetFont(const wxFont& font);
132 bool HasTextColour();
133 bool HasBackgroundColour();
136 const wxColour& GetTextColour();
137 const wxColour& GetBackgroundColour();
138 const wxFont& GetFont();
149 void ClearAttributes();
152 void SetMask(long mask);
154 void SetColumn(int col);
155 void SetState(long state);
156 void SetStateMask(long stateMask);
157 void SetText(const wxString& text);
158 void SetImage(int image);
159 void SetData(long data);
161 void SetWidth(int width);
162 void SetAlign(wxListColumnFormat align);
164 void SetTextColour(const wxColour& colText);
165 void SetBackgroundColour(const wxColour& colBack);
166 void SetFont(const wxFont& font);
173 const wxString& GetText();
178 wxListColumnFormat GetAlign();
180 wxListItemAttr *GetAttributes();
181 bool HasAttributes();
183 wxColour GetTextColour() const;
184 wxColour GetBackgroundColour() const;
185 wxFont GetFont() const;
187 // these members are public for compatibility
188 long m_mask; // Indicates what fields are valid
189 long m_itemId; // The zero-based item position
190 int m_col; // Zero-based column, if in report mode
191 long m_state; // The state of the item
192 long m_stateMask;// Which flags of m_state are valid (uses same flags)
193 wxString m_text; // The label/header text
194 int m_image; // The zero-based index into an image list
195 long m_data; // App-defined data
198 int m_format; // left, right, centre
199 int m_width; // width of column
204 class wxListEvent: public wxNotifyEvent {
221 const wxString& GetLabel();
222 const wxString& GetText();
226 const wxListItem& GetItem();
231 class wxListCtrl : public wxControl {
233 wxListCtrl(wxWindow* parent, wxWindowID id,
234 const wxPoint& pos = wxDefaultPosition,
235 const wxSize& size = wxDefaultSize,
236 long style = wxLC_ICON,
237 const wxValidator& validator = wxDefaultValidator,
238 char* name = "listCtrl");
240 %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
242 bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
243 void AssignImageList(wxImageList* imageList, int which);
244 bool DeleteItem(long item);
245 bool DeleteAllItems();
246 bool DeleteColumn(int col);
247 bool DeleteAllColumns(void);
250 wxTextCtrl* EditLabel(long item);
251 bool EndEditLabel(bool cancel);
252 wxTextCtrl* GetEditControl();
254 void EditLabel(long item);
256 bool EnsureVisible(long item);
257 long FindItem(long start, const wxString& str, bool partial = FALSE);
258 %name(FindItemData)long FindItem(long start, long data);
259 %name(FindItemAtPos)long FindItem(long start, const wxPoint& pt,
261 bool GetColumn(int col, wxListItem& item);
262 int GetColumnWidth(int col);
263 int GetCountPerPage();
264 wxImageList* GetImageList(int which);
265 long GetItemData(long item);
268 %new wxListItem* GetItem(long itemId, int col=0) {
269 wxListItem* info = new wxListItem;
270 info->m_itemId = itemId;
272 info->m_mask = 0xFFFF;
273 self->GetItem(*info);
276 %new wxPoint* GetItemPosition(long item) {
277 wxPoint* pos = new wxPoint;
278 self->GetItemPosition(item, *pos);
281 %new wxRect* GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
282 wxRect* rect= new wxRect;
283 self->GetItemRect(item, *rect, code);
288 int GetItemState(long item, long stateMask);
290 int GetItemSpacing(bool isSmall);
291 wxString GetItemText(long item);
292 long GetNextItem(long item,
293 int geometry = wxLIST_NEXT_ALL,
294 int state = wxLIST_STATE_DONTCARE);
295 int GetSelectedItemCount();
297 wxColour GetTextColour();
298 void SetTextColour(const wxColour& col);
301 long HitTest(const wxPoint& point, int& OUTPUT);
302 %name(InsertColumnInfo)long InsertColumn(long col, wxListItem& info);
303 long InsertColumn(long col, const wxString& heading,
304 int format = wxLIST_FORMAT_LEFT,
307 long InsertItem(wxListItem& info);
308 %name(InsertStringItem) long InsertItem(long index, const wxString& label);
309 %name(InsertImageItem) long InsertItem(long index, int imageIndex);
310 %name(InsertImageStringItem)long InsertItem(long index, const wxString& label,
313 bool ScrollList(int dx, int dy);
314 void SetBackgroundColour(const wxColour& col);
315 bool SetColumn(int col, wxListItem& item);
316 bool SetColumnWidth(int col, int width);
317 void SetImageList(wxImageList* imageList, int which);
319 bool SetItem(wxListItem& info);
320 %name(SetStringItem)long SetItem(long index, int col, const wxString& label,
323 bool SetItemData(long item, long data);
324 bool SetItemImage(long item, int image, int selImage);
325 bool SetItemPosition(long item, const wxPoint& pos);
326 bool SetItemState(long item, long state, long stateMask);
327 void SetItemText(long item, const wxString& text);
328 void SetSingleStyle(long style, bool add = TRUE);
329 void SetWindowStyleFlag(long style);
331 // bool SortItems(wxListCtrlCompare fn, long data);
333 bool SortItems(PyObject* func) {
334 if (!PyCallable_Check(func))
337 return self->SortItems(wxPyListCtrl_SortItems, (long)func);
343 int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
345 PyObject* func = (PyObject*)funcPtr;
346 bool doSave = wxPyRestoreThread();
348 PyObject* args = Py_BuildValue("(ii)", item1, item2);
349 PyObject* result = PyEval_CallObject(func, args);
352 retval = PyInt_AsLong(result);
356 wxPySaveThread(doSave);
362 //----------------------------------------------------------------------
366 wxTreeItemIcon_Normal, // not selected, not expanded
367 wxTreeItemIcon_Selected, // selected, not expanded
368 wxTreeItemIcon_Expanded, // not selected, expanded
369 wxTreeItemIcon_SelectedExpanded, // selected, expanded
374 // constants for HitTest
376 wxTREE_HITTEST_ABOVE,
377 wxTREE_HITTEST_BELOW,
378 wxTREE_HITTEST_NOWHERE,
379 wxTREE_HITTEST_ONITEMBUTTON,
380 wxTREE_HITTEST_ONITEMICON,
381 wxTREE_HITTEST_ONITEMINDENT,
382 wxTREE_HITTEST_ONITEMLABEL,
383 wxTREE_HITTEST_ONITEMRIGHT,
384 wxTREE_HITTEST_ONITEMSTATEICON,
385 wxTREE_HITTEST_TOLEFT,
386 wxTREE_HITTEST_TORIGHT,
387 wxTREE_HITTEST_ONITEMUPPERPART,
388 wxTREE_HITTEST_ONITEMLOWERPART,
389 wxTREE_HITTEST_ONITEM
394 /* Tree control event types */
395 wxEVT_COMMAND_TREE_BEGIN_DRAG,
396 wxEVT_COMMAND_TREE_BEGIN_RDRAG,
397 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
398 wxEVT_COMMAND_TREE_END_LABEL_EDIT,
399 wxEVT_COMMAND_TREE_DELETE_ITEM,
400 wxEVT_COMMAND_TREE_GET_INFO,
401 wxEVT_COMMAND_TREE_SET_INFO,
402 wxEVT_COMMAND_TREE_ITEM_EXPANDED,
403 wxEVT_COMMAND_TREE_ITEM_EXPANDING,
404 wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
405 wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
406 wxEVT_COMMAND_TREE_SEL_CHANGED,
407 wxEVT_COMMAND_TREE_SEL_CHANGING,
408 wxEVT_COMMAND_TREE_KEY_DOWN,
409 wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
410 wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK,
411 wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK,
412 wxEVT_COMMAND_TREE_END_DRAG,
423 int __cmp__(wxTreeItemId* other) {
424 if (! other) return -1;
425 return *self != *other;
433 class wxPyTreeItemData : public wxTreeItemData {
435 wxPyTreeItemData(PyObject* obj = NULL) {
442 ~wxPyTreeItemData() {
443 bool doSave = wxPyRestoreThread();
445 wxPySaveThread(doSave);
448 PyObject* GetData() {
453 void SetData(PyObject* obj) {
454 bool doSave = wxPyRestoreThread();
456 wxPySaveThread(doSave);
467 %name(wxTreeItemData) class wxPyTreeItemData {
469 wxPyTreeItemData(PyObject* obj = NULL);
472 void SetData(PyObject* obj);
474 const wxTreeItemId& GetId();
475 void SetId(const wxTreeItemId& id);
480 class wxTreeEvent : public wxNotifyEvent {
482 wxTreeItemId GetItem();
483 wxTreeItemId GetOldItem();
486 const wxString& GetLabel();
492 class wxPyTreeCtrl : public wxTreeCtrl {
493 DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl);
495 wxPyTreeCtrl(wxWindow *parent, wxWindowID id,
499 const wxValidator& validator,
501 wxTreeCtrl(parent, id, pos, size, style, validator, name) {}
503 int OnCompareItems(const wxTreeItemId& item1,
504 const wxTreeItemId& item2) {
506 bool doSave = wxPyRestoreThread();
507 if (m_myInst.findCallback("OnCompareItems"))
508 rval = m_myInst.callCallback(Py_BuildValue(
510 wxPyConstructObject((void*)&item1, "wxTreeItemId"),
511 wxPyConstructObject((void*)&item2, "wxTreeItemId")));
513 rval = wxTreeCtrl::OnCompareItems(item1, item2);
514 wxPySaveThread(doSave);
520 IMPLEMENT_ABSTRACT_CLASS(wxPyTreeCtrl, wxTreeCtrl);
524 // These are for the GetFirstChild/GetNextChild methods below
525 %typemap(python, in) long& INOUT = long* INOUT;
526 %typemap(python, argout) long& INOUT = long* INOUT;
529 %name(wxTreeCtrl)class wxPyTreeCtrl : public wxControl {
531 wxPyTreeCtrl(wxWindow *parent, wxWindowID id = -1,
532 const wxPoint& pos = wxDefaultPosition,
533 const wxSize& size = wxDefaultSize,
534 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
535 const wxValidator& validator = wxDefaultValidator,
536 char* name = "wxTreeCtrl");
538 void _setSelf(PyObject* self, PyObject* _class);
539 %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
540 %pragma(python) addtomethod = "__init__:self._setSelf(self, wxTreeCtrl)"
542 void AssignImageList(wxImageList* imageList);
544 unsigned int GetIndent();
545 void SetIndent(unsigned int indent);
546 wxImageList *GetImageList();
547 wxImageList *GetStateImageList();
548 void SetImageList(wxImageList *imageList);
549 void SetStateImageList(wxImageList *imageList);
551 unsigned int GetSpacing();
552 void SetSpacing(unsigned int spacing);
554 wxString GetItemText(const wxTreeItemId& item);
555 int GetItemImage(const wxTreeItemId& item,
556 wxTreeItemIcon which = wxTreeItemIcon_Normal);
557 int GetItemSelectedImage(const wxTreeItemId& item);
559 void SetItemText(const wxTreeItemId& item, const wxString& text);
560 void SetItemImage(const wxTreeItemId& item, int image,
561 wxTreeItemIcon which = wxTreeItemIcon_Normal);
562 void SetItemSelectedImage(const wxTreeItemId& item, int image);
563 void SetItemHasChildren(const wxTreeItemId& item, bool hasChildren = TRUE);
566 // [Get|Set]ItemData substitutes. Automatically create wxPyTreeItemData
568 wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
569 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
571 data = new wxPyTreeItemData();
572 data->SetId(item); // set the id
573 self->SetItemData(item, data);
578 void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
579 data->SetId(item); // set the id
580 self->SetItemData(item, data);
583 // [Get|Set]PyData are short-cuts. Also made somewhat crash-proof by
584 // automatically creating data classes.
585 PyObject* GetPyData(const wxTreeItemId& item) {
586 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
588 data = new wxPyTreeItemData();
589 data->SetId(item); // set the id
590 self->SetItemData(item, data);
592 return data->GetData();
595 void SetPyData(const wxTreeItemId& item, PyObject* obj) {
596 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
598 data = new wxPyTreeItemData(obj);
599 data->SetId(item); // set the id
600 self->SetItemData(item, data);
607 bool IsVisible(const wxTreeItemId& item);
608 bool ItemHasChildren(const wxTreeItemId& item);
609 bool IsExpanded(const wxTreeItemId& item);
610 bool IsSelected(const wxTreeItemId& item);
612 wxTreeItemId GetRootItem();
613 wxTreeItemId GetSelection();
614 %name(GetItemParent) wxTreeItemId GetParent(const wxTreeItemId& item);
615 //size_t GetSelections(wxArrayTreeItemIds& selection);
617 PyObject* GetSelections() {
618 bool doSave = wxPyRestoreThread();
619 PyObject* rval = PyList_New(0);
620 wxArrayTreeItemIds array;
622 num = self->GetSelections(array);
623 for (x=0; x < num; x++) {
624 wxTreeItemId *tii = new wxTreeItemId(array.Item(x));
625 PyObject* item = wxPyConstructObject((void*)tii, "wxTreeItemId", TRUE);
626 PyList_Append(rval, item);
628 wxPySaveThread(doSave);
635 size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
637 wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT);
638 wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
639 wxTreeItemId GetNextSibling(const wxTreeItemId& item);
640 wxTreeItemId GetPrevSibling(const wxTreeItemId& item);
641 wxTreeItemId GetFirstVisibleItem();
642 wxTreeItemId GetNextVisible(const wxTreeItemId& item);
643 wxTreeItemId GetPrevVisible(const wxTreeItemId& item);
644 wxTreeItemId GetLastChild(const wxTreeItemId& item);
648 wxTreeItemId AddRoot(const wxString& text,
649 int image = -1, int selectedImage = -1,
650 wxPyTreeItemData *data = NULL);
651 wxTreeItemId PrependItem(const wxTreeItemId& parent,
652 const wxString& text,
653 int image = -1, int selectedImage = -1,
654 wxPyTreeItemData *data = NULL);
655 wxTreeItemId InsertItem(const wxTreeItemId& parent,
656 const wxTreeItemId& idPrevious,
657 const wxString& text,
658 int image = -1, int selectedImage = -1,
659 wxPyTreeItemData *data = NULL);
660 %name(InsertItemBefore)
661 wxTreeItemId InsertItem(const wxTreeItemId& parent,
663 const wxString& text,
664 int image = -1, int selectedImage = -1,
665 wxTreeItemData *data = NULL);
666 wxTreeItemId AppendItem(const wxTreeItemId& parent,
667 const wxString& text,
668 int image = -1, int selectedImage = -1,
669 wxPyTreeItemData *data = NULL);
671 void Delete(const wxTreeItemId& item);
672 void DeleteChildren(const wxTreeItemId& item);
673 void DeleteAllItems();
675 void Expand(const wxTreeItemId& item);
676 void Collapse(const wxTreeItemId& item);
677 void CollapseAndReset(const wxTreeItemId& item);
678 void Toggle(const wxTreeItemId& item);
682 void SelectItem(const wxTreeItemId& item);
683 void EnsureVisible(const wxTreeItemId& item);
684 void ScrollTo(const wxTreeItemId& item);
686 wxTextCtrl* EditLabel(const wxTreeItemId& item);
687 wxTextCtrl* GetEditControl();
688 void EndEditLabel(const wxTreeItemId& item, int discardChanges = FALSE);
690 void EditLabel(const wxTreeItemId& item);
693 void SortChildren(const wxTreeItemId& item);
695 void SetItemBold(const wxTreeItemId& item, int bold = TRUE);
696 bool IsBold(const wxTreeItemId& item) const;
697 wxTreeItemId HitTest(const wxPoint& point, int& OUTPUT);
701 void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
702 void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
703 void SetItemFont(const wxTreeItemId& item, const wxFont& font);
706 void SetItemDropHighlight(const wxTreeItemId& item, int highlight = TRUE);
708 //bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, int textOnly = FALSE)
710 PyObject* GetBoundingRect(const wxTreeItemId& item, int textOnly = FALSE) {
712 if (self->GetBoundingRect(item, rect, textOnly)) {
713 bool doSave = wxPyRestoreThread();
714 wxRect* r = new wxRect(rect);
715 PyObject* val = wxPyConstructObject((void*)r, "wxRect");
716 wxPySaveThread(doSave);
727 %pragma(python) addtoclass = "
728 # Redefine some methods that SWIG gets a bit confused on...
729 def GetFirstChild(self, *_args, **_kwargs):
730 val1,val2 = apply(controls2c.wxTreeCtrl_GetFirstChild,(self,) + _args, _kwargs)
731 val1 = wxTreeItemIdPtr(val1)
734 def GetNextChild(self, *_args, **_kwargs):
735 val1,val2 = apply(controls2c.wxTreeCtrl_GetNextChild,(self,) + _args, _kwargs)
736 val1 = wxTreeItemIdPtr(val1)
739 def HitTest(self, *_args, **_kwargs):
740 val1, val2 = apply(controls2c.wxTreeCtrl_HitTest,(self,) + _args, _kwargs)
741 val1 = wxTreeItemIdPtr(val1)
748 //----------------------------------------------------------------------
755 /* tab control event types */
756 wxEVT_COMMAND_TAB_SEL_CHANGED,
757 wxEVT_COMMAND_TAB_SEL_CHANGING,
761 class wxTabEvent : public wxCommandEvent {
767 class wxTabCtrl : public wxControl {
769 wxTabCtrl(wxWindow* parent, wxWindowID id,
770 const wxPoint& pos = wxDefaultPosition,
771 const wxSize& size = wxDefaultSize,
773 char* name = "tabCtrl");
775 %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
777 bool DeleteAllItems();
778 bool DeleteItem(int item);
779 wxImageList* GetImageList();
781 // TODO: void* GetItemData();
782 int GetItemImage(int item);
785 %new wxRect* GetItemRect(int item) {
786 wxRect* rect = new wxRect;
787 self->GetItemRect(item, *rect);
792 wxString GetItemText(int item);
795 int HitTest(const wxPoint& pt, long& OUTPUT);
796 void InsertItem(int item, const wxString& text,
797 int imageId = -1, void* clientData = NULL);
798 // TODO: bool SetItemData(int item, void* data);
799 bool SetItemImage(int item, int image);
800 void SetImageList(wxImageList* imageList);
801 void SetItemSize(const wxSize& size);
802 bool SetItemText(int item, const wxString& text);
803 void SetPadding(const wxSize& padding);
804 int SetSelection(int item);
811 //----------------------------------------------------------------------