wxPython/src/_listctrl.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _listctrl.i
   3 // Purpose:     SWIG interface file for wxListCtrl and related classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     10-June-1998
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2002 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17
  18 %{
  19 #include <wx/listctrl.h>
  20 %}
  21
  22 MAKE_CONST_WXSTRING2(ListCtrlNameStr, _T("wxListCtrl"));
  23
  24 //---------------------------------------------------------------------------
  25 %newgroup
  26
  27 enum {
  28     // style flags
  29     wxLC_VRULES,
  30     wxLC_HRULES,
  31
  32     wxLC_ICON,
  33     wxLC_SMALL_ICON,
  34     wxLC_LIST,
  35     wxLC_REPORT,
  36
  37     wxLC_ALIGN_TOP,
  38     wxLC_ALIGN_LEFT,
  39     wxLC_AUTOARRANGE,
  40     wxLC_VIRTUAL,
  41     wxLC_EDIT_LABELS,
  42     wxLC_NO_HEADER,
  43     wxLC_NO_SORT_HEADER,
  44     wxLC_SINGLE_SEL,
  45     wxLC_SORT_ASCENDING,
  46     wxLC_SORT_DESCENDING,
  47
  48     wxLC_MASK_TYPE,
  49     wxLC_MASK_ALIGN,
  50     wxLC_MASK_SORT
  51 };
  52
  53
  54 enum {
  55     // Mask flags to tell app/GUI what fields of wxListItem are valid
  56     wxLIST_MASK_STATE,
  57     wxLIST_MASK_TEXT,
  58     wxLIST_MASK_IMAGE,
  59     wxLIST_MASK_DATA,
  60     wxLIST_SET_ITEM,
  61     wxLIST_MASK_WIDTH,
  62     wxLIST_MASK_FORMAT,
  63
  64 // State flags for indicating the state of an item
  65     wxLIST_STATE_DONTCARE,
  66     wxLIST_STATE_DROPHILITED,
  67     wxLIST_STATE_FOCUSED,
  68     wxLIST_STATE_SELECTED,
  69     wxLIST_STATE_CUT,
  70     wxLIST_STATE_DISABLED,
  71     wxLIST_STATE_FILTERED,
  72     wxLIST_STATE_INUSE,
  73     wxLIST_STATE_PICKED,
  74     wxLIST_STATE_SOURCE,
  75
  76 // Hit test flags, used in HitTest
  77     wxLIST_HITTEST_ABOVE,
  78     wxLIST_HITTEST_BELOW,
  79     wxLIST_HITTEST_NOWHERE,
  80     wxLIST_HITTEST_ONITEMICON,
  81     wxLIST_HITTEST_ONITEMLABEL,
  82     wxLIST_HITTEST_ONITEMRIGHT,
  83     wxLIST_HITTEST_ONITEMSTATEICON,
  84     wxLIST_HITTEST_TOLEFT,
  85     wxLIST_HITTEST_TORIGHT,
  86     wxLIST_HITTEST_ONITEM,
  87 };
  88
  89
  90 // Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
  91 enum
  92 {
  93     wxLIST_NEXT_ABOVE,          // Searches for an item above the specified item
  94     wxLIST_NEXT_ALL,            // Searches for subsequent item by index
  95     wxLIST_NEXT_BELOW,          // Searches for an item below the specified item
  96     wxLIST_NEXT_LEFT,           // Searches for an item to the left of the specified item
  97     wxLIST_NEXT_RIGHT           // Searches for an item to the right of the specified item
  98 };
  99
 100 // Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT)
 101 enum
 102 {
 103     wxLIST_ALIGN_DEFAULT,
 104     wxLIST_ALIGN_LEFT,
 105     wxLIST_ALIGN_TOP,
 106     wxLIST_ALIGN_SNAP_TO_GRID
 107 };
 108
 109 // Column format (MSW only except wxLIST_FORMAT_LEFT)
 110 enum wxListColumnFormat
 111 {
 112     wxLIST_FORMAT_LEFT,
 113     wxLIST_FORMAT_RIGHT,
 114     wxLIST_FORMAT_CENTRE,
 115     wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
 116 };
 117
 118 // Autosize values for SetColumnWidth
 119 enum
 120 {
 121     wxLIST_AUTOSIZE = -1,
 122     wxLIST_AUTOSIZE_USEHEADER = -2      // partly supported by generic version
 123 };
 124
 125 // Flag values for GetItemRect
 126 enum
 127 {
 128     wxLIST_RECT_BOUNDS,
 129     wxLIST_RECT_ICON,
 130     wxLIST_RECT_LABEL
 131 };
 132
 133 // Flag values for FindItem (MSW only)
 134 enum
 135 {
 136     wxLIST_FIND_UP,
 137     wxLIST_FIND_DOWN,
 138     wxLIST_FIND_LEFT,
 139     wxLIST_FIND_RIGHT
 140 };
 141
 142
 143
 144 //---------------------------------------------------------------------------
 145 %newgroup
 146
 147 // wxListItemAttr: a structure containing the visual attributes of an item
 148 class wxListItemAttr
 149 {
 150 public:
 151     // ctors
 152     //wxListItemAttr();
 153     wxListItemAttr(const wxColour& colText = wxNullColour,
 154                    const wxColour& colBack = wxNullColour,
 155                    const wxFont& font = wxNullFont);
 156
 157
 158     // setters
 159     void SetTextColour(const wxColour& colText);
 160     void SetBackgroundColour(const wxColour& colBack);
 161     void SetFont(const wxFont& font);
 162
 163     // accessors
 164     bool HasTextColour();
 165     bool HasBackgroundColour();
 166     bool HasFont();
 167
 168     wxColour GetTextColour();
 169     wxColour GetBackgroundColour();
 170     wxFont GetFont();
 171
 172     %extend { void Destroy() { delete self; } }
 173 };
 174
 175
 176
 177
 178 //---------------------------------------------------------------------------
 179 %newgroup
 180
 181
 182 // wxListItem: the item or column info, used to exchange data with wxListCtrl
 183 class wxListItem : public wxObject {
 184 public:
 185     wxListItem();
 186     ~wxListItem();
 187
 188     // resetting
 189     void Clear();
 190     void ClearAttributes();
 191
 192     // setters
 193     void SetMask(long mask);
 194     void SetId(long id);
 195     void SetColumn(int col);
 196     void SetState(long state);
 197     void SetStateMask(long stateMask);
 198     void SetText(const wxString& text);
 199     void SetImage(int image);
 200     void SetData(long data);
 201
 202     void SetWidth(int width);
 203     void SetAlign(wxListColumnFormat align);
 204
 205     void SetTextColour(const wxColour& colText);
 206     void SetBackgroundColour(const wxColour& colBack);
 207     void SetFont(const wxFont& font);
 208
 209     // accessors
 210     long GetMask();
 211     long GetId();
 212     int GetColumn();
 213     long GetState();
 214     const wxString& GetText();
 215     int GetImage();
 216     long GetData();
 217
 218     int GetWidth();
 219     wxListColumnFormat GetAlign();
 220
 221     wxListItemAttr *GetAttributes();
 222     bool HasAttributes();
 223
 224     wxColour GetTextColour() const;
 225     wxColour GetBackgroundColour() const;
 226     wxFont GetFont() const;
 227
 228     // these members are public for compatibility
 229     long            m_mask;     // Indicates what fields are valid
 230     long            m_itemId;   // The zero-based item position
 231     int             m_col;      // Zero-based column, if in report mode
 232     long            m_state;    // The state of the item
 233     long            m_stateMask;// Which flags of m_state are valid (uses same flags)
 234     wxString        m_text;     // The label/header text
 235     int             m_image;    // The zero-based index into an image list
 236     long            m_data;     // App-defined data
 237
 238     // For columns only
 239     int             m_format;   // left, right, centre
 240     int             m_width;    // width of column
 241
 242 };
 243
 244
 245 //---------------------------------------------------------------------------
 246 %newgroup
 247
 248
 249 // wxListEvent - the event class for the wxListCtrl notifications
 250 class wxListEvent: public wxNotifyEvent {
 251 public:
 252     wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 253
 254     int           m_code;
 255     long          m_oldItemIndex;
 256     long          m_itemIndex;
 257     int           m_col;
 258     wxPoint       m_pointDrag;
 259     %immutable;
 260     wxListItem    m_item;
 261     %mutable;
 262
 263     int GetKeyCode();
 264     %pythoncode { GetCode = GetKeyCode }
 265     long GetIndex();
 266     int GetColumn();
 267     wxPoint GetPoint();
 268     %pythoncode { GetPosition = GetPoint }
 269     const wxString& GetLabel();
 270     const wxString& GetText();
 271     int GetImage();
 272     long GetData();
 273     long GetMask();
 274     const wxListItem& GetItem();
 275
 276     long GetCacheFrom();
 277     long GetCacheTo();
 278
 279     // was label editing canceled? (for wxEVT_COMMAND_LIST_END_LABEL_EDIT only)
 280     bool IsEditCancelled() const;
 281     void SetEditCanceled(bool editCancelled);
 282 };
 283
 284 /* List control event types */
 285 %constant wxEventType wxEVT_COMMAND_LIST_BEGIN_DRAG;
 286 %constant wxEventType wxEVT_COMMAND_LIST_BEGIN_RDRAG;
 287 %constant wxEventType wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
 288 %constant wxEventType wxEVT_COMMAND_LIST_END_LABEL_EDIT;
 289 %constant wxEventType wxEVT_COMMAND_LIST_DELETE_ITEM;
 290 %constant wxEventType wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
 291 %constant wxEventType wxEVT_COMMAND_LIST_GET_INFO;
 292 %constant wxEventType wxEVT_COMMAND_LIST_SET_INFO;
 293 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_SELECTED;
 294 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_DESELECTED;
 295 %constant wxEventType wxEVT_COMMAND_LIST_KEY_DOWN;
 296 %constant wxEventType wxEVT_COMMAND_LIST_INSERT_ITEM;
 297 %constant wxEventType wxEVT_COMMAND_LIST_COL_CLICK;
 298 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
 299 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK;
 300 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
 301 %constant wxEventType wxEVT_COMMAND_LIST_CACHE_HINT;
 302 %constant wxEventType wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
 303 %constant wxEventType wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
 304 %constant wxEventType wxEVT_COMMAND_LIST_COL_DRAGGING;
 305 %constant wxEventType wxEVT_COMMAND_LIST_COL_END_DRAG;
 306 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_FOCUSED;
 307
 308
 309
 310 %pythoncode {
 311
 312 EVT_LIST_BEGIN_DRAG        = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_DRAG       , 1)
 313 EVT_LIST_BEGIN_RDRAG       = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_RDRAG      , 1)
 314 EVT_LIST_BEGIN_LABEL_EDIT  = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT , 1)
 315 EVT_LIST_END_LABEL_EDIT    = wx.PyEventBinder(wxEVT_COMMAND_LIST_END_LABEL_EDIT   , 1)
 316 EVT_LIST_DELETE_ITEM       = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ITEM      , 1)
 317 EVT_LIST_DELETE_ALL_ITEMS  = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS , 1)
 318 EVT_LIST_GET_INFO          = wx.PyEventBinder(wxEVT_COMMAND_LIST_GET_INFO         , 1)
 319 EVT_LIST_SET_INFO          = wx.PyEventBinder(wxEVT_COMMAND_LIST_SET_INFO         , 1)
 320 EVT_LIST_ITEM_SELECTED     = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_SELECTED    , 1)
 321 EVT_LIST_ITEM_DESELECTED   = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_DESELECTED  , 1)
 322 EVT_LIST_KEY_DOWN          = wx.PyEventBinder(wxEVT_COMMAND_LIST_KEY_DOWN         , 1)
 323 EVT_LIST_INSERT_ITEM       = wx.PyEventBinder(wxEVT_COMMAND_LIST_INSERT_ITEM      , 1)
 324 EVT_LIST_COL_CLICK         = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_CLICK        , 1)
 325 EVT_LIST_ITEM_RIGHT_CLICK  = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK , 1)
 326 EVT_LIST_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 1)
 327 EVT_LIST_ITEM_ACTIVATED    = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_ACTIVATED   , 1)
 328 EVT_LIST_CACHE_HINT        = wx.PyEventBinder(wxEVT_COMMAND_LIST_CACHE_HINT       , 1)
 329 EVT_LIST_COL_RIGHT_CLICK   = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK  , 1)
 330 EVT_LIST_COL_BEGIN_DRAG    = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG   , 1)
 331 EVT_LIST_COL_DRAGGING      = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_DRAGGING     , 1)
 332 EVT_LIST_COL_END_DRAG      = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_END_DRAG     , 1)
 333 EVT_LIST_ITEM_FOCUSED      = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED     , 1)
 334 }
 335
 336 //---------------------------------------------------------------------------
 337 %newgroup
 338
 339
 340 %{ // Python aware sorting function for wxPyListCtrl
 341     static int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
 342         int retval = 0;
 343         PyObject* func = (PyObject*)funcPtr;
 344         bool blocked = wxPyBeginBlockThreads();
 345
 346         PyObject* args = Py_BuildValue("(ii)", item1, item2);
 347         PyObject* result = PyEval_CallObject(func, args);
 348         Py_DECREF(args);
 349         if (result) {
 350             retval = PyInt_AsLong(result);
 351             Py_DECREF(result);
 352         }
 353
 354         wxPyEndBlockThreads(blocked);
 355         return retval;
 356     }
 357 %}
 358
 359
 360
 361 %{  // C++ Version of a Python aware class
 362 class wxPyListCtrl : public wxListCtrl {
 363     DECLARE_ABSTRACT_CLASS(wxPyListCtrl);
 364 public:
 365     wxPyListCtrl() : wxListCtrl() {}
 366     wxPyListCtrl(wxWindow* parent, wxWindowID id,
 367                  const wxPoint& pos,
 368                  const wxSize& size,
 369                  long style,
 370                  const wxValidator& validator,
 371                  const wxString& name) :
 372         wxListCtrl(parent, id, pos, size, style, validator, name) {}
 373
 374     bool Create(wxWindow* parent, wxWindowID id,
 375                 const wxPoint& pos,
 376                 const wxSize& size,
 377                 long style,
 378                 const wxValidator& validator,
 379                 const wxString& name) {
 380         return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
 381     }
 382
 383     DEC_PYCALLBACK_STRING_LONGLONG(OnGetItemText);
 384     DEC_PYCALLBACK_INT_LONG(OnGetItemImage);
 385     DEC_PYCALLBACK_LISTATTR_LONG(OnGetItemAttr);
 386
 387     PYPRIVATE;
 388 };
 389
 390 IMPLEMENT_ABSTRACT_CLASS(wxPyListCtrl, wxListCtrl);
 391
 392 IMP_PYCALLBACK_STRING_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemText);
 393 IMP_PYCALLBACK_INT_LONG(wxPyListCtrl, wxListCtrl, OnGetItemImage);
 394 IMP_PYCALLBACK_LISTATTR_LONG(wxPyListCtrl, wxListCtrl, OnGetItemAttr);
 395 %}
 396
 397
 398
 399
 400
 401 MustHaveApp(wxPyListCtrl);
 402
 403 %name(ListCtrl)class wxPyListCtrl : public wxControl {
 404 public:
 405
 406     %pythonAppend wxPyListCtrl         "self._setOORInfo(self);self._setCallbackInfo(self, ListCtrl)"
 407     %pythonAppend wxPyListCtrl()       ""
 408
 409     wxPyListCtrl(wxWindow* parent, wxWindowID id = -1,
 410                  const wxPoint& pos = wxDefaultPosition,
 411                  const wxSize& size = wxDefaultSize,
 412                  long style = wxLC_ICON,
 413                  const wxValidator& validator = wxDefaultValidator,
 414                  const wxString& name = wxPyListCtrlNameStr);
 415     %name(PreListCtrl)wxPyListCtrl();
 416
 417     bool Create(wxWindow* parent, wxWindowID id = -1,
 418                  const wxPoint& pos = wxDefaultPosition,
 419                  const wxSize& size = wxDefaultSize,
 420                  long style = wxLC_ICON,
 421                  const wxValidator& validator = wxDefaultValidator,
 422                  const wxString& name = wxPyListCtrlNameStr);
 423
 424     void _setCallbackInfo(PyObject* self, PyObject* _class);
 425
 426
 427     // Set the control colours
 428     bool SetForegroundColour(const wxColour& col);
 429     bool SetBackgroundColour(const wxColour& col);
 430
 431     // Gets information about this column
 432     %pythonAppend GetColumn "if val is not None: val.thisown = 1";  // %newobject doesn't work with OOR typemap
 433     %extend {
 434         wxListItem* GetColumn(int col) {
 435             wxListItem item;
 436             item.SetMask( wxLIST_MASK_STATE |
 437                           wxLIST_MASK_TEXT  |
 438                           wxLIST_MASK_IMAGE |
 439                           wxLIST_MASK_DATA  |
 440                           wxLIST_SET_ITEM   |
 441                           wxLIST_MASK_WIDTH |
 442                           wxLIST_MASK_FORMAT
 443                           );
 444             if (self->GetColumn(col, item))
 445                 return new wxListItem(item);
 446             else
 447                 return NULL;
 448         }
 449     }
 450
 451     // Sets information about this column
 452     bool SetColumn(int col, wxListItem& item) ;
 453
 454     // Gets the column width
 455     int GetColumnWidth(int col) const;
 456
 457     // Sets the column width
 458     bool SetColumnWidth(int col, int width) ;
 459
 460     // Gets the number of items that can fit vertically in the
 461     // visible area of the list control (list or report view)
 462     // or the total number of items in the list control (icon
 463     // or small icon view)
 464     int GetCountPerPage() const;
 465
 466     // return the total area occupied by all the items (icon/small icon only)
 467     wxRect GetViewRect() const;
 468
 469 #ifdef __WXMSW__
 470     // Gets the edit control for editing labels.
 471     wxTextCtrl* GetEditControl() const;
 472 #endif
 473
 474     // Gets information about the item
 475     %pythonAppend GetItem "if val is not None: val.thisown = 1";  // %newobject doesn't work with OOR typemap
 476     %extend {
 477         wxListItem* GetItem(long itemId, int col=0) {
 478             wxListItem* info = new wxListItem;
 479             info->m_itemId = itemId;
 480             info->m_col = col;
 481             info->m_mask = 0xFFFF;
 482             self->GetItem(*info);
 483             return info;
 484         }
 485     }
 486
 487     // Sets information about the item
 488     bool SetItem(wxListItem& info) ;
 489
 490     // Sets a string field at a particular column
 491     %name(SetStringItem)long SetItem(long index, int col, const wxString& label, int imageId = -1);
 492
 493     // Gets the item state
 494     int  GetItemState(long item, long stateMask) const ;
 495
 496     // Sets the item state
 497     bool SetItemState(long item, long state, long stateMask) ;
 498
 499     // Sets the item image
 500     bool SetItemImage(long item, int image, int selImage) ;
 501
 502     // Gets the item text
 503     wxString GetItemText(long item) const ;
 504
 505     // Sets the item text
 506     void SetItemText(long item, const wxString& str) ;
 507
 508     // Gets the item data
 509     long GetItemData(long item) const ;
 510
 511     // Sets the item data
 512     bool SetItemData(long item, long data) ;
 513
 514
 515     //bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
 516     //bool GetItemPosition(long item, wxPoint& pos) const ;
 517
 518     // Gets the item position
 519     %extend {
 520         wxPoint GetItemPosition(long item) {
 521             wxPoint pos;
 522             self->GetItemPosition(item, pos);
 523             return pos;
 524         }
 525         // Gets the item rectangle
 526         wxRect GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
 527             wxRect rect;
 528             self->GetItemRect(item, rect, code);
 529             return rect;
 530         }
 531     }
 532
 533
 534     // Sets the item position
 535     bool SetItemPosition(long item, const wxPoint& pos) ;
 536
 537     // Gets the number of items in the list control
 538     int GetItemCount() const;
 539
 540     // Gets the number of columns in the list control
 541     int GetColumnCount() const;
 542
 543     // get the horizontal and vertical components of the item spacing
 544     wxSize GetItemSpacing() const;
 545
 546 #ifndef __WXMSW__
 547     void SetItemSpacing( int spacing, bool isSmall = false );
 548 #endif
 549
 550     // Gets the number of selected items in the list control
 551     int GetSelectedItemCount() const;
 552
 553     // Gets the text colour of the listview
 554     wxColour GetTextColour() const;
 555
 556     // Sets the text colour of the listview
 557     void SetTextColour(const wxColour& col);
 558
 559     // Gets the index of the topmost visible item when in
 560     // list or report view
 561     long GetTopItem() const ;
 562
 563     // Add or remove a single window style
 564     void SetSingleStyle(long style, bool add = true) ;
 565
 566     // Set the whole window style
 567     void SetWindowStyleFlag(long style) ;
 568
 569     // Searches for an item, starting from 'item'.
 570     // item can be -1 to find the first item that matches the
 571     // specified flags.
 572     // Returns the item or -1 if unsuccessful.
 573     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
 574
 575     // Gets one of the three image lists
 576     wxImageList *GetImageList(int which) const ;
 577
 578     // Sets the image list
 579     void SetImageList(wxImageList *imageList, int which);
 580
 581     // is there a way to tell SWIG to disown this???
 582
 583     %apply SWIGTYPE *DISOWN { wxImageList *imageList };
 584     void AssignImageList(wxImageList *imageList, int which);
 585     %clear wxImageList *imageList;
 586
 587     // are we in report mode?
 588     bool InReportView() const;
 589
 590     // returns True if it is a virtual list control
 591     bool IsVirtual() const;
 592
 593     // refresh items selectively (only useful for virtual list controls)
 594     void RefreshItem(long item);
 595     void RefreshItems(long itemFrom, long itemTo);
 596
 597     // Arranges the items
 598     bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
 599
 600     // Deletes an item
 601     bool DeleteItem(long item);
 602
 603     // Deletes all items
 604     bool DeleteAllItems() ;
 605
 606     // Deletes a column
 607     bool DeleteColumn(int col);
 608
 609     // Deletes all columns
 610     bool DeleteAllColumns();
 611
 612     // Clears items, and columns if there are any.
 613     void ClearAll();
 614
 615 #ifdef __WXMSW__
 616     // Edit the label
 617     wxTextCtrl* EditLabel(long item /*, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)*/);
 618
 619     // End label editing, optionally cancelling the edit
 620     bool EndEditLabel(bool cancel);
 621 #else
 622     void EditLabel(long item);
 623 #endif
 624
 625     // Ensures this item is visible
 626     bool EnsureVisible(long item) ;
 627
 628     // Find an item whose label matches this string, starting from the item after 'start'
 629     // or the beginning if 'start' is -1.
 630     long FindItem(long start, const wxString& str, bool partial = false);
 631
 632     // Find an item whose data matches this data, starting from the item after 'start'
 633     // or the beginning if 'start' is -1.
 634     %name(FindItemData) long FindItem(long start, long data);
 635
 636     // Find an item nearest this position in the specified direction, starting from
 637     // the item after 'start' or the beginning if 'start' is -1.
 638     %name(FindItemAtPos) long FindItem(long start, const wxPoint& pt, int direction);
 639
 640
 641     DocDeclAStr(
 642         long, HitTest(const wxPoint& point, int& OUTPUT),
 643         "HitTest(Point point) -> (item, where)",
 644         "Determines which item (if any) is at the specified point, giving
 645 details in the second return value (see wxLIST_HITTEST_... flags.)", "");
 646
 647     // Inserts an item, returning the index of the new item if successful,
 648     // -1 otherwise.
 649     long InsertItem(wxListItem& info);
 650
 651     // Insert a string item
 652     %name(InsertStringItem) long InsertItem(long index, const wxString& label);
 653
 654     // Insert an image item
 655     %name(InsertImageItem) long InsertItem(long index, int imageIndex);
 656
 657     // Insert an image/string item
 658     %name(InsertImageStringItem) long InsertItem(long index, const wxString& label, int imageIndex);
 659
 660     // For list view mode (only), inserts a column.
 661     %name(InsertColumnInfo) long InsertColumn(long col, wxListItem& info);
 662
 663     long InsertColumn(long col,
 664                       const wxString& heading,
 665                       int format = wxLIST_FORMAT_LEFT,
 666                       int width = -1);
 667
 668     // set the number of items in a virtual list control
 669     void SetItemCount(long count);
 670
 671     // Scrolls the list control. If in icon, small icon or report view mode,
 672     // x specifies the number of pixels to scroll. If in list view mode, x
 673     // specifies the number of columns to scroll.
 674     // If in icon, small icon or list view mode, y specifies the number of pixels
 675     // to scroll. If in report view mode, y specifies the number of lines to scroll.
 676     bool ScrollList(int dx, int dy);
 677
 678     void SetItemTextColour( long item, const wxColour& col);
 679     wxColour GetItemTextColour( long item ) const;
 680     void SetItemBackgroundColour( long item, const wxColour &col);
 681     wxColour GetItemBackgroundColour( long item ) const;
 682
 683
 684     %pythoncode {
 685     %#
 686     %# Some helpers...
 687     def Select(self, idx, on=1):
 688         '''[de]select an item'''
 689         if on: state = wx.LIST_STATE_SELECTED
 690         else: state = 0
 691         self.SetItemState(idx, state, wx.LIST_STATE_SELECTED)
 692
 693     def Focus(self, idx):
 694         '''Focus and show the given item'''
 695         self.SetItemState(idx, wx.LIST_STATE_FOCUSED, wx.LIST_STATE_FOCUSED)
 696         self.EnsureVisible(idx)
 697
 698     def GetFocusedItem(self):
 699         '''get the currently focused item or -1 if none'''
 700         return self.GetNextItem(-1, wx.LIST_NEXT_ALL, wx.LIST_STATE_FOCUSED)
 701
 702     def GetFirstSelected(self, *args):
 703         '''return first selected item, or -1 when none'''
 704         return self.GetNextSelected(-1)
 705
 706     def GetNextSelected(self, item):
 707         '''return subsequent selected items, or -1 when no more'''
 708         return self.GetNextItem(item, wx.LIST_NEXT_ALL, wx.LIST_STATE_SELECTED)
 709
 710     def IsSelected(self, idx):
 711         '''return True if the item is selected'''
 712         return self.GetItemState(idx, wx.LIST_STATE_SELECTED) != 0
 713
 714     def SetColumnImage(self, col, image):
 715         item = self.GetColumn(col)
 716         %# preserve all other attributes too
 717         item.SetMask( wx.LIST_MASK_STATE |
 718                       wx.LIST_MASK_TEXT  |
 719                       wx.LIST_MASK_IMAGE |
 720                       wx.LIST_MASK_DATA  |
 721                       wx.LIST_SET_ITEM   |
 722                       wx.LIST_MASK_WIDTH |
 723                       wx.LIST_MASK_FORMAT )
 724         item.SetImage(image)
 725         self.SetColumn(col, item)
 726
 727     def ClearColumnImage(self, col):
 728         self.SetColumnImage(col, -1)
 729
 730     def Append(self, entry):
 731         '''Append an item to the list control.  The entry parameter should be a
 732            sequence with an item for each column'''
 733         if len(entry):
 734             if wx.USE_UNICODE:
 735                 cvtfunc = unicode
 736             else:
 737                 cvtfunc = str
 738             pos = self.GetItemCount()
 739             self.InsertStringItem(pos, cvtfunc(entry[0]))
 740             for i in range(1, len(entry)):
 741                 self.SetStringItem(pos, i, cvtfunc(entry[i]))
 742             return pos
 743     }
 744
 745
 746     // bool SortItems(wxListCtrlCompare fn, long data);
 747     %extend {
 748         // Sort items.
 749         // func is a function which takes 2 long arguments: item1, item2.
 750         // item1 is the long data associated with a first item (NOT the index).
 751         // item2 is the long data associated with a second item (NOT the index).
 752         // The return value is a negative number if the first item should precede the second
 753         // item, a positive number of the second item should precede the first,
 754         // or zero if the two items are equivalent.
 755         bool SortItems(PyObject* func) {
 756             if (!PyCallable_Check(func))
 757                 return false;
 758             return self->SortItems((wxListCtrlCompare)wxPyListCtrl_SortItems, (long)func);
 759         }
 760     }
 761
 762
 763     %extend {
 764         wxWindow* GetMainWindow() {
 765         #ifdef __WXMSW__
 766             return self;
 767         #else
 768             return (wxWindow*)self->m_mainWin;
 769         #endif
 770         }
 771     }
 772
 773     static wxVisualAttributes
 774     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 775 };
 776
 777
 778
 779 //---------------------------------------------------------------------------
 780 %newgroup
 781
 782
 783 MustHaveApp(wxListView);
 784
 785 // wxListView: a class which provides a little better API for list control
 786 class wxListView : public wxPyListCtrl
 787 {
 788 public:
 789     %pythonAppend wxListView         "self._setOORInfo(self)"
 790     %pythonAppend wxListView()       ""
 791
 792     wxListView( 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     %name(PreListView)wxListView();
 800
 801     bool Create( wxWindow *parent,
 802                 wxWindowID id = -1,
 803                 const wxPoint& pos = wxDefaultPosition,
 804                 const wxSize& size = wxDefaultSize,
 805                 long style = wxLC_REPORT,
 806                 const wxValidator& validator = wxDefaultValidator,
 807                 const wxString& name = wxPyListCtrlNameStr);
 808
 809     // [de]select an item
 810     void Select(long n, bool on = true);
 811
 812     // focus and show the given item
 813     void Focus(long index);
 814
 815     // get the currently focused item or -1 if none
 816     long GetFocusedItem() const;
 817
 818     // get first and subsequent selected items, return -1 when no more
 819     long GetNextSelected(long item) const;
 820     long GetFirstSelected() const;
 821
 822     // return True if the item is selected
 823     bool IsSelected(long index);
 824
 825     void SetColumnImage(int col, int image);
 826     void ClearColumnImage(int col);
 827 };
 828
 829
 830
 831 //---------------------------------------------------------------------------
 832
 833 %init %{
 834     // Map renamed classes back to their common name for OOR
 835     wxPyPtrTypeMap_Add("wxListCtrl", "wxPyListCtrl");
 836 %}
 837
 838 //---------------------------------------------------------------------------