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