1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxDataViewCtrl base classes
4 // Author: Robert Roebling
8 // Copyright: (c) Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_DATAVIEW_H_BASE_
13 #define _WX_DATAVIEW_H_BASE_
17 #if wxUSE_DATAVIEWCTRL
19 #include "wx/control.h"
20 #include "wx/textctrl.h"
21 #include "wx/bitmap.h"
22 #include "wx/variant.h"
23 #include "wx/listctrl.h"
25 #if defined(__WXGTK20__)
27 // #define wxUSE_GENERICDATAVIEWCTRL 1
28 #elif defined(__WXMAC__)
30 #define wxUSE_GENERICDATAVIEWCTRL 1
33 // ----------------------------------------------------------------------------
34 // wxDataViewCtrl flags
35 // ----------------------------------------------------------------------------
37 // ----------------------------------------------------------------------------
38 // wxDataViewCtrl globals
39 // ----------------------------------------------------------------------------
41 class WXDLLIMPEXP_FWD_ADV wxDataViewItem
;
42 class WXDLLIMPEXP_FWD_ADV wxDataViewModel
;
43 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl
;
44 class WXDLLIMPEXP_FWD_ADV wxDataViewColumn
;
45 class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer
;
46 class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier
;
47 class wxDataViewEventModelNotifier
;
49 extern WXDLLIMPEXP_DATA_ADV(const wxChar
) wxDataViewCtrlNameStr
[];
51 // the default width of new (text) columns:
52 #define wxDVC_DEFAULT_WIDTH 80
54 // the default width of new toggle columns:
55 #define wxDVC_TOGGLE_DEFAULT_WIDTH 30
57 // the default minimal width of the columns:
58 #define wxDVC_DEFAULT_MINWIDTH 30
60 // the default alignment of wxDataViewRenderers:
61 #define wxDVR_DEFAULT_ALIGNMENT (wxALIGN_LEFT|wxALIGN_TOP)
64 // ---------------------------------------------------------
66 // ---------------------------------------------------------
68 class WXDLLIMPEXP_ADV wxDataViewItem
71 wxDataViewItem( wxUint32 id
= 0 )
72 { m_id
= id
; m_reserved1
= 0; m_reserved2
= NULL
; }
73 wxDataViewItem( const wxDataViewItem
&item
)
74 { m_id
= item
.m_id
; m_reserved1
= item
.m_reserved1
; m_reserved2
= item
.m_reserved2
; }
75 bool IsOk() const { return m_id
!= 0; }
76 wxUint32
GetID() const { return m_id
; }
86 bool operator == ( const wxDataViewItem
& left
, const wxDataViewItem
& right
);
88 // ---------------------------------------------------------
90 // ---------------------------------------------------------
92 class WXDLLIMPEXP_ADV wxDataViewModel
: public wxObjectRefData
97 virtual unsigned int GetColumnCount() const = 0;
99 // return type as reported by wxVariant
100 virtual wxString
GetColumnType( unsigned int col
) const = 0;
102 // get value into a wxVariant
103 virtual void GetValue( wxVariant
&variant
,
104 const wxDataViewItem
&item
, unsigned int col
) const = 0;
106 // set value, call ValueChanged() afterwards!
107 virtual bool SetValue( const wxVariant
&variant
,
108 const wxDataViewItem
&item
, unsigned int col
) = 0;
111 virtual bool HasChildren( const wxDataViewItem
&item
) const = 0;
112 virtual int GetChildCount( const wxDataViewItem
&item
) const = 0;
113 virtual wxDataViewItem
GetParent( const wxDataViewItem
&child
) const = 0;
114 virtual wxDataViewItem
GetFirstChild( const wxDataViewItem
&parent
) const = 0;
115 virtual wxDataViewItem
GetNextSibling( const wxDataViewItem
&item
) const = 0;
116 virtual wxDataViewItem
GetNthChild( const wxDataViewItem
&parent
, unsigned int n
) const = 0;
118 // delegated notifiers
119 virtual bool ItemAdded( const wxDataViewItem
&parent
, const wxDataViewItem
&item
);
120 virtual bool ItemDeleted( const wxDataViewItem
&item
);
121 virtual bool ItemChanged( const wxDataViewItem
&item
);
122 virtual bool ValueChanged( const wxDataViewItem
&item
, unsigned int col
);
123 virtual bool Cleared();
125 void AddNotifier( wxDataViewModelNotifier
*notifier
);
126 void RemoveNotifier( wxDataViewModelNotifier
*notifier
);
129 // the user should not delete this class directly: he should use DecRef() instead!
130 virtual ~wxDataViewModel() { }
135 // ---------------------------------------------------------
136 // wxDataViewModelNotifier
137 // ---------------------------------------------------------
139 class WXDLLIMPEXP_ADV wxDataViewModelNotifier
: public wxObject
142 wxDataViewModelNotifier() { }
143 virtual ~wxDataViewModelNotifier() { m_owner
= NULL
; }
145 virtual bool ItemAdded( const wxDataViewItem
&parent
, const wxDataViewItem
&item
) = 0;
146 virtual bool ItemDeleted( const wxDataViewItem
&item
) = 0;
147 virtual bool ItemChanged( const wxDataViewItem
&item
) = 0;
148 virtual bool ValueChanged( const wxDataViewItem
&item
, unsigned int col
) = 0;
149 virtual bool Cleared() = 0;
151 void SetOwner( wxDataViewModel
*owner
) { m_owner
= owner
; }
152 wxDataViewModel
*GetOwner() { return m_owner
; }
155 wxDataViewModel
*m_owner
;
159 //-----------------------------------------------------------------------------
160 // wxDataViewEditorCtrlEvtHandler
161 //-----------------------------------------------------------------------------
163 class wxDataViewEditorCtrlEvtHandler
: public wxEvtHandler
166 wxDataViewEditorCtrlEvtHandler( wxControl
*editor
, wxDataViewRenderer
*owner
);
168 void AcceptChangesAndFinish();
169 void SetFocusOnIdle( bool focus
= true ) { m_focusOnIdle
= focus
; }
172 void OnChar( wxKeyEvent
&event
);
173 void OnKillFocus( wxFocusEvent
&event
);
174 void OnIdle( wxIdleEvent
&event
);
177 wxDataViewRenderer
*m_owner
;
178 wxControl
*m_editorCtrl
;
183 DECLARE_EVENT_TABLE()
186 // ---------------------------------------------------------
187 // wxDataViewRendererBase
188 // ---------------------------------------------------------
190 enum wxDataViewCellMode
192 wxDATAVIEW_CELL_INERT
,
193 wxDATAVIEW_CELL_ACTIVATABLE
,
194 wxDATAVIEW_CELL_EDITABLE
197 enum wxDataViewCellRenderState
199 wxDATAVIEW_CELL_SELECTED
= 1,
200 wxDATAVIEW_CELL_PRELIT
= 2,
201 wxDATAVIEW_CELL_INSENSITIVE
= 4,
202 wxDATAVIEW_CELL_FOCUSED
= 8
205 class WXDLLIMPEXP_ADV wxDataViewRendererBase
: public wxObject
208 wxDataViewRendererBase( const wxString
&varianttype
,
209 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
210 int alignment
= wxDVR_DEFAULT_ALIGNMENT
);
212 virtual bool Validate( wxVariant
& WXUNUSED(value
) )
215 void SetOwner( wxDataViewColumn
*owner
) { m_owner
= owner
; }
216 wxDataViewColumn
* GetOwner() { return m_owner
; }
218 // renderer properties:
220 virtual bool SetValue( const wxVariant
& WXUNUSED(value
) ) = 0;
221 virtual bool GetValue( wxVariant
& WXUNUSED(value
) ) const = 0;
223 wxString
GetVariantType() const { return m_variantType
; }
225 virtual void SetMode( wxDataViewCellMode mode
) = 0;
226 virtual wxDataViewCellMode
GetMode() const = 0;
228 // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but
229 // rather an "int"; that's because for rendering cells it's allowed
230 // to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM)
231 virtual void SetAlignment( int align
) = 0;
232 virtual int GetAlignment() const = 0;
235 virtual bool HasEditorCtrl()
237 virtual wxControl
* CreateEditorCtrl(wxWindow
* WXUNUSED(parent
),
238 wxRect
WXUNUSED(labelRect
),
239 const wxVariant
& WXUNUSED(value
))
241 virtual bool GetValueFromEditorCtrl(wxControl
* WXUNUSED(editor
),
242 wxVariant
& WXUNUSED(value
))
245 virtual bool StartEditing( const wxDataViewItem
&item
, wxRect labelRect
);
246 virtual void CancelEditing();
247 virtual bool FinishEditing();
249 wxControl
*GetEditorCtrl() { return m_editorCtrl
; }
252 wxString m_variantType
;
253 wxDataViewColumn
*m_owner
;
254 wxControl
*m_editorCtrl
;
255 wxDataViewItem m_item
; // for m_editorCtrl
258 const wxDataViewCtrl
* GetView() const;
261 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase
)
264 // ---------------------------------------------------------
265 // wxDataViewColumnBase
266 // ---------------------------------------------------------
268 enum wxDataViewColumnFlags
270 wxDATAVIEW_COL_RESIZABLE
= 1,
271 wxDATAVIEW_COL_SORTABLE
= 2,
272 wxDATAVIEW_COL_HIDDEN
= 4
275 class WXDLLIMPEXP_ADV wxDataViewColumnBase
: public wxObject
278 wxDataViewColumnBase( const wxString
&title
, wxDataViewRenderer
*renderer
,
279 unsigned int model_column
, int width
= wxDVC_DEFAULT_WIDTH
,
280 wxAlignment align
= wxALIGN_CENTER
,
281 int flags
= wxDATAVIEW_COL_RESIZABLE
);
282 wxDataViewColumnBase( const wxBitmap
&bitmap
, wxDataViewRenderer
*renderer
,
283 unsigned int model_column
, int width
= wxDVC_DEFAULT_WIDTH
,
284 wxAlignment align
= wxALIGN_CENTER
,
285 int flags
= wxDATAVIEW_COL_RESIZABLE
);
286 virtual ~wxDataViewColumnBase();
290 virtual void SetTitle( const wxString
&title
) = 0;
291 virtual void SetAlignment( wxAlignment align
) = 0;
292 virtual void SetSortable( bool sortable
) = 0;
293 virtual void SetResizeable( bool resizeable
) = 0;
294 virtual void SetHidden( bool hidden
) = 0;
295 virtual void SetSortOrder( bool ascending
) = 0;
296 virtual void SetFlags( int flags
);
297 virtual void SetOwner( wxDataViewCtrl
*owner
)
299 virtual void SetBitmap( const wxBitmap
&bitmap
)
302 virtual void SetMinWidth( int minWidth
) = 0;
303 virtual void SetWidth( int width
) = 0;
308 virtual wxString
GetTitle() const = 0;
309 virtual wxAlignment
GetAlignment() const = 0;
310 virtual int GetWidth() const = 0;
311 virtual int GetMinWidth() const = 0;
313 virtual int GetFlags() const;
315 virtual bool IsSortable() const = 0;
316 virtual bool IsResizeable() const = 0;
317 virtual bool IsHidden() const = 0;
318 virtual bool IsSortOrderAscending() const = 0;
320 const wxBitmap
&GetBitmap() const { return m_bitmap
; }
321 unsigned int GetModelColumn() const { return m_model_column
; }
323 wxDataViewCtrl
*GetOwner() { return m_owner
; }
324 wxDataViewRenderer
* GetRenderer() { return m_renderer
; }
327 wxDataViewRenderer
*m_renderer
;
330 wxDataViewCtrl
*m_owner
;
333 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase
)
336 // ---------------------------------------------------------
337 // wxDataViewCtrlBase
338 // ---------------------------------------------------------
340 #define wxDV_SINGLE 0x0000 // for convenience
341 #define wxDV_MULTIPLE 0x0001 // can select multiple items
343 #define wxDV_NO_HEADER 0x0002 // column titles not visible
344 #define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows
345 #define wxDV_VERT_RULES 0x0008 // light vertical rules between columns
347 class WXDLLIMPEXP_ADV wxDataViewCtrlBase
: public wxControl
350 wxDataViewCtrlBase();
351 virtual ~wxDataViewCtrlBase();
353 virtual bool AssociateModel( wxDataViewModel
*model
);
354 wxDataViewModel
* GetModel();
357 bool AppendTextColumn( const wxString
&label
, unsigned int model_column
,
358 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
359 wxAlignment align
= wxALIGN_CENTER
,
360 int flags
= wxDATAVIEW_COL_RESIZABLE
);
361 bool AppendToggleColumn( const wxString
&label
, unsigned int model_column
,
362 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
363 wxAlignment align
= wxALIGN_CENTER
,
364 int flags
= wxDATAVIEW_COL_RESIZABLE
);
365 bool AppendProgressColumn( const wxString
&label
, unsigned int model_column
,
366 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
367 wxAlignment align
= wxALIGN_CENTER
,
368 int flags
= wxDATAVIEW_COL_RESIZABLE
);
369 bool AppendDateColumn( const wxString
&label
, unsigned int model_column
,
370 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
371 wxAlignment align
= wxALIGN_CENTER
,
372 int flags
= wxDATAVIEW_COL_RESIZABLE
);
373 bool AppendBitmapColumn( const wxString
&label
, unsigned int model_column
,
374 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
375 wxAlignment align
= wxALIGN_CENTER
,
376 int flags
= wxDATAVIEW_COL_RESIZABLE
);
377 bool AppendTextColumn( const wxBitmap
&label
, unsigned int model_column
,
378 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
379 wxAlignment align
= wxALIGN_CENTER
,
380 int flags
= wxDATAVIEW_COL_RESIZABLE
);
381 bool AppendToggleColumn( const wxBitmap
&label
, unsigned int model_column
,
382 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_TOGGLE_DEFAULT_WIDTH
,
383 wxAlignment align
= wxALIGN_CENTER
,
384 int flags
= wxDATAVIEW_COL_RESIZABLE
);
385 bool AppendProgressColumn( const wxBitmap
&label
, unsigned int model_column
,
386 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= wxDVC_DEFAULT_WIDTH
,
387 wxAlignment align
= wxALIGN_CENTER
,
388 int flags
= wxDATAVIEW_COL_RESIZABLE
);
389 bool AppendDateColumn( const wxBitmap
&label
, unsigned int model_column
,
390 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
, int width
= -1,
391 wxAlignment align
= wxALIGN_CENTER
,
392 int flags
= wxDATAVIEW_COL_RESIZABLE
);
393 bool AppendBitmapColumn( const wxBitmap
&label
, unsigned int model_column
,
394 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int width
= -1,
395 wxAlignment align
= wxALIGN_CENTER
,
396 int flags
= wxDATAVIEW_COL_RESIZABLE
);
398 virtual bool AppendColumn( wxDataViewColumn
*col
);
400 virtual unsigned int GetColumnCount() const;
402 virtual bool DeleteColumn( unsigned int pos
);
403 virtual bool ClearColumns();
404 virtual wxDataViewColumn
* GetColumn( unsigned int pos
);
406 // TODO selection code
409 wxDataViewModel
*m_model
;
411 wxDataViewEventModelNotifier
*m_eventNotifier
;
414 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase
)
417 // ----------------------------------------------------------------------------
418 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
419 // ----------------------------------------------------------------------------
421 class WXDLLIMPEXP_ADV wxDataViewEvent
: public wxNotifyEvent
424 wxDataViewEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
425 : wxNotifyEvent(commandType
, winid
),
429 m_value(wxNullVariant
),
433 wxDataViewEvent(const wxDataViewEvent
& event
)
434 : wxNotifyEvent(event
),
435 m_item(event
.m_item
),
437 m_model(event
.m_model
),
438 m_value(event
.m_value
),
439 m_column(event
.m_column
)
442 wxDataViewItem
GetItem() const { return m_item
; }
443 void SetItem( const wxDataViewItem
&item
) { m_item
= item
; }
445 int GetColumn() const { return m_col
; }
446 void SetColumn( int col
) { m_col
= col
; }
448 wxDataViewModel
* GetModel() const { return m_model
; }
449 void SetModel( wxDataViewModel
*model
) { m_model
= model
; }
451 const wxVariant
&GetValue() const { return m_value
; }
452 void SetValue( const wxVariant
&value
) { m_value
= value
; }
454 // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
455 void SetDataViewColumn( wxDataViewColumn
*col
) { m_column
= col
; }
456 wxDataViewColumn
*GetDataViewColumn() const { return m_column
; }
458 virtual wxEvent
*Clone() const { return new wxDataViewEvent(*this); }
461 wxDataViewItem m_item
;
463 wxDataViewModel
*m_model
;
465 wxDataViewColumn
*m_column
;
468 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent
)
471 BEGIN_DECLARE_EVENT_TYPES()
472 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_SELECTED
, -1)
473 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED
, -1)
474 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK
, -1)
475 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK
, -1)
476 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED
, -1)
477 // notifications from the model to the control
478 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_ADDED
, -1)
479 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_DELETED
, -1)
480 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_CHANGED
, -1)
481 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_MODEL_VALUE_CHANGED
, -1)
482 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV
, wxEVT_COMMAND_DATAVIEW_MODEL_CLEARED
, -1)
483 END_DECLARE_EVENT_TYPES()
485 typedef void (wxEvtHandler::*wxDataViewEventFunction
)(wxDataViewEvent
&);
487 #define wxDataViewEventHandler(func) \
488 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func)
490 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
491 wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
493 #define EVT_DATAVIEW_ITEM_SELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_SELECTED, id, fn)
494 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
495 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
496 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
497 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
499 #define EVT_DATAVIEW_MODEL_ITEM_ADDED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_APPENDED, id, fn)
500 #define EVT_DATAVIEW_MODEL_ITEM_DELETED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_DELETED, id, fn)
501 #define EVT_DATAVIEW_MODEL_ITEM_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_CHANGED, id, fn)
502 #define EVT_DATAVIEW_MODEL_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_VALUE_CHANGED, id, fn)
503 #define EVT_DATAVIEW_MODEL_CLEARED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_CLEARED, id, fn)
506 #if defined(wxUSE_GENERICDATAVIEWCTRL)
507 #include "wx/generic/dataview.h"
508 #elif defined(__WXGTK20__)
509 #include "wx/gtk/dataview.h"
510 #elif defined(__WXMAC__)
511 #include "wx/mac/dataview.h"
513 #include "wx/generic/dataview.h"
516 #endif // wxUSE_DATAVIEWCTRL
519 // _WX_DATAVIEW_H_BASE_