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