utils/wxPython/src/controls2.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        controls2.i
   3 // Purpose:     More control (widget) classes for wxPython
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     6/10/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 %module controls2
  14
  15 %{
  16 #include "helpers.h"
  17 #ifdef __WXMSW__
  18 #include <windows.h>
  19 #endif
  20 #include <wx/listctrl.h>
  21 #include <wx/treectrl.h>
  22 %}
  23
  24 //----------------------------------------------------------------------
  25
  26 %include typemaps.i
  27 %include my_typemaps.i
  28
  29 // Import some definitions of other classes, etc.
  30 %import _defs.i
  31 %import misc.i
  32 %import windows.i
  33 %import gdi.i
  34 %import events.i
  35 %import controls.i
  36
  37 %pragma(python) code = "import wx"
  38
  39 //----------------------------------------------------------------------
  40
  41 %{
  42 extern wxValidator wxPyDefaultValidator;
  43 %}
  44
  45 //----------------------------------------------------------------------
  46
  47 enum {
  48     wxLIST_MASK_TEXT,
  49     wxLIST_MASK_IMAGE,
  50     wxLIST_MASK_DATA,
  51     wxLIST_MASK_WIDTH,
  52     wxLIST_MASK_FORMAT,
  53     wxLIST_MASK_STATE,
  54     wxLIST_STATE_DONTCARE,
  55     wxLIST_STATE_DROPHILITED,
  56     wxLIST_STATE_FOCUSED,
  57     wxLIST_STATE_SELECTED,
  58     wxLIST_STATE_CUT,
  59     wxLIST_HITTEST_ABOVE,
  60     wxLIST_HITTEST_BELOW,
  61     wxLIST_HITTEST_NOWHERE,
  62     wxLIST_HITTEST_ONITEMICON,
  63     wxLIST_HITTEST_ONITEMLABEL,
  64     wxLIST_HITTEST_ONITEMRIGHT,
  65     wxLIST_HITTEST_ONITEMSTATEICON,
  66     wxLIST_HITTEST_TOLEFT,
  67     wxLIST_HITTEST_TORIGHT,
  68     wxLIST_HITTEST_ONITEM,
  69     wxLIST_NEXT_ABOVE,
  70     wxLIST_NEXT_ALL,
  71     wxLIST_NEXT_BELOW,
  72     wxLIST_NEXT_LEFT,
  73     wxLIST_NEXT_RIGHT,
  74     wxLIST_ALIGN_DEFAULT,
  75     wxLIST_ALIGN_LEFT,
  76     wxLIST_ALIGN_TOP,
  77     wxLIST_ALIGN_SNAP_TO_GRID,
  78     wxLIST_FORMAT_LEFT,
  79     wxLIST_FORMAT_RIGHT,
  80     wxLIST_FORMAT_CENTRE,
  81     wxLIST_FORMAT_CENTER,
  82     wxLIST_AUTOSIZE,
  83     wxLIST_AUTOSIZE_USEHEADER,
  84     wxLIST_RECT_BOUNDS,
  85     wxLIST_RECT_ICON,
  86     wxLIST_RECT_LABEL,
  87     wxLIST_FIND_UP,
  88     wxLIST_FIND_DOWN,
  89     wxLIST_FIND_LEFT,
  90     wxLIST_FIND_RIGHT,
  91 };
  92
  93
  94 class wxListItem {
  95 public:
  96     long            m_mask;     // Indicates what fields are valid
  97     long            m_itemId;   // The zero-based item position
  98     int             m_col;      // Zero-based column, if in report mode
  99     long            m_state;    // The state of the item
 100     long            m_stateMask; // Which flags of m_state are valid (uses same flags)
 101     wxString        m_text;     // The label/header text
 102     int             m_image;    // The zero-based index into an image list
 103     long            m_data;     // App-defined data
 104 //    wxColour       *m_colour;   // only wxGLC, not supported by Windows ;->
 105
 106     // For columns only
 107     int             m_format;   // left, right, centre
 108     int             m_width;    // width of column
 109
 110     wxListItem();
 111     ~wxListItem();
 112 };
 113
 114 class wxListEvent: public wxCommandEvent {
 115 public:
 116     int           m_code;
 117     long          m_itemIndex;
 118     long          m_oldItemIndex;
 119     int           m_col;
 120     bool          m_cancelled;
 121     wxPoint       m_pointDrag;
 122     wxListItem    m_item;
 123 };
 124
 125
 126
 127
 128 class wxListCtrl : public wxControl {
 129 public:
 130     wxListCtrl(wxWindow* parent, wxWindowID id,
 131                const wxPoint& pos = wxPyDefaultPosition,
 132                const wxSize& size = wxPyDefaultSize,
 133                long style = wxLC_ICON,
 134                const wxValidator& validator = wxPyDefaultValidator,
 135                char* name = "listCtrl");
 136
 137     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 138
 139     bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
 140     bool DeleteItem(long item);
 141     bool DeleteAllItems();
 142     bool DeleteColumn(int col);
 143     bool DeleteAllColumns(void);
 144     void ClearAll(void);
 145 #ifdef __WXMSW__
 146     wxTextCtrl* EditLabel(long item);
 147     bool EndEditLabel(bool cancel);
 148     wxTextCtrl* GetEditControl();
 149 #else
 150     void EditLabel(long item);
 151 #endif
 152     bool EnsureVisible(long item);
 153     long FindItem(long start, const wxString& str, bool partial = FALSE);
 154     %name(FindItemData)long FindItem(long start, long data);
 155     %name(FindItemAtPos)long FindItem(long start, const wxPoint& pt,
 156                                       int direction);
 157     bool GetColumn(int col, wxListItem& item);
 158     int GetColumnWidth(int col);
 159     int GetCountPerPage();
 160     wxImageList* GetImageList(int which);
 161     long GetItemData(long item);
 162
 163     %addmethods {
 164         %new wxListItem* GetItem(long itemId, int col=0) {
 165             wxListItem* info = new wxListItem;
 166             info->m_itemId = itemId;
 167             info->m_col = col;
 168             info->m_mask = 0xFFFF;
 169             self->GetItem(*info);
 170             return info;
 171         }
 172         %new wxPoint* GetItemPosition(long item) {
 173             wxPoint* pos = new wxPoint;
 174             self->GetItemPosition(item, *pos);
 175             return pos;
 176         }
 177         %new wxRect* GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
 178             wxRect* rect= new wxRect;
 179             self->GetItemRect(item, *rect, code);
 180             return rect;
 181         }
 182     }
 183
 184     int GetItemState(long item, long stateMask);
 185     int GetItemCount();
 186     int GetItemSpacing(bool isSmall);
 187     wxString GetItemText(long item);
 188     long GetNextItem(long item,
 189                      int geometry = wxLIST_NEXT_ALL,
 190                      int state = wxLIST_STATE_DONTCARE);
 191     int GetSelectedItemCount();
 192 #ifdef __WXMSW__
 193     wxColour GetTextColour();
 194     void SetTextColour(const wxColour& col);
 195 #endif
 196     long GetTopItem();
 197     long HitTest(const wxPoint& point, int& OUTPUT);
 198     %name(InsertColumnWith)long InsertColumn(long col, wxListItem& info);
 199     long InsertColumn(long col, const wxString& heading,
 200                       int format = wxLIST_FORMAT_LEFT,
 201                       int width = -1);
 202
 203     long InsertItem(wxListItem& info);
 204     %name(InsertStringItem)     long InsertItem(long index, const wxString& label);
 205     %name(InsertImageItem)      long InsertItem(long index, int imageIndex);
 206     %name(InsertImageStringItem)long InsertItem(long index, const wxString& label,
 207                                                 int imageIndex);
 208
 209     bool ScrollList(int dx, int dy);
 210     void SetBackgroundColour(const wxColour& col);
 211     bool SetColumn(int col, wxListItem& item);
 212     bool SetColumnWidth(int col, int width);
 213     void SetImageList(wxImageList* imageList, int which);
 214
 215     bool SetItem(wxListItem& info);
 216     %name(SetStringItem)long SetItem(long index, int col, const wxString& label,
 217                                      int imageId = -1);
 218
 219     bool SetItemData(long item, long data);
 220     bool SetItemImage(long item, int image, int selImage);
 221     bool SetItemPosition(long item, const wxPoint& pos);
 222     bool SetItemState(long item, long state, long stateMask);
 223     void SetItemText(long item, const wxString& text);
 224     void SetSingleStyle(long style, bool add = TRUE);
 225     void SetWindowStyleFlag(long style);
 226     // TODO:  bool SortItems(wxListCtrlCompare fn, long data);
 227 };
 228
 229
 230
 231 //----------------------------------------------------------------------
 232
 233 enum wxTreeItemIcon
 234 {
 235     wxTreeItemIcon_Normal,              // not selected, not expanded
 236     wxTreeItemIcon_Selected,            //     selected, not expanded
 237     wxTreeItemIcon_Expanded,            // not selected,     expanded
 238     wxTreeItemIcon_SelectedExpanded,    //     selected,     expanded
 239     wxTreeItemIcon_Max
 240 };
 241
 242
 243 class wxTreeItemId {
 244 public:
 245     wxTreeItemId();
 246     ~wxTreeItemId();
 247     bool IsOk();
 248
 249 };
 250
 251
 252
 253 %{
 254 class wxPyTreeItemData : public wxTreeItemData {
 255 public:
 256     wxPyTreeItemData(PyObject* obj = NULL) {
 257         if (obj == NULL)
 258             obj = Py_None;
 259         Py_INCREF(obj);
 260         m_obj = obj;
 261     }
 262
 263     ~wxPyTreeItemData() {
 264         bool doSave = wxPyRestoreThread();
 265         Py_DECREF(m_obj);
 266         wxPySaveThread(doSave);
 267     }
 268
 269     PyObject* GetData() {
 270         Py_INCREF(m_obj);
 271         return m_obj;
 272     }
 273
 274     void SetData(PyObject* obj) {
 275         Py_DECREF(m_obj);
 276         m_obj = obj;
 277         Py_INCREF(obj);
 278     }
 279
 280     PyObject* m_obj;
 281 };
 282 %}
 283
 284
 285
 286 %name(wxTreeItemData) class wxPyTreeItemData {
 287 public:
 288     wxPyTreeItemData(PyObject* obj = NULL);
 289
 290     PyObject* GetData();
 291     void      SetData(PyObject* obj);
 292
 293     const wxTreeItemId& GetId();
 294     void                SetId(const wxTreeItemId& id);
 295 };
 296
 297
 298
 299 class wxTreeEvent : public wxNotifyEvent {
 300 public:
 301     wxTreeItemId GetItem();
 302     wxTreeItemId GetOldItem();
 303     wxPoint GetPoint();
 304     int GetCode();
 305     const wxString& GetLabel();
 306 };
 307
 308
 309 // These are for the GetFirstChild/GetNextChild methods below
 310 %typemap(python, in)     long& INOUT = long* INOUT;
 311 %typemap(python, argout) long& INOUT = long* INOUT;
 312
 313
 314 class wxTreeCtrl : public wxControl {
 315 public:
 316     wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
 317                const wxPoint& pos = wxPyDefaultPosition,
 318                const wxSize& size = wxPyDefaultSize,
 319                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
 320                const wxValidator& validator = wxPyDefaultValidator,
 321                char* name = "wxTreeCtrl");
 322
 323     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 324
 325     size_t GetCount();
 326     unsigned int GetIndent();
 327     void SetIndent(unsigned int indent);
 328     wxImageList *GetImageList();
 329     wxImageList *GetStateImageList();
 330     void SetImageList(wxImageList *imageList/*, int which = wxIMAGE_LIST_NORMAL*/);
 331     void SetStateImageList(wxImageList *imageList);
 332
 333     unsigned int GetSpacing();
 334     void SetSpacing(unsigned int spacing);
 335
 336     wxString GetItemText(const wxTreeItemId& item);
 337     int GetItemImage(const wxTreeItemId& item,
 338                      wxTreeItemIcon which = wxTreeItemIcon_Normal);
 339     int GetItemSelectedImage(const wxTreeItemId& item);
 340
 341     void SetItemText(const wxTreeItemId& item, const wxString& text);
 342     void SetItemImage(const wxTreeItemId& item, int image,
 343                       wxTreeItemIcon which = wxTreeItemIcon_Normal);
 344     void SetItemSelectedImage(const wxTreeItemId& item, int image);
 345     void SetItemHasChildren(const wxTreeItemId& item, bool hasChildren = TRUE);
 346
 347     %addmethods {
 348         // [Get|Set]ItemData substitutes.  Automatically create wxPyTreeItemData
 349         // if needed.
 350         wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
 351             wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
 352             if (data == NULL) {
 353                 data = new wxPyTreeItemData();
 354                 self->SetItemData(item, data);
 355             }
 356             return data;
 357         }
 358
 359         void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
 360           self->SetItemData(item, data);
 361         }
 362
 363         // [Get|Set]PyData are short-cuts.  Also made somewhat crash-proof by
 364         // automatically creating data classes.
 365         PyObject* GetPyData(const wxTreeItemId& item) {
 366             wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
 367             if (data == NULL) {
 368                 data = new wxPyTreeItemData();
 369                 self->SetItemData(item, data);
 370             }
 371             return data->GetData();
 372         }
 373
 374         void SetPyData(const wxTreeItemId& item, PyObject* obj) {
 375             wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
 376             if (data == NULL) {
 377                 data = new wxPyTreeItemData(obj);
 378                 self->SetItemData(item, data);
 379             } else
 380                 data->SetData(obj);
 381         }
 382     }
 383
 384
 385     bool IsVisible(const wxTreeItemId& item);
 386     bool ItemHasChildren(const wxTreeItemId& item);
 387     bool IsExpanded(const wxTreeItemId& item);
 388     bool IsSelected(const wxTreeItemId& item);
 389
 390     wxTreeItemId GetRootItem();
 391     wxTreeItemId GetSelection();
 392     %name(GetItemParent) wxTreeItemId GetParent(const wxTreeItemId& item);
 393     //size_t GetSelections(wxArrayTreeItemIds& selection);
 394     %addmethods {
 395         PyObject* GetSelections() {
 396             PyObject*           rval = PyList_New(0);
 397             wxArrayTreeItemIds  array;
 398             size_t              num, x;
 399             num = self->GetSelections(array);
 400             for (x=0; x < num; x++) {
 401                 PyObject* item = wxPyConstructObject((void*)&array.Item(x),
 402                                                      "wxTreeItemId");
 403                 PyList_Append(rval, item);
 404             }
 405             return rval;
 406         }
 407     }
 408
 409
 410
 411     size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
 412
 413     wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT);
 414     wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
 415     wxTreeItemId GetNextSibling(const wxTreeItemId& item);
 416     wxTreeItemId GetPrevSibling(const wxTreeItemId& item);
 417     wxTreeItemId GetFirstVisibleItem();
 418     wxTreeItemId GetNextVisible(const wxTreeItemId& item);
 419     wxTreeItemId GetPrevVisible(const wxTreeItemId& item);
 420     wxTreeItemId GetLastChild(const wxTreeItemId& item);
 421
 422
 423
 424     wxTreeItemId AddRoot(const wxString& text,
 425                          int image = -1, int selectedImage = -1,
 426                          wxPyTreeItemData *data = NULL);
 427     wxTreeItemId PrependItem(const wxTreeItemId& parent,
 428                              const wxString& text,
 429                              int image = -1, int selectedImage = -1,
 430                              wxPyTreeItemData *data = NULL);
 431     wxTreeItemId InsertItem(const wxTreeItemId& parent,
 432                             const wxTreeItemId& idPrevious,
 433                             const wxString& text,
 434                             int image = -1, int selectedImage = -1,
 435                             wxPyTreeItemData *data = NULL);
 436     wxTreeItemId AppendItem(const wxTreeItemId& parent,
 437                             const wxString& text,
 438                             int image = -1, int selectedImage = -1,
 439                             wxPyTreeItemData *data = NULL);
 440
 441     void Delete(const wxTreeItemId& item);
 442     void DeleteChildren(const wxTreeItemId& item);
 443     void DeleteAllItems();
 444
 445     void Expand(const wxTreeItemId& item);
 446     void Collapse(const wxTreeItemId& item);
 447     void CollapseAndReset(const wxTreeItemId& item);
 448     void Toggle(const wxTreeItemId& item);
 449
 450     void Unselect();
 451     void UnselectAll();
 452     void SelectItem(const wxTreeItemId& item);
 453     void EnsureVisible(const wxTreeItemId& item);
 454     void ScrollTo(const wxTreeItemId& item);
 455 #ifdef __WXMSW__
 456     wxTextCtrl* EditLabel(const wxTreeItemId& item);
 457     wxTextCtrl* GetEditControl();
 458     void EndEditLabel(const wxTreeItemId& item, int discardChanges = FALSE);
 459 #else
 460     void EditLabel(const wxTreeItemId& item);
 461 #endif
 462
 463     void SortChildren(const wxTreeItemId& item);
 464
 465     void SetItemBold(const wxTreeItemId& item, int bold = TRUE);
 466     bool IsBold(const wxTreeItemId& item) const;
 467     wxTreeItemId HitTest(const wxPoint& point);
 468
 469 #ifdef __WXMSW__
 470     void SetItemDropHighlight(const wxTreeItemId& item, int highlight = TRUE);
 471
 472     //bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, int textOnly = FALSE)
 473     %addmethods {
 474         PyObject* GetBoundingRect(const wxTreeItemId& item, int textOnly = FALSE) {
 475             wxRect rect;
 476             if (self->GetBoundingRect(item, rect, textOnly))
 477                 return wxPyConstructObject((void*)&rect, "wxRect");
 478             else {
 479                 Py_INCREF(Py_None);
 480                 return Py_None;
 481             }
 482         }
 483     }
 484 #endif
 485
 486 %pragma(python) addtoclass = "
 487     # Redefine a couple methods that SWIG gets a bit confused on...
 488     def GetFirstChild(self,arg0,arg1):
 489         val1, val2 = controls2c.wxTreeCtrl_GetFirstChild(self.this,arg0.this,arg1)
 490         val1 = wxTreeItemIdPtr(val1)
 491         val1.thisown = 1
 492         return (val1,val2)
 493     def GetNextChild(self,arg0,arg1):
 494         val1, val2 = controls2c.wxTreeCtrl_GetNextChild(self.this,arg0.this,arg1)
 495         val1 = wxTreeItemIdPtr(val1)
 496         val1.thisown = 1
 497         return (val1,val2)
 498 "
 499 };
 500
 501
 502 //----------------------------------------------------------------------
 503
 504 #ifdef SKIPTHIS
 505 #ifdef __WXMSW__
 506 class wxTabEvent : public wxCommandEvent {
 507 public:
 508 };
 509
 510
 511
 512 class wxTabCtrl : public wxControl {
 513 public:
 514     wxTabCtrl(wxWindow* parent, wxWindowID id,
 515               const wxPoint& pos = wxPyDefaultPosition,
 516               const wxSize& size = wxPyDefaultSize,
 517               long style = 0,
 518               char* name = "tabCtrl");
 519
 520     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 521
 522     bool DeleteAllItems();
 523     bool DeleteItem(int item);
 524     wxImageList* GetImageList();
 525     int GetItemCount();
 526     // TODO: void* GetItemData();
 527     int GetItemImage(int item);
 528
 529     %addmethods {
 530         %new wxRect* GetItemRect(int item) {
 531             wxRect* rect = new wxRect;
 532             self->GetItemRect(item, *rect);
 533             return rect;
 534         }
 535     }
 536
 537     wxString GetItemText(int item);
 538     bool GetRowCount();
 539     int GetSelection();
 540     int HitTest(const wxPoint& pt, long& OUTPUT);
 541     void InsertItem(int item, const wxString& text,
 542                     int imageId = -1, void* clientData = NULL);
 543     // TODO: bool SetItemData(int item, void* data);
 544     bool SetItemImage(int item, int image);
 545     void SetImageList(wxImageList* imageList);
 546     void SetItemSize(const wxSize& size);
 547     bool SetItemText(int item, const wxString& text);
 548     void SetPadding(const wxSize& padding);
 549     int SetSelection(int item);
 550
 551 };
 552
 553 #endif
 554 #endif
 555
 556 //----------------------------------------------------------------------
 557
 558