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