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