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_WXSTRING(ListCtrlNameStr);
  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_ITEM_SELECTED;
 292 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_DESELECTED;
 293 %constant wxEventType wxEVT_COMMAND_LIST_KEY_DOWN;
 294 %constant wxEventType wxEVT_COMMAND_LIST_INSERT_ITEM;
 295 %constant wxEventType wxEVT_COMMAND_LIST_COL_CLICK;
 296 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
 297 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK;
 298 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
 299 %constant wxEventType wxEVT_COMMAND_LIST_CACHE_HINT;
 300 %constant wxEventType wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
 301 %constant wxEventType wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
 302 %constant wxEventType wxEVT_COMMAND_LIST_COL_DRAGGING;
 303 %constant wxEventType wxEVT_COMMAND_LIST_COL_END_DRAG;
 304 %constant wxEventType wxEVT_COMMAND_LIST_ITEM_FOCUSED;
 305
 306 // WXWIN_COMPATIBILITY_2_4
 307 #if 0
 308 %constant wxEventType wxEVT_COMMAND_LIST_GET_INFO;
 309 %constant wxEventType wxEVT_COMMAND_LIST_SET_INFO;
 310 #endif
 311
 312 %pythoncode {
 313
 314 EVT_LIST_BEGIN_DRAG        = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_DRAG       , 1)
 315 EVT_LIST_BEGIN_RDRAG       = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_RDRAG      , 1)
 316 EVT_LIST_BEGIN_LABEL_EDIT  = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT , 1)
 317 EVT_LIST_END_LABEL_EDIT    = wx.PyEventBinder(wxEVT_COMMAND_LIST_END_LABEL_EDIT   , 1)
 318 EVT_LIST_DELETE_ITEM       = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ITEM      , 1)
 319 EVT_LIST_DELETE_ALL_ITEMS  = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS , 1)
 320 #WXWIN_COMPATIBILITY_2_4
 321 #EVT_LIST_GET_INFO          = wx.PyEventBinder(wxEVT_COMMAND_LIST_GET_INFO         , 1)
 322 #EVT_LIST_SET_INFO          = wx.PyEventBinder(wxEVT_COMMAND_LIST_SET_INFO         , 1)
 323 #END WXWIN_COMPATIBILITY_2_4
 324 EVT_LIST_ITEM_SELECTED     = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_SELECTED    , 1)
 325 EVT_LIST_ITEM_DESELECTED   = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_DESELECTED  , 1)
 326 EVT_LIST_KEY_DOWN          = wx.PyEventBinder(wxEVT_COMMAND_LIST_KEY_DOWN         , 1)
 327 EVT_LIST_INSERT_ITEM       = wx.PyEventBinder(wxEVT_COMMAND_LIST_INSERT_ITEM      , 1)
 328 EVT_LIST_COL_CLICK         = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_CLICK        , 1)
 329 EVT_LIST_ITEM_RIGHT_CLICK  = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK , 1)
 330 EVT_LIST_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 1)
 331 EVT_LIST_ITEM_ACTIVATED    = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_ACTIVATED   , 1)
 332 EVT_LIST_CACHE_HINT        = wx.PyEventBinder(wxEVT_COMMAND_LIST_CACHE_HINT       , 1)
 333 EVT_LIST_COL_RIGHT_CLICK   = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK  , 1)
 334 EVT_LIST_COL_BEGIN_DRAG    = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG   , 1)
 335 EVT_LIST_COL_DRAGGING      = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_DRAGGING     , 1)
 336 EVT_LIST_COL_END_DRAG      = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_END_DRAG     , 1)
 337 EVT_LIST_ITEM_FOCUSED      = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED     , 1)
 338
 339 #WXWIN_COMPATIBILITY_2_4
 340 #EVT_LIST_GET_INFO = wx._deprecated(EVT_LIST_GET_INFO)
 341 #EVT_LIST_SET_INFO = wx._deprecated(EVT_LIST_SET_INFO)
 342 }
 343
 344 //---------------------------------------------------------------------------
 345 %newgroup
 346
 347
 348 %{ // Python aware sorting function for wxPyListCtrl
 349     static int wxCALLBACK wxPyListCtrl_SortItems(long item1, long item2, long funcPtr) {
 350         int retval = 0;
 351         PyObject* func = (PyObject*)funcPtr;
 352         wxPyBlock_t blocked = wxPyBeginBlockThreads();
 353
 354         PyObject* args = Py_BuildValue("(ii)", item1, item2);
 355         PyObject* result = PyEval_CallObject(func, args);
 356         Py_DECREF(args);
 357         if (result) {
 358             retval = PyInt_AsLong(result);
 359             Py_DECREF(result);
 360         }
 361
 362         wxPyEndBlockThreads(blocked);
 363         return retval;
 364     }
 365 %}
 366
 367
 368
 369 %{  // C++ Version of a Python aware class
 370 class wxPyListCtrl : public wxListCtrl {
 371     DECLARE_ABSTRACT_CLASS(wxPyListCtrl)
 372 public:
 373     wxPyListCtrl() : wxListCtrl() {}
 374     wxPyListCtrl(wxWindow* parent, wxWindowID id,
 375                  const wxPoint& pos,
 376                  const wxSize& size,
 377                  long style,
 378                  const wxValidator& validator,
 379                  const wxString& name) :
 380         wxListCtrl(parent, id, pos, size, style, validator, name) {}
 381
 382     bool Create(wxWindow* parent, wxWindowID id,
 383                 const wxPoint& pos,
 384                 const wxSize& size,
 385                 long style,
 386                 const wxValidator& validator,
 387                 const wxString& name) {
 388         return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
 389     }
 390
 391     DEC_PYCALLBACK_STRING_LONGLONG(OnGetItemText);
 392     DEC_PYCALLBACK_LISTATTR_LONG(OnGetItemAttr);
 393
 394     // use the virtual version to avoid a confusing assert in the base class
 395     DEC_PYCALLBACK_INT_LONG_virtual(OnGetItemImage);
 396     DEC_PYCALLBACK_INT_LONGLONG(OnGetItemColumnImage);
 397
 398     PYPRIVATE;
 399 };
 400
 401 IMPLEMENT_ABSTRACT_CLASS(wxPyListCtrl, wxListCtrl);
 402
 403 IMP_PYCALLBACK_STRING_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemText);
 404 IMP_PYCALLBACK_LISTATTR_LONG(wxPyListCtrl, wxListCtrl, OnGetItemAttr);
 405 IMP_PYCALLBACK_INT_LONG_virtual(wxPyListCtrl, wxListCtrl, OnGetItemImage);
 406 IMP_PYCALLBACK_INT_LONGLONG(wxPyListCtrl, wxListCtrl, OnGetItemColumnImage);
 407
 408 %}
 409
 410
 411
 412
 413
 414 MustHaveApp(wxPyListCtrl);
 415
 416 %rename(ListCtrl) wxPyListCtrl;
 417 class wxPyListCtrl : public wxControl {
 418 public:
 419
 420     %pythonAppend wxPyListCtrl         "self._setOORInfo(self);self._setCallbackInfo(self, ListCtrl)"
 421     %pythonAppend wxPyListCtrl()       ""
 422
 423     wxPyListCtrl(wxWindow* parent, wxWindowID id = -1,
 424                  const wxPoint& pos = wxDefaultPosition,
 425                  const wxSize& size = wxDefaultSize,
 426                  long style = wxLC_ICON,
 427                  const wxValidator& validator = wxDefaultValidator,
 428                  const wxString& name = wxPyListCtrlNameStr);
 429     %RenameCtor(PreListCtrl, wxPyListCtrl());
 430
 431     bool Create(wxWindow* parent, wxWindowID id = -1,
 432                  const wxPoint& pos = wxDefaultPosition,
 433                  const wxSize& size = wxDefaultSize,
 434                  long style = wxLC_ICON,
 435                  const wxValidator& validator = wxDefaultValidator,
 436                  const wxString& name = wxPyListCtrlNameStr);
 437
 438     void _setCallbackInfo(PyObject* self, PyObject* _class);
 439
 440
 441     // Set the control colours
 442     bool SetForegroundColour(const wxColour& col);
 443     bool SetBackgroundColour(const wxColour& col);
 444
 445     // Gets information about this column
 446     %pythonAppend GetColumn "if val is not None: val.thisown = 1";  // %newobject doesn't work with OOR typemap
 447     %extend {
 448         wxListItem* GetColumn(int col) {
 449             wxListItem item;
 450             item.SetMask( wxLIST_MASK_STATE |
 451                           wxLIST_MASK_TEXT  |
 452                           wxLIST_MASK_IMAGE |
 453                           wxLIST_MASK_DATA  |
 454                           wxLIST_SET_ITEM   |
 455                           wxLIST_MASK_WIDTH |
 456                           wxLIST_MASK_FORMAT
 457                           );
 458             if (self->GetColumn(col, item))
 459                 return new wxListItem(item);
 460             else
 461                 return NULL;
 462         }
 463     }
 464
 465     // Sets information about this column
 466     bool SetColumn(int col, wxListItem& item) ;
 467
 468     // Gets the column width
 469     int GetColumnWidth(int col) const;
 470
 471     // Sets the column width
 472     bool SetColumnWidth(int col, int width) ;
 473
 474     // Gets the number of items that can fit vertically in the
 475     // visible area of the list control (list or report view)
 476     // or the total number of items in the list control (icon
 477     // or small icon view)
 478     int GetCountPerPage() const;
 479
 480     // return the total area occupied by all the items (icon/small icon only)
 481     wxRect GetViewRect() const;
 482
 483 #ifdef __WXMSW__
 484     // Gets the edit control for editing labels.
 485     wxTextCtrl* GetEditControl() const;
 486 #endif
 487
 488     // Gets information about the item
 489     %pythonAppend GetItem "if val is not None: val.thisown = 1";  // %newobject doesn't work with OOR typemap
 490     %extend {
 491         wxListItem* GetItem(long itemId, int col=0) {
 492             wxListItem* info = new wxListItem;
 493             info->m_itemId = itemId;
 494             info->m_col = col;
 495             info->m_mask = 0xFFFF;
 496             self->GetItem(*info);
 497             return info;
 498         }
 499     }
 500
 501     // Sets information about the item
 502     bool SetItem(wxListItem& info) ;
 503
 504     // Sets a string field at a particular column
 505     %Rename(SetStringItem, long, SetItem(long index, int col, const wxString& label, int imageId = -1));
 506
 507     // Gets the item state
 508     int  GetItemState(long item, long stateMask) const ;
 509
 510     // Sets the item state
 511     bool SetItemState(long item, long state, long stateMask) ;
 512
 513     // Sets the item image
 514     bool SetItemImage(long item, int image, int selImage=-1) ;
 515
 516     // Gets the item text
 517     wxString GetItemText(long item) const ;
 518
 519     // Sets the item text
 520     void SetItemText(long item, const wxString& str) ;
 521
 522     // Gets the item data
 523     long GetItemData(long item) const ;
 524
 525     // Sets the item data
 526     bool SetItemData(long item, long data) ;
 527
 528
 529     //bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
 530     //bool GetItemPosition(long item, wxPoint& pos) const ;
 531
 532     // Gets the item position
 533     %extend {
 534         wxPoint GetItemPosition(long item) {
 535             wxPoint pos;
 536             self->GetItemPosition(item, pos);
 537             return pos;
 538         }
 539         // Gets the item rectangle
 540         wxRect GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
 541             wxRect rect;
 542             self->GetItemRect(item, rect, code);
 543             return rect;
 544         }
 545     }
 546
 547
 548     // Sets the item position
 549     bool SetItemPosition(long item, const wxPoint& pos) ;
 550
 551     // Gets the number of items in the list control
 552     int GetItemCount() const;
 553
 554     // Gets the number of columns in the list control
 555     int GetColumnCount() const;
 556
 557     // get the horizontal and vertical components of the item spacing
 558     wxSize GetItemSpacing() const;
 559
 560 #ifndef __WXMSW__
 561     void SetItemSpacing( int spacing, bool isSmall = false );
 562 #endif
 563
 564     // Gets the number of selected items in the list control
 565     int GetSelectedItemCount() const;
 566
 567     // Gets the text colour of the listview
 568     wxColour GetTextColour() const;
 569
 570     // Sets the text colour of the listview
 571     void SetTextColour(const wxColour& col);
 572
 573     // Gets the index of the topmost visible item when in
 574     // list or report view
 575     long GetTopItem() const ;
 576
 577     // Add or remove a single window style
 578     void SetSingleStyle(long style, bool add = true) ;
 579
 580     // Set the whole window style
 581     void SetWindowStyleFlag(long style) ;
 582
 583     // Searches for an item, starting from 'item'.
 584     // item can be -1 to find the first item that matches the
 585     // specified flags.
 586     // Returns the item or -1 if unsuccessful.
 587     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
 588
 589     // Gets one of the three image lists
 590     wxImageList *GetImageList(int which) const ;
 591
 592     // Sets the image list
 593     void SetImageList(wxImageList *imageList, int which);
 594
 595     // is there a way to tell SWIG to disown this???
 596
 597     %apply SWIGTYPE *DISOWN { wxImageList *imageList };
 598     void AssignImageList(wxImageList *imageList, int which);
 599     %clear wxImageList *imageList;
 600
 601     // are we in report mode?
 602     bool InReportView() const;
 603
 604     // returns True if it is a virtual list control
 605     bool IsVirtual() const;
 606
 607     // refresh items selectively (only useful for virtual list controls)
 608     void RefreshItem(long item);
 609     void RefreshItems(long itemFrom, long itemTo);
 610
 611     // Arranges the items
 612     bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
 613
 614     // Deletes an item
 615     bool DeleteItem(long item);
 616
 617     // Deletes all items
 618     bool DeleteAllItems() ;
 619
 620     // Deletes a column
 621     bool DeleteColumn(int col);
 622
 623     // Deletes all columns
 624     bool DeleteAllColumns();
 625
 626     // Clears items, and columns if there are any.
 627     void ClearAll();
 628
 629 #ifdef __WXMSW__
 630     // Edit the label
 631     wxTextCtrl* EditLabel(long item /*, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)*/);
 632
 633     // End label editing, optionally cancelling the edit
 634     bool EndEditLabel(bool cancel);
 635 #else
 636     void EditLabel(long item);
 637 #endif
 638
 639     // Ensures this item is visible
 640     bool EnsureVisible(long item) ;
 641
 642     // Find an item whose label matches this string, starting from the item after 'start'
 643     // or the beginning if 'start' is -1.
 644     long FindItem(long start, const wxString& str, bool partial = false);
 645
 646     // Find an item whose data matches this data, starting from the item after 'start'
 647     // or the beginning if 'start' is -1.
 648     %Rename(FindItemData,  long, FindItem(long start, long data));
 649
 650     // Find an item nearest this position in the specified direction, starting from
 651     // the item after 'start' or the beginning if 'start' is -1.
 652     %Rename(FindItemAtPos,  long, FindItem(long start, const wxPoint& pt, int direction));
 653
 654
 655     DocDeclAStr(
 656         long, HitTest(const wxPoint& point, int& OUTPUT),
 657         "HitTest(Point point) -> (item, where)",
 658         "Determines which item (if any) is at the specified point, giving
 659 details in the second return value (see wx.LIST_HITTEST flags.)", "");
 660
 661     // Inserts an item, returning the index of the new item if successful,
 662     // -1 otherwise.
 663     long InsertItem(wxListItem& info);
 664
 665     // Insert a string item
 666     %Rename(InsertStringItem,
 667             long, InsertItem(long index, const wxString& label, int imageIndex=-1));
 668
 669     // Insert an image item
 670     %Rename(InsertImageItem,
 671             long, InsertItem(long index, int imageIndex));
 672
 673     // Insert an image/string item
 674     %Rename(InsertImageStringItem,
 675             long, InsertItem(long index, const wxString& label, int imageIndex));
 676
 677     // For list view mode (only), inserts a column.
 678     %Rename(InsertColumnItem,  long, InsertColumn(long col, wxListItem& info));
 679     %pythoncode { InsertColumnInfo = InsertColumnItem }
 680
 681     long InsertColumn(long col,
 682                       const wxString& heading,
 683                       int format = wxLIST_FORMAT_LEFT,
 684                       int width = -1);
 685
 686     // set the number of items in a virtual list control
 687     void SetItemCount(long count);
 688
 689     // Scrolls the list control. If in icon, small icon or report view mode,
 690     // x specifies the number of pixels to scroll. If in list view mode, x
 691     // specifies the number of columns to scroll.
 692     // If in icon, small icon or list view mode, y specifies the number of pixels
 693     // to scroll. If in report view mode, y specifies the number of lines to scroll.
 694     bool ScrollList(int dx, int dy);
 695
 696     void SetItemTextColour( long item, const wxColour& col);
 697     wxColour GetItemTextColour( long item ) const;
 698     void SetItemBackgroundColour( long item, const wxColour &col);
 699     wxColour GetItemBackgroundColour( long item ) const;
 700
 701     // Font of an item.
 702     void SetItemFont( long item, const wxFont &f);
 703     wxFont GetItemFont( long item ) const;
 704
 705     %pythoncode {
 706     %#
 707     %# Some helpers...
 708     def Select(self, idx, on=1):
 709         '''[de]select an item'''
 710         if on: state = wx.LIST_STATE_SELECTED
 711         else: state = 0
 712         self.SetItemState(idx, state, wx.LIST_STATE_SELECTED)
 713
 714     def Focus(self, idx):
 715         '''Focus and show the given item'''
 716         self.SetItemState(idx, wx.LIST_STATE_FOCUSED, wx.LIST_STATE_FOCUSED)
 717         self.EnsureVisible(idx)
 718
 719     def GetFocusedItem(self):
 720         '''get the currently focused item or -1 if none'''
 721         return self.GetNextItem(-1, wx.LIST_NEXT_ALL, wx.LIST_STATE_FOCUSED)
 722
 723     def GetFirstSelected(self, *args):
 724         '''return first selected item, or -1 when none'''
 725         return self.GetNextSelected(-1)
 726
 727     def GetNextSelected(self, item):
 728         '''return subsequent selected items, or -1 when no more'''
 729         return self.GetNextItem(item, wx.LIST_NEXT_ALL, wx.LIST_STATE_SELECTED)
 730
 731     def IsSelected(self, idx):
 732         '''return True if the item is selected'''
 733         return (self.GetItemState(idx, wx.LIST_STATE_SELECTED) & wx.LIST_STATE_SELECTED) != 0
 734
 735     def SetColumnImage(self, col, image):
 736         item = self.GetColumn(col)
 737         %# preserve all other attributes too
 738         item.SetMask( wx.LIST_MASK_STATE |
 739                       wx.LIST_MASK_TEXT  |
 740                       wx.LIST_MASK_IMAGE |
 741                       wx.LIST_MASK_DATA  |
 742                       wx.LIST_SET_ITEM   |
 743                       wx.LIST_MASK_WIDTH |
 744                       wx.LIST_MASK_FORMAT )
 745         item.SetImage(image)
 746         self.SetColumn(col, item)
 747
 748     def ClearColumnImage(self, col):
 749         self.SetColumnImage(col, -1)
 750
 751     def Append(self, entry):
 752         '''Append an item to the list control.  The entry parameter should be a
 753            sequence with an item for each column'''
 754         if len(entry):
 755             if wx.USE_UNICODE:
 756                 cvtfunc = unicode
 757             else:
 758                 cvtfunc = str
 759             pos = self.GetItemCount()
 760             self.InsertStringItem(pos, cvtfunc(entry[0]))
 761             for i in range(1, len(entry)):
 762                 self.SetStringItem(pos, i, cvtfunc(entry[i]))
 763             return pos
 764     }
 765
 766
 767     // bool SortItems(wxListCtrlCompare fn, long data);
 768     %extend {
 769         // Sort items.
 770         // func is a function which takes 2 long arguments: item1, item2.
 771         // item1 is the long data associated with a first item (NOT the index).
 772         // item2 is the long data associated with a second item (NOT the index).
 773         // The return value is a negative number if the first item should precede the second
 774         // item, a positive number of the second item should precede the first,
 775         // or zero if the two items are equivalent.
 776         bool SortItems(PyObject* func) {
 777             if (!PyCallable_Check(func))
 778                 return false;
 779             return self->SortItems((wxListCtrlCompare)wxPyListCtrl_SortItems, (long)func);
 780         }
 781     }
 782
 783
 784     %extend {
 785         wxWindow* GetMainWindow() {
 786         #ifdef __WXMSW__
 787             return self;
 788         #else
 789             return (wxWindow*)self->m_mainWin;
 790         #endif
 791         }
 792     }
 793
 794     static wxVisualAttributes
 795     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 796 };
 797
 798
 799
 800 //---------------------------------------------------------------------------
 801 %newgroup
 802
 803
 804 MustHaveApp(wxListView);
 805
 806 // wxListView: a class which provides a little better API for list control
 807 class wxListView : public wxPyListCtrl
 808 {
 809 public:
 810     %pythonAppend wxListView         "self._setOORInfo(self)"
 811     %pythonAppend wxListView()       ""
 812
 813     wxListView( wxWindow *parent,
 814                 wxWindowID id = -1,
 815                 const wxPoint& pos = wxDefaultPosition,
 816                 const wxSize& size = wxDefaultSize,
 817                 long style = wxLC_REPORT,
 818                 const wxValidator& validator = wxDefaultValidator,
 819                 const wxString& name = wxPyListCtrlNameStr);
 820     %RenameCtor(PreListView, wxListView());
 821
 822     bool Create( wxWindow *parent,
 823                 wxWindowID id = -1,
 824                 const wxPoint& pos = wxDefaultPosition,
 825                 const wxSize& size = wxDefaultSize,
 826                 long style = wxLC_REPORT,
 827                 const wxValidator& validator = wxDefaultValidator,
 828                 const wxString& name = wxPyListCtrlNameStr);
 829
 830     // [de]select an item
 831     void Select(long n, bool on = true);
 832
 833     // focus and show the given item
 834     void Focus(long index);
 835
 836     // get the currently focused item or -1 if none
 837     long GetFocusedItem() const;
 838
 839     // get first and subsequent selected items, return -1 when no more
 840     long GetNextSelected(long item) const;
 841     long GetFirstSelected() const;
 842
 843     // return True if the item is selected
 844     bool IsSelected(long index);
 845
 846     void SetColumnImage(int col, int image);
 847     void ClearColumnImage(int col);
 848 };
 849
 850
 851
 852 //---------------------------------------------------------------------------
 853
 854 %init %{
 855     // Map renamed classes back to their common name for OOR
 856     wxPyPtrTypeMap_Add("wxListCtrl", "wxPyListCtrl");
 857 %}
 858
 859 //---------------------------------------------------------------------------