]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/generic/dataview.h
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
use a single wxBookCtrlEvent class for all wxBookCtrlBase-derived controls (#9667)
[wxWidgets.git] / include / wx / generic / dataview.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/generic/dataview.h
3// Purpose: wxDataViewCtrl generic implementation header
4// Author: Robert Roebling
5// Modified By: Bo Yang
6// Id: $Id$
7// Copyright: (c) 1998 Robert Roebling
8// Licence: wxWindows licence
9/////////////////////////////////////////////////////////////////////////////
10
11#ifndef __GENERICDATAVIEWCTRLH__
12#define __GENERICDATAVIEWCTRLH__
13
14#include "wx/defs.h"
15#include "wx/object.h"
16#include "wx/list.h"
17#include "wx/control.h"
18#include "wx/scrolwin.h"
19#include "wx/icon.h"
20
21// ---------------------------------------------------------
22// classes
23// ---------------------------------------------------------
24
25class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
26class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow;
27class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;
28
29// ---------------------------------------------------------
30// wxDataViewRenderer
31// ---------------------------------------------------------
32
33class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
34{
35public:
36 wxDataViewRenderer( const wxString &varianttype,
37 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
38 int align = wxDVR_DEFAULT_ALIGNMENT );
39 virtual ~wxDataViewRenderer();
40
41 virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
42 virtual wxSize GetSize() const = 0;
43
44 virtual void SetAlignment( int align );
45 virtual int GetAlignment() const;
46
47 virtual void SetMode( wxDataViewCellMode mode )
48 { m_mode=mode; }
49 virtual wxDataViewCellMode GetMode() const
50 { return m_mode; }
51
52 virtual bool Activate( wxRect WXUNUSED(cell),
53 wxDataViewModel *WXUNUSED(model),
54 const wxDataViewItem & WXUNUSED(item),
55 unsigned int WXUNUSED(col) )
56 { return false; }
57
58 virtual bool LeftClick( wxPoint WXUNUSED(cursor),
59 wxRect WXUNUSED(cell),
60 wxDataViewModel *WXUNUSED(model),
61 const wxDataViewItem & WXUNUSED(item),
62 unsigned int WXUNUSED(col) )
63 { return false; }
64 virtual bool RightClick( wxPoint WXUNUSED(cursor),
65 wxRect WXUNUSED(cell),
66 wxDataViewModel *WXUNUSED(model),
67 const wxDataViewItem & WXUNUSED(item),
68 unsigned int WXUNUSED(col) )
69 { return false; }
70 virtual bool StartDrag( wxPoint WXUNUSED(cursor),
71 wxRect WXUNUSED(cell),
72 wxDataViewModel *WXUNUSED(model),
73 const wxDataViewItem & WXUNUSED(item),
74 unsigned int WXUNUSED(col) )
75 { return false; }
76
77 // Create DC on request
78 virtual wxDC *GetDC();
79
80 void SetHasAttr( bool set ) { m_hasAttr = set; }
81 void SetAttr( const wxDataViewItemAttr &attr ) { m_attr = attr; }
82 bool GetWantsAttr() { return m_wantsAttr; }
83
84 // implementation
85 int CalculateAlignment() const;
86
87private:
88 wxDC *m_dc;
89 int m_align;
90 wxDataViewCellMode m_mode;
91
92protected:
93 bool m_wantsAttr;
94 bool m_hasAttr;
95 wxDataViewItemAttr m_attr;
96
97protected:
98 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
99};
100
101// ---------------------------------------------------------
102// wxDataViewCustomRenderer
103// ---------------------------------------------------------
104
105class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer
106{
107public:
108 wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"),
109 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
110 int align = wxDVR_DEFAULT_ALIGNMENT );
111
112 void RenderText( const wxString &text, int xoffset, wxRect cell, wxDC *dc, int state );
113
114protected:
115 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
116};
117
118
119// ---------------------------------------------------------
120// wxDataViewTextRenderer
121// ---------------------------------------------------------
122
123class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewCustomRenderer
124{
125public:
126 wxDataViewTextRenderer( const wxString &varianttype = wxT("string"),
127 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
128 int align = wxDVR_DEFAULT_ALIGNMENT );
129
130 bool SetValue( const wxVariant &value );
131 bool GetValue( wxVariant &value ) const;
132
133 bool Render( wxRect cell, wxDC *dc, int state );
134 wxSize GetSize() const;
135
136 // in-place editing
137 virtual bool HasEditorCtrl();
138 virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
139 virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
140
141protected:
142 wxString m_text;
143
144protected:
145 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
146};
147
148// ---------------------------------------------------------
149// wxDataViewTextRendererAttr
150// ---------------------------------------------------------
151
152class WXDLLIMPEXP_ADV wxDataViewTextRendererAttr: public wxDataViewTextRenderer
153{
154public:
155 wxDataViewTextRendererAttr( const wxString &varianttype = wxT("string"),
156 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
157 int align = wxDVR_DEFAULT_ALIGNMENT );
158
159 bool Render( wxRect cell, wxDC *dc, int state );
160
161protected:
162 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRendererAttr)
163};
164
165// ---------------------------------------------------------
166// wxDataViewBitmapRenderer
167// ---------------------------------------------------------
168
169class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer
170{
171public:
172 wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
173 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
174 int align = wxDVR_DEFAULT_ALIGNMENT );
175
176 bool SetValue( const wxVariant &value );
177 bool GetValue( wxVariant &value ) const;
178
179 bool Render( wxRect cell, wxDC *dc, int state );
180 wxSize GetSize() const;
181
182private:
183 wxIcon m_icon;
184 wxBitmap m_bitmap;
185
186protected:
187 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
188};
189
190// ---------------------------------------------------------
191// wxDataViewToggleRenderer
192// ---------------------------------------------------------
193
194class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewCustomRenderer
195{
196public:
197 wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
198 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
199 int align = wxDVR_DEFAULT_ALIGNMENT );
200
201 bool SetValue( const wxVariant &value );
202 bool GetValue( wxVariant &value ) const;
203
204 bool Render( wxRect cell, wxDC *dc, int state );
205 bool Activate( wxRect cell, wxDataViewModel *model, const wxDataViewItem & item,
206 unsigned int col );
207 wxSize GetSize() const;
208
209private:
210 bool m_toggle;
211
212protected:
213 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
214};
215
216// ---------------------------------------------------------
217// wxDataViewProgressRenderer
218// ---------------------------------------------------------
219
220class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer
221{
222public:
223 wxDataViewProgressRenderer( const wxString &label = wxEmptyString,
224 const wxString &varianttype = wxT("long"),
225 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
226 int align = wxDVR_DEFAULT_ALIGNMENT );
227 virtual ~wxDataViewProgressRenderer();
228
229 bool SetValue( const wxVariant &value );
230 bool GetValue( wxVariant& value ) const;
231
232 virtual bool Render( wxRect cell, wxDC *dc, int state );
233 virtual wxSize GetSize() const;
234
235private:
236 wxString m_label;
237 int m_value;
238
239protected:
240 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
241};
242
243// ---------------------------------------------------------
244// wxDataViewIconTextRenderer
245// ---------------------------------------------------------
246
247class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewCustomRenderer
248{
249public:
250 wxDataViewIconTextRenderer( const wxString &varianttype = wxT("wxDataViewIconText"),
251 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
252 int align = wxDVR_DEFAULT_ALIGNMENT );
253 virtual ~wxDataViewIconTextRenderer();
254
255 bool SetValue( const wxVariant &value );
256 bool GetValue( wxVariant &value ) const;
257
258 virtual bool Render( wxRect cell, wxDC *dc, int state );
259 virtual wxSize GetSize() const;
260
261 virtual bool HasEditorCtrl() { return true; }
262 virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
263 virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
264
265private:
266 wxDataViewIconText m_value;
267
268protected:
269 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
270};
271
272// ---------------------------------------------------------
273// wxDataViewDateRenderer
274// ---------------------------------------------------------
275
276class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
277{
278public:
279 wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
280 wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
281 int align = wxDVR_DEFAULT_ALIGNMENT );
282
283 bool SetValue( const wxVariant &value );
284 bool GetValue( wxVariant& value ) const;
285
286 virtual bool Render( wxRect cell, wxDC *dc, int state );
287 virtual wxSize GetSize() const;
288 virtual bool Activate( wxRect cell,
289 wxDataViewModel *model, const wxDataViewItem & item, unsigned int col );
290
291private:
292 wxDateTime m_date;
293
294protected:
295 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)
296};
297
298// ---------------------------------------------------------
299// wxDataViewColumn
300// ---------------------------------------------------------
301
302class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
303{
304 friend class wxDataViewHeaderWindowBase;
305 friend class wxDataViewHeaderWindow;
306 friend class wxDataViewHeaderWindowMSW;
307
308public:
309 wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer,
310 unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
311 wxAlignment align = wxALIGN_CENTER,
312 int flags = wxDATAVIEW_COL_RESIZABLE );
313 wxDataViewColumn( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
314 unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
315 wxAlignment align = wxALIGN_CENTER,
316 int flags = wxDATAVIEW_COL_RESIZABLE );
317 virtual ~wxDataViewColumn();
318
319 // setters:
320
321 virtual void SetTitle( const wxString &title )
322 { m_title=title; }
323 virtual void SetAlignment( wxAlignment align )
324 { m_align=align; }
325 virtual void SetMinWidth( int minWidth )
326 { m_minWidth=minWidth; }
327 virtual void SetWidth( int width );
328 virtual void SetSortable( bool sortable );
329 virtual void SetResizeable( bool resizeable );
330 virtual void SetHidden( bool hidden );
331 virtual void SetSortOrder( bool ascending );
332 virtual void SetReorderable( bool reorderable );
333
334 // getters:
335
336 virtual wxString GetTitle() const
337 { return m_title; }
338 virtual wxAlignment GetAlignment() const
339 { return m_align; }
340 virtual int GetWidth() const
341 { return m_width; }
342 virtual int GetMinWidth() const
343 { return m_minWidth; }
344 virtual bool IsSortable() const
345 { return (m_flags & wxDATAVIEW_COL_SORTABLE) != 0; }
346 virtual bool IsResizeable() const
347 { return (m_flags & wxDATAVIEW_COL_RESIZABLE) != 0; }
348 virtual bool IsHidden() const
349 { return (m_flags & wxDATAVIEW_COL_HIDDEN) != 0; }
350 virtual bool IsSortOrderAscending() const;
351 virtual bool IsReorderable() const
352 { return (m_flags & wxDATAVIEW_COL_REORDERABLE) != 0; }
353
354private:
355 int m_width;
356 int m_minWidth;
357 int m_flags;
358 wxAlignment m_align;
359 wxString m_title;
360 bool m_ascending;
361 bool m_autosize;
362
363 void Init(int width);
364
365 // like SetWidth() but does not ask the header window of the
366 // wxDataViewCtrl to reflect the width-change.
367 void SetInternalWidth(int width);
368
369protected:
370 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
371};
372
373// ---------------------------------------------------------
374// wxDataViewCtrl
375// ---------------------------------------------------------
376
377WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
378 class WXDLLIMPEXP_ADV);
379
380class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase,
381 public wxScrollHelperNative
382{
383 friend class wxDataViewMainWindow;
384 friend class wxDataViewHeaderWindowBase;
385 friend class wxDataViewHeaderWindow;
386 friend class wxDataViewHeaderWindowMSW;
387 friend class wxDataViewColumn;
388
389public:
390 wxDataViewCtrl() : wxScrollHelperNative(this)
391 {
392 //No sorting column at start, I think
393 m_sortingColumn = NULL;
394 Init();
395 }
396
397 wxDataViewCtrl( wxWindow *parent, wxWindowID id,
398 const wxPoint& pos = wxDefaultPosition,
399 const wxSize& size = wxDefaultSize, long style = 0,
400 const wxValidator& validator = wxDefaultValidator )
401 : wxScrollHelperNative(this)
402 {
403 m_sortingColumn = NULL;
404 Create(parent, id, pos, size, style, validator );
405 }
406
407 virtual ~wxDataViewCtrl();
408
409 void Init();
410
411 bool Create(wxWindow *parent, wxWindowID id,
412 const wxPoint& pos = wxDefaultPosition,
413 const wxSize& size = wxDefaultSize, long style = 0,
414 const wxValidator& validator = wxDefaultValidator );
415
416 virtual bool AssociateModel( wxDataViewModel *model );
417
418 virtual bool AppendColumn( wxDataViewColumn *col );
419 virtual bool PrependColumn( wxDataViewColumn *col );
420 virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
421
422 virtual void DoSetExpanderColumn();
423 virtual void DoSetIndent();
424
425 virtual unsigned int GetColumnCount() const;
426 virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
427 virtual bool DeleteColumn( wxDataViewColumn *column );
428 virtual bool ClearColumns();
429 virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
430
431 virtual wxDataViewColumn *GetSortingColumn() const;
432
433 virtual wxDataViewItem GetSelection() const;
434 virtual int GetSelections( wxDataViewItemArray & sel ) const;
435 virtual void SetSelections( const wxDataViewItemArray & sel );
436 virtual void Select( const wxDataViewItem & item );
437 virtual void Unselect( const wxDataViewItem & item );
438 virtual bool IsSelected( const wxDataViewItem & item ) const;
439
440 virtual void SelectAll();
441 virtual void UnselectAll();
442
443 virtual void EnsureVisible( const wxDataViewItem & item,
444 const wxDataViewColumn *column = NULL );
445 virtual void HitTest( const wxPoint & point, wxDataViewItem & item, wxDataViewColumn* &column ) const;
446 virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const;
447
448 virtual void Expand( const wxDataViewItem & item );
449 virtual void Collapse( const wxDataViewItem & item );
450
451protected:
452 virtual int GetSelections( wxArrayInt & sel ) const;
453 virtual void SetSelections( const wxArrayInt & sel );
454 virtual void Select( int row );
455 virtual void Unselect( int row );
456 virtual bool IsSelected( int row ) const;
457 virtual void SelectRange( int from, int to );
458 virtual void UnselectRange( int from, int to );
459
460 virtual void EnsureVisible( int row, int column );
461
462 virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
463 virtual int GetRowByItem( const wxDataViewItem & item ) const;
464
465 wxDataViewColumn* GetSortingColumn() { return m_sortingColumn; }
466 void SetSortingColumn( wxDataViewColumn* column ) { m_sortingColumn = column; }
467
468public: // utility functions not part of the API
469
470 // returns the "best" width for the idx-th column
471 unsigned int GetBestColumnWidth(int WXUNUSED(idx)) const
472 {
473 return GetClientSize().GetWidth() / GetColumnCount();
474 }
475
476 // called by header window after reorder
477 void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos );
478
479 // updates the header window after a change in a column setting
480 void OnColumnChange();
481
482 wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; }
483
484private:
485 wxDataViewColumnList m_cols;
486 wxDataViewModelNotifier *m_notifier;
487 wxDataViewMainWindow *m_clientArea;
488 wxDataViewHeaderWindow *m_headerArea;
489 wxDataViewColumn *m_sortingColumn;
490
491private:
492 void OnSize( wxSizeEvent &event );
493
494 // we need to return a special WM_GETDLGCODE value to process just the
495 // arrows but let the other navigation characters through
496#ifdef __WXMSW__
497 virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
498#endif // __WXMSW__
499
500 WX_FORWARD_TO_SCROLL_HELPER()
501
502private:
503 DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
504 DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
505 DECLARE_EVENT_TABLE()
506};
507
508
509#endif // __GENERICDATAVIEWCTRLH__
wxWidgets (Impactor)