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 #include <wx/imaglist.h>
  23 #include <wx/dirctrl.h>
  24 %}
  25
  26 //----------------------------------------------------------------------
  27
  28 %include typemaps.i
  29 %include my_typemaps.i
  30
  31 // Import some definitions of other classes, etc.
  32 %import _defs.i
  33 %import misc.i
  34 %import windows.i
  35 %import gdi.i
  36 %import events.i
  37 %import controls.i
  38
  39 %pragma(python) code = "import wx"
  40
  41
  42 //----------------------------------------------------------------------
  43 %{
  44     // Put some wx default wxChar* values into wxStrings.
  45     const wxChar* wxListCtrlNameStr = _T("wxListCtrl");
  46     DECLARE_DEF_STRING(ListCtrlNameStr);
  47
  48     const wxChar* wx_TreeCtrlNameStr = _T("wxTreeCtrl");
  49     DECLARE_DEF_STRING(_TreeCtrlNameStr);
  50     DECLARE_DEF_STRING(DirDialogDefaultFolderStr);
  51
  52     static const wxString wxPyEmptyString(wxT(""));
  53 %}
  54
  55
  56 %{
  57     static const long longzero = 0;
  58 %}
  59
  60 //----------------------------------------------------------------------
  61
  62 enum {
  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,
  86 };
  87
  88
  89 %pragma(python) code = "
  90 def EVT_LIST_BEGIN_DRAG(win, id, func):
  91     win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_DRAG, func)
  92
  93 def EVT_LIST_BEGIN_RDRAG(win, id, func):
  94     win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_RDRAG, func)
  95
  96 def EVT_LIST_BEGIN_LABEL_EDIT(win, id, func):
  97     win.Connect(id, -1, wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, func)
  98
  99 def EVT_LIST_END_LABEL_EDIT(win, id, func):
 100     win.Connect(id, -1, wxEVT_COMMAND_LIST_END_LABEL_EDIT, func)
 101
 102 def EVT_LIST_DELETE_ITEM(win, id, func):
 103     win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ITEM, func)
 104
 105 def EVT_LIST_DELETE_ALL_ITEMS(win, id, func):
 106     win.Connect(id, -1, wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, func)
 107
 108 def EVT_LIST_GET_INFO(win, id, func):
 109     win.Connect(id, -1, wxEVT_COMMAND_LIST_GET_INFO, func)
 110
 111 def EVT_LIST_SET_INFO(win, id, func):
 112     win.Connect(id, -1, wxEVT_COMMAND_LIST_SET_INFO, func)
 113
 114 def EVT_LIST_ITEM_SELECTED(win, id, func):
 115     win.Connect(id, -1,  wxEVT_COMMAND_LIST_ITEM_SELECTED, func)
 116
 117 def EVT_LIST_ITEM_DESELECTED(win, id, func):
 118     win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_DESELECTED, func)
 119
 120 def EVT_LIST_KEY_DOWN(win, id, func):
 121     win.Connect(id, -1, wxEVT_COMMAND_LIST_KEY_DOWN, func)
 122
 123 def EVT_LIST_INSERT_ITEM(win, id, func):
 124     win.Connect(id, -1, wxEVT_COMMAND_LIST_INSERT_ITEM, func)
 125
 126 def EVT_LIST_COL_CLICK(win, id, func):
 127     win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_CLICK, func)
 128
 129 def EVT_LIST_COL_RIGHT_CLICK(win, id, func):
 130     win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_RIGHT_CLICK, func)
 131
 132 def EVT_LIST_COL_BEGIN_DRAG(win, id, func):
 133     win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_BEGIN_DRAG, func)
 134
 135 def EVT_LIST_COL_DRAGGING(win, id, func):
 136     win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_DRAGGING, func)
 137
 138 def EVT_LIST_COL_END_DRAG(win, id, func):
 139     win.Connect(id, -1, wxEVT_COMMAND_LIST_COL_END_DRAG, func)
 140
 141 def EVT_LIST_ITEM_RIGHT_CLICK(win, id, func):
 142     win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, func)
 143
 144 def EVT_LIST_ITEM_MIDDLE_CLICK(win, id, func):
 145     win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, func)
 146
 147 def EVT_LIST_ITEM_ACTIVATED(win, id, func):
 148     win.Connect(id, -1,  wxEVT_COMMAND_LIST_ITEM_ACTIVATED, func)
 149
 150 def EVT_LIST_CACHE_HINT(win, id, func):
 151     win.Connect(id, -1, wxEVT_COMMAND_LIST_CACHE_HINT, func)
 152
 153 def EVT_LIST_ITEM_FOCUSED(win, id, func):
 154     win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_FOCUSED, func)
 155 "
 156
 157
 158 enum {
 159     /* Style flags */
 160     wxLC_VRULES,
 161     wxLC_HRULES,
 162
 163     wxLC_ICON,
 164     wxLC_SMALL_ICON,
 165     wxLC_LIST,
 166     wxLC_REPORT,
 167
 168     wxLC_ALIGN_TOP,
 169     wxLC_ALIGN_LEFT,
 170     wxLC_AUTOARRANGE,
 171     wxLC_VIRTUAL,
 172     wxLC_EDIT_LABELS,
 173     wxLC_NO_HEADER,
 174     wxLC_NO_SORT_HEADER,
 175     wxLC_SINGLE_SEL,
 176     wxLC_SORT_ASCENDING,
 177     wxLC_SORT_DESCENDING,
 178
 179     wxLC_MASK_TYPE,
 180     wxLC_MASK_ALIGN,
 181     wxLC_MASK_SORT,
 182
 183     wxLC_USER_TEXT,
 184 };
 185
 186
 187 enum {
 188     // Mask flags
 189     wxLIST_MASK_STATE,
 190     wxLIST_MASK_TEXT,
 191     wxLIST_MASK_IMAGE,
 192     wxLIST_MASK_DATA,
 193     wxLIST_SET_ITEM,
 194     wxLIST_MASK_WIDTH,
 195     wxLIST_MASK_FORMAT,
 196
 197     // State flags
 198     wxLIST_STATE_DONTCARE,
 199     wxLIST_STATE_DROPHILITED,
 200     wxLIST_STATE_FOCUSED,
 201     wxLIST_STATE_SELECTED,
 202     wxLIST_STATE_CUT,
 203
 204     // Hit test flags
 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,
 215
 216     // Flags for GetNextItem
 217     wxLIST_NEXT_ABOVE,
 218     wxLIST_NEXT_ALL,
 219     wxLIST_NEXT_BELOW,
 220     wxLIST_NEXT_LEFT,
 221     wxLIST_NEXT_RIGHT,
 222
 223     // Alignment flags
 224     wxLIST_ALIGN_DEFAULT,
 225     wxLIST_ALIGN_LEFT,
 226     wxLIST_ALIGN_TOP,
 227     wxLIST_ALIGN_SNAP_TO_GRID,
 228
 229     // Autosize values for SetColumnWidth
 230     wxLIST_AUTOSIZE = -1,
 231     wxLIST_AUTOSIZE_USEHEADER = -2,
 232
 233     // Flag values for GetItemRect
 234     wxLIST_RECT_BOUNDS,
 235     wxLIST_RECT_ICON,
 236     wxLIST_RECT_LABEL,
 237
 238     // Flag values for FindItem (MSW only)
 239     wxLIST_FIND_UP,
 240     wxLIST_FIND_DOWN,
 241     wxLIST_FIND_LEFT,
 242     wxLIST_FIND_RIGHT,
 243
 244
 245 };
 246
 247
 248
 249 enum wxListColumnFormat
 250 {
 251     wxLIST_FORMAT_LEFT,
 252     wxLIST_FORMAT_RIGHT,
 253     wxLIST_FORMAT_CENTRE,
 254     wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
 255 };
 256
 257
 258
 259
 260 class wxListItemAttr
 261 {
 262 public:
 263     // ctors
 264     //wxListItemAttr();
 265     wxListItemAttr(const wxColour& colText = wxNullColour,
 266                    const wxColour& colBack = wxNullColour,
 267                    const wxFont& font = wxNullFont);
 268
 269
 270     // setters
 271     void SetTextColour(const wxColour& colText);
 272     void SetBackgroundColour(const wxColour& colBack);
 273     void SetFont(const wxFont& font);
 274
 275     // accessors
 276     bool HasTextColour();
 277     bool HasBackgroundColour();
 278     bool HasFont();
 279
 280     wxColour GetTextColour();
 281     wxColour GetBackgroundColour();
 282     wxFont GetFont();
 283 };
 284
 285
 286 class wxListItem : public wxObject {
 287 public:
 288     wxListItem();
 289     ~wxListItem();
 290
 291     // resetting
 292     void Clear();
 293     void ClearAttributes();
 294
 295     // setters
 296     void SetMask(long mask);
 297     void SetId(long id);
 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);
 304
 305     void SetWidth(int width);
 306     void SetAlign(wxListColumnFormat align);
 307
 308     void SetTextColour(const wxColour& colText);
 309     void SetBackgroundColour(const wxColour& colBack);
 310     void SetFont(const wxFont& font);
 311
 312     // accessors
 313     long GetMask();
 314     long GetId();
 315     int GetColumn();
 316     long GetState();
 317     const wxString& GetText();
 318     int GetImage();
 319     long GetData();
 320
 321     int GetWidth();
 322     wxListColumnFormat GetAlign();
 323
 324     wxListItemAttr *GetAttributes();
 325     bool HasAttributes();
 326
 327     wxColour GetTextColour() const;
 328     wxColour GetBackgroundColour() const;
 329     wxFont GetFont() const;
 330
 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
 340
 341     // For columns only
 342     int             m_format;   // left, right, centre
 343     int             m_width;    // width of column
 344
 345 };
 346
 347
 348 class wxListEvent: public wxNotifyEvent {
 349 public:
 350     wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 351
 352 %readonly
 353     int           m_code;
 354     long          m_oldItemIndex;
 355     long          m_itemIndex;
 356     int           m_col;
 357     wxPoint       m_pointDrag;
 358     wxListItem    m_item;
 359 %readwrite
 360
 361     int GetKeyCode();
 362     %pragma(python) addtoclass = "GetCode = GetKeyCode"
 363     long GetIndex();
 364     int GetColumn();
 365     wxPoint GetPoint();
 366     const wxString& GetLabel();
 367     const wxString& GetText();
 368     int GetImage();
 369     long GetData();
 370     long GetMask();
 371     const wxListItem& GetItem();
 372
 373     long GetCacheFrom();
 374     long GetCacheTo();
 375 };
 376
 377
 378 %{  // C++ Version of a Python aware class
 379 class wxPyListCtrl : public wxListCtrl {
 380     DECLARE_ABSTRACT_CLASS(wxPyListCtrl);
 381 public:
 382     wxPyListCtrl() : wxListCtrl() {}
 383     wxPyListCtrl(wxWindow* parent, wxWindowID id,
 384                  const wxPoint& pos,
 385                  const wxSize& size,
 386                  long style,
 387                  const wxValidator& validator,
 388                  const wxString& name) :
 389         wxListCtrl(parent, id, pos, size, style, validator, name) {}
 390
 391     bool Create(wxWindow* parent, wxWindowID id,
 392                 const wxPoint& pos,
 393                 const wxSize& size,
 394                 long style,
 395                 const wxValidator& validator,
 396                 const wxString& name) {
 397         return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
 398     }
 399
 400     DEC_PYCALLBACK_STRING_LONGLONG(OnGetItemText);
 401     DEC_PYCALLBACK_INT_LONG(OnGetItemImage);
 402     DEC_PYCALLBACK_LISTATTR_LONG(OnGetItemAttr);
 403
 404     PYPRIVATE;
 405 };
 406
 407 IMPLEMENT_ABSTRACT_CLASS(wxPyListCtrl, wxListCtrl);
 408
 409 IMP_PYCALLBACK_STRING_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemText);
 410 IMP_PYCALLBACK_INT_LONG(wxPyListCtrl, wxListCtrl, OnGetItemImage);
 411 IMP_PYCALLBACK_LISTATTR_LONG(wxPyListCtrl, wxListCtrl, OnGetItemAttr);
 412 %}
 413
 414
 415
 416 %name(wxListCtrl)class wxPyListCtrl : public wxControl {
 417 public:
 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();
 425
 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);
 432
 433     void _setCallbackInfo(PyObject* self, PyObject* _class);
 434     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxListCtrl)"
 435
 436     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 437     %pragma(python) addtomethod = "wxPreListCtrl:val._setOORInfo(val)"
 438
 439     // Set the control colours
 440     bool SetForegroundColour(const wxColour& col);
 441     bool SetBackgroundColour(const wxColour& col);
 442
 443     // Gets information about this column
 444     // bool GetColumn(int col, wxListItem& item) const;
 445     %addmethods {
 446         %new wxListItem* GetColumn(int col) {
 447             wxListItem item;
 448             item.SetMask(0xFFFF);
 449             if (self->GetColumn(col, item))
 450                 return new wxListItem(item);
 451             else
 452                 return NULL;
 453         }
 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
 459         return val
 460     "
 461
 462     // Sets information about this column
 463     bool SetColumn(int col, wxListItem& item) ;
 464
 465     // Gets the column width
 466     int GetColumnWidth(int col) const;
 467
 468     // Sets the column width
 469     bool SetColumnWidth(int col, int width) ;
 470
 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;
 476
 477 #ifdef __WXMSW__
 478     // Gets the edit control for editing labels.
 479     wxTextCtrl* GetEditControl() const;
 480 #endif
 481
 482     //bool GetItem(wxListItem& info) const ;
 483     %addmethods {
 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;
 488             info->m_col = col;
 489             info->m_mask = 0xFFFF;
 490             self->GetItem(*info);
 491             return info;
 492         }
 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
 498         return val
 499     "
 500
 501
 502     // Sets information about the item
 503     bool SetItem(wxListItem& info) ;
 504
 505     // Sets a string field at a particular column
 506     %name(SetStringItem)long SetItem(long index, int col, const wxString& label, int imageId = -1);
 507
 508     // Gets the item state
 509     int  GetItemState(long item, long stateMask) const ;
 510
 511     // Sets the item state
 512     bool SetItemState(long item, long state, long stateMask) ;
 513
 514     // Sets the item image
 515     bool SetItemImage(long item, int image, int selImage) ;
 516
 517     // Gets the item text
 518     wxString GetItemText(long item) const ;
 519
 520     // Sets the item text
 521     void SetItemText(long item, const wxString& str) ;
 522
 523     // Gets the item data
 524     long GetItemData(long item) const ;
 525
 526     // Sets the item data
 527     bool SetItemData(long item, long data) ;
 528
 529
 530     //bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
 531     //bool GetItemPosition(long item, wxPoint& pos) const ;
 532
 533     // Gets the item position
 534     %addmethods {
 535         %new wxPoint* GetItemPosition(long item) {
 536             wxPoint* pos = new wxPoint;
 537             self->GetItemPosition(item, *pos);
 538             return pos;
 539         }
 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);
 544             return rect;
 545         }
 546     }
 547
 548
 549     // Sets the item position
 550     bool SetItemPosition(long item, const wxPoint& pos) ;
 551
 552     // Gets the number of items in the list control
 553     int GetItemCount() const;
 554
 555     // Gets the number of columns in the list control
 556     int GetColumnCount() const;
 557
 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;
 562
 563     // Gets the number of selected items in the list control
 564     int GetSelectedItemCount() const;
 565
 566     // Gets the text colour of the listview
 567     wxColour GetTextColour() const;
 568
 569     // Sets the text colour of the listview
 570     void SetTextColour(const wxColour& col);
 571
 572     // Gets the index of the topmost visible item when in
 573     // list or report view
 574     long GetTopItem() const ;
 575
 576     // Add or remove a single window style
 577     void SetSingleStyle(long style, bool add = TRUE) ;
 578
 579     // Set the whole window style
 580     void SetWindowStyleFlag(long style) ;
 581
 582     // Searches for an item, starting from 'item'.
 583     // item can be -1 to find the first item that matches the
 584     // specified flags.
 585     // Returns the item or -1 if unsuccessful.
 586     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
 587
 588     // Gets one of the three image lists
 589     wxImageList *GetImageList(int which) const ;
 590
 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"
 595
 596     // returns true if it is a virtual list control
 597     bool IsVirtual() const;
 598
 599     // refresh items selectively (only useful for virtual list controls)
 600     void RefreshItem(long item);
 601     void RefreshItems(long itemFrom, long itemTo);
 602
 603     // Arranges the items
 604     bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
 605
 606     // Deletes an item
 607     bool DeleteItem(long item);
 608
 609     // Deletes all items
 610     bool DeleteAllItems() ;
 611
 612     // Deletes a column
 613     bool DeleteColumn(int col);
 614
 615     // Deletes all columns
 616     bool DeleteAllColumns();
 617
 618     // Clears items, and columns if there are any.
 619     void ClearAll();
 620
 621 #ifdef __WXMSW__
 622     // Edit the label
 623     wxTextCtrl* EditLabel(long item /*, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)*/);
 624
 625     // End label editing, optionally cancelling the edit
 626     bool EndEditLabel(bool cancel);
 627 #endif
 628
 629     // Ensures this item is visible
 630     bool EnsureVisible(long item) ;
 631
 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);
 635
 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);
 639
 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);
 643
 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);
 647
 648     // Inserts an item, returning the index of the new item if successful,
 649     // -1 otherwise.
 650     long InsertItem(wxListItem& info);
 651
 652     // Insert a string item
 653     %name(InsertStringItem)long InsertItem(long index, const wxString& label);
 654
 655     // Insert an image item
 656     %name(InsertImageItem)long InsertItem(long index, int imageIndex);
 657
 658     // Insert an image/string item
 659     %name(InsertImageStringItem)long InsertItem(long index, const wxString& label, int imageIndex);
 660
 661     // For list view mode (only), inserts a column.
 662     %name(InsertColumnInfo)long InsertColumn(long col, wxListItem& info);
 663
 664     long InsertColumn(long col,
 665                       const wxString& heading,
 666                       int format = wxLIST_FORMAT_LEFT,
 667                       int width = -1);
 668
 669     // set the number of items in a virtual list control
 670     void SetItemCount(long count);
 671
 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);
 678
 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;
 683
 684
 685     %pragma(python) addtoclass = "
 686     # Some helpers...
 687
 688     def Select(self, idx, on=1):
 689         '''[de]select an item'''
 690         if on: state = wxLIST_STATE_SELECTED
 691         else: state = 0
 692         self.SetItemState(idx, state, wxLIST_STATE_SELECTED)
 693
 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)
 698
 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)
 702
 703     def IsSelected(self, idx):
 704         '''return TRUE if the item is selected'''
 705         return self.GetItemState(idx, wxLIST_STATE_SELECTED) != 0
 706
 707     def SetColumnImage(self, col, image):
 708         item = wxListItem()
 709         item.SetMask(wxLIST_MASK_IMAGE)
 710         item.SetImage(image)
 711         self.SetColumn(col, item)
 712
 713     def ClearColumnImage(self, col):
 714         self.SetColumnImage(col, -1)
 715
 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'''
 719         if len(entry):
 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]))
 724             return pos
 725     "
 726
 727
 728     // bool SortItems(wxListCtrlCompare fn, long data);
 729     %addmethods {
 730         // Sort items.
 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))
 739                 return FALSE;
 740             return self->SortItems(wxPyListCtrl_SortItems, (long)func);
 741         }
 742     }
 743
 744
 745     %addmethods {
 746         wxWindow* GetMainWindow() {
 747         #ifdef __WXMSW__
 748             return self;
 749         #else
 750             return (wxWindow*)self->m_mainWin;
 751         #endif
 752         }
 753     }
 754 };
 755
 756
 757
 758 %{ // Python aware sorting function for wxPyListCtrl
 759     int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
 760         int retval = 0;
 761         PyObject* func = (PyObject*)funcPtr;
 762         wxPyBeginBlockThreads();
 763
 764         PyObject* args = Py_BuildValue("(ii)", item1, item2);
 765         PyObject* result = PyEval_CallObject(func, args);
 766         Py_DECREF(args);
 767         if (result) {
 768             retval = PyInt_AsLong(result);
 769             Py_DECREF(result);
 770         }
 771
 772         wxPyEndBlockThreads();
 773         return retval;
 774     }
 775
 776 %}
 777
 778 //----------------------------------------------------------------------
 779
 780 class wxListView : public wxPyListCtrl
 781 {
 782 public:
 783     wxListView( wxWindow *parent,
 784                 wxWindowID id = -1,
 785                 const wxPoint& pos = wxDefaultPosition,
 786                 const wxSize& size = wxDefaultSize,
 787                 long style = wxLC_REPORT,
 788                 const wxValidator& validator = wxDefaultValidator,
 789                 const wxString& name = wxPyListCtrlNameStr);
 790     %name(wxPreListView)wxListView();
 791
 792     bool Create( wxWindow *parent,
 793                 wxWindowID id = -1,
 794                 const wxPoint& pos = wxDefaultPosition,
 795                 const wxSize& size = wxDefaultSize,
 796                 long style = wxLC_REPORT,
 797                 const wxValidator& validator = wxDefaultValidator,
 798                 const wxString& name = wxPyListCtrlNameStr);
 799
 800     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 801     %pragma(python) addtomethod = "wxPreListView:val._setOORInfo(val)"
 802
 803     // [de]select an item
 804     void Select(long n, bool on = TRUE);
 805
 806     // focus and show the given item
 807     void Focus(long index);
 808
 809     // get the currently focused item or -1 if none
 810     long GetFocusedItem() const;
 811
 812     // get first and subsequent selected items, return -1 when no more
 813     long GetNextSelected(long item) const;
 814     long GetFirstSelected() const;
 815
 816     // return TRUE if the item is selected
 817     bool IsSelected(long index);
 818
 819     void SetColumnImage(int col, int image);
 820     void ClearColumnImage(int col);
 821 };
 822
 823
 824 //----------------------------------------------------------------------
 825
 826 // wxTreeCtrl flags
 827 enum {
 828     wxTR_NO_BUTTONS,
 829     wxTR_HAS_BUTTONS,
 830     wxTR_TWIST_BUTTONS,
 831     wxTR_NO_LINES,
 832     wxTR_MAC_BUTTONS,
 833     wxTR_AQUA_BUTTONS,
 834
 835     wxTR_SINGLE,
 836     wxTR_MULTIPLE,
 837     wxTR_EXTENDED,
 838     wxTR_FULL_ROW_HIGHLIGHT,
 839
 840     wxTR_EDIT_LABELS,
 841     wxTR_LINES_AT_ROOT,
 842     wxTR_HIDE_ROOT,
 843     wxTR_ROW_LINES,
 844     wxTR_HAS_VARIABLE_ROW_HEIGHT,
 845
 846     wxTR_DEFAULT_STYLE,
 847 };
 848
 849 enum wxTreeItemIcon
 850 {
 851     wxTreeItemIcon_Normal,              // not selected, not expanded
 852     wxTreeItemIcon_Selected,            //     selected, not expanded
 853     wxTreeItemIcon_Expanded,            // not selected,     expanded
 854     wxTreeItemIcon_SelectedExpanded,    //     selected,     expanded
 855     wxTreeItemIcon_Max
 856 };
 857
 858
 859 // constants for HitTest
 860 enum {
 861     wxTREE_HITTEST_ABOVE,
 862     wxTREE_HITTEST_BELOW,
 863     wxTREE_HITTEST_NOWHERE,
 864     wxTREE_HITTEST_ONITEMBUTTON,
 865     wxTREE_HITTEST_ONITEMICON,
 866     wxTREE_HITTEST_ONITEMINDENT,
 867     wxTREE_HITTEST_ONITEMLABEL,
 868     wxTREE_HITTEST_ONITEMRIGHT,
 869     wxTREE_HITTEST_ONITEMSTATEICON,
 870     wxTREE_HITTEST_TOLEFT,
 871     wxTREE_HITTEST_TORIGHT,
 872     wxTREE_HITTEST_ONITEMUPPERPART,
 873     wxTREE_HITTEST_ONITEMLOWERPART,
 874     wxTREE_HITTEST_ONITEM
 875 };
 876
 877
 878 enum {
 879     /* Tree control event types */
 880     wxEVT_COMMAND_TREE_BEGIN_DRAG,
 881     wxEVT_COMMAND_TREE_BEGIN_RDRAG,
 882     wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
 883     wxEVT_COMMAND_TREE_END_LABEL_EDIT,
 884     wxEVT_COMMAND_TREE_DELETE_ITEM,
 885     wxEVT_COMMAND_TREE_GET_INFO,
 886     wxEVT_COMMAND_TREE_SET_INFO,
 887     wxEVT_COMMAND_TREE_ITEM_EXPANDED,
 888     wxEVT_COMMAND_TREE_ITEM_EXPANDING,
 889     wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
 890     wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
 891     wxEVT_COMMAND_TREE_SEL_CHANGED,
 892     wxEVT_COMMAND_TREE_SEL_CHANGING,
 893     wxEVT_COMMAND_TREE_KEY_DOWN,
 894     wxEVT_COMMAND_TREE_ITEM_ACTIVATED,
 895     wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK,
 896     wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK,
 897     wxEVT_COMMAND_TREE_END_DRAG,
 898 };
 899
 900
 901 %pragma(python) code = "
 902 # wxTreeCtrl events
 903 def EVT_TREE_BEGIN_DRAG(win, id, func):
 904     win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_DRAG, func)
 905
 906 def EVT_TREE_BEGIN_RDRAG(win, id, func):
 907     win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_RDRAG, func)
 908
 909 def EVT_TREE_END_DRAG(win, id, func):
 910     win.Connect(id, -1, wxEVT_COMMAND_TREE_END_DRAG, func)
 911
 912 def EVT_TREE_BEGIN_LABEL_EDIT(win, id, func):
 913     win.Connect(id, -1, wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, func)
 914
 915 def EVT_TREE_END_LABEL_EDIT(win, id, func):
 916     win.Connect(id, -1, wxEVT_COMMAND_TREE_END_LABEL_EDIT, func)
 917
 918 def EVT_TREE_GET_INFO(win, id, func):
 919     win.Connect(id, -1, wxEVT_COMMAND_TREE_GET_INFO, func)
 920
 921 def EVT_TREE_SET_INFO(win, id, func):
 922     win.Connect(id, -1, wxEVT_COMMAND_TREE_SET_INFO, func)
 923
 924 def EVT_TREE_ITEM_EXPANDED(win, id, func):
 925     win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_EXPANDED, func)
 926
 927 def EVT_TREE_ITEM_EXPANDING(win, id, func):
 928     win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_EXPANDING, func)
 929
 930 def EVT_TREE_ITEM_COLLAPSED(win, id, func):
 931     win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_COLLAPSED, func)
 932
 933 def EVT_TREE_ITEM_COLLAPSING(win, id, func):
 934     win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_COLLAPSING, func)
 935
 936 def EVT_TREE_SEL_CHANGED(win, id, func):
 937     win.Connect(id, -1, wxEVT_COMMAND_TREE_SEL_CHANGED, func)
 938
 939 def EVT_TREE_SEL_CHANGING(win, id, func):
 940     win.Connect(id, -1, wxEVT_COMMAND_TREE_SEL_CHANGING, func)
 941
 942 def EVT_TREE_KEY_DOWN(win, id, func):
 943     win.Connect(id, -1, wxEVT_COMMAND_TREE_KEY_DOWN, func)
 944
 945 def EVT_TREE_DELETE_ITEM(win, id, func):
 946     win.Connect(id, -1, wxEVT_COMMAND_TREE_DELETE_ITEM, func)
 947
 948 def EVT_TREE_ITEM_ACTIVATED(win, id, func):
 949     win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_ACTIVATED, func)
 950
 951 def EVT_TREE_ITEM_RIGHT_CLICK(win, id, func):
 952     win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, func)
 953
 954 def EVT_TREE_ITEM_MIDDLE_CLICK(win, id, func):
 955     win.Connect(id, -1, wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, func)
 956 "
 957
 958
 959 class wxTreeItemAttr
 960 {
 961 public:
 962     // ctors
 963     //wxTreeItemAttr() { }
 964     wxTreeItemAttr(const wxColour& colText = wxNullColour,
 965                    const wxColour& colBack = wxNullColour,
 966                    const wxFont& font = wxNullFont);
 967
 968     // setters
 969     void SetTextColour(const wxColour& colText);
 970     void SetBackgroundColour(const wxColour& colBack);
 971     void SetFont(const wxFont& font);
 972
 973     // accessors
 974     bool HasTextColour();
 975     bool HasBackgroundColour();
 976     bool HasFont();
 977
 978     wxColour GetTextColour();
 979     wxColour GetBackgroundColour();
 980     wxFont GetFont();
 981 };
 982
 983
 984 class wxTreeItemId {
 985 public:
 986     wxTreeItemId();
 987     ~wxTreeItemId();
 988     bool IsOk();
 989     %pragma(python) addtoclass = "Ok = IsOk"
 990
 991     %addmethods {
 992         int __cmp__(wxTreeItemId* other) {
 993             if (! other) return -1;
 994             return *self != *other;
 995         }
 996     }
 997 };
 998
 999
1000
1001 %{
1002 class wxPyTreeItemData : public wxTreeItemData {
1003 public:
1004     wxPyTreeItemData(PyObject* obj = NULL) {
1005         if (obj == NULL)
1006             obj = Py_None;
1007         Py_INCREF(obj);
1008         m_obj = obj;
1009     }
1010
1011     ~wxPyTreeItemData() {
1012         wxPyBeginBlockThreads();
1013         Py_DECREF(m_obj);
1014         wxPyEndBlockThreads();
1015     }
1016
1017     PyObject* GetData() {
1018         Py_INCREF(m_obj);
1019         return m_obj;
1020     }
1021
1022     void SetData(PyObject* obj) {
1023         wxPyBeginBlockThreads();
1024         Py_DECREF(m_obj);
1025         wxPyEndBlockThreads();
1026         m_obj = obj;
1027         Py_INCREF(obj);
1028     }
1029
1030     PyObject* m_obj;
1031 };
1032 %}
1033
1034
1035
1036 %name(wxTreeItemData) class wxPyTreeItemData : public wxObject {
1037 public:
1038     wxPyTreeItemData(PyObject* obj = NULL);
1039
1040     PyObject* GetData();
1041     void      SetData(PyObject* obj);
1042
1043     const wxTreeItemId& GetId();
1044     void                SetId(const wxTreeItemId& id);
1045 };
1046
1047
1048
1049 class wxTreeEvent : public wxNotifyEvent {
1050 public:
1051     wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
1052
1053     wxTreeItemId GetItem();
1054     wxTreeItemId GetOldItem();
1055     wxPoint GetPoint();
1056     const wxKeyEvent& GetKeyEvent();
1057     int GetKeyCode();
1058     %pragma(python) addtoclass = "GetCode = GetKeyCode"
1059     const wxString& GetLabel();
1060     bool IsEditCancelled() const;
1061 };
1062
1063
1064
1065 %{ // C++ version of Python aware wxTreeCtrl
1066 class wxPyTreeCtrl : public wxTreeCtrl {
1067     DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl);
1068 public:
1069     wxPyTreeCtrl() : wxTreeCtrl() {}
1070     wxPyTreeCtrl(wxWindow *parent, wxWindowID id,
1071                  const wxPoint& pos,
1072                  const wxSize& size,
1073                  long style,
1074                  const wxValidator& validator,
1075                  const wxString& name) :
1076         wxTreeCtrl(parent, id, pos, size, style, validator, name) {}
1077
1078     bool Create(wxWindow *parent, wxWindowID id,
1079                 const wxPoint& pos,
1080                 const wxSize& size,
1081                 long style,
1082                 const wxValidator& validator,
1083                 const wxString& name) {
1084         return wxTreeCtrl::Create(parent, id, pos, size, style, validator, name);
1085     }
1086
1087
1088     int OnCompareItems(const wxTreeItemId& item1,
1089                        const wxTreeItemId& item2) {
1090         int rval = 0;
1091         bool found;
1092         wxPyBeginBlockThreads();
1093         if ((found = m_myInst.findCallback("OnCompareItems"))) {
1094             PyObject *o1 = wxPyConstructObject((void*)&item1, "wxTreeItemId");
1095             PyObject *o2 = wxPyConstructObject((void*)&item2, "wxTreeItemId");
1096             rval = m_myInst.callCallback(Py_BuildValue("(OO)",o1,o2));
1097             Py_DECREF(o1);
1098             Py_DECREF(o2);
1099         }
1100         wxPyEndBlockThreads();
1101         if (! found)
1102             rval = wxTreeCtrl::OnCompareItems(item1, item2);
1103         return rval;
1104     }
1105     PYPRIVATE;
1106 };
1107
1108 IMPLEMENT_ABSTRACT_CLASS(wxPyTreeCtrl, wxTreeCtrl);
1109
1110 %}
1111
1112 // These are for the GetFirstChild/GetNextChild methods below
1113 %typemap(python, in)     long& INOUT = long* INOUT;
1114 %typemap(python, argout) long& INOUT = long* INOUT;
1115
1116
1117 %name(wxTreeCtrl)class wxPyTreeCtrl : public wxControl {
1118 public:
1119     wxPyTreeCtrl(wxWindow *parent, wxWindowID id = -1,
1120                const wxPoint& pos = wxDefaultPosition,
1121                const wxSize& size = wxDefaultSize,
1122                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
1123                const wxValidator& validator = wxDefaultValidator,
1124                const wxString& name = wxPy_TreeCtrlNameStr);
1125     %name(wxPreTreeCtrl)wxPyTreeCtrl();
1126
1127     bool Create(wxWindow *parent, wxWindowID id = -1,
1128                const wxPoint& pos = wxDefaultPosition,
1129                const wxSize& size = wxDefaultSize,
1130                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
1131                const wxValidator& validator = wxDefaultValidator,
1132                const wxString& name = wxPy_TreeCtrlNameStr);
1133
1134     void _setCallbackInfo(PyObject* self, PyObject* _class);
1135     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTreeCtrl)"
1136
1137     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1138     %pragma(python) addtomethod = "wxPreTreeCtrl:val._setOORInfo(val)"
1139
1140     size_t GetCount();
1141     unsigned int GetIndent();
1142     void SetIndent(unsigned int indent);
1143     wxImageList *GetImageList();
1144     wxImageList *GetStateImageList();
1145     void SetImageList(wxImageList *imageList);
1146     void SetStateImageList(wxImageList *imageList);
1147     void AssignImageList(wxImageList* imageList);
1148     %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
1149     void AssignStateImageList(wxImageList* imageList);
1150     %pragma(python) addtomethod = "AssignStateImageList:_args[0].thisown = 0"
1151
1152     unsigned int GetSpacing();
1153     void SetSpacing(unsigned int spacing);
1154
1155     wxString GetItemText(const wxTreeItemId& item);
1156     int GetItemImage(const wxTreeItemId& item,
1157                      wxTreeItemIcon which = wxTreeItemIcon_Normal);
1158     int GetItemSelectedImage(const wxTreeItemId& item);
1159
1160     void SetItemText(const wxTreeItemId& item, const wxString& text);
1161     void SetItemImage(const wxTreeItemId& item, int image,
1162                       wxTreeItemIcon which = wxTreeItemIcon_Normal);
1163     void SetItemSelectedImage(const wxTreeItemId& item, int image);
1164     void SetItemHasChildren(const wxTreeItemId& item, bool hasChildren = TRUE);
1165
1166     %addmethods {
1167         // [Get|Set]ItemData substitutes.  Automatically create wxPyTreeItemData
1168         // if needed.
1169         wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
1170             wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1171             if (data == NULL) {
1172                 data = new wxPyTreeItemData();
1173                 data->SetId(item); // set the id
1174                 self->SetItemData(item, data);
1175             }
1176             return data;
1177         }
1178
1179         void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
1180             data->SetId(item); // set the id
1181             self->SetItemData(item, data);
1182         }
1183
1184         // [Get|Set]PyData are short-cuts.  Also made somewhat crash-proof by
1185         // automatically creating data classes.
1186         PyObject* GetPyData(const wxTreeItemId& item) {
1187             wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1188             if (data == NULL) {
1189                 data = new wxPyTreeItemData();
1190                 data->SetId(item); // set the id
1191                 self->SetItemData(item, data);
1192             }
1193             return data->GetData();
1194         }
1195
1196         void SetPyData(const wxTreeItemId& item, PyObject* obj) {
1197             wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
1198             if (data == NULL) {
1199                 data = new wxPyTreeItemData(obj);
1200                 data->SetId(item); // set the id
1201                 self->SetItemData(item, data);
1202             } else
1203                 data->SetData(obj);
1204         }
1205     }
1206
1207
1208     bool IsVisible(const wxTreeItemId& item);
1209     bool ItemHasChildren(const wxTreeItemId& item);
1210     bool IsExpanded(const wxTreeItemId& item);
1211     bool IsSelected(const wxTreeItemId& item);
1212
1213     wxTreeItemId GetRootItem();
1214     wxTreeItemId GetSelection();
1215     %name(GetItemParent) wxTreeItemId GetParent(const wxTreeItemId& item);
1216     //size_t GetSelections(wxArrayTreeItemIds& selection);
1217     %addmethods {
1218         PyObject* GetSelections() {
1219             wxPyBeginBlockThreads();
1220             PyObject*           rval = PyList_New(0);
1221             wxArrayTreeItemIds  array;
1222             size_t              num, x;
1223             num = self->GetSelections(array);
1224             for (x=0; x < num; x++) {
1225                 wxTreeItemId *tii = new wxTreeItemId(array.Item(x));
1226                 PyObject* item = wxPyConstructObject((void*)tii, "wxTreeItemId", TRUE);
1227                 PyList_Append(rval, item);
1228             }
1229             wxPyEndBlockThreads();
1230             return rval;
1231         }
1232     }
1233
1234
1235
1236     size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
1237
1238     wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT = longzero);
1239     wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
1240     wxTreeItemId GetNextSibling(const wxTreeItemId& item);
1241     wxTreeItemId GetPrevSibling(const wxTreeItemId& item);
1242     wxTreeItemId GetFirstVisibleItem();
1243     wxTreeItemId GetNextVisible(const wxTreeItemId& item);
1244     wxTreeItemId GetPrevVisible(const wxTreeItemId& item);
1245     wxTreeItemId GetLastChild(const wxTreeItemId& item);
1246
1247
1248
1249     wxTreeItemId AddRoot(const wxString& text,
1250                          int image = -1, int selectedImage = -1,
1251                          wxPyTreeItemData *data = NULL);
1252     wxTreeItemId PrependItem(const wxTreeItemId& parent,
1253                              const wxString& text,
1254                              int image = -1, int selectedImage = -1,
1255                              wxPyTreeItemData *data = NULL);
1256     wxTreeItemId InsertItem(const wxTreeItemId& parent,
1257                             const wxTreeItemId& idPrevious,
1258                             const wxString& text,
1259                             int image = -1, int selectedImage = -1,
1260                             wxPyTreeItemData *data = NULL);
1261     %name(InsertItemBefore)
1262         wxTreeItemId InsertItem(const wxTreeItemId& parent,
1263                                 size_t before,
1264                                 const wxString& text,
1265                                 int image = -1, int selectedImage = -1,
1266                                 wxPyTreeItemData *data = NULL);
1267     wxTreeItemId AppendItem(const wxTreeItemId& parent,
1268                             const wxString& text,
1269                             int image = -1, int selectedImage = -1,
1270                             wxPyTreeItemData *data = NULL);
1271
1272     void Delete(const wxTreeItemId& item);
1273     void DeleteChildren(const wxTreeItemId& item);
1274     void DeleteAllItems();
1275
1276     void Expand(const wxTreeItemId& item);
1277     void Collapse(const wxTreeItemId& item);
1278     void CollapseAndReset(const wxTreeItemId& item);
1279     void Toggle(const wxTreeItemId& item);
1280
1281     void Unselect();
1282     void UnselectAll();
1283     void SelectItem(const wxTreeItemId& item);
1284     void EnsureVisible(const wxTreeItemId& item);
1285     void ScrollTo(const wxTreeItemId& item);
1286 #ifdef __WXMSW__
1287     wxTextCtrl* EditLabel(const wxTreeItemId& item);
1288     wxTextCtrl* GetEditControl();
1289     void EndEditLabel(const wxTreeItemId& item, int discardChanges = FALSE);
1290 #else
1291     void EditLabel(const wxTreeItemId& item);
1292 #endif
1293
1294     void SortChildren(const wxTreeItemId& item);
1295
1296     void SetItemBold(const wxTreeItemId& item, int bold = TRUE);
1297     bool IsBold(const wxTreeItemId& item) const;
1298     wxTreeItemId HitTest(const wxPoint& point, int& OUTPUT);
1299
1300
1301
1302     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
1303     void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
1304     void SetItemFont(const wxTreeItemId& item, const wxFont& font);
1305
1306 #ifdef __WXMSW__
1307     void SetItemDropHighlight(const wxTreeItemId& item, int highlight = TRUE);
1308 #endif
1309
1310     //bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, int textOnly = FALSE)
1311     %addmethods {
1312         PyObject* GetBoundingRect(const wxTreeItemId& item, int textOnly = FALSE) {
1313             wxRect rect;
1314             if (self->GetBoundingRect(item, rect, textOnly)) {
1315                 wxPyBeginBlockThreads();
1316                 wxRect* r = new wxRect(rect);
1317                 PyObject* val = wxPyConstructObject((void*)r, "wxRect");
1318                 wxPyEndBlockThreads();
1319                 return val;
1320             }
1321             else {
1322                 Py_INCREF(Py_None);
1323                 return Py_None;
1324             }
1325         }
1326     }
1327
1328
1329 %pragma(python) addtoclass = "
1330     # Redefine some methods that SWIG gets a bit confused on...
1331     def GetFirstChild(self, *_args, **_kwargs):
1332         val1,val2 = apply(controls2c.wxTreeCtrl_GetFirstChild,(self,) + _args, _kwargs)
1333         val1 = wxTreeItemIdPtr(val1)
1334         val1.thisown = 1
1335         return (val1,val2)
1336     def GetNextChild(self, *_args, **_kwargs):
1337         val1,val2 = apply(controls2c.wxTreeCtrl_GetNextChild,(self,) + _args, _kwargs)
1338         val1 = wxTreeItemIdPtr(val1)
1339         val1.thisown = 1
1340         return (val1,val2)
1341     def HitTest(self, *_args, **_kwargs):
1342         val1, val2 = apply(controls2c.wxTreeCtrl_HitTest,(self,) + _args, _kwargs)
1343         val1 = wxTreeItemIdPtr(val1)
1344         val1.thisown = 1
1345         return (val1,val2)
1346 "
1347
1348 };
1349
1350
1351 //----------------------------------------------------------------------
1352
1353
1354 enum {
1355     wxDIRCTRL_DIR_ONLY,
1356     wxDIRCTRL_SELECT_FIRST,
1357     wxDIRCTRL_SHOW_FILTERS,
1358     wxDIRCTRL_3D_INTERNAL,
1359     wxDIRCTRL_EDIT_LABELS,
1360
1361     wxID_TREECTRL,
1362     wxID_FILTERLISTCTRL,
1363 };
1364
1365
1366 class wxDirItemData : public wxObject // wxTreeItemData
1367 {
1368 public:
1369   wxDirItemData(const wxString& path, const wxString& name, bool isDir);
1370 //  ~wxDirItemDataEx();
1371   void SetNewDirName( wxString path );
1372   wxString m_path, m_name;
1373   bool m_isHidden;
1374   bool m_isExpanded;
1375   bool m_isDir;
1376 };
1377
1378
1379 class wxGenericDirCtrl: public wxControl
1380 {
1381 public:
1382     wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = -1,
1383                      const wxString& dir = wxPyDirDialogDefaultFolderStr,
1384                      const wxPoint& pos = wxDefaultPosition,
1385                      const wxSize& size = wxDefaultSize,
1386                      long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
1387                      const wxString& filter = wxPyEmptyString,
1388                      int defaultFilter = 0,
1389                      const wxString& name = wxPy_TreeCtrlNameStr);
1390     %name(wxPreGenericDirCtrl)wxGenericDirCtrl();
1391
1392     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1393     %pragma(python) addtomethod = "wxPreGenericDirCtrl:val._setOORInfo(val)"
1394
1395     bool Create(wxWindow *parent, const wxWindowID id = -1,
1396                 const wxString& dir = wxPyDirDialogDefaultFolderStr,
1397                 const wxPoint& pos = wxDefaultPosition,
1398                 const wxSize& size = wxDefaultSize,
1399                 long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
1400                 const wxString& filter = wxPyEmptyString,
1401                 int defaultFilter = 0,
1402                 const wxString& name = wxPy_TreeCtrlNameStr);
1403
1404
1405     // Try to expand as much of the given path as possible.
1406     bool ExpandPath(const wxString& path);
1407
1408     // Accessors
1409
1410     inline wxString GetDefaultPath() const;
1411     void SetDefaultPath(const wxString& path);
1412
1413     // Get dir or filename
1414     wxString GetPath() const ;
1415
1416     // Get selected filename path only (else empty string).
1417     // I.e. don't count a directory as a selection
1418     wxString GetFilePath() const ;
1419     void SetPath(const wxString& path) ;
1420
1421     void ShowHidden( bool show );
1422     bool GetShowHidden();
1423
1424     wxString GetFilter() const;
1425     void SetFilter(const wxString& filter);
1426
1427     int GetFilterIndex() const;
1428     void SetFilterIndex(int n) ;
1429
1430     wxTreeItemId GetRootId();
1431
1432     wxTreeCtrl* GetTreeCtrl() const;
1433     wxDirFilterListCtrl* GetFilterListCtrl() const;
1434
1435 //  //// Helpers
1436 //      void SetupSections();
1437 //      // Parse the filter into an array of filters and an array of descriptions
1438 //      int ParseFilter(const wxString& filterStr, wxArrayString& filters, wxArrayString& descriptions);
1439 //      // Find the child that matches the first part of 'path'.
1440 //      // E.g. if a child path is "/usr" and 'path' is "/usr/include"
1441 //      // then the child for /usr is returned.
1442 //      // If the path string has been used (we're at the leaf), done is set to TRUE
1443 //      wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);
1444 };
1445
1446
1447 class wxDirFilterListCtrl: public wxChoice
1448 {
1449 public:
1450     wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = -1,
1451                         const wxPoint& pos = wxDefaultPosition,
1452                         const wxSize& size = wxDefaultSize,
1453                         long style = 0);
1454     %name(wxPreDirFilterListCtrl)wxDirFilterListCtrl();
1455
1456     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1457     %pragma(python) addtomethod = "wxPreDirFilterListCtrl:val._setOORInfo(val)"
1458
1459     bool Create(wxGenericDirCtrl* parent, const wxWindowID id = -1,
1460               const wxPoint& pos = wxDefaultPosition,
1461               const wxSize& size = wxDefaultSize,
1462               long style = 0);
1463
1464 //// Operations
1465     void FillFilterList(const wxString& filter, int defaultFilter);
1466 };
1467
1468
1469 //----------------------------------------------------------------------
1470 //----------------------------------------------------------------------
1471
1472 %init %{
1473     // Map renamed classes back to their common name for OOR
1474     wxPyPtrTypeMap_Add("wxTreeItemData", "wxPyTreeItemData");
1475     wxPyPtrTypeMap_Add("wxTreeCtrl", "wxPyTreeCtrl");
1476     wxPyPtrTypeMap_Add("wxListCtrl", "wxPyListCtrl");
1477 %}
1478
1479 //----------------------------------------------------------------------
1480
1481