include/wx/generic/listctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listctrl.h
   3 // Purpose:     Generic list control
   4 // Author:      Robert Roebling
   5 // Created:     01/02/97
   6 // Id:
   7 // Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef __LISTCTRLH_G__
  12 #define __LISTCTRLH_G__
  13
  14 #ifdef __GNUG__
  15 #pragma interface "listctrl.h"
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #include "wx/object.h"
  20 #include "wx/imaglist.h"
  21 #include "wx/control.h"
  22 #include "wx/timer.h"
  23 #include "wx/textctrl.h"
  24 #include "wx/dcclient.h"
  25 #include "wx/scrolwin.h"
  26 #include "wx/settings.h"
  27
  28 //-----------------------------------------------------------------------------
  29 // classes
  30 //-----------------------------------------------------------------------------
  31
  32 class wxListItem;
  33 class wxListEvent;
  34 class wxListCtrl;
  35
  36 //-----------------------------------------------------------------------------
  37 // internal classes
  38 //-----------------------------------------------------------------------------
  39
  40 class wxListHeaderData;
  41 class wxListItemData;
  42 class wxListLineData;
  43
  44 class wxListHeaderWindow;
  45 class wxListMainWindow;
  46
  47 class wxListRenameTimer;
  48 //class wxListTextCtrl;
  49
  50 //-----------------------------------------------------------------------------
  51 // types
  52 //-----------------------------------------------------------------------------
  53
  54 // type of compare function for wxListCtrl sort operation
  55 typedef int (*wxListCtrlCompare)(long item1, long item2, long sortData);
  56
  57 //-----------------------------------------------------------------------------
  58 // wxListCtrl flags
  59 //-----------------------------------------------------------------------------
  60
  61 #define wxLC_ICON            0x0004
  62 #define wxLC_SMALL_ICON      0x0008
  63 #define wxLC_LIST            0x0010
  64 #define wxLC_REPORT          0x0020
  65 #define wxLC_ALIGN_TOP       0x0040
  66 #define wxLC_ALIGN_LEFT      0x0080
  67 #define wxLC_AUTOARRANGE     0x0100  // not supported in wxGLC
  68 #define wxLC_USER_TEXT       0x0200  // not supported in wxGLC (how does it work?)
  69 #define wxLC_EDIT_LABELS     0x0400
  70 #define wxLC_NO_HEADER       0x0800  // not supported in wxGLC
  71 #define wxLC_NO_SORT_HEADER  0x1000  // not supported in wxGLC
  72 #define wxLC_SINGLE_SEL      0x2000
  73 #define wxLC_SORT_ASCENDING  0x4000
  74 #define wxLC_SORT_DESCENDING 0x8000  // not supported in wxGLC
  75
  76 #define wxLC_MASK_TYPE       (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
  77 #define wxLC_MASK_ALIGN      (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
  78 #define wxLC_MASK_SORT       (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
  79
  80 // Omitted because (a) too much detail (b) not enough style flags
  81 // #define wxLC_NO_SCROLL
  82 // #define wxLC_NO_LABEL_WRAP
  83 // #define wxLC_OWNERDRAW_FIXED
  84 // #define wxLC_SHOW_SEL_ALWAYS
  85
  86 // Mask flags to tell app/GUI what fields of wxListItem are valid
  87 #define wxLIST_MASK_STATE           0x0001
  88 #define wxLIST_MASK_TEXT            0x0002
  89 #define wxLIST_MASK_IMAGE           0x0004
  90 #define wxLIST_MASK_DATA            0x0008
  91 #define wxLIST_SET_ITEM             0x0010
  92 #define wxLIST_MASK_WIDTH           0x0020
  93 #define wxLIST_MASK_FORMAT          0x0040
  94
  95 // State flags for indicating the state of an item
  96 #define wxLIST_STATE_DONTCARE       0x0000
  97 #define wxLIST_STATE_DROPHILITED    0x0001  // not supported in wxGLC
  98 #define wxLIST_STATE_FOCUSED        0x0002
  99 #define wxLIST_STATE_SELECTED       0x0004
 100 #define wxLIST_STATE_CUT            0x0008  // not supported in wxGLC
 101
 102 // Hit test flags, used in HitTest // wxGLC suppots 20 and 80
 103 #define wxLIST_HITTEST_ABOVE            0x0001  // Above the client area.
 104 #define wxLIST_HITTEST_BELOW            0x0002  // Below the client area.
 105 #define wxLIST_HITTEST_NOWHERE          0x0004  // In the client area but below the last item.
 106 #define wxLIST_HITTEST_ONITEMICON       0x0020  // On the bitmap associated with an item.
 107 #define wxLIST_HITTEST_ONITEMLABEL      0x0080  // On the label (string) associated with an item.
 108 #define wxLIST_HITTEST_ONITEMRIGHT      0x0100  // In the area to the right of an item.
 109 #define wxLIST_HITTEST_ONITEMSTATEICON  0x0200  // On the state icon for a tree view item that is in a user-defined state.
 110 #define wxLIST_HITTEST_TOLEFT           0x0400  // To the right of the client area.
 111 #define wxLIST_HITTEST_TORIGHT          0x0800  // To the left of the client area.
 112
 113 #define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
 114
 115
 116
 117 // Flags for GetNextItem  // always wxLIST_NEXT_ALL in wxGLC
 118 enum {
 119     wxLIST_NEXT_ABOVE,          // Searches for an item above the specified item
 120     wxLIST_NEXT_ALL,            // Searches for subsequent item by index
 121     wxLIST_NEXT_BELOW,          // Searches for an item below the specified item
 122     wxLIST_NEXT_LEFT,           // Searches for an item to the left of the specified item
 123     wxLIST_NEXT_RIGHT           // Searches for an item to the right of the specified item
 124 };
 125
 126 // Alignment flags for Arrange  // always wxLIST_ALIGN_LEFT in wxGLC
 127 enum {
 128     wxLIST_ALIGN_DEFAULT,
 129     wxLIST_ALIGN_LEFT,
 130     wxLIST_ALIGN_TOP,
 131     wxLIST_ALIGN_SNAP_TO_GRID
 132 };
 133
 134 // Column format  // always wxLIST_FORMAT_LEFT in wxGLC
 135 enum {
 136     wxLIST_FORMAT_LEFT,
 137     wxLIST_FORMAT_RIGHT,
 138     wxLIST_FORMAT_CENTRE,
 139     wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
 140 };
 141
 142 // Autosize values for SetColumnWidth
 143 enum {
 144     wxLIST_AUTOSIZE = -1,          // always 80 in wxGLC (what else?)
 145     wxLIST_AUTOSIZE_USEHEADER = -2
 146 };
 147
 148 // Flag values for GetItemRect
 149 enum {
 150     wxLIST_RECT_BOUNDS,
 151     wxLIST_RECT_ICON,
 152     wxLIST_RECT_LABEL
 153 };
 154
 155 // Flag values for FindItem  // not supported by wxGLC
 156 enum {
 157     wxLIST_FIND_UP,
 158     wxLIST_FIND_DOWN,
 159     wxLIST_FIND_LEFT,
 160     wxLIST_FIND_RIGHT
 161 };
 162
 163 //-----------------------------------------------------------------------------
 164 // wxListItem
 165 //-----------------------------------------------------------------------------
 166
 167 class wxListItem: public wxObject
 168 {
 169   DECLARE_DYNAMIC_CLASS(wxListItem)
 170
 171   public:
 172     long            m_mask;     // Indicates what fields are valid
 173     long            m_itemId;   // The zero-based item position
 174     int             m_col;      // Zero-based column, if in report mode
 175     long            m_state;    // The state of the item
 176     long            m_stateMask; // Which flags of m_state are valid (uses same flags)
 177     wxString        m_text;     // The label/header text
 178     int             m_image;    // The zero-based index into an image list
 179     long            m_data;     // App-defined data
 180     wxColour       *m_colour;   // only wxGLC, not supported by Windows ;->
 181
 182     // For columns only
 183     int             m_format;   // left, right, centre
 184     int             m_width;    // width of column
 185
 186     wxListItem(void);
 187 };
 188
 189 //-----------------------------------------------------------------------------
 190 // wxListEvent
 191 //-----------------------------------------------------------------------------
 192
 193 class WXDLLEXPORT wxListEvent: public wxCommandEvent
 194 {
 195   DECLARE_DYNAMIC_CLASS(wxListEvent)
 196
 197  public:
 198   wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 199
 200   int           m_code;
 201   long          m_itemIndex;
 202   long          m_oldItemIndex;
 203   int           m_col;
 204   bool          m_cancelled;
 205   wxPoint       m_pointDrag;
 206
 207   wxListItem    m_item;
 208 };
 209
 210 typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
 211
 212 #define EVT_LIST_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 213 #define EVT_LIST_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 214 #define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 215 #define EVT_LIST_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 216 #define EVT_LIST_DELETE_ITEM(id, fn) { wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 217 #define EVT_LIST_DELETE_ALL_ITEMS(id, fn) { wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 218 #define EVT_LIST_GET_INFO(id, fn) { wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 219 #define EVT_LIST_SET_INFO(id, fn) { wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 220 #define EVT_LIST_ITEM_SELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 221 #define EVT_LIST_ITEM_DESELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 222 #define EVT_LIST_KEY_DOWN(id, fn) { wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 223 #define EVT_LIST_INSERT_ITEM(id, fn) { wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 224 #define EVT_LIST_COL_CLICK(id, fn) { wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 225
 226
 227 //-----------------------------------------------------------------------------
 228 //  wxListItemData (internal)
 229 //-----------------------------------------------------------------------------
 230
 231 class wxListItemData : public wxObject
 232 {
 233   DECLARE_DYNAMIC_CLASS(wxListItemData);
 234
 235   public:
 236     wxString   m_text;
 237     int        m_image;
 238     long       m_data;
 239     int        m_xpos,m_ypos;
 240     int        m_width,m_height;
 241     wxColour   *m_colour;
 242
 243   public:
 244     wxListItemData(void);
 245     wxListItemData( const wxListItem &info );
 246     void SetItem( const wxListItem &info );
 247     void SetText( const wxString &s );
 248     void SetImage( int image );
 249     void SetData( long data );
 250     void SetPosition( int x, int y );
 251     void SetSize( int width, int height );
 252     void SetColour( wxColour *col );
 253     bool HasImage(void) const;
 254     bool HasText(void) const;
 255     bool IsHit( int x, int y ) const;
 256     void GetText( wxString &s );
 257     int GetX( void ) const;
 258     int GetY( void ) const;
 259     int GetWidth(void) const;
 260     int GetHeight(void) const;
 261     int GetImage(void) const;
 262     void GetItem( wxListItem &info );
 263     wxColour *GetColour(void);
 264 };
 265
 266 //-----------------------------------------------------------------------------
 267 //  wxListHeaderData (internal)
 268 //-----------------------------------------------------------------------------
 269
 270 class wxListHeaderData : public wxObject
 271 {
 272   DECLARE_DYNAMIC_CLASS(wxListHeaderData);
 273
 274   protected:
 275     long      m_mask;
 276     int       m_image;
 277     wxString  m_text;
 278     int       m_format;
 279     int       m_width;
 280     int       m_xpos,m_ypos;
 281     int       m_height;
 282
 283   public:
 284     wxListHeaderData(void);
 285     wxListHeaderData( const wxListItem &info );
 286     void SetItem( const wxListItem &item );
 287     void SetPosition( int x, int y );
 288     void SetWidth( int w );
 289     void SetFormat( int format );
 290     void SetHeight( int h );
 291     bool HasImage(void) const;
 292     bool HasText(void) const;
 293     bool IsHit( int x, int y ) const;
 294     void GetItem( wxListItem &item );
 295     void GetText( wxString &s );
 296     int GetImage(void) const;
 297     int GetWidth(void) const;
 298     int GetFormat(void) const;
 299 };
 300
 301 //-----------------------------------------------------------------------------
 302 //  wxListLineData (internal)
 303 //-----------------------------------------------------------------------------
 304
 305 class wxListLineData : public wxObject
 306 {
 307   DECLARE_DYNAMIC_CLASS(wxListLineData);
 308
 309   public:
 310     wxList              m_items;
 311     wxRectangle         m_bound_all;
 312     wxRectangle         m_bound_label;
 313     wxRectangle         m_bound_icon;
 314     wxRectangle         m_bound_hilight;
 315     int                 m_mode;
 316     bool                m_hilighted;
 317     wxBrush            *m_hilightBrush;
 318     int                 m_spacing;
 319     wxListMainWindow   *m_owner;
 320
 321     void DoDraw( wxPaintDC *dc, bool hilight, bool paintBG );
 322
 323   public:
 324     wxListLineData( void ) {};
 325     wxListLineData( wxListMainWindow *owner, int mode, wxBrush *hilightBrush );
 326     void CalculateSize( wxPaintDC *dc, int spacing );
 327     void SetPosition( wxPaintDC *dc, int x, int y,  int window_width );
 328     void SetColumnPosition( int index, int x );
 329     void GetSize( int &width, int &height );
 330     void GetExtent( int &x, int &y, int &width, int &height );
 331     void GetLabelExtent( int &x, int &y, int &width, int &height );
 332     long IsHit( int x, int y );
 333     void InitItems( int num );
 334     void SetItem( int index, const wxListItem &info );
 335     void GetItem( int index, wxListItem &info );
 336     void GetText( int index, wxString &s );
 337     void SetText( int index, const wxString s );
 338     int GetImage( int index );
 339     void GetRect( wxRectangle &rect );
 340     void Hilight( bool on );
 341     void ReverseHilight( void );
 342     void DrawRubberBand( wxPaintDC *dc, bool on );
 343     void Draw( wxPaintDC *dc );
 344     bool IsInRect( int x, int y, const wxRectangle &rect );
 345     bool IsHilighted( void );
 346     void AssignRect( wxRectangle &dest, int x, int y, int width, int height );
 347     void AssignRect( wxRectangle &dest, const wxRectangle &source );
 348 };
 349
 350 //-----------------------------------------------------------------------------
 351 //  wxListHeaderWindow (internal)
 352 //-----------------------------------------------------------------------------
 353
 354 class wxListHeaderWindow : public wxWindow
 355 {
 356   DECLARE_DYNAMIC_CLASS(wxListHeaderWindow)
 357
 358   protected:
 359     wxListMainWindow  *m_owner;
 360     wxCursor          *m_currentCursor;
 361     wxCursor          *m_resizeCursor;
 362     bool               m_isDraging;
 363     int                m_column;
 364     int                m_minX;
 365     int                m_currentX;
 366
 367   public:
 368     wxListHeaderWindow( void );
 369     ~wxListHeaderWindow( void );
 370     wxListHeaderWindow( wxWindow *win, wxWindowID id, wxListMainWindow *owner,
 371       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
 372       long style = 0, const wxString &name = "columntitles" );
 373     void DoDrawRect( wxPaintDC *dc, int x, int y, int w, int h );
 374     void OnPaint( wxPaintEvent &event );
 375     void DrawCurrent();
 376     void OnMouse( wxMouseEvent &event );
 377     void OnSetFocus( wxFocusEvent &event );
 378
 379   DECLARE_EVENT_TABLE()
 380 };
 381
 382 //-----------------------------------------------------------------------------
 383 // wxListRenameTimer (internal)
 384 //-----------------------------------------------------------------------------
 385
 386 class wxListRenameTimer: public wxTimer
 387 {
 388  private:
 389    wxListMainWindow   *m_owner;
 390
 391  public:
 392    wxListRenameTimer( wxListMainWindow *owner );
 393    void Notify();
 394 };
 395
 396 //-----------------------------------------------------------------------------
 397 //  wxListTextCtrl (internal)
 398 //-----------------------------------------------------------------------------
 399
 400 class wxListTextCtrl: public wxTextCtrl
 401 {
 402   DECLARE_DYNAMIC_CLASS(wxListTextCtrl);
 403
 404   private:
 405     bool               *m_accept;
 406     wxString           *m_res;
 407     wxListMainWindow   *m_owner;
 408
 409   public:
 410     wxListTextCtrl(void) {};
 411     wxListTextCtrl( wxWindow *parent, const wxWindowID id,
 412                     bool *accept, wxString *res, wxListMainWindow *owner,
 413                     const wxString &value = "",
 414                     const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
 415                     int style = 0, const wxValidator& validator = wxDefaultValidator,
 416                     const wxString &name = "wxListTextCtrlText" );
 417     void OnChar( wxKeyEvent &event );
 418     void OnKillFocus( wxFocusEvent &event );
 419
 420   DECLARE_EVENT_TABLE()
 421 };
 422
 423 //-----------------------------------------------------------------------------
 424 //  wxListMainWindow (internal)
 425 //-----------------------------------------------------------------------------
 426
 427 class wxListMainWindow: public wxScrolledWindow
 428 {
 429   DECLARE_DYNAMIC_CLASS(wxListMainWindow);
 430
 431   public:
 432     long                 m_mode;
 433     wxList               m_lines;
 434     wxList               m_columns;
 435     wxListLineData      *m_current;
 436     int                  m_visibleLines;
 437     wxBrush             *m_hilightBrush;
 438     wxColour            *m_hilightColour;
 439     int                  m_xScroll,m_yScroll;
 440     bool                 m_dirty;
 441     wxImageList         *m_small_image_list;
 442     wxImageList         *m_normal_image_list;
 443     int                  m_small_spacing;
 444     int                  m_normal_spacing;
 445     bool                 m_hasFocus;
 446     bool                 m_usedKeys;
 447     bool                 m_lastOnSame;
 448     wxTimer             *m_renameTimer;
 449 //  wxListTextCtrl      *m_text;
 450     bool                 m_renameAccept;
 451     wxString             m_renameRes;
 452     bool                 m_isCreated;
 453     int                  m_dragCount;
 454
 455   public:
 456     wxListMainWindow(void);
 457     wxListMainWindow( wxWindow *parent, wxWindowID id,
 458       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
 459       long style = 0, const wxString &name = "listctrl" );
 460     ~wxListMainWindow(void);
 461     void RefreshLine( wxListLineData *line );
 462     void OnPaint( wxPaintEvent &event );
 463     void HilightAll( bool on );
 464     void ActivateLine( wxListLineData *line );
 465     void SendNotify( wxListLineData *line, wxEventType command );
 466     void FocusLine( wxListLineData *line );
 467     void UnfocusLine( wxListLineData *line );
 468     void SelectLine( wxListLineData *line );
 469     void DeselectLine( wxListLineData *line );
 470     void DeleteLine( wxListLineData *line );
 471     void RenameLine( wxListLineData *line, const wxString &newName );
 472     void StartLabelEdit( wxListLineData *line );
 473     void OnRenameTimer(void);
 474     void OnRenameAccept(void);
 475     void OnMouse( wxMouseEvent &event );
 476     void MoveToFocus( void );
 477     void OnArrowChar( wxListLineData *newCurrent, bool shiftDown );
 478     void OnChar( wxKeyEvent &event );
 479     void OnSetFocus( wxFocusEvent &event );
 480     void OnKillFocus( wxFocusEvent &event );
 481     void OnSize( wxSizeEvent &event );
 482     void DrawImage( int index, wxPaintDC *dc, int x, int y );
 483     void GetImageSize( int index, int &width, int &height );
 484     int GetIndexOfLine( const wxListLineData *line );
 485     int GetTextLength( wxString &s );  // should be const
 486
 487     void SetImageList( wxImageList *imageList, int which );
 488     void SetItemSpacing( int spacing, bool isSmall = FALSE );
 489     int GetItemSpacing( bool isSmall = FALSE );
 490     void SetColumn( int col, wxListItem &item );
 491     void SetColumnWidth( int col, int width );
 492     void GetColumn( int col, wxListItem &item );
 493     int GetColumnWidth( int vol );
 494     int GetColumnCount( void );
 495     int GetCountPerPage( void );
 496     void SetItem( wxListItem &item );
 497     void GetItem( wxListItem &item );
 498     void SetItemState( long item, long state, long stateMask );
 499     int GetItemState( long item, long stateMask );
 500     int GetItemCount( void );
 501     void GetItemRect( long index, wxRectangle &rect );
 502     bool GetItemPosition(long item, wxPoint& pos);
 503     int GetSelectedItemCount( void );
 504     void SetMode( long mode );
 505     long GetMode( void ) const;
 506     void CalculatePositions( void );
 507     void RealizeChanges(void);
 508     long GetNextItem( long item, int geometry, int state );
 509     void DeleteItem( long index );
 510     void DeleteAllItems( void );
 511     void DeleteColumn( int col );
 512     void DeleteEverything( void );
 513     void EnsureVisible( long index );
 514     long FindItem(long start, const wxString& str, bool partial = FALSE );
 515     long FindItem(long start, long data);
 516     long HitTest( int x, int y, int &flags );
 517     void InsertItem( wxListItem &item );
 518 //    void AddItem( wxListItem &item );
 519     void InsertColumn( long col, wxListItem &item );
 520 //    void AddColumn( wxListItem &item );
 521     void SortItems( wxListCtrlCompare fn, long data );
 522     virtual bool OnListNotify( wxListEvent &event );
 523
 524   DECLARE_EVENT_TABLE()
 525 };
 526
 527 //-----------------------------------------------------------------------------
 528 // wxListCtrl
 529 //-----------------------------------------------------------------------------
 530
 531 class wxListCtrl: public wxControl
 532 {
 533   DECLARE_DYNAMIC_CLASS(wxListCtrl);
 534
 535   public:
 536
 537     wxListCtrl(void);
 538     wxListCtrl( wxWindow *parent, wxWindowID id = -1,
 539       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
 540       long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
 541        const wxString &name = "listctrl" )
 542     {
 543       Create(parent, id, pos, size, style, validator, name);
 544     }
 545     ~wxListCtrl(void);
 546     bool Create( wxWindow *parent, wxWindowID id = -1,
 547       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
 548       long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
 549        const wxString &name = "listctrl" );
 550     void OnSize( wxSizeEvent &event );
 551     bool GetColumn( int col, wxListItem& item ) const;
 552     bool SetColumn( int col, wxListItem& item );
 553     int GetColumnWidth( int col ) const;
 554     bool SetColumnWidth( int col, int width);
 555     int GetCountPerPage(void) const; // not the same in wxGLC as in Windows, I think
 556 //  wxText& GetEditControl(void) const; // not supported in wxGLC
 557     bool GetItem( wxListItem& info ) const;
 558     bool SetItem( wxListItem& info ) ;
 559     long SetItem( long index, int col, const wxString& label, int imageId = -1 );
 560     int  GetItemState( long item, long stateMask ) const;
 561     bool SetItemState( long item, long state, long stateMask);
 562     bool SetItemImage( long item, int image, int selImage);
 563     wxString GetItemText( long item ) const;
 564     void SetItemText( long item, const wxString& str );
 565     long GetItemData( long item ) const;
 566     bool SetItemData( long item, long data );
 567     bool GetItemRect( long item, wxRectangle& rect, int code = wxLIST_RECT_BOUNDS ) const;
 568     bool GetItemPosition( long item, wxPoint& pos ) const;
 569     bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
 570     int GetItemCount(void) const;
 571     void SetItemSpacing( int spacing, bool isSmall = FALSE );
 572     int GetItemSpacing( bool isSmall ) const;
 573     int GetSelectedItemCount(void) const;
 574 //  wxColour GetTextColour(void) const; // wxGLC has colours for every Item (see wxListItem)
 575 //  void SetTextColour(const wxColour& col);
 576     long GetTopItem(void) const;
 577     void SetSingleStyle( long style, bool add = TRUE ) ;
 578     void SetWindowStyleFlag(long style);
 579     void RecreateWindow(void) {};
 580     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const;
 581     wxImageList *GetImageList(int which) const;
 582     void SetImageList(wxImageList *imageList, int which) ;
 583     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
 584     bool DeleteItem( long item );
 585     bool DeleteAllItems(void) ;
 586     void DeleteAllColumns(void) ;
 587     bool DeleteColumn( int col );
 588 //  wxText& Edit(long item) ;  // not supported in wxGLC
 589     bool EnsureVisible( long item );
 590     long FindItem(long start, const wxString& str, bool partial = FALSE );
 591     long FindItem(long start, long data);
 592     long FindItem(long start, const wxPoint& pt, int direction); // not supported in wxGLC
 593     long HitTest(const wxPoint& point, int& flags);
 594     long InsertItem(wxListItem& info);
 595     long InsertItem(long index, const wxString& label);
 596     long InsertItem(long index, int imageIndex);
 597     long InsertItem(long index, const wxString& label, int imageIndex);
 598     long InsertColumn(long col, wxListItem& info);
 599     long InsertColumn(long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT,
 600       int width = -1);
 601     bool ScrollList(int dx, int dy);
 602     bool SortItems(wxListCtrlCompare fn, long data);
 603     bool Update(long item);
 604     virtual bool OnListNotify(wxListEvent& WXUNUSED(event)) { return FALSE; }
 605     void OnIdle( wxIdleEvent &event );
 606
 607     // We have to hand down a few functions
 608
 609     void SetBackgroundColour( const wxColour &colour );
 610     void SetForegroundColour( const wxColour &colour );
 611     void SetFont( const wxFont &font );
 612
 613     void SetDropTarget( wxDropTarget *dropTarget )
 614       { m_mainWin->SetDropTarget( dropTarget ); }
 615     wxDropTarget *GetDropTarget() const
 616       { return m_mainWin->GetDropTarget(); }
 617     void SetCursor( const wxCursor &cursor )
 618       { if (m_mainWin) m_mainWin->wxWindow::SetCursor( cursor); }
 619     wxColour GetBackgroundColour() const
 620       { if (m_mainWin) return m_mainWin->GetBackgroundColour();
 621         else return wxColour(); }
 622     wxColour GetForegroundColour() const
 623       { if (m_mainWin) return m_mainWin->GetForegroundColour();
 624         else return wxColour(); }
 625     bool PopupMenu( wxMenu *menu, int x, int y )
 626       { return m_mainWin->PopupMenu( menu, x, y ); }
 627
 628   // implementation
 629
 630 //  wxListTextCtrl       m_textCtrl;
 631     wxImageList         *m_imageListNormal;
 632     wxImageList         *m_imageListSmall;
 633     wxImageList         *m_imageListState;  // what's that ?
 634     wxListHeaderWindow  *m_headerWin;
 635     wxListMainWindow    *m_mainWin;
 636
 637   DECLARE_EVENT_TABLE()
 638
 639 };
 640
 641
 642 #endif // __LISTCTRLH_G__