]> git.saurik.com Git - wxWidgets.git/blame - include/wx/dataview.h
use UTF8 build by default on Unix (except Darwin)
[wxWidgets.git] / include / wx / dataview.h
CommitLineData
bcd846ea
RR
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/dataview.h
3// Purpose: wxDataViewCtrl base classes
4// Author: Robert Roebling
5// Modified by:
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"
b9b8b59c 23#include "wx/listctrl.h"
4ed7af08
RR
24
25#if defined(__WXGTK20__)
26 // for testing
1e08ad10 27 // #define wxUSE_GENERICDATAVIEWCTRL 1
4ed7af08 28#elif defined(__WXMAC__)
4ed7af08
RR
29#else
30 #define wxUSE_GENERICDATAVIEWCTRL 1
31#endif
32
bcd846ea 33// ----------------------------------------------------------------------------
f554a14b 34// wxDataViewCtrl flags
bcd846ea
RR
35// ----------------------------------------------------------------------------
36
239eaa41
RR
37// ----------------------------------------------------------------------------
38// wxDataViewCtrl globals
39// ----------------------------------------------------------------------------
bcd846ea 40
b5dbe15d
VS
41class WXDLLIMPEXP_FWD_ADV wxDataViewItem;
42class WXDLLIMPEXP_FWD_ADV wxDataViewModel;
43class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
44class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
45class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer;
46class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier;
e0062c04 47class wxDataViewEventModelNotifier;
fa28826d 48
f460c29d 49extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
bcd846ea 50
87f0efe2
RR
51// the default width of new (text) columns:
52#define wxDVC_DEFAULT_WIDTH 80
53
54// the default width of new toggle columns:
55#define wxDVC_TOGGLE_DEFAULT_WIDTH 30
56
9861f022
RR
57// the default minimal width of the columns:
58#define wxDVC_DEFAULT_MINWIDTH 30
59
60// the default alignment of wxDataViewRenderers:
61#define wxDVR_DEFAULT_ALIGNMENT (wxALIGN_LEFT|wxALIGN_TOP)
62
87f0efe2 63
f554a14b 64// ---------------------------------------------------------
e0062c04 65// wxDataViewItem
f554a14b 66// ---------------------------------------------------------
239eaa41 67
e0062c04 68class WXDLLIMPEXP_ADV wxDataViewItem
239eaa41
RR
69{
70public:
9d52aad3
RR
71 wxDataViewItem( void* id = NULL )
72 { m_id = id; }
e0062c04 73 wxDataViewItem( const wxDataViewItem &item )
9d52aad3
RR
74 { m_id = item.m_id; }
75 bool IsOk() const { return m_id != NULL; }
76 void* GetID() const { return m_id; }
e0062c04 77
8f850e28 78private:
9d52aad3 79 void* m_id;
64ffb888 80};
239eaa41 81
d5025dc0 82bool operator == (const wxDataViewItem &left, const wxDataViewItem &right);
aba9bfd0 83
9d8fe14a
RR
84// ---------------------------------------------------------
85// wxDataViewModelNotifier
86// ---------------------------------------------------------
87
88class WXDLLIMPEXP_ADV wxDataViewModelNotifier
89{
90public:
91 wxDataViewModelNotifier() { }
92 virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
93
94 virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
95 virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
96 virtual bool ItemChanged( const wxDataViewItem &item ) = 0;
97 virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
98 virtual bool Cleared() = 0;
99
d3f00f59 100 virtual void Resort() = 0;
9d8fe14a
RR
101
102 void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
103 wxDataViewModel *GetOwner() { return m_owner; }
104
105private:
106 wxDataViewModel *m_owner;
107};
108
109
f554a14b 110// ---------------------------------------------------------
e0062c04 111// wxDataViewModel
f554a14b 112// ---------------------------------------------------------
239eaa41 113
9d8fe14a
RR
114WX_DECLARE_LIST(wxDataViewModelNotifier, wxDataViewModelNotifiers );
115
e0062c04 116class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData
239eaa41
RR
117{
118public:
e0062c04 119 wxDataViewModel();
239eaa41 120
9861f022 121 virtual unsigned int GetColumnCount() const = 0;
87f0efe2 122
a7f61f76 123 // return type as reported by wxVariant
9861f022 124 virtual wxString GetColumnType( unsigned int col ) const = 0;
87f0efe2 125
a7f61f76 126 // get value into a wxVariant
e0062c04
RR
127 virtual void GetValue( wxVariant &variant,
128 const wxDataViewItem &item, unsigned int col ) const = 0;
87f0efe2 129
a7f61f76 130 // set value, call ValueChanged() afterwards!
e0062c04
RR
131 virtual bool SetValue( const wxVariant &variant,
132 const wxDataViewItem &item, unsigned int col ) = 0;
239eaa41 133
e0062c04 134 // define hierachy
ed903e42
RR
135 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
136 virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
e0062c04
RR
137 virtual wxDataViewItem GetFirstChild( const wxDataViewItem &parent ) const = 0;
138 virtual wxDataViewItem GetNextSibling( const wxDataViewItem &item ) const = 0;
b9b8b59c 139
239eaa41 140 // delegated notifiers
e0062c04 141 virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
469d3e9b 142 virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
e0062c04
RR
143 virtual bool ItemChanged( const wxDataViewItem &item );
144 virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col );
8981608c 145 virtual bool Cleared();
b5d777c7 146
ef427989
RR
147 // delegatd action
148 virtual void Resort();
149
e0062c04
RR
150 void AddNotifier( wxDataViewModelNotifier *notifier );
151 void RemoveNotifier( wxDataViewModelNotifier *notifier );
63415a42 152
ef427989
RR
153 // default compare function
154 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2 );
155
156 void SetSortingColumn( unsigned int col ) { m_sortingColumn = col; }
157 unsigned int GetSortingColumn() { return m_sortingColumn; }
5732efaa 158
87f0efe2
RR
159protected:
160 // the user should not delete this class directly: he should use DecRef() instead!
5debbdcf 161 virtual ~wxDataViewModel() { }
87f0efe2 162
9d8fe14a
RR
163 wxDataViewModelNotifiers m_notifiers;
164 unsigned int m_sortingColumn;
ef427989
RR
165};
166
167// ---------------------------------------------------------
c534e696 168// wxDataViewIndexListModel
ef427989
RR
169// ---------------------------------------------------------
170
c534e696
RR
171// use hash map later
172WX_DEFINE_ARRAY_PTR( void*, wxDataViewItemHash );
173
ef427989
RR
174class wxDataViewIndexListModel: public wxDataViewModel
175{
176public:
c534e696 177 wxDataViewIndexListModel( unsigned int initial_size = 0 );
ef427989
RR
178 ~wxDataViewIndexListModel();
179
180 virtual unsigned int GetRowCount() = 0;
181
182 virtual void GetValue( wxVariant &variant,
183 unsigned int row, unsigned int col ) const = 0;
184
185 virtual bool SetValue( const wxVariant &variant,
186 unsigned int row, unsigned int col ) = 0;
187
c534e696
RR
188 void RowPrepended();
189 void RowInserted( unsigned int before );
190 void RowAppended();
191 void RowDeleted( unsigned int row );
192 void RowChanged( unsigned int row );
193 void RowValueChanged( unsigned int row, unsigned int col );
194
195 // convert to/from row/wxDataViewItem
ef427989 196
c534e696
RR
197 unsigned int GetRow( const wxDataViewItem &item ) const;
198 wxDataViewItem GetItem( unsigned int row ) const;
199
200 // compare based on index
ef427989
RR
201
202 virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2 );
c534e696
RR
203
204 // implement base methods
205
206 virtual void GetValue( wxVariant &variant,
207 const wxDataViewItem &item, unsigned int col ) const;
208 virtual bool SetValue( const wxVariant &variant,
209 const wxDataViewItem &item, unsigned int col );
210 virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
211 virtual bool IsContainer( const wxDataViewItem &item ) const;
212 virtual wxDataViewItem GetFirstChild( const wxDataViewItem &parent ) const;
213 virtual wxDataViewItem GetNextSibling( const wxDataViewItem &item ) const;
ef427989 214
c534e696
RR
215private:
216 wxDataViewItemHash m_hash;
217 unsigned int m_lastIndex;
239eaa41
RR
218};
219
1e510b1e
RR
220//-----------------------------------------------------------------------------
221// wxDataViewEditorCtrlEvtHandler
222//-----------------------------------------------------------------------------
223
224class wxDataViewEditorCtrlEvtHandler: public wxEvtHandler
225{
226public:
227 wxDataViewEditorCtrlEvtHandler( wxControl *editor, wxDataViewRenderer *owner );
228
229 void AcceptChangesAndFinish();
30715fa1 230 void SetFocusOnIdle( bool focus = true ) { m_focusOnIdle = focus; }
1e510b1e
RR
231
232protected:
233 void OnChar( wxKeyEvent &event );
234 void OnKillFocus( wxFocusEvent &event );
30715fa1 235 void OnIdle( wxIdleEvent &event );
1e510b1e
RR
236
237private:
238 wxDataViewRenderer *m_owner;
239 wxControl *m_editorCtrl;
240 bool m_finished;
30715fa1 241 bool m_focusOnIdle;
1e510b1e
RR
242
243private:
244 DECLARE_EVENT_TABLE()
245};
246
f554a14b 247// ---------------------------------------------------------
baa9ebc4 248// wxDataViewRendererBase
f554a14b 249// ---------------------------------------------------------
fa28826d 250
6842a71a 251enum wxDataViewCellMode
fa28826d 252{
6842a71a
RR
253 wxDATAVIEW_CELL_INERT,
254 wxDATAVIEW_CELL_ACTIVATABLE,
255 wxDATAVIEW_CELL_EDITABLE
fa28826d
RR
256};
257
6842a71a
RR
258enum wxDataViewCellRenderState
259{
260 wxDATAVIEW_CELL_SELECTED = 1,
261 wxDATAVIEW_CELL_PRELIT = 2,
262 wxDATAVIEW_CELL_INSENSITIVE = 4,
263 wxDATAVIEW_CELL_FOCUSED = 8
264};
265
baa9ebc4 266class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
6842a71a
RR
267{
268public:
9861f022
RR
269 wxDataViewRendererBase( const wxString &varianttype,
270 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
271 int alignment = wxDVR_DEFAULT_ALIGNMENT );
6842a71a 272
9861f022
RR
273 virtual bool Validate( wxVariant& WXUNUSED(value) )
274 { return true; }
f554a14b 275
6842a71a
RR
276 void SetOwner( wxDataViewColumn *owner ) { m_owner = owner; }
277 wxDataViewColumn* GetOwner() { return m_owner; }
f554a14b 278
9861f022
RR
279 // renderer properties:
280
281 virtual bool SetValue( const wxVariant& WXUNUSED(value) ) = 0;
282 virtual bool GetValue( wxVariant& WXUNUSED(value) ) const = 0;
283
284 wxString GetVariantType() const { return m_variantType; }
285
286 virtual void SetMode( wxDataViewCellMode mode ) = 0;
287 virtual wxDataViewCellMode GetMode() const = 0;
288
289 // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but
290 // rather an "int"; that's because for rendering cells it's allowed
291 // to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM)
292 virtual void SetAlignment( int align ) = 0;
293 virtual int GetAlignment() const = 0;
99d471a5 294
1e510b1e
RR
295 // in-place editing
296 virtual bool HasEditorCtrl()
297 { return false; }
96c2a0dd
VZ
298 virtual wxControl* CreateEditorCtrl(wxWindow * WXUNUSED(parent),
299 wxRect WXUNUSED(labelRect),
300 const wxVariant& WXUNUSED(value))
1e510b1e 301 { return NULL; }
96c2a0dd
VZ
302 virtual bool GetValueFromEditorCtrl(wxControl * WXUNUSED(editor),
303 wxVariant& WXUNUSED(value))
1e510b1e
RR
304 { return false; }
305
e0062c04 306 virtual bool StartEditing( const wxDataViewItem &item, wxRect labelRect );
1e510b1e
RR
307 virtual void CancelEditing();
308 virtual bool FinishEditing();
309
310 wxControl *GetEditorCtrl() { return m_editorCtrl; }
311
a7f61f76 312protected:
6842a71a
RR
313 wxString m_variantType;
314 wxDataViewColumn *m_owner;
1e510b1e 315 wxControl *m_editorCtrl;
e0062c04 316 wxDataViewItem m_item; // for m_editorCtrl
6842a71a 317
9861f022
RR
318 // internal utility:
319 const wxDataViewCtrl* GetView() const;
320
6842a71a 321protected:
baa9ebc4 322 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
6842a71a
RR
323};
324
f554a14b 325// ---------------------------------------------------------
6842a71a 326// wxDataViewColumnBase
f554a14b 327// ---------------------------------------------------------
6842a71a 328
fa28826d
RR
329enum wxDataViewColumnFlags
330{
331 wxDATAVIEW_COL_RESIZABLE = 1,
332 wxDATAVIEW_COL_SORTABLE = 2,
333 wxDATAVIEW_COL_HIDDEN = 4
334};
335
f460c29d 336class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject
fa28826d
RR
337{
338public:
87f0efe2
RR
339 wxDataViewColumnBase( const wxString &title, wxDataViewRenderer *renderer,
340 unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
341 wxAlignment align = wxALIGN_CENTER,
342 int flags = wxDATAVIEW_COL_RESIZABLE );
343 wxDataViewColumnBase( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
344 unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
345 wxAlignment align = wxALIGN_CENTER,
346 int flags = wxDATAVIEW_COL_RESIZABLE );
d3c7fc99 347 virtual ~wxDataViewColumnBase();
fa28826d 348
9861f022 349 // setters:
07b6378f 350
9861f022 351 virtual void SetTitle( const wxString &title ) = 0;
47cef10f 352 virtual void SetAlignment( wxAlignment align ) = 0;
31fb32e1 353 virtual void SetSortable( bool sortable ) = 0;
9861f022
RR
354 virtual void SetResizeable( bool resizeable ) = 0;
355 virtual void SetHidden( bool hidden ) = 0;
47cef10f 356 virtual void SetSortOrder( bool ascending ) = 0;
9861f022
RR
357 virtual void SetFlags( int flags );
358 virtual void SetOwner( wxDataViewCtrl *owner )
359 { m_owner = owner; }
360 virtual void SetBitmap( const wxBitmap &bitmap )
361 { m_bitmap=bitmap; }
07a84e7b 362
9861f022
RR
363 virtual void SetMinWidth( int minWidth ) = 0;
364 virtual void SetWidth( int width ) = 0;
f554a14b 365
f554a14b 366
9861f022 367 // getters:
07b6378f 368
9861f022
RR
369 virtual wxString GetTitle() const = 0;
370 virtual wxAlignment GetAlignment() const = 0;
87f0efe2 371 virtual int GetWidth() const = 0;
9861f022 372 virtual int GetMinWidth() const = 0;
07b6378f 373
9861f022
RR
374 virtual int GetFlags() const;
375
376 virtual bool IsSortable() const = 0;
377 virtual bool IsResizeable() const = 0;
378 virtual bool IsHidden() const = 0;
379 virtual bool IsSortOrderAscending() const = 0;
380
381 const wxBitmap &GetBitmap() const { return m_bitmap; }
382 unsigned int GetModelColumn() const { return m_model_column; }
383
384 wxDataViewCtrl *GetOwner() { return m_owner; }
385 wxDataViewRenderer* GetRenderer() { return m_renderer; }
386
387protected:
baa9ebc4 388 wxDataViewRenderer *m_renderer;
6842a71a 389 int m_model_column;
07a84e7b 390 wxBitmap m_bitmap;
6842a71a 391 wxDataViewCtrl *m_owner;
fa28826d
RR
392
393protected:
394 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
395};
396
f554a14b 397// ---------------------------------------------------------
239eaa41 398// wxDataViewCtrlBase
f554a14b 399// ---------------------------------------------------------
239eaa41 400
c21f7aa1 401#define wxDV_SINGLE 0x0000 // for convenience
9861f022
RR
402#define wxDV_MULTIPLE 0x0001 // can select multiple items
403
404#define wxDV_NO_HEADER 0x0002 // column titles not visible
405#define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows
406#define wxDV_VERT_RULES 0x0008 // light vertical rules between columns
c21f7aa1 407
f460c29d 408class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
239eaa41
RR
409{
410public:
411 wxDataViewCtrlBase();
d3c7fc99 412 virtual ~wxDataViewCtrlBase();
f554a14b 413
e0062c04
RR
414 virtual bool AssociateModel( wxDataViewModel *model );
415 wxDataViewModel* GetModel();
f554a14b 416
07a84e7b 417 // short cuts
1286b7ba 418 bool AppendTextColumn( const wxString &label, unsigned int model_column,
87f0efe2
RR
419 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
420 wxAlignment align = wxALIGN_CENTER,
421 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 422 bool AppendToggleColumn( const wxString &label, unsigned int model_column,
87f0efe2
RR
423 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
424 wxAlignment align = wxALIGN_CENTER,
425 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 426 bool AppendProgressColumn( const wxString &label, unsigned int model_column,
87f0efe2
RR
427 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
428 wxAlignment align = wxALIGN_CENTER,
429 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 430 bool AppendDateColumn( const wxString &label, unsigned int model_column,
87f0efe2
RR
431 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
432 wxAlignment align = wxALIGN_CENTER,
433 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 434 bool AppendBitmapColumn( const wxString &label, unsigned int model_column,
87f0efe2
RR
435 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
436 wxAlignment align = wxALIGN_CENTER,
437 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 438 bool AppendTextColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2
RR
439 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
440 wxAlignment align = wxALIGN_CENTER,
441 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 442 bool AppendToggleColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2
RR
443 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
444 wxAlignment align = wxALIGN_CENTER,
445 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 446 bool AppendProgressColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2
RR
447 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
448 wxAlignment align = wxALIGN_CENTER,
449 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 450 bool AppendDateColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2
RR
451 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
452 wxAlignment align = wxALIGN_CENTER,
453 int flags = wxDATAVIEW_COL_RESIZABLE );
1286b7ba 454 bool AppendBitmapColumn( const wxBitmap &label, unsigned int model_column,
87f0efe2
RR
455 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
456 wxAlignment align = wxALIGN_CENTER,
457 int flags = wxDATAVIEW_COL_RESIZABLE );
07a84e7b 458
f554a14b 459 virtual bool AppendColumn( wxDataViewColumn *col );
9861f022
RR
460
461 virtual unsigned int GetColumnCount() const;
462
0a71f9e9 463 virtual bool DeleteColumn( unsigned int pos );
fa28826d 464 virtual bool ClearColumns();
0a71f9e9 465 virtual wxDataViewColumn* GetColumn( unsigned int pos );
f554a14b 466
3b6280be
RR
467 void SetExpanderColumn( unsigned int col )
468 { m_expander_column = col ; DoSetExpanderColumn(); }
469 unsigned int GetExpanderColumn() const
470 { return m_expander_column; }
471
472 void SetIndent( int indent )
473 { m_indent = indent ; DoSetIndent(); }
474 int GetIndent() const
475 { return m_indent; }
476
e0062c04 477 // TODO selection code
1e08ad10 478 virtual wxDataViewItem GetSelection() = 0;
6ff7eee7 479
3b6280be
RR
480protected:
481 virtual void DoSetExpanderColumn() = 0 ;
482 virtual void DoSetIndent() = 0;
483
239eaa41 484private:
e0062c04 485 wxDataViewModel *m_model;
fa28826d 486 wxList m_cols;
e0062c04 487 wxDataViewEventModelNotifier *m_eventNotifier;
3b6280be
RR
488 unsigned int m_expander_column;
489 int m_indent ;
490
239eaa41 491protected:
260b9be7 492 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
239eaa41 493};
bcd846ea 494
eb7f97f8
RR
495// ----------------------------------------------------------------------------
496// wxDataViewEvent - the event class for the wxDataViewCtrl notifications
497// ----------------------------------------------------------------------------
498
2f799ae8 499class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
eb7f97f8
RR
500{
501public:
502 wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
503 : wxNotifyEvent(commandType, winid),
e0062c04 504 m_item(0),
eb7f97f8 505 m_col(-1),
eb7f97f8
RR
506 m_model(NULL),
507 m_value(wxNullVariant),
31fb32e1 508 m_column(NULL)
eb7f97f8
RR
509 { }
510
511 wxDataViewEvent(const wxDataViewEvent& event)
512 : wxNotifyEvent(event),
e0062c04 513 m_item(event.m_item),
eb7f97f8 514 m_col(event.m_col),
eb7f97f8
RR
515 m_model(event.m_model),
516 m_value(event.m_value),
31fb32e1 517 m_column(event.m_column)
eb7f97f8
RR
518 { }
519
e0062c04
RR
520 wxDataViewItem GetItem() const { return m_item; }
521 void SetItem( const wxDataViewItem &item ) { m_item = item; }
522
eb7f97f8
RR
523 int GetColumn() const { return m_col; }
524 void SetColumn( int col ) { m_col = col; }
9861f022 525
eb7f97f8
RR
526 wxDataViewModel* GetModel() const { return m_model; }
527 void SetModel( wxDataViewModel *model ) { m_model = model; }
9861f022 528
eb7f97f8
RR
529 const wxVariant &GetValue() const { return m_value; }
530 void SetValue( const wxVariant &value ) { m_value = value; }
531
31fb32e1
RR
532 // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
533 void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; }
9861f022 534 wxDataViewColumn *GetDataViewColumn() const { return m_column; }
31fb32e1 535
eb7f97f8
RR
536 virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
537
538protected:
e0062c04 539 wxDataViewItem m_item;
eb7f97f8 540 int m_col;
eb7f97f8
RR
541 wxDataViewModel *m_model;
542 wxVariant m_value;
31fb32e1 543 wxDataViewColumn *m_column;
eb7f97f8
RR
544
545private:
546 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent)
547};
548
549BEGIN_DECLARE_EVENT_TYPES()
e0062c04
RR
550 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_SELECTED, -1)
551 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED, -1)
e07c1146
PC
552 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, -1)
553 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK, -1)
c0a66d92 554 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED, -1)
1821abd1 555 // notifications from the model to the control
e0062c04
RR
556 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_ADDED, -1)
557 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_DELETED, -1)
558 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_CHANGED, -1)
1821abd1 559 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_VALUE_CHANGED, -1)
1821abd1 560 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_CLEARED, -1)
eb7f97f8
RR
561END_DECLARE_EVENT_TYPES()
562
563typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
564
565#define wxDataViewEventHandler(func) \
566 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func)
567
568#define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
569 wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
570
e0062c04
RR
571#define EVT_DATAVIEW_ITEM_SELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_SELECTED, id, fn)
572#define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
31fb32e1
RR
573#define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
574#define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
c0a66d92 575#define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
eb7f97f8 576
d8331a01 577#define EVT_DATAVIEW_MODEL_ITEM_ADDED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_ADDED, id, fn)
e0062c04
RR
578#define EVT_DATAVIEW_MODEL_ITEM_DELETED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_DELETED, id, fn)
579#define EVT_DATAVIEW_MODEL_ITEM_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_CHANGED, id, fn)
1821abd1 580#define EVT_DATAVIEW_MODEL_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_VALUE_CHANGED, id, fn)
1821abd1
RR
581#define EVT_DATAVIEW_MODEL_CLEARED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_CLEARED, id, fn)
582
eb7f97f8 583
4ed7af08
RR
584#if defined(wxUSE_GENERICDATAVIEWCTRL)
585 #include "wx/generic/dataview.h"
586#elif defined(__WXGTK20__)
bcd846ea
RR
587 #include "wx/gtk/dataview.h"
588#elif defined(__WXMAC__)
c0a66d92 589 #include "wx/mac/dataview.h"
bcd846ea
RR
590#else
591 #include "wx/generic/dataview.h"
592#endif
593
594#endif // wxUSE_DATAVIEWCTRL
595
596#endif
597 // _WX_DATAVIEW_H_BASE_