]> git.saurik.com Git - wxWidgets.git/blame - include/wx/generic/listctrl.h
Fixed return code of GetSelectionCount()
[wxWidgets.git] / include / wx / generic / listctrl.h
CommitLineData
c801d85f
KB
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__
0d3820b3 15#pragma interface "listctrl.h"
c801d85f
KB
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"
ee7ee469 23#include "wx/textctrl.h"
c801d85f
KB
24#include "wx/dcclient.h"
25#include "wx/scrolwin.h"
26#include "wx/settings.h"
27
28//-----------------------------------------------------------------------------
29// classes
30//-----------------------------------------------------------------------------
31
32class wxListItem;
33class wxListEvent;
34class wxListCtrl;
35
36//-----------------------------------------------------------------------------
37// internal classes
38//-----------------------------------------------------------------------------
39
40class wxListHeaderData;
41class wxListItemData;
42class wxListLineData;
43
44class wxListHeaderWindow;
45class wxListMainWindow;
46
47class wxListRenameTimer;
48//class wxListTextCtrl;
49
50//-----------------------------------------------------------------------------
51// types
52//-----------------------------------------------------------------------------
53
54// type of compare function for wxListCtrl sort operation
debe6624 55typedef int (*wxListCtrlCompare)(long item1, long item2, long sortData);
c801d85f
KB
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
a3622daa 73#define wxLC_SORT_ASCENDING 0x4000
c801d85f
KB
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
a3622daa 99#define wxLIST_STATE_SELECTED 0x0004
c801d85f
KB
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
118enum {
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
a3622daa 123 wxLIST_NEXT_RIGHT // Searches for an item to the right of the specified item
c801d85f
KB
124};
125
126// Alignment flags for Arrange // always wxLIST_ALIGN_LEFT in wxGLC
127enum {
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
135enum {
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
143enum {
144 wxLIST_AUTOSIZE = -1, // always 80 in wxGLC (what else?)
145 wxLIST_AUTOSIZE_USEHEADER = -2
146};
147
148// Flag values for GetItemRect
149enum {
150 wxLIST_RECT_BOUNDS,
151 wxLIST_RECT_ICON,
152 wxLIST_RECT_LABEL
153};
154
155// Flag values for FindItem // not supported by wxGLC
156enum {
157 wxLIST_FIND_UP,
158 wxLIST_FIND_DOWN,
159 wxLIST_FIND_LEFT,
160 wxLIST_FIND_RIGHT
161};
162
c801d85f
KB
163//-----------------------------------------------------------------------------
164// wxListItem
165//-----------------------------------------------------------------------------
166
167class 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
193class WXDLLEXPORT wxListEvent: public wxCommandEvent
194{
195 DECLARE_DYNAMIC_CLASS(wxListEvent)
196
197 public:
64693098 198 wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
c801d85f
KB
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
210typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
211
c67daf87
UR
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 },
c801d85f
KB
225
226
227//-----------------------------------------------------------------------------
228// wxListItemData (internal)
229//-----------------------------------------------------------------------------
230
231class wxListItemData : public wxObject
232{
233 DECLARE_DYNAMIC_CLASS(wxListItemData);
234
0208334d 235 public:
c801d85f
KB
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;
a3622daa 242
c801d85f
KB
243 public:
244 wxListItemData(void);
245 wxListItemData( const wxListItem &info );
246 void SetItem( const wxListItem &info );
247 void SetText( const wxString &s );
debe6624
JS
248 void SetImage( int image );
249 void SetData( long data );
250 void SetPosition( int x, int y );
251 void SetSize( int width, int height );
c801d85f
KB
252 void SetColour( wxColour *col );
253 bool HasImage(void) const;
254 bool HasText(void) const;
debe6624 255 bool IsHit( int x, int y ) const;
c801d85f
KB
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
270class 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;
a3622daa 282
c801d85f
KB
283 public:
284 wxListHeaderData(void);
285 wxListHeaderData( const wxListItem &info );
286 void SetItem( const wxListItem &item );
debe6624
JS
287 void SetPosition( int x, int y );
288 void SetWidth( int w );
289 void SetFormat( int format );
290 void SetHeight( int h );
c801d85f
KB
291 bool HasImage(void) const;
292 bool HasText(void) const;
debe6624 293 bool IsHit( int x, int y ) const;
c801d85f
KB
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
305class wxListLineData : public wxObject
306{
307 DECLARE_DYNAMIC_CLASS(wxListLineData);
308
0208334d 309 public:
c801d85f
KB
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
debe6624 321 void DoDraw( wxPaintDC *dc, bool hilight, bool paintBG );
c801d85f
KB
322
323 public:
324 wxListLineData( void ) {};
debe6624
JS
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 );
c801d85f
KB
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 );
debe6624
JS
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 );
c801d85f 339 void GetRect( wxRectangle &rect );
debe6624 340 void Hilight( bool on );
c801d85f 341 void ReverseHilight( void );
debe6624 342 void DrawRubberBand( wxPaintDC *dc, bool on );
c801d85f 343 void Draw( wxPaintDC *dc );
debe6624 344 bool IsInRect( int x, int y, const wxRectangle &rect );
c801d85f 345 bool IsHilighted( void );
debe6624 346 void AssignRect( wxRectangle &dest, int x, int y, int width, int height );
c801d85f
KB
347 void AssignRect( wxRectangle &dest, const wxRectangle &source );
348};
349
350//-----------------------------------------------------------------------------
351// wxListHeaderWindow (internal)
352//-----------------------------------------------------------------------------
353
354class wxListHeaderWindow : public wxWindow
355{
356 DECLARE_DYNAMIC_CLASS(wxListHeaderWindow)
357
358 protected:
359 wxListMainWindow *m_owner;
360 wxCursor *m_currentCursor;
361 wxCursor *m_resizeCursor;
0208334d
RR
362 bool m_isDraging;
363 int m_column;
364 int m_minX;
365 int m_currentX;
c801d85f
KB
366
367 public:
368 wxListHeaderWindow( void );
a3622daa 369 wxListHeaderWindow( wxWindow *win, wxWindowID id, wxListMainWindow *owner,
debe6624
JS
370 const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
371 long style = 0, const wxString &name = "columntitles" );
c801d85f
KB
372 void DoDrawRect( wxPaintDC *dc, int x, int y, int w, int h );
373 void OnPaint( wxPaintEvent &event );
0208334d 374 void DrawCurrent();
c801d85f
KB
375 void OnMouse( wxMouseEvent &event );
376 void OnSetFocus( wxFocusEvent &event );
a3622daa 377
c801d85f
KB
378 DECLARE_EVENT_TABLE()
379};
380
381//-----------------------------------------------------------------------------
382// wxListRenameTimer (internal)
383//-----------------------------------------------------------------------------
384
385class wxListRenameTimer: public wxTimer
386{
387 private:
388 wxListMainWindow *m_owner;
a3622daa 389
c801d85f
KB
390 public:
391 wxListRenameTimer( wxListMainWindow *owner );
392 void Notify();
393};
394
c801d85f
KB
395//-----------------------------------------------------------------------------
396// wxListTextCtrl (internal)
397//-----------------------------------------------------------------------------
398
399class wxListTextCtrl: public wxTextCtrl
400{
401 DECLARE_DYNAMIC_CLASS(wxListTextCtrl);
a3622daa 402
c801d85f
KB
403 private:
404 bool *m_accept;
405 wxString *m_res;
406 wxListMainWindow *m_owner;
407
408 public:
ee7ee469
RR
409 wxListTextCtrl(void) {};
410 wxListTextCtrl( wxWindow *parent, const wxWindowID id,
411 bool *accept, wxString *res, wxListMainWindow *owner,
412 const wxString &value = "",
413 const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
414 int style = 0, const wxValidator& validator = wxDefaultValidator,
415 const wxString &name = "wxListTextCtrlText" );
416 void OnChar( wxKeyEvent &event );
417 void OnKillFocus( wxFocusEvent &event );
418
419 DECLARE_EVENT_TABLE()
c801d85f
KB
420};
421
c801d85f
KB
422//-----------------------------------------------------------------------------
423// wxListMainWindow (internal)
424//-----------------------------------------------------------------------------
425
426class wxListMainWindow: public wxScrolledWindow
427{
428 DECLARE_DYNAMIC_CLASS(wxListMainWindow);
429
430 public:
431 long m_mode;
432 wxList m_lines;
a3622daa 433 wxList m_columns;
c801d85f
KB
434 wxListLineData *m_current;
435 int m_visibleLines;
436 wxBrush *m_hilightBrush;
437 wxColour *m_hilightColour;
c801d85f
KB
438 int m_xScroll,m_yScroll;
439 bool m_dirty;
440 wxImageList *m_small_image_list;
441 wxImageList *m_normal_image_list;
442 int m_small_spacing;
443 int m_normal_spacing;
444 bool m_hasFocus;
445 bool m_usedKeys;
446 bool m_lastOnSame;
447 wxTimer *m_renameTimer;
448// wxListTextCtrl *m_text;
449 bool m_renameAccept;
450 wxString m_renameRes;
451 bool m_isCreated;
e3e65dac 452 int m_dragCount;
c801d85f
KB
453
454 public:
a3622daa
VZ
455 wxListMainWindow(void);
456 wxListMainWindow( wxWindow *parent, wxWindowID id,
debe6624
JS
457 const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
458 long style = 0, const wxString &name = "listctrl" );
c801d85f
KB
459 ~wxListMainWindow(void);
460 void RefreshLine( wxListLineData *line );
461 void OnPaint( wxPaintEvent &event );
debe6624 462 void HilightAll( bool on );
c801d85f 463 void ActivateLine( wxListLineData *line );
64693098 464 void SendNotify( wxListLineData *line, wxEventType command );
c801d85f
KB
465 void FocusLine( wxListLineData *line );
466 void UnfocusLine( wxListLineData *line );
467 void SelectLine( wxListLineData *line );
468 void DeselectLine( wxListLineData *line );
469 void DeleteLine( wxListLineData *line );
470 void RenameLine( wxListLineData *line, const wxString &newName );
ee7ee469 471 void StartLabelEdit( wxListLineData *line );
c801d85f
KB
472 void OnRenameTimer(void);
473 void OnRenameAccept(void);
474 void OnMouse( wxMouseEvent &event );
475 void MoveToFocus( void );
476 void OnArrowChar( wxListLineData *newCurrent, bool shiftDown );
477 void OnChar( wxKeyEvent &event );
478 void OnSetFocus( wxFocusEvent &event );
479 void OnKillFocus( wxFocusEvent &event );
480 void OnSize( wxSizeEvent &event );
c801d85f
KB
481 void DrawImage( int index, wxPaintDC *dc, int x, int y );
482 void GetImageSize( int index, int &width, int &height );
483 int GetIndexOfLine( const wxListLineData *line );
484 int GetTextLength( wxString &s ); // should be const
485
debe6624
JS
486 void SetImageList( wxImageList *imageList, int which );
487 void SetItemSpacing( int spacing, bool isSmall = FALSE );
488 int GetItemSpacing( bool isSmall = FALSE );
489 void SetColumn( int col, wxListItem &item );
490 void SetColumnWidth( int col, int width );
491 void GetColumn( int col, wxListItem &item );
492 int GetColumnWidth( int vol );
c801d85f 493 int GetColumnCount( void );
a3622daa 494 int GetCountPerPage( void );
c801d85f
KB
495 void SetItem( wxListItem &item );
496 void GetItem( wxListItem &item );
a3622daa 497 void SetItemState( long item, long state, long stateMask );
debe6624 498 int GetItemState( long item, long stateMask );
c801d85f 499 int GetItemCount( void );
debe6624 500 void GetItemRect( long index, wxRectangle &rect );
e3e65dac 501 bool GetItemPosition(long item, wxPoint& pos);
c801d85f 502 int GetSelectedItemCount( void );
debe6624 503 void SetMode( long mode );
c801d85f
KB
504 long GetMode( void ) const;
505 void CalculatePositions( void );
506 void RealizeChanges(void);
debe6624
JS
507 long GetNextItem( long item, int geometry, int state );
508 void DeleteItem( long index );
c801d85f 509 void DeleteAllItems( void );
debe6624 510 void DeleteColumn( int col );
c801d85f 511 void DeleteEverything( void );
debe6624
JS
512 void EnsureVisible( long index );
513 long FindItem(long start, const wxString& str, bool partial = FALSE );
514 long FindItem(long start, long data);
515 long HitTest( int x, int y, int &flags );
c801d85f 516 void InsertItem( wxListItem &item );
30dea054 517// void AddItem( wxListItem &item );
debe6624 518 void InsertColumn( long col, wxListItem &item );
30dea054 519// void AddColumn( wxListItem &item );
c801d85f
KB
520 void SortItems( wxListCtrlCompare fn, long data );
521 virtual bool OnListNotify( wxListEvent &event );
a3622daa 522
c801d85f
KB
523 DECLARE_EVENT_TABLE()
524};
525
526//-----------------------------------------------------------------------------
527// wxListCtrl
528//-----------------------------------------------------------------------------
529
530class wxListCtrl: public wxControl
531{
532 DECLARE_DYNAMIC_CLASS(wxListCtrl);
a3622daa 533
c801d85f 534 public:
a3622daa 535
c801d85f 536 wxListCtrl(void);
32e9da8b 537 wxListCtrl( wxWindow *parent, wxWindowID id = -1,
debe6624 538 const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
32e9da8b
RR
539 long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
540 const wxString &name = "listctrl" )
541 {
542 Create(parent, id, pos, size, style, validator, name);
543 }
c801d85f 544 ~wxListCtrl(void);
32e9da8b 545 bool Create( wxWindow *parent, wxWindowID id = -1,
debe6624 546 const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
32e9da8b
RR
547 long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
548 const wxString &name = "listctrl" );
c801d85f 549 void OnSize( wxSizeEvent &event );
debe6624
JS
550 bool GetColumn( int col, wxListItem& item );
551 bool SetColumn( int col, wxListItem& item );
552 int GetColumnWidth( int col );
553 bool SetColumnWidth( int col, int width);
c801d85f
KB
554 int GetCountPerPage(void); // not the same in wxGLC as in Windows, I think
555// wxText& GetEditControl(void) const; // not supported in wxGLC
556 bool GetItem( wxListItem& info );
557 bool SetItem( wxListItem& info ) ;
debe6624
JS
558 long SetItem( long index, int col, const wxString& label, int imageId = -1 );
559 int GetItemState( long item, long stateMask );
560 bool SetItemState( long item, long state, long stateMask);
561 bool SetItemImage( long item, int image, int selImage);
562 wxString GetItemText( long item );
563 void SetItemText( long item, const wxString& str );
564 long GetItemData( long item );
565 bool SetItemData( long item, long data );
a3622daa 566 bool GetItemRect( long item, wxRectangle& rect, int code = wxLIST_RECT_BOUNDS );
e3e65dac 567 bool GetItemPosition( long item, wxPoint& pos );
debe6624 568 bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
c801d85f 569 int GetItemCount(void);
33d0b396 570 void SetItemSpacing( int spacing, bool isSmall = FALSE );
c801d85f
KB
571 int GetItemSpacing( bool isSmall );
572 int GetSelectedItemCount(void);
573// wxColour GetTextColour(void) const; // wxGLC has colours for every Item (see wxListItem)
574// void SetTextColour(const wxColour& col);
575 long GetTopItem(void);
debe6624
JS
576 void SetSingleStyle( long style, bool add = TRUE ) ;
577 void SetWindowStyleFlag(long style);
c801d85f 578 void RecreateWindow(void) {};
6de97a3b 579 long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const;
debe6624
JS
580 wxImageList *GetImageList(int which);
581 void SetImageList(wxImageList *imageList, int which) ;
582 bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
583 bool DeleteItem( long item );
c801d85f 584 bool DeleteAllItems(void) ;
debe6624
JS
585 bool DeleteColumn( int col );
586// wxText& Edit(long item) ; // not supported in wxGLC
587 bool EnsureVisible( long item );
588 long FindItem(long start, const wxString& str, bool partial = FALSE );
589 long FindItem(long start, long data);
590 long FindItem(long start, const wxPoint& pt, int direction); // not supported in wxGLC
c801d85f
KB
591 long HitTest(const wxPoint& point, int& flags);
592 long InsertItem(wxListItem& info);
debe6624
JS
593 long InsertItem(long index, const wxString& label);
594 long InsertItem(long index, int imageIndex);
595 long InsertItem(long index, const wxString& label, int imageIndex);
596 long InsertColumn(long col, wxListItem& info);
597 long InsertColumn(long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT,
598 int width = -1);
599 bool ScrollList(int dx, int dy);
c801d85f 600 bool SortItems(wxListCtrlCompare fn, long data);
debe6624 601 bool Update(long item);
c801d85f 602 virtual bool OnListNotify(wxListEvent& WXUNUSED(event)) { return FALSE; }
77e7a1dc
RR
603 void OnIdle( wxIdleEvent &event );
604
605 // We have to hand down a few functions
606
e4d06860
RR
607 void SetBackgroundColour( const wxColour &colour );
608 void SetForegroundColour( const wxColour &colour );
609 void SetFont( const wxFont &font );
610
c801d85f 611 void SetDropTarget( wxDropTarget *dropTarget )
77e7a1dc 612 { m_mainWin->SetDropTarget( dropTarget ); }
c801d85f 613 wxDropTarget *GetDropTarget() const
77e7a1dc
RR
614 { return m_mainWin->GetDropTarget(); }
615 void SetCursor( const wxCursor &cursor )
616 { m_mainWin->SetCursor( cursor); }
617 wxColour GetBackgroundColour() const
618 { return m_mainWin->GetBackgroundColour(); }
77e7a1dc
RR
619 wxColour GetForegroundColour() const
620 { return m_mainWin->GetForegroundColour(); }
77e7a1dc 621 bool PopupMenu( wxMenu *menu, int x, int y )
39570cd4 622 { return m_mainWin->PopupMenu( menu, x, y ); }
c801d85f 623
0208334d 624 // implementation
a3622daa 625
c801d85f 626// wxListTextCtrl m_textCtrl;
a3622daa
VZ
627 wxImageList *m_imageListNormal;
628 wxImageList *m_imageListSmall;
c801d85f
KB
629 wxImageList *m_imageListState; // what's that ?
630 wxListHeaderWindow *m_headerWin;
631 wxListMainWindow *m_mainWin;
a3622daa 632
c801d85f
KB
633 DECLARE_EVENT_TABLE()
634
635};
636
637
638#endif // __LISTCTRLH_G__