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