]> git.saurik.com Git - wxWidgets.git/blame - include/wx/dataview.h
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Added automatic dialog scrolling ability
[wxWidgets.git] / include / wx / dataview.h
CommitLineData
bcd846ea
RR		 1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/dataview.h
3// Purpose: wxDataViewCtrl base classes
4// Author: Robert Roebling
b7e9f8b1 5// Modified by: Bo Yang
bcd846ea
RR		 6// Created: 08.01.06
7// RCS-ID: $Id$
8// Copyright: (c) Robert Roebling
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_DATAVIEW_H_BASE_
13#define _WX_DATAVIEW_H_BASE_
14
15#include "wx/defs.h"
16
17#if wxUSE_DATAVIEWCTRL
18
239eaa41
RR		 19#include "wx/control.h"
20#include "wx/textctrl.h"
21#include "wx/bitmap.h"
64ffb888 22#include "wx/variant.h"
b7e9f8b1 23#include "wx/dynarray.h"
89352653 24#include "wx/icon.h"
a75124d0 25#include "wx/imaglist.h"
4ed7af08
RR		 26
27#if defined(__WXGTK20__)
28 // for testing
001f0f82 29 // #define wxUSE_GENERICDATAVIEWCTRL 1
4ed7af08 30#elif defined(__WXMAC__)
4ed7af08
RR		 31#else
32 #define wxUSE_GENERICDATAVIEWCTRL 1
33#endif
34
bcd846ea 35// ----------------------------------------------------------------------------
f554a14b 36// wxDataViewCtrl flags
bcd846ea
RR		 37// ----------------------------------------------------------------------------
38
239eaa41
RR		 39// ----------------------------------------------------------------------------
40// wxDataViewCtrl globals
41// ----------------------------------------------------------------------------
bcd846ea 42
b5dbe15d
VS		 43class WXDLLIMPEXP_FWD_ADV wxDataViewItem;
44class WXDLLIMPEXP_FWD_ADV wxDataViewModel;
45class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
46class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
47class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer;
48class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier;
fa28826d 49
f460c29d 50extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
bcd846ea 51
87f0efe2
RR		 52// the default width of new (text) columns:
53#define wxDVC_DEFAULT_WIDTH 80
54
55// the default width of new toggle columns:
56#define wxDVC_TOGGLE_DEFAULT_WIDTH 30
57
9861f022
RR		 58// the default minimal width of the columns:
59#define wxDVC_DEFAULT_MINWIDTH 30
60
61// the default alignment of wxDataViewRenderers:
69357fa0 62#define wxDVR_DEFAULT_ALIGNMENT (wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL)
9861f022 63
87f0efe2 64
f554a14b 65// ---------------------------------------------------------
e0062c04 66// wxDataViewItem
f554a14b 67// ---------------------------------------------------------
239eaa41 68
e0062c04 69class WXDLLIMPEXP_ADV wxDataViewItem
239eaa41
RR		 70{
71public:
b5ec7dd6 72 wxDataViewItem( void* id = NULL )
9d52aad3 73 { m_id = id; }
e0062c04 74 wxDataViewItem( const wxDataViewItem &item )
9d52aad3
RR		 75 { m_id = item.m_id; }
76 bool IsOk() const { return m_id != NULL; }
77 void* GetID() const { return m_id; }
4f1cf94b 78 operator const void* () const { return m_id; }
b5ec7dd6 79
e94d0c1e 80#ifdef __WXDEBUG__
c3c62822 81 void Print( const wxString &text ) const;
e94d0c1e 82#endif
b5ec7dd6 83
8f850e28 84private:
9d52aad3 85 void* m_id;
64ffb888 86};
239eaa41 87
d5025dc0 88bool operator == (const wxDataViewItem &left, const wxDataViewItem &right);
aba9bfd0 89
cd722937
RR		 90WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
91
9d8fe14a
RR		 92// ---------------------------------------------------------
93// wxDataViewModelNotifier
94// ---------------------------------------------------------
95
96class WXDLLIMPEXP_ADV wxDataViewModelNotifier
97{
98public:
99 wxDataViewModelNotifier() { }
100 virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
101
102 virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
103 virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
104 virtual bool ItemChanged( const wxDataViewItem &item ) = 0;
854cdb09
RR		 105 virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
106 virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
107 virtual bool ItemsChanged( const wxDataViewItemArray &items );
9d8fe14a
RR		 108 virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
109 virtual bool Cleared() = 0;
b5ec7dd6 110
d3f00f59 111 virtual void Resort() = 0;
9d8fe14a
RR		 112
113 void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
114 wxDataViewModel *GetOwner() { return m_owner; }
115
116private:
117 wxDataViewModel *m_owner;
118};
119
120
4264606e
RR		 121
122// ----------------------------------------------------------------------------
123// wxDataViewItemAttr: a structure containing the visual attributes of an item
124// ----------------------------------------------------------------------------
125
126// TODO: this should be renamed to wxItemAttr or something general like this
127
128class WXDLLIMPEXP_ADV wxDataViewItemAttr
129{
130public:
131 // ctors
132 wxDataViewItemAttr()
133 {
134 m_bold = false;
135 m_italic = false;
136 }
137
138 // setters
139 void SetColour(const wxColour& colour) { m_colour = colour; }
140 void SetBold( bool set ) { m_bold = set; }
141 void SetItalic( bool set ) { m_italic = set; }
142
143 // accessors
144 bool HasColour() const { return m_colour.Ok(); }
145 const wxColour& GetColour() const { return m_colour; }
146
147 bool GetBold() const { return m_bold; }
148 bool GetItalic() const { return m_italic; }
149
150private:
151 wxColour m_colour;
152 bool m_bold;
153 bool m_italic;
154};
155
156
f554a14b 157// ---------------------------------------------------------
e0062c04 158// wxDataViewModel
f554a14b 159// ---------------------------------------------------------
239eaa41 160
d350fbec
VS		 161WX_DECLARE_LIST_WITH_DECL(wxDataViewModelNotifier, wxDataViewModelNotifiers,
162 class WXDLLIMPEXP_ADV);
9d8fe14a 163
e0062c04 164class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData
239eaa41
RR		 165{
166public:
e0062c04 167 wxDataViewModel();
239eaa41 168
9861f022 169 virtual unsigned int GetColumnCount() const = 0;
87f0efe2 170
a7f61f76 171 // return type as reported by wxVariant
9861f022 172 virtual wxString GetColumnType( unsigned int col ) const = 0;
87f0efe2 173
a7f61f76 174 // get value into a wxVariant
b5ec7dd6 175 virtual void GetValue( wxVariant &variant,
e0062c04 176 const wxDataViewItem &item, unsigned int col ) const = 0;
87f0efe2 177
a7f61f76 178 // set value, call ValueChanged() afterwards!
b5ec7dd6 179 virtual bool SetValue( const wxVariant &variant,
e0062c04 180 const wxDataViewItem &item, unsigned int col ) = 0;
239eaa41 181
4264606e
RR		 182 // Get text attribute, return false of default attributes should be used
183 virtual bool GetAttr( const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col), wxDataViewItemAttr &WXUNUSED(attr) )
184 { return false; }
185
e0062c04 186 // define hierachy
ed903e42
RR		 187 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
188 virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
1e40f667 189 // Is the container just a header or an item with all columns
b5ec7dd6
VZ		 190 virtual bool HasContainerColumns(const wxDataViewItem& WXUNUSED(item)) const
191 { return false; }
74fe973b 192 virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const = 0;
b9b8b59c 193
239eaa41 194 // delegated notifiers
e0062c04 195 virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
854cdb09 196 virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
469d3e9b 197 virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
854cdb09 198 virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
e0062c04 199 virtual bool ItemChanged( const wxDataViewItem &item );
854cdb09 200 virtual bool ItemsChanged( const wxDataViewItemArray &items );
e0062c04 201 virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col );
8981608c 202 virtual bool Cleared();
b5d777c7 203
ef427989
RR		 204 // delegatd action
205 virtual void Resort();
206
e0062c04
RR		 207 void AddNotifier( wxDataViewModelNotifier *notifier );
208 void RemoveNotifier( wxDataViewModelNotifier *notifier );
b5ec7dd6 209
ef427989 210 // default compare function
b5ec7dd6 211 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
7ee7191c 212 unsigned int column, bool ascending );
09711964 213 virtual bool HasDefaultCompare() const { return false; }
2056dede
RR		 214
215 // internal
216 virtual bool IsIndexListModel() const { return false; }
66e09788 217
87f0efe2
RR		 218protected:
219 // the user should not delete this class directly: he should use DecRef() instead!
5debbdcf 220 virtual ~wxDataViewModel() { }
87f0efe2 221
9d8fe14a 222 wxDataViewModelNotifiers m_notifiers;
ef427989
RR		 223};
224
225// ---------------------------------------------------------
c534e696 226// wxDataViewIndexListModel
ef427989
RR		 227// ---------------------------------------------------------
228
d350fbec 229class WXDLLIMPEXP_ADV wxDataViewIndexListModel: public wxDataViewModel
ef427989
RR		 230{
231public:
c534e696 232 wxDataViewIndexListModel( unsigned int initial_size = 0 );
ef427989 233 ~wxDataViewIndexListModel();
b5ec7dd6 234
b5ec7dd6 235 virtual void GetValue( wxVariant &variant,
ef427989
RR		 236 unsigned int row, unsigned int col ) const = 0;
237
b5ec7dd6 238 virtual bool SetValue( const wxVariant &variant,
ef427989 239 unsigned int row, unsigned int col ) = 0;
b5ec7dd6 240
4264606e
RR		 241 virtual bool GetAttr( unsigned int WXUNUSED(row), unsigned int WXUNUSED(col), wxDataViewItemAttr &WXUNUSED(attr) )
242 { return false; }
243
c534e696
RR		 244 void RowPrepended();
245 void RowInserted( unsigned int before );
246 void RowAppended();
247 void RowDeleted( unsigned int row );
8b6cf9bf 248 void RowsDeleted( const wxArrayInt &rows );
c534e696
RR		 249 void RowChanged( unsigned int row );
250 void RowValueChanged( unsigned int row, unsigned int col );
33ba5a05 251 void Reset( unsigned int new_size );
b5ec7dd6 252
c534e696 253 // convert to/from row/wxDataViewItem
b5ec7dd6 254
c534e696
RR		 255 unsigned int GetRow( const wxDataViewItem &item ) const;
256 wxDataViewItem GetItem( unsigned int row ) const;
b5ec7dd6 257
c534e696 258 // compare based on index
b5ec7dd6
VZ		 259
260 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
7ee7191c 261 unsigned int column, bool ascending );
517166e6 262 virtual bool HasDefaultCompare() const;
c534e696
RR		 263
264 // implement base methods
265
b5ec7dd6 266 virtual void GetValue( wxVariant &variant,
c534e696 267 const wxDataViewItem &item, unsigned int col ) const;
b5ec7dd6 268 virtual bool SetValue( const wxVariant &variant,
c534e696 269 const wxDataViewItem &item, unsigned int col );
4264606e 270 virtual bool GetAttr( const wxDataViewItem &item, unsigned int col, wxDataViewItemAttr &attr );
c534e696
RR		 271 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
272 virtual bool IsContainer( const wxDataViewItem &item ) const;
74fe973b 273 virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
b5ec7dd6 274
2056dede
RR		 275 // internal
276 virtual bool IsIndexListModel() const { return true; }
277 unsigned int GetLastIndex() const { return m_lastIndex; }
278
c534e696 279private:
cd722937 280 wxDataViewItemArray m_hash;
c534e696 281 unsigned int m_lastIndex;
517166e6 282 bool m_ordered;
2056dede 283 bool m_useHash;
239eaa41
RR		 284};
285
c33edc08 286
1e510b1e
RR		 287//-----------------------------------------------------------------------------
288// wxDataViewEditorCtrlEvtHandler
289//-----------------------------------------------------------------------------
290
291class wxDataViewEditorCtrlEvtHandler: public wxEvtHandler
292{
293public:
294 wxDataViewEditorCtrlEvtHandler( wxControl *editor, wxDataViewRenderer *owner );
b5ec7dd6 295
1e510b1e 296 void AcceptChangesAndFinish();
30715fa1 297 void SetFocusOnIdle( bool focus = true ) { m_focusOnIdle = focus; }
1e510b1e
RR		 298
299protected:
300 void OnChar( wxKeyEvent &event );
301 void OnKillFocus( wxFocusEvent &event );
30715fa1 302 void OnIdle( wxIdleEvent &event );
1e510b1e
RR		 303
304private:
305 wxDataViewRenderer *m_owner;
306 wxControl *m_editorCtrl;
307 bool m_finished;
30715fa1 308 bool m_focusOnIdle;
1e510b1e
RR		 309
310private:
311 DECLARE_EVENT_TABLE()
312};
313
f554a14b 314// ---------------------------------------------------------
baa9ebc4 315// wxDataViewRendererBase
f554a14b 316// ---------------------------------------------------------
fa28826d 317
6842a71a 318enum wxDataViewCellMode
fa28826d 319{
6842a71a
RR		 320 wxDATAVIEW_CELL_INERT,
321 wxDATAVIEW_CELL_ACTIVATABLE,
322 wxDATAVIEW_CELL_EDITABLE
fa28826d
RR		 323};
324
6842a71a
RR		 325enum wxDataViewCellRenderState
326{
327 wxDATAVIEW_CELL_SELECTED = 1,
328 wxDATAVIEW_CELL_PRELIT = 2,
329 wxDATAVIEW_CELL_INSENSITIVE = 4,
330 wxDATAVIEW_CELL_FOCUSED = 8
331};
332
baa9ebc4 333class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
6842a71a
RR		 334{
335public:
b5ec7dd6 336 wxDataViewRendererBase( const wxString &varianttype,
9861f022
RR		 337 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
338 int alignment = wxDVR_DEFAULT_ALIGNMENT );
6842a71a 339
9861f022
RR		 340 virtual bool Validate( wxVariant& WXUNUSED(value) )
341 { return true; }
f554a14b 342
6842a71a
RR		 343 void SetOwner( wxDataViewColumn *owner ) { m_owner = owner; }
344 wxDataViewColumn* GetOwner() { return m_owner; }
f554a14b 345
9861f022
RR		 346 // renderer properties:
347
348 virtual bool SetValue( const wxVariant& WXUNUSED(value) ) = 0;
349 virtual bool GetValue( wxVariant& WXUNUSED(value) ) const = 0;
350
351 wxString GetVariantType() const { return m_variantType; }
352
353 virtual void SetMode( wxDataViewCellMode mode ) = 0;
354 virtual wxDataViewCellMode GetMode() const = 0;
355
356 // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but
357 // rather an "int"; that's because for rendering cells it's allowed
358 // to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM)
359 virtual void SetAlignment( int align ) = 0;
360 virtual int GetAlignment() const = 0;
b5ec7dd6 361
1e510b1e
RR		 362 // in-place editing
363 virtual bool HasEditorCtrl()
364 { return false; }
96c2a0dd
VZ		 365 virtual wxControl* CreateEditorCtrl(wxWindow * WXUNUSED(parent),
366 wxRect WXUNUSED(labelRect),
367 const wxVariant& WXUNUSED(value))
1e510b1e 368 { return NULL; }
96c2a0dd
VZ		 369 virtual bool GetValueFromEditorCtrl(wxControl * WXUNUSED(editor),
370 wxVariant& WXUNUSED(value))
1e510b1e
RR		 371 { return false; }
372
e0062c04 373 virtual bool StartEditing( const wxDataViewItem &item, wxRect labelRect );
1e510b1e
RR		 374 virtual void CancelEditing();
375 virtual bool FinishEditing();
b5ec7dd6 376
1e510b1e 377 wxControl *GetEditorCtrl() { return m_editorCtrl; }
b5ec7dd6 378
a7f61f76 379protected:
6842a71a
RR		 380 wxString m_variantType;
381 wxDataViewColumn *m_owner;
1e510b1e 382 wxControl *m_editorCtrl;
e0062c04 383 wxDataViewItem m_item; // for m_editorCtrl
6842a71a 384
9861f022
RR		 385 // internal utility:
386 const wxDataViewCtrl* GetView() const;
387
6842a71a 388protected:
baa9ebc4 389 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
6842a71a
RR		 390};
391
89352653
RR		 392//-----------------------------------------------------------------------------
393// wxDataViewIconText
394//-----------------------------------------------------------------------------
395
d350fbec 396class WXDLLIMPEXP_ADV wxDataViewIconText: public wxObject
89352653
RR		 397{
398public:
399 wxDataViewIconText( const wxString &text = wxEmptyString, const wxIcon& icon = wxNullIcon )
400 { m_icon = icon; m_text = text; }
401 wxDataViewIconText( const wxDataViewIconText &other )
402 { m_icon = other.m_icon; m_text = other.m_text; }
403
404 void SetText( const wxString &text ) { m_text = text; }
405 wxString GetText() const { return m_text; }
406 void SetIcon( const wxIcon &icon ) { m_icon = icon; }
407 const wxIcon &GetIcon() const { return m_icon; }
408
409private:
410 wxString m_text;
411 wxIcon m_icon;
412
413private:
414 DECLARE_DYNAMIC_CLASS(wxDataViewIconText)
415};
416
417bool operator == (const wxDataViewIconText &one, const wxDataViewIconText &two);
418
d350fbec 419DECLARE_VARIANT_OBJECT_EXPORTED(wxDataViewIconText, WXDLLIMPEXP_ADV)
89352653 420
f554a14b 421// ---------------------------------------------------------
6842a71a 422// wxDataViewColumnBase
f554a14b 423// ---------------------------------------------------------
6842a71a 424
fa28826d
RR		 425enum wxDataViewColumnFlags
426{
e483dfcb
RR		 427 wxDATAVIEW_COL_RESIZABLE = 1,
428 wxDATAVIEW_COL_SORTABLE = 2,
429 wxDATAVIEW_COL_REORDERABLE = 4,
430 wxDATAVIEW_COL_HIDDEN = 8
fa28826d
RR		 431};
432
f460c29d 433class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject
fa28826d
RR		 434{
435public:
b5ec7dd6
VZ		 436 wxDataViewColumnBase( const wxString &title, wxDataViewRenderer *renderer,
437 unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
87f0efe2
RR		 438 wxAlignment align = wxALIGN_CENTER,
439 int flags = wxDATAVIEW_COL_RESIZABLE );
b5ec7dd6
VZ		 440 wxDataViewColumnBase( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
441 unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
87f0efe2
RR		 442 wxAlignment align = wxALIGN_CENTER,
443 int flags = wxDATAVIEW_COL_RESIZABLE );
d3c7fc99 444 virtual ~wxDataViewColumnBase();
fa28826d 445
9861f022 446 // setters:
07b6378f 447
9861f022 448 virtual void SetTitle( const wxString &title ) = 0;
47cef10f 449 virtual void SetAlignment( wxAlignment align ) = 0;
31fb32e1 450 virtual void SetSortable( bool sortable ) = 0;
99c75ebc 451 virtual void SetReorderable(bool reorderable) = 0;
9861f022
RR		 452 virtual void SetResizeable( bool resizeable ) = 0;
453 virtual void SetHidden( bool hidden ) = 0;
47cef10f 454 virtual void SetSortOrder( bool ascending ) = 0;
9861f022 455 virtual void SetFlags( int flags );
b5ec7dd6 456 virtual void SetOwner( wxDataViewCtrl *owner )
9861f022
RR		 457 { m_owner = owner; }
458 virtual void SetBitmap( const wxBitmap &bitmap )
459 { m_bitmap=bitmap; }
07a84e7b 460
9861f022
RR		 461 virtual void SetMinWidth( int minWidth ) = 0;
462 virtual void SetWidth( int width ) = 0;
f554a14b 463
f554a14b 464
9861f022 465 // getters:
07b6378f 466
9861f022
RR		 467 virtual wxString GetTitle() const = 0;
468 virtual wxAlignment GetAlignment() const = 0;
87f0efe2 469 virtual int GetWidth() const = 0;
9861f022 470 virtual int GetMinWidth() const = 0;
07b6378f 471
9861f022
RR		 472 virtual int GetFlags() const;
473
9861f022 474 virtual bool IsHidden() const = 0;
99c75ebc
RR		 475 virtual bool IsReorderable() const = 0;
476 virtual bool IsResizeable() const = 0;
477 virtual bool IsSortable() const = 0;
9861f022
RR		 478 virtual bool IsSortOrderAscending() const = 0;
479
480 const wxBitmap &GetBitmap() const { return m_bitmap; }
6d9ecc87 481 unsigned int GetModelColumn() const { return static_cast<unsigned int>(m_model_column); }
9861f022 482
594d5596
RR		 483 wxDataViewCtrl *GetOwner() const { return m_owner; }
484 wxDataViewRenderer* GetRenderer() const { return m_renderer; }
9861f022
RR		 485
486protected:
baa9ebc4 487 wxDataViewRenderer *m_renderer;
6842a71a 488 int m_model_column;
07a84e7b 489 wxBitmap m_bitmap;
6842a71a 490 wxDataViewCtrl *m_owner;
fa28826d
RR		 491
492protected:
493 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
494};
495
f554a14b 496// ---------------------------------------------------------
239eaa41 497// wxDataViewCtrlBase
f554a14b 498// ---------------------------------------------------------
239eaa41 499
c21f7aa1 500#define wxDV_SINGLE 0x0000 // for convenience
9861f022
RR		 501#define wxDV_MULTIPLE 0x0001 // can select multiple items
502
503#define wxDV_NO_HEADER 0x0002 // column titles not visible
504#define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows
505#define wxDV_VERT_RULES 0x0008 // light vertical rules between columns
c21f7aa1 506
1a07a730
RR		 507#define wxDV_ROW_LINES 0x0010 // alternating colour in rows
508
f460c29d 509class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
239eaa41
RR		 510{
511public:
512 wxDataViewCtrlBase();
d3c7fc99 513 virtual ~wxDataViewCtrlBase();
f554a14b 514
e0062c04
RR		 515 virtual bool AssociateModel( wxDataViewModel *model );
516 wxDataViewModel* GetModel();
a75124d0 517 const wxDataViewModel* GetModel() const;
f554a14b 518
07a84e7b 519 // short cuts
b5ec7dd6 520 wxDataViewColumn *PrependTextColumn( const wxString &label, unsigned int model_column,
736fe67c
RR		 521 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
522 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
523 int flags = wxDATAVIEW_COL_RESIZABLE );
b5ec7dd6 524 wxDataViewColumn *PrependIconTextColumn( const wxString &label, unsigned int model_column,
736fe67c
RR		 525 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
526 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
527 int flags = wxDATAVIEW_COL_RESIZABLE );
528 wxDataViewColumn *PrependToggleColumn( const wxString &label, unsigned int model_column,
529 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
530 wxAlignment align = wxALIGN_CENTER,
531 int flags = wxDATAVIEW_COL_RESIZABLE );
b5ec7dd6 532 wxDataViewColumn *PrependProgressColumn( const wxString &label, unsigned int model_column,
736fe67c
RR		 533 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
534 wxAlignment align = wxALIGN_CENTER,
535 int flags = wxDATAVIEW_COL_RESIZABLE );
536 wxDataViewColumn *PrependDateColumn( const wxString &label, unsigned int model_column,
537 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
538 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
539 int flags = wxDATAVIEW_COL_RESIZABLE );
540 wxDataViewColumn *PrependBitmapColumn( const wxString &label, unsigned int model_column,
541 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
542 wxAlignment align = wxALIGN_CENTER,
543 int flags = wxDATAVIEW_COL_RESIZABLE );
544 wxDataViewColumn *PrependTextColumn( const wxBitmap &label, unsigned int model_column,
545 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
546 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
547 int flags = wxDATAVIEW_COL_RESIZABLE );
548 wxDataViewColumn *PrependIconTextColumn( const wxBitmap &label, unsigned int model_column,
549 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
550 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
551 int flags = wxDATAVIEW_COL_RESIZABLE );
552 wxDataViewColumn *PrependToggleColumn( const wxBitmap &label, unsigned int model_column,
553 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
554 wxAlignment align = wxALIGN_CENTER,
555 int flags = wxDATAVIEW_COL_RESIZABLE );
556 wxDataViewColumn *PrependProgressColumn( const wxBitmap &label, unsigned int model_column,
557 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
558 wxAlignment align = wxALIGN_CENTER,
559 int flags = wxDATAVIEW_COL_RESIZABLE );
560 wxDataViewColumn *PrependDateColumn( const wxBitmap &label, unsigned int model_column,
561 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
562 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
563 int flags = wxDATAVIEW_COL_RESIZABLE );
564 wxDataViewColumn *PrependBitmapColumn( const wxBitmap &label, unsigned int model_column,
565 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
566 wxAlignment align = wxALIGN_CENTER,
567 int flags = wxDATAVIEW_COL_RESIZABLE );
b5ec7dd6
VZ		 568
569 wxDataViewColumn *AppendTextColumn( const wxString &label, unsigned int model_column,
87f0efe2 570 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
e2da67f6 571 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
87f0efe2 572 int flags = wxDATAVIEW_COL_RESIZABLE );
b5ec7dd6 573 wxDataViewColumn *AppendIconTextColumn( const wxString &label, unsigned int model_column,
b04fcede 574 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
e2da67f6 575 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
b04fcede 576 int flags = wxDATAVIEW_COL_RESIZABLE );
c7074d44 577 wxDataViewColumn *AppendToggleColumn( const wxString &label, unsigned int model_column,
87f0efe2
RR		 578 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
579 wxAlignment align = wxALIGN_CENTER,
580 int flags = wxDATAVIEW_COL_RESIZABLE );
b5ec7dd6 581 wxDataViewColumn *AppendProgressColumn( const wxString &label, unsigned int model_column,
87f0efe2
RR		 582 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
583 wxAlignment align = wxALIGN_CENTER,
584 int flags = wxDATAVIEW_COL_RESIZABLE );
c7074d44 585 wxDataViewColumn *AppendDateColumn( const wxString &label, unsigned int model_column,
87f0efe2 586 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
e2da67f6 587 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
87f0efe2 588 int flags = wxDATAVIEW_COL_RESIZABLE );
c7074d44 589 wxDataViewColumn *AppendBitmapColumn( const wxString &label, unsigned int model_column,
87f0efe2
RR		 590 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
591 wxAlignment align = wxALIGN_CENTER,
592 int flags = wxDATAVIEW_COL_RESIZABLE );
c7074d44 593 wxDataViewColumn *AppendTextColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2 594 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
e2da67f6 595 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
87f0efe2 596 int flags = wxDATAVIEW_COL_RESIZABLE );
b04fcede
RR		 597 wxDataViewColumn *AppendIconTextColumn( const wxBitmap &label, unsigned int model_column,
598 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
e2da67f6 599 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
b04fcede 600 int flags = wxDATAVIEW_COL_RESIZABLE );
c7074d44 601 wxDataViewColumn *AppendToggleColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2
RR		 602 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
603 wxAlignment align = wxALIGN_CENTER,
604 int flags = wxDATAVIEW_COL_RESIZABLE );
c7074d44 605 wxDataViewColumn *AppendProgressColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2
RR		 606 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
607 wxAlignment align = wxALIGN_CENTER,
608 int flags = wxDATAVIEW_COL_RESIZABLE );
c7074d44 609 wxDataViewColumn *AppendDateColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2 610 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
e2da67f6 611 wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
87f0efe2 612 int flags = wxDATAVIEW_COL_RESIZABLE );
c7074d44 613 wxDataViewColumn *AppendBitmapColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2
RR		 614 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
615 wxAlignment align = wxALIGN_CENTER,
616 int flags = wxDATAVIEW_COL_RESIZABLE );
736fe67c
RR		 617
618
619 virtual bool PrependColumn( wxDataViewColumn *col );
f554a14b 620 virtual bool AppendColumn( wxDataViewColumn *col );
9861f022 621
91a6c655
RR		 622 virtual unsigned int GetColumnCount() const = 0;
623 virtual wxDataViewColumn* GetColumn( unsigned int pos ) const = 0;
453091c2 624 virtual int GetColumnPosition( const wxDataViewColumn *column ) const = 0;
b5ec7dd6 625
91a6c655
RR		 626 virtual bool DeleteColumn( wxDataViewColumn *column ) = 0;
627 virtual bool ClearColumns() = 0;
b5ec7dd6 628
1b27b2bd 629 void SetExpanderColumn( wxDataViewColumn *col )
3b6280be 630 { m_expander_column = col ; DoSetExpanderColumn(); }
b5ec7dd6 631 wxDataViewColumn *GetExpanderColumn() const
3b6280be 632 { return m_expander_column; }
b5ec7dd6 633
21f47fb9 634 virtual wxDataViewColumn *GetSortingColumn() const = 0;
3b6280be
RR		 635
636 void SetIndent( int indent )
637 { m_indent = indent ; DoSetIndent(); }
b5ec7dd6
VZ		 638 int GetIndent() const
639 { return m_indent; }
3b6280be 640
fbda518c 641 virtual wxDataViewItem GetSelection() const = 0;
b7e9f8b1
RR		 642 virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
643 virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
644 virtual void Select( const wxDataViewItem & item ) = 0;
645 virtual void Unselect( const wxDataViewItem & item ) = 0;
646 virtual bool IsSelected( const wxDataViewItem & item ) const = 0;
647
b7e9f8b1
RR		 648 virtual void SelectAll() = 0;
649 virtual void UnselectAll() = 0;
650
f71d3ba4
RR		 651 virtual void Expand( const wxDataViewItem & item ) = 0;
652 virtual void Collapse( const wxDataViewItem & item ) = 0;
653
6154212e 654 virtual void EnsureVisible( const wxDataViewItem & item,
fbda518c 655 const wxDataViewColumn *column = NULL ) = 0;
a87b466d 656 virtual void HitTest( const wxPoint & point, wxDataViewItem &item, wxDataViewColumn* &column ) const = 0;
fbda518c 657 virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const = 0;
b7e9f8b1 658
3b6280be
RR		 659protected:
660 virtual void DoSetExpanderColumn() = 0 ;
661 virtual void DoSetIndent() = 0;
662
239eaa41 663private:
e0062c04 664 wxDataViewModel *m_model;
1b27b2bd 665 wxDataViewColumn *m_expander_column;
3b6280be 666 int m_indent ;
b5ec7dd6 667
239eaa41 668protected:
260b9be7 669 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
239eaa41 670};
bcd846ea 671
eb7f97f8
RR		 672// ----------------------------------------------------------------------------
673// wxDataViewEvent - the event class for the wxDataViewCtrl notifications
674// ----------------------------------------------------------------------------
675
2f799ae8 676class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
eb7f97f8
RR		 677{
678public:
679 wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
680 : wxNotifyEvent(commandType, winid),
e0062c04 681 m_item(0),
eb7f97f8 682 m_col(-1),
eb7f97f8
RR		 683 m_model(NULL),
684 m_value(wxNullVariant),
6af3eec2
RR		 685 m_column(NULL),
686 m_pos(-1,-1)
eb7f97f8
RR		 687 { }
688
689 wxDataViewEvent(const wxDataViewEvent& event)
690 : wxNotifyEvent(event),
e0062c04 691 m_item(event.m_item),
eb7f97f8 692 m_col(event.m_col),
eb7f97f8
RR		 693 m_model(event.m_model),
694 m_value(event.m_value),
6af3eec2
RR		 695 m_column(event.m_column),
696 m_pos(m_pos)
eb7f97f8
RR		 697 { }
698
e0062c04
RR		 699 wxDataViewItem GetItem() const { return m_item; }
700 void SetItem( const wxDataViewItem &item ) { m_item = item; }
701
eb7f97f8
RR		 702 int GetColumn() const { return m_col; }
703 void SetColumn( int col ) { m_col = col; }
9861f022 704
eb7f97f8
RR		 705 wxDataViewModel* GetModel() const { return m_model; }
706 void SetModel( wxDataViewModel *model ) { m_model = model; }
9861f022 707
eb7f97f8
RR		 708 const wxVariant &GetValue() const { return m_value; }
709 void SetValue( const wxVariant &value ) { m_value = value; }
710
31fb32e1
RR		 711 // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
712 void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; }
9861f022 713 wxDataViewColumn *GetDataViewColumn() const { return m_column; }
6af3eec2
RR		 714
715 // for wxEVT_DATAVIEW_CONTEXT_MENU only
716 wxPoint GetPosition() const;
717 void SetPosition( int x, int y ) { m_pos.x = x; m_pos.y = y; }
31fb32e1 718
eb7f97f8
RR		 719 virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
720
721protected:
e0062c04 722 wxDataViewItem m_item;
eb7f97f8 723 int m_col;
eb7f97f8
RR		 724 wxDataViewModel *m_model;
725 wxVariant m_value;
31fb32e1 726 wxDataViewColumn *m_column;
6af3eec2 727 wxPoint m_pos;
eb7f97f8
RR		 728
729private:
730 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent)
731};
732
733BEGIN_DECLARE_EVENT_TYPES()
d86c1870 734 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED, -1)
b5ec7dd6 735
e0062c04 736 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED, -1)
d209a914
RR		 737 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED, -1)
738 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED, -1)
6977c3bf
RR		 739 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING, -1)
740 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, -1)
e0000f94
RR		 741 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED, -1)
742 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE, -1)
6608fdab 743 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED, -1)
6af3eec2
RR		 744
745 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU, -1)
b5ec7dd6 746
e07c1146
PC		 747 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, -1)
748 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK, -1)
c0a66d92 749 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED, -1)
e483dfcb 750 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED, -1)
eb7f97f8
RR		 751END_DECLARE_EVENT_TYPES()
752
753typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
754
755#define wxDataViewEventHandler(func) \
756 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func)
757
758#define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
759 wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
760
d86c1870
RR		 761#define EVT_DATAVIEW_SELECTION_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(SELECTION_CHANGED, id, fn)
762
e0062c04 763#define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
6977c3bf 764#define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
3ecb8a53 765#define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
6977c3bf 766#define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
3ecb8a53 767#define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
e0000f94
RR		 768#define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
769#define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
6608fdab 770#define EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_VALUE_CHANGED, id, fn)
e0000f94 771
6af3eec2
RR		 772#define EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_CONTEXT_MENU, id, fn)
773
31fb32e1
RR		 774#define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
775#define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
c0a66d92 776#define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
e483dfcb 777#define EVT_DATAVIEW_COLUMN_REORDERED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_REORDERED, id, fn)
eb7f97f8 778
4ed7af08
RR		 779#if defined(wxUSE_GENERICDATAVIEWCTRL)
780 #include "wx/generic/dataview.h"
781#elif defined(__WXGTK20__)
bcd846ea
RR		 782 #include "wx/gtk/dataview.h"
783#elif defined(__WXMAC__)
c0a66d92 784 #include "wx/mac/dataview.h"
bcd846ea
RR		 785#else
786 #include "wx/generic/dataview.h"
787#endif
788
52e750fc
RR		 789// -------------------------------------
790// wxDataViewSpinRenderer
791// -------------------------------------
792
4660b556 793class WXDLLIMPEXP_ADV wxDataViewSpinRenderer: public wxDataViewCustomRenderer
52e750fc
RR		 794{
795public:
796 wxDataViewSpinRenderer( int min, int max,
797 wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
798 int alignment = wxDVR_DEFAULT_ALIGNMENT );
799 virtual bool HasEditorCtrl() { return true; }
800 virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
801 virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
802 virtual bool Render( wxRect rect, wxDC *dc, int state );
803 virtual wxSize GetSize() const;
804 virtual bool SetValue( const wxVariant &value );
805 virtual bool GetValue( wxVariant &value ) const;
b5ec7dd6 806
52e750fc
RR		 807private:
808 long m_data;
809 long m_min,m_max;
810};
811
e94d0c1e
RR		 812//-----------------------------------------------------------------------------
813// wxDataViewTreeStore
814//-----------------------------------------------------------------------------
815
816class WXDLLIMPEXP_ADV wxDataViewTreeStoreNode
817{
818public:
819 wxDataViewTreeStoreNode( wxDataViewTreeStoreNode *parent,
820 const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
821 virtual ~wxDataViewTreeStoreNode();
b5ec7dd6
VZ		 822
823 void SetText( const wxString &text )
e94d0c1e
RR		 824 { m_text = text; }
825 wxString GetText() const
826 { return m_text; }
827 void SetIcon( const wxIcon &icon )
828 { m_icon = icon; }
829 const wxIcon &GetIcon() const
830 { return m_icon; }
831 void SetData( wxClientData *data )
832 { if (m_data) delete m_data; m_data = data; }
833 wxClientData *GetData() const
834 { return m_data; }
b5ec7dd6 835
e94d0c1e
RR		 836 wxDataViewItem GetItem() const
837 { return wxDataViewItem( (void*) this ); }
b5ec7dd6 838
e94d0c1e
RR		 839 virtual bool IsContainer()
840 { return false; }
b5ec7dd6 841
e94d0c1e
RR		 842 wxDataViewTreeStoreNode *GetParent()
843 { return m_parent; }
b5ec7dd6 844
e94d0c1e
RR		 845private:
846 wxDataViewTreeStoreNode *m_parent;
847 wxString m_text;
848 wxIcon m_icon;
849 wxClientData *m_data;
850};
851
852WX_DECLARE_LIST_WITH_DECL(wxDataViewTreeStoreNode, wxDataViewTreeStoreNodeList,
853 class WXDLLIMPEXP_ADV);
854
855class WXDLLIMPEXP_ADV wxDataViewTreeStoreContainerNode: public wxDataViewTreeStoreNode
856{
857public:
b5ec7dd6
VZ		 858 wxDataViewTreeStoreContainerNode( wxDataViewTreeStoreNode *parent,
859 const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
e94d0c1e
RR		 860 wxClientData *data = NULL );
861 virtual ~wxDataViewTreeStoreContainerNode();
862
b5ec7dd6 863 const wxDataViewTreeStoreNodeList &GetChildren() const
e94d0c1e 864 { return m_children; }
b5ec7dd6 865 wxDataViewTreeStoreNodeList &GetChildren()
e94d0c1e
RR		 866 { return m_children; }
867
868 void SetExpandedIcon( const wxIcon &icon )
869 { m_iconExpanded = icon; }
870 const wxIcon &GetExpandedIcon() const
871 { return m_iconExpanded; }
b5ec7dd6 872
a75124d0
RR		 873 void SetExpanded( bool expanded = true )
874 { m_isExpanded = expanded; }
875 bool IsExpanded() const
876 { return m_isExpanded; }
877
e94d0c1e
RR		 878 virtual bool IsContainer()
879 { return true; }
b5ec7dd6 880
e94d0c1e
RR		 881private:
882 wxDataViewTreeStoreNodeList m_children;
883 wxIcon m_iconExpanded;
a75124d0 884 bool m_isExpanded;
e94d0c1e
RR		 885};
886
887//-----------------------------------------------------------------------------
888
889class WXDLLIMPEXP_ADV wxDataViewTreeStore: public wxDataViewModel
890{
891public:
892 wxDataViewTreeStore();
893 ~wxDataViewTreeStore();
894
b5ec7dd6 895 wxDataViewItem AppendItem( const wxDataViewItem& parent,
e94d0c1e
RR		 896 const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
897 wxDataViewItem PrependItem( const wxDataViewItem& parent,
898 const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
899 wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
900 const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
b5ec7dd6
VZ		 901
902 wxDataViewItem PrependContainer( const wxDataViewItem& parent,
903 const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
e94d0c1e
RR		 904 wxClientData *data = NULL );
905 wxDataViewItem AppendContainer( const wxDataViewItem& parent,
b5ec7dd6 906 const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
e94d0c1e
RR		 907 wxClientData *data = NULL );
908 wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
b5ec7dd6 909 const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
e94d0c1e
RR		 910 wxClientData *data = NULL );
911
912 wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const;
913 int GetChildCount( const wxDataViewItem& parent ) const;
b5ec7dd6 914
e94d0c1e
RR		 915 void SetItemText( const wxDataViewItem& item, const wxString &text );
916 wxString GetItemText( const wxDataViewItem& item ) const;
b5ec7dd6 917 void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon );
e94d0c1e
RR		 918 const wxIcon &GetItemIcon( const wxDataViewItem& item ) const;
919 void SetItemExpandedIcon( const wxDataViewItem& item, const wxIcon &icon );
920 const wxIcon &GetItemExpandedIcon( const wxDataViewItem& item ) const;
921 void SetItemData( const wxDataViewItem& item, wxClientData *data );
922 wxClientData *GetItemData( const wxDataViewItem& item ) const;
923
924 void DeleteItem( const wxDataViewItem& item );
925 void DeleteChildren( const wxDataViewItem& item );
926 void DeleteAllItems();
b5ec7dd6 927
e94d0c1e
RR		 928 // implement base methods
929
b5ec7dd6 930 virtual void GetValue( wxVariant &variant,
e94d0c1e 931 const wxDataViewItem &item, unsigned int col ) const;
b5ec7dd6 932 virtual bool SetValue( const wxVariant &variant,
e94d0c1e
RR		 933 const wxDataViewItem &item, unsigned int col );
934 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
935 virtual bool IsContainer( const wxDataViewItem &item ) const;
936 virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
937
b5ec7dd6 938 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
e94d0c1e 939 unsigned int column, bool ascending );
b5ec7dd6
VZ		 940
941 virtual bool HasDefaultCompare() const
e94d0c1e 942 { return true; }
b5ec7dd6 943 virtual unsigned int GetColumnCount() const
e94d0c1e 944 { return 1; };
b5ec7dd6 945 virtual wxString GetColumnType( unsigned int WXUNUSED(col) ) const
594d5596 946 { return wxT("wxDataViewIconText"); }
b5ec7dd6 947
e94d0c1e
RR		 948 wxDataViewTreeStoreNode *FindNode( const wxDataViewItem &item ) const;
949 wxDataViewTreeStoreContainerNode *FindContainerNode( const wxDataViewItem &item ) const;
950 wxDataViewTreeStoreNode *GetRoot() const { return m_root; }
b5ec7dd6 951
e94d0c1e
RR		 952public:
953 wxDataViewTreeStoreNode *m_root;
954};
955
e94d0c1e
RR		 956class WXDLLIMPEXP_ADV wxDataViewTreeCtrl: public wxDataViewCtrl
957{
958public:
a75124d0
RR		 959 wxDataViewTreeCtrl();
960 wxDataViewTreeCtrl( wxWindow *parent, wxWindowID id,
e94d0c1e 961 const wxPoint& pos = wxDefaultPosition,
1a07a730 962 const wxSize& size = wxDefaultSize, long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
e94d0c1e 963 const wxValidator& validator = wxDefaultValidator );
a75124d0 964 ~wxDataViewTreeCtrl();
e94d0c1e
RR		 965
966 bool Create( wxWindow *parent, wxWindowID id,
967 const wxPoint& pos = wxDefaultPosition,
1a07a730 968 const wxSize& size = wxDefaultSize, long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
e94d0c1e
RR		 969 const wxValidator& validator = wxDefaultValidator );
970
971 wxDataViewTreeStore *GetStore()
972 { return (wxDataViewTreeStore*) GetModel(); }
a75124d0
RR		 973 const wxDataViewTreeStore *GetStore() const
974 { return (const wxDataViewTreeStore*) GetModel(); }
b5ec7dd6 975
a75124d0
RR		 976 void SetImageList( wxImageList *imagelist );
977 wxImageList* GetImageList() { return m_imageList; }
978
979 wxDataViewItem AppendItem( const wxDataViewItem& parent,
980 const wxString &text, int icon = -1, wxClientData *data = NULL );
981 wxDataViewItem PrependItem( const wxDataViewItem& parent,
982 const wxString &text, int icon = -1, wxClientData *data = NULL );
983 wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
984 const wxString &text, int icon = -1, wxClientData *data = NULL );
985
986 wxDataViewItem PrependContainer( const wxDataViewItem& parent,
987 const wxString &text, int icon = -1, int expanded = -1,
988 wxClientData *data = NULL );
989 wxDataViewItem AppendContainer( const wxDataViewItem& parent,
990 const wxString &text, int icon = -1, int expanded = -1,
991 wxClientData *data = NULL );
992 wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
993 const wxString &text, int icon = -1, int expanded = -1,
994 wxClientData *data = NULL );
995
996 wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const
997 { return GetStore()->GetNthChild(parent, pos); }
998 int GetChildCount( const wxDataViewItem& parent ) const
999 { return GetStore()->GetChildCount(parent); }
1000
1001 void SetItemText( const wxDataViewItem& item, const wxString &text )
1002 { GetStore()->SetItemText(item,text); }
1003 wxString GetItemText( const wxDataViewItem& item ) const
1004 { return GetStore()->GetItemText(item); }
1005 void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon )
1006 { GetStore()->SetItemIcon(item,icon); }
1007 const wxIcon &GetItemIcon( const wxDataViewItem& item ) const
1008 { return GetStore()->GetItemIcon(item); }
1009 void SetItemExpandedIcon( const wxDataViewItem& item, const wxIcon &icon )
1010 { GetStore()->SetItemExpandedIcon(item,icon); }
1011 const wxIcon &GetItemExpandedIcon( const wxDataViewItem& item ) const
1012 { return GetStore()->GetItemExpandedIcon(item); }
1013 void SetItemData( const wxDataViewItem& item, wxClientData *data )
1014 { GetStore()->SetItemData(item,data); }
1015 wxClientData *GetItemData( const wxDataViewItem& item ) const
1016 { return GetStore()->GetItemData(item); }
1017
1018 void DeleteItem( const wxDataViewItem& item )
1019 { GetStore()->DeleteItem(item); }
1020 void DeleteChildren( const wxDataViewItem& item )
1021 { GetStore()->DeleteChildren(item); }
1022 void DeleteAllItems()
1023 { GetStore()->DeleteAllItems(); }
1024
1025 void OnExpanded( wxDataViewEvent &event );
1026 void OnCollapsed( wxDataViewEvent &event );
1a07a730 1027 void OnSize( wxSizeEvent &event );
b5ec7dd6 1028
e94d0c1e 1029private:
a75124d0
RR		 1030 wxImageList *m_imageList;
1031
1032private:
1033 DECLARE_EVENT_TABLE()
e94d0c1e
RR		 1034 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewTreeCtrl)
1035};
e94d0c1e 1036
bcd846ea
RR		 1037#endif // wxUSE_DATAVIEWCTRL
1038
1039#endif
1040 // _WX_DATAVIEW_H_BASE_
wxWidgets (Impactor)