]>
Commit | Line | Data |
---|---|---|
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" |
239eaa41 | 23 | |
4ed7af08 RR |
24 | |
25 | #if defined(__WXGTK20__) | |
26 | // for testing | |
0f0297d8 | 27 | #define wxUSE_GENERICDATAVIEWCTRL 1 |
4ed7af08 RR |
28 | #elif defined(__WXMAC__) |
29 | #define wxUSE_GENERICDATAVIEWCTRL 1 | |
30 | #else | |
31 | #define wxUSE_GENERICDATAVIEWCTRL 1 | |
32 | #endif | |
33 | ||
bcd846ea | 34 | // ---------------------------------------------------------------------------- |
f554a14b | 35 | // wxDataViewCtrl flags |
bcd846ea RR |
36 | // ---------------------------------------------------------------------------- |
37 | ||
239eaa41 RR |
38 | // ---------------------------------------------------------------------------- |
39 | // wxDataViewCtrl globals | |
40 | // ---------------------------------------------------------------------------- | |
bcd846ea | 41 | |
f460c29d RD |
42 | class WXDLLIMPEXP_ADV wxDataViewModel; |
43 | class WXDLLIMPEXP_ADV wxDataViewListModel; | |
44 | class WXDLLIMPEXP_ADV wxDataViewCtrl; | |
45 | class WXDLLIMPEXP_ADV wxDataViewColumn; | |
46 | class WXDLLIMPEXP_ADV wxDataViewCell; | |
fa28826d | 47 | |
f460c29d | 48 | extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[]; |
bcd846ea | 49 | |
f554a14b | 50 | // --------------------------------------------------------- |
239eaa41 | 51 | // wxDataViewModel |
f554a14b | 52 | // --------------------------------------------------------- |
239eaa41 | 53 | |
f460c29d | 54 | class WXDLLIMPEXP_ADV wxDataViewModel: public wxObject |
239eaa41 RR |
55 | { |
56 | public: | |
57 | wxDataViewModel() { } | |
58 | virtual ~wxDataViewModel() { } | |
f554a14b | 59 | |
239eaa41 | 60 | protected: |
260b9be7 | 61 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewModel) |
239eaa41 RR |
62 | }; |
63 | ||
f554a14b | 64 | // --------------------------------------------------------- |
239eaa41 | 65 | // wxDataViewListModelNotifier |
f554a14b | 66 | // --------------------------------------------------------- |
239eaa41 | 67 | |
8f850e28 | 68 | |
f460c29d | 69 | class WXDLLIMPEXP_ADV wxDataViewListModelNotifier: public wxObject |
239eaa41 RR |
70 | { |
71 | public: | |
72 | wxDataViewListModelNotifier() { } | |
73 | virtual ~wxDataViewListModelNotifier() { } | |
f554a14b | 74 | |
239eaa41 RR |
75 | virtual bool RowAppended() = 0; |
76 | virtual bool RowPrepended() = 0; | |
77 | virtual bool RowInserted( size_t before ) = 0; | |
78 | virtual bool RowDeleted( size_t row ) = 0; | |
79 | virtual bool RowChanged( size_t row ) = 0; | |
b5d777c7 | 80 | virtual bool ValueChanged( size_t col, size_t row ) = 0; |
4eccd3a1 | 81 | virtual bool RowsReordered( size_t *new_order ) = 0; |
239eaa41 | 82 | virtual bool Cleared() = 0; |
f554a14b | 83 | |
8f850e28 RR |
84 | void SetOwner( wxDataViewListModel *owner ) { m_owner = owner; } |
85 | wxDataViewListModel *GetOwner() { return m_owner; } | |
f554a14b | 86 | |
8f850e28 RR |
87 | private: |
88 | wxDataViewListModel *m_owner; | |
64ffb888 | 89 | }; |
239eaa41 | 90 | |
f554a14b | 91 | // --------------------------------------------------------- |
239eaa41 | 92 | // wxDataViewListModel |
f554a14b | 93 | // --------------------------------------------------------- |
239eaa41 | 94 | |
f460c29d | 95 | class WXDLLIMPEXP_ADV wxDataViewViewingColumn: public wxObject |
8f850e28 RR |
96 | { |
97 | public: | |
98 | wxDataViewViewingColumn( wxDataViewColumn *view_column, size_t model_column ) | |
99 | { | |
100 | m_viewColumn = view_column; | |
101 | m_modelColumn = model_column; | |
102 | } | |
f554a14b | 103 | |
8f850e28 RR |
104 | wxDataViewColumn *m_viewColumn; |
105 | size_t m_modelColumn; | |
106 | }; | |
107 | ||
f460c29d | 108 | class WXDLLIMPEXP_ADV wxDataViewListModel: public wxDataViewModel |
239eaa41 RR |
109 | { |
110 | public: | |
111 | wxDataViewListModel(); | |
112 | virtual ~wxDataViewListModel(); | |
113 | ||
114 | virtual size_t GetNumberOfRows() = 0; | |
115 | virtual size_t GetNumberOfCols() = 0; | |
a7f61f76 | 116 | // return type as reported by wxVariant |
239eaa41 | 117 | virtual wxString GetColType( size_t col ) = 0; |
a7f61f76 | 118 | // get value into a wxVariant |
3f3af7e7 | 119 | virtual void GetValue( wxVariant &variant, size_t col, size_t row ) = 0; |
a7f61f76 RR |
120 | // set value, call ValueChanged() afterwards! |
121 | virtual bool SetValue( wxVariant &variant, size_t col, size_t row ) = 0; | |
239eaa41 RR |
122 | |
123 | // delegated notifiers | |
8981608c RR |
124 | virtual bool RowAppended(); |
125 | virtual bool RowPrepended(); | |
126 | virtual bool RowInserted( size_t before ); | |
127 | virtual bool RowDeleted( size_t row ); | |
128 | virtual bool RowChanged( size_t row ); | |
129 | virtual bool ValueChanged( size_t col, size_t row ); | |
4eccd3a1 | 130 | virtual bool RowsReordered( size_t *new_order ); |
8981608c | 131 | virtual bool Cleared(); |
b5d777c7 | 132 | |
f554a14b | 133 | // Used internally |
8981608c RR |
134 | virtual void AddViewingColumn( wxDataViewColumn *view_column, size_t model_column ); |
135 | virtual void RemoveViewingColumn( wxDataViewColumn *column ); | |
f554a14b | 136 | |
8f850e28 RR |
137 | virtual void AddNotifier( wxDataViewListModelNotifier *notifier ); |
138 | virtual void RemoveNotifier( wxDataViewListModelNotifier *notifier ); | |
f554a14b | 139 | |
8f850e28 RR |
140 | wxList m_notifiers; |
141 | wxList m_viewingColumns; | |
239eaa41 RR |
142 | |
143 | protected: | |
260b9be7 | 144 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewListModel) |
239eaa41 RR |
145 | }; |
146 | ||
f554a14b | 147 | // --------------------------------------------------------- |
8981608c | 148 | // wxDataViewSortedListModel |
f554a14b | 149 | // --------------------------------------------------------- |
8981608c RR |
150 | |
151 | typedef int (wxCALLBACK *wxDataViewListModelCompare) | |
152 | (size_t row1, size_t row2, size_t col, wxDataViewListModel* model ); | |
153 | ||
f460c29d | 154 | WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SIZE_T(size_t, wxDataViewSortedIndexArray, WXDLLIMPEXP_ADV); |
8981608c | 155 | |
f460c29d | 156 | class WXDLLIMPEXP_ADV wxDataViewSortedListModel: public wxDataViewListModel |
8981608c RR |
157 | { |
158 | public: | |
159 | wxDataViewSortedListModel( wxDataViewListModel *child ); | |
160 | virtual ~wxDataViewSortedListModel(); | |
161 | ||
162 | virtual size_t GetNumberOfRows(); | |
163 | virtual size_t GetNumberOfCols(); | |
164 | // return type as reported by wxVariant | |
165 | virtual wxString GetColType( size_t col ); | |
166 | // get value into a wxVariant | |
3f3af7e7 | 167 | virtual void GetValue( wxVariant &variant, size_t col, size_t row ); |
8981608c RR |
168 | // set value, call ValueChanged() afterwards! |
169 | virtual bool SetValue( wxVariant &variant, size_t col, size_t row ); | |
170 | ||
171 | // delegated notifiers | |
172 | virtual bool RowAppended(); | |
173 | virtual bool RowPrepended(); | |
174 | virtual bool RowInserted( size_t before ); | |
175 | virtual bool RowDeleted( size_t row ); | |
176 | virtual bool RowChanged( size_t row ); | |
177 | virtual bool ValueChanged( size_t col, size_t row ); | |
4eccd3a1 | 178 | virtual bool RowsReordered( size_t *new_order ); |
8981608c RR |
179 | virtual bool Cleared(); |
180 | ||
4eccd3a1 RR |
181 | bool ChildValueChanged( size_t col, size_t row ); |
182 | ||
8f850e28 RR |
183 | virtual void Resort(); |
184 | ||
8981608c RR |
185 | private: |
186 | wxDataViewListModel *m_child; | |
187 | wxDataViewSortedIndexArray m_array; | |
4eccd3a1 | 188 | wxDataViewListModelNotifier *m_notifierOnChild; |
8981608c RR |
189 | |
190 | protected: | |
191 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewSortedListModel) | |
192 | }; | |
193 | ||
f554a14b | 194 | // --------------------------------------------------------- |
6842a71a | 195 | // wxDataViewCellBase |
f554a14b | 196 | // --------------------------------------------------------- |
fa28826d | 197 | |
6842a71a | 198 | enum wxDataViewCellMode |
fa28826d | 199 | { |
6842a71a RR |
200 | wxDATAVIEW_CELL_INERT, |
201 | wxDATAVIEW_CELL_ACTIVATABLE, | |
202 | wxDATAVIEW_CELL_EDITABLE | |
fa28826d RR |
203 | }; |
204 | ||
6842a71a RR |
205 | enum wxDataViewCellRenderState |
206 | { | |
207 | wxDATAVIEW_CELL_SELECTED = 1, | |
208 | wxDATAVIEW_CELL_PRELIT = 2, | |
209 | wxDATAVIEW_CELL_INSENSITIVE = 4, | |
210 | wxDATAVIEW_CELL_FOCUSED = 8 | |
211 | }; | |
212 | ||
f460c29d | 213 | class WXDLLIMPEXP_ADV wxDataViewCellBase: public wxObject |
6842a71a RR |
214 | { |
215 | public: | |
216 | wxDataViewCellBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); | |
217 | ||
f554a14b WS |
218 | virtual bool SetValue( const wxVariant& WXUNUSED(value) ) { return true; } |
219 | virtual bool GetValue( wxVariant& WXUNUSED(value) ) { return true; } | |
220 | virtual bool Validate( wxVariant& WXUNUSED(value) ) { return true; } | |
221 | ||
0fdc2321 RR |
222 | wxString GetVariantType() { return m_variantType; } |
223 | wxDataViewCellMode GetMode() { return m_mode; } | |
f554a14b | 224 | |
6842a71a RR |
225 | void SetOwner( wxDataViewColumn *owner ) { m_owner = owner; } |
226 | wxDataViewColumn* GetOwner() { return m_owner; } | |
f554a14b | 227 | |
a7f61f76 | 228 | protected: |
6842a71a RR |
229 | wxDataViewCellMode m_mode; |
230 | wxString m_variantType; | |
231 | wxDataViewColumn *m_owner; | |
232 | ||
233 | protected: | |
234 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCellBase) | |
235 | }; | |
236 | ||
f554a14b | 237 | // --------------------------------------------------------- |
6842a71a | 238 | // wxDataViewColumnBase |
f554a14b | 239 | // --------------------------------------------------------- |
6842a71a | 240 | |
fa28826d RR |
241 | enum wxDataViewColumnFlags |
242 | { | |
243 | wxDATAVIEW_COL_RESIZABLE = 1, | |
244 | wxDATAVIEW_COL_SORTABLE = 2, | |
245 | wxDATAVIEW_COL_HIDDEN = 4 | |
246 | }; | |
247 | ||
533544f2 RR |
248 | enum wxDataViewColumnSizing |
249 | { | |
250 | wxDATAVIEW_COL_WIDTH_FIXED, | |
251 | wxDATAVIEW_COL_WIDTH_AUTO, | |
252 | wxDATAVIEW_COL_WIDTH_GROW | |
253 | }; | |
254 | ||
f460c29d | 255 | class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject |
fa28826d RR |
256 | { |
257 | public: | |
07b6378f | 258 | wxDataViewColumnBase( const wxString &title, wxDataViewCell *cell, size_t model_column, |
533544f2 | 259 | int fixed_width = 80, wxDataViewColumnSizing sizing = wxDATAVIEW_COL_WIDTH_FIXED, int flags = 0 ); |
d3c7fc99 | 260 | virtual ~wxDataViewColumnBase(); |
fa28826d RR |
261 | |
262 | virtual void SetTitle( const wxString &title ); | |
263 | virtual wxString GetTitle(); | |
07b6378f | 264 | |
6842a71a | 265 | wxDataViewCell* GetCell() { return m_cell; } |
f554a14b | 266 | |
6842a71a | 267 | size_t GetModelColumn() { return m_model_column; } |
f554a14b | 268 | |
6842a71a RR |
269 | void SetOwner( wxDataViewCtrl *owner ) { m_owner = owner; } |
270 | wxDataViewCtrl *GetOwner() { return m_owner; } | |
07b6378f | 271 | |
533544f2 | 272 | virtual int GetWidth() = 0; |
07b6378f | 273 | |
533544f2 RR |
274 | virtual void SetFixedWidth( int width ) = 0; |
275 | virtual int GetFixedWidth() = 0; | |
fa28826d RR |
276 | |
277 | private: | |
278 | wxDataViewCtrl *m_ctrl; | |
6842a71a RR |
279 | wxDataViewCell *m_cell; |
280 | int m_model_column; | |
fa28826d RR |
281 | int m_flags; |
282 | wxString m_title; | |
6842a71a | 283 | wxDataViewCtrl *m_owner; |
fa28826d RR |
284 | |
285 | protected: | |
286 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase) | |
287 | }; | |
288 | ||
f554a14b | 289 | // --------------------------------------------------------- |
239eaa41 | 290 | // wxDataViewCtrlBase |
f554a14b | 291 | // --------------------------------------------------------- |
239eaa41 | 292 | |
c21f7aa1 RR |
293 | #define wxDV_SINGLE 0x0000 // for convenience |
294 | #define wxDV_MULTIPLE 0x0020 // can select multiple items | |
295 | ||
f460c29d | 296 | class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl |
239eaa41 RR |
297 | { |
298 | public: | |
299 | wxDataViewCtrlBase(); | |
d3c7fc99 | 300 | virtual ~wxDataViewCtrlBase(); |
f554a14b | 301 | |
6e2e590f RR |
302 | virtual bool AssociateModel( wxDataViewListModel *model ); |
303 | wxDataViewListModel* GetModel(); | |
f554a14b | 304 | |
605c2c4a RR |
305 | virtual bool AppendTextColumn( const wxString &label, size_t model_column ); |
306 | virtual bool AppendToggleColumn( const wxString &label, size_t model_column ); | |
ad63bf41 | 307 | virtual bool AppendProgressColumn( const wxString &label, size_t model_column ); |
4d496ecb | 308 | virtual bool AppendDateColumn( const wxString &label, size_t model_column ); |
f554a14b | 309 | virtual bool AppendColumn( wxDataViewColumn *col ); |
fa28826d RR |
310 | virtual size_t GetNumberOfColumns(); |
311 | virtual bool DeleteColumn( size_t pos ); | |
312 | virtual bool ClearColumns(); | |
313 | virtual wxDataViewColumn* GetColumn( size_t pos ); | |
f554a14b | 314 | |
239eaa41 | 315 | private: |
6e2e590f | 316 | wxDataViewListModel *m_model; |
fa28826d | 317 | wxList m_cols; |
bcd846ea | 318 | |
239eaa41 | 319 | protected: |
260b9be7 | 320 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase) |
239eaa41 | 321 | }; |
bcd846ea | 322 | |
4ed7af08 RR |
323 | #if defined(wxUSE_GENERICDATAVIEWCTRL) |
324 | #include "wx/generic/dataview.h" | |
325 | #elif defined(__WXGTK20__) | |
bcd846ea RR |
326 | #include "wx/gtk/dataview.h" |
327 | #elif defined(__WXMAC__) | |
07b6378f WS |
328 | // TODO |
329 | // #include "wx/mac/dataview.h" | |
bcd846ea RR |
330 | #else |
331 | #include "wx/generic/dataview.h" | |
332 | #endif | |
333 | ||
334 | #endif // wxUSE_DATAVIEWCTRL | |
335 | ||
336 | #endif | |
337 | // _WX_DATAVIEW_H_BASE_ |