1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxDataView* classes
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
11 @class wxDataViewModel
13 wxDataViewModel is the base class for all data model to be displayed by a
16 All other models derive from it and must implement its pure virtual functions
17 in order to define a complete data model. In detail, you need to override
18 wxDataViewModel::IsContainer, wxDataViewModel::GetParent, wxDataViewModel::GetChildren,
19 wxDataViewModel::GetColumnCount, wxDataViewModel::GetColumnType and
20 wxDataViewModel::GetValue in order to define the data model which acts as an
21 interface between your actual data and the wxDataViewCtrl.
23 Note that wxDataViewModel does not define the position or index of any item
24 in the control because different controls might display the same data differently.
25 wxDataViewModel does provide a wxDataViewModel::Compare method which the
26 wxDataViewCtrl may use to sort the data either in conjunction with a column
27 header or without (see wxDataViewModel::HasDefaultCompare).
29 wxDataViewModel (as indeed the entire wxDataViewCtrl code) is using wxVariant
30 to store data and its type in a generic way. wxVariant can be extended to contain
31 almost any data without changes to the original class. To a certain extent,
32 you can use (the somewhat more elegant) wxAny instead of wxVariant as there
33 is code to convert between the two, but it is unclear what impact this will
36 Since you will usually allow the wxDataViewCtrl to change your data
37 through its graphical interface, you will also have to override
38 wxDataViewModel::SetValue which the wxDataViewCtrl will call when a change
39 to some data has been committed.
41 If the data represented by the model is changed by something else than its
42 associated wxDataViewCtrl, the control has to be notified about the change.
43 Depending on what happened you need to call one of the following methods:
44 - wxDataViewModel::ValueChanged,
45 - wxDataViewModel::ItemAdded,
46 - wxDataViewModel::ItemDeleted,
47 - wxDataViewModel::ItemChanged,
48 - wxDataViewModel::Cleared.
50 There are plural forms for notification of addition, change or removal of
51 several item at once. See:
52 - wxDataViewModel::ItemsAdded,
53 - wxDataViewModel::ItemsDeleted,
54 - wxDataViewModel::ItemsChanged.
56 This class maintains a list of wxDataViewModelNotifier which link this class
57 to the specific implementations on the supported platforms so that e.g. calling
58 wxDataViewModel::ValueChanged on this model will just call
59 wxDataViewModelNotifier::ValueChanged for each notifier that has been added.
60 You can also add your own notifier in order to get informed about any changes
61 to the data in the list model.
63 Currently wxWidgets provides the following models apart from the base model:
64 wxDataViewIndexListModel, wxDataViewVirtualListModel, wxDataViewTreeStore,
67 Note that wxDataViewModel is reference counted, derives from wxRefCounter
68 and cannot be deleted directly as it can be shared by several wxDataViewCtrls.
69 This implies that you need to decrease the reference count after
70 associating the model with a control like this:
73 wxDataViewCtrl *musicCtrl = new wxDataViewCtrl( this, wxID_ANY );
74 wxDataViewModel *musicModel = new MyMusicModel;
75 m_musicCtrl->AssociateModel( musicModel );
76 musicModel->DecRef(); // avoid memory leak !!
81 A potentially better way to avoid memory leaks is to use wxObjectDataPtr
84 wxObjectDataPtr<MyMusicModel> musicModel;
86 wxDataViewCtrl *musicCtrl = new wxDataViewCtrl( this, wxID_ANY );
87 musicModel = new MyMusicModel;
88 m_musicCtrl->AssociateModel( musicModel.get() );
97 class wxDataViewModel
: public wxRefCounter
106 Adds a wxDataViewModelNotifier to the model.
108 void AddNotifier(wxDataViewModelNotifier
* notifier
);
111 Change the value of the given item and update the control to reflect
114 This function simply calls SetValue() and, if it succeeded,
122 The item (row) to update.
124 The column to update.
126 @true if both SetValue() and ValueChanged() returned @true.
128 bool ChangeValue(const wxVariant
& variant
,
129 const wxDataViewItem
& item
,
133 Called to inform the model that all data has been cleared.
134 The control will reread the data from the model again.
136 virtual bool Cleared();
139 The compare function to be used by control. The default compare function
140 sorts by container and other items separately and in ascending order.
141 Override this for a different sorting behaviour.
143 @see HasDefaultCompare().
145 virtual int Compare(const wxDataViewItem
& item1
,
146 const wxDataViewItem
& item2
,
148 bool ascending
) const;
151 Override this to indicate that the item has special font attributes.
152 This only affects the wxDataViewTextRendererText renderer.
154 The base class version always simply returns @false.
156 @see wxDataViewItemAttr.
159 The item for which the attribute is requested.
161 The column of the item for which the attribute is requested.
163 The attribute to be filled in if the function returns @true.
165 @true if this item has an attribute or @false otherwise.
167 virtual bool GetAttr(const wxDataViewItem
& item
, unsigned int col
,
168 wxDataViewItemAttr
& attr
) const;
171 Override this to indicate that the item should be disabled.
173 Disabled items are displayed differently (e.g. grayed out) and cannot
176 The base class version always returns @true, thus making all items
180 The item whose enabled status is requested.
182 The column of the item whose enabled status is requested.
184 @true if this item should be enabled, @false otherwise.
186 @note Currently disabling items is fully implemented only for the
187 native control implementation in wxOSX/Cocoa and wxGTK.
188 This feature is only partially supported in the generic
189 version (used by wxMSW) and not supported by the wxOSX/Carbon
194 virtual bool IsEnabled(const wxDataViewItem
&item
,
195 unsigned int col
) const;
198 Override this so the control can query the child items of an item.
199 Returns the number of items.
201 virtual unsigned int GetChildren(const wxDataViewItem
& item
,
202 wxDataViewItemArray
& children
) const = 0;
205 Override this to indicate the number of columns in the model.
207 virtual unsigned int GetColumnCount() const = 0;
210 Override this to indicate what type of data is stored in the
211 column specified by @a col.
213 This should return a string indicating the type of data as reported by wxVariant.
215 virtual wxString
GetColumnType(unsigned int col
) const = 0;
218 Override this to indicate which wxDataViewItem representing the parent
219 of @a item or an invalid wxDataViewItem if the root item is
222 virtual wxDataViewItem
GetParent(const wxDataViewItem
& item
) const = 0;
225 Override this to indicate the value of @a item.
226 A wxVariant is used to store the data.
228 virtual void GetValue(wxVariant
& variant
, const wxDataViewItem
& item
,
229 unsigned int col
) const = 0;
232 Override this method to indicate if a container item merely acts as a
233 headline (or for categorisation) or if it also acts a normal item with
234 entries for further columns. By default returns @false.
236 virtual bool HasContainerColumns(const wxDataViewItem
& item
) const;
239 Override this to indicate that the model provides a default compare
240 function that the control should use if no wxDataViewColumn has been
241 chosen for sorting. Usually, the user clicks on a column header for
242 sorting, the data will be sorted alphanumerically.
244 If any other order (e.g. by index or order of appearance) is required,
245 then this should be used.
246 See wxDataViewIndexListModel for a model which makes use of this.
248 virtual bool HasDefaultCompare() const;
251 Return true if there is a value in the given column of this item.
253 All normal items have values in all columns but the container items
254 only show their label in the first column (@a col == 0) by default (but
255 see HasContainerColumns()). So this function always returns true for
256 the first column while for the other ones it returns true only if the
257 item is not a container or HasContainerColumns() was overridden to
262 bool HasValue(const wxDataViewItem
& item
, unsigned col
) const;
265 Override this to indicate of @a item is a container, i.e. if
266 it can have child items.
268 virtual bool IsContainer(const wxDataViewItem
& item
) const = 0;
271 Call this to inform the model that an item has been added to the data.
273 bool ItemAdded(const wxDataViewItem
& parent
,
274 const wxDataViewItem
& item
);
277 Call this to inform the model that an item has changed.
279 This will eventually emit a @c wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
280 event (in which the column fields will not be set) to the user.
282 bool ItemChanged(const wxDataViewItem
& item
);
285 Call this to inform the model that an item has been deleted from the data.
287 bool ItemDeleted(const wxDataViewItem
& parent
,
288 const wxDataViewItem
& item
);
291 Call this to inform the model that several items have been added to the data.
293 bool ItemsAdded(const wxDataViewItem
& parent
,
294 const wxDataViewItemArray
& items
);
297 Call this to inform the model that several items have changed.
299 This will eventually emit @c wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
300 events (in which the column fields will not be set) to the user.
302 bool ItemsChanged(const wxDataViewItemArray
& items
);
305 Call this to inform the model that several items have been deleted.
307 bool ItemsDeleted(const wxDataViewItem
& parent
,
308 const wxDataViewItemArray
& items
);
311 Remove the @a notifier from the list of notifiers.
313 void RemoveNotifier(wxDataViewModelNotifier
* notifier
);
316 Call this to initiate a resort after the sort function has been changed.
318 virtual void Resort();
321 This gets called in order to set a value in the data model.
323 The most common scenario is that the wxDataViewCtrl calls this method
324 after the user changed some data in the view.
326 This is the function you need to override in your derived class but if
327 you want to call it, ChangeValue() is usually more convenient as
328 otherwise you need to manually call ValueChanged() to update the
331 virtual bool SetValue(const wxVariant
& variant
,
332 const wxDataViewItem
& item
,
333 unsigned int col
) = 0;
336 Call this to inform this model that a value in the model has been changed.
337 This is also called from wxDataViewCtrl's internal editing code, e.g. when
338 editing a text field in the control.
340 This will eventually emit a @c wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
343 virtual bool ValueChanged(const wxDataViewItem
& item
,
349 Destructor. This should not be called directly. Use DecRef() instead.
351 virtual ~wxDataViewModel();
357 @class wxDataViewListModel
359 Base class with abstract API for wxDataViewIndexListModel and
360 wxDataViewVirtualListModel.
365 class wxDataViewListModel
: public wxDataViewModel
372 virtual ~wxDataViewIndexListModel();
375 Compare method that sorts the items by their index.
377 int Compare(const wxDataViewItem
& item1
,
378 const wxDataViewItem
& item2
,
379 unsigned int column
, bool ascending
);
382 Override this to indicate that the row has special font attributes.
383 This only affects the wxDataViewTextRendererText() renderer.
385 The base class version always simply returns @false.
387 @see wxDataViewItemAttr.
390 The row for which the attribute is requested.
392 The column for which the attribute is requested.
394 The attribute to be filled in if the function returns @true.
396 @true if this item has an attribute or @false otherwise.
398 virtual bool GetAttrByRow(unsigned int row
, unsigned int col
,
399 wxDataViewItemAttr
& attr
) const;
402 Override this if you want to disable specific items.
404 The base class version always returns @true, thus making all items
408 The row of the item whose enabled status is requested.
410 The column of the item whose enabled status is requested.
412 @true if the item at this row and column should be enabled,
415 @note See wxDataViewModel::IsEnabled() for the current status of
416 support for disabling the items under different platforms.
420 virtual bool IsEnabledByRow(unsigned int row
,
421 unsigned int col
) const;
424 Returns the number of items (i.e. rows) in the list.
426 unsigned int GetCount() const;
429 Returns the wxDataViewItem at the given @e row.
431 wxDataViewItem
GetItem(unsigned int row
) const;
434 Returns the position of given @e item.
436 unsigned int GetRow(const wxDataViewItem
& item
) const;
439 Override this to allow getting values from the model.
441 virtual void GetValueByRow(wxVariant
& variant
, unsigned int row
,
442 unsigned int col
) const = 0;
445 Call this after if the data has to be read again from the model.
446 This is useful after major changes when calling the methods below
447 (possibly thousands of times) doesn't make sense.
449 void Reset(unsigned int new_size
);
452 Call this after a row has been appended to the model.
457 Call this after a row has been changed.
459 void RowChanged(unsigned int row
);
462 Call this after a row has been deleted.
464 void RowDeleted(unsigned int row
);
467 Call this after a row has been inserted at the given position.
469 void RowInserted(unsigned int before
);
472 Call this after a row has been prepended to the model.
477 Call this after a value has been changed.
479 void RowValueChanged(unsigned int row
, unsigned int col
);
482 Call this after rows have been deleted.
483 The array will internally get copied and sorted in descending order so
484 that the rows with the highest position will be deleted first.
486 void RowsDeleted(const wxArrayInt
& rows
);
489 Called in order to set a value in the model.
491 virtual bool SetValueByRow(const wxVariant
& variant
, unsigned int row
,
492 unsigned int col
) = 0;
497 @class wxDataViewIndexListModel
499 wxDataViewIndexListModel is a specialized data model which lets you address
500 an item by its position (row) rather than its wxDataViewItem (which you can
501 obtain from this class).
502 This model also provides its own wxDataViewIndexListModel::Compare
503 method which sorts the model's data by the index.
505 This model is not a virtual model since the control stores each wxDataViewItem.
506 Use wxDataViewVirtualListModel if you need to display millions of items or
507 have other reason to use a virtual control.
509 @see wxDataViewListModel for the API.
515 class wxDataViewIndexListModel
: public wxDataViewListModel
521 wxDataViewIndexListModel(unsigned int initial_size
= 0);
526 @class wxDataViewVirtualListModel
528 wxDataViewVirtualListModel is a specialized data model which lets you address
529 an item by its position (row) rather than its wxDataViewItem and as such offers
530 the exact same interface as wxDataViewIndexListModel.
531 The important difference is that under platforms other than OS X, using this
532 model will result in a truly virtual control able to handle millions of items
533 as the control doesn't store any item (a feature not supported by OS X).
535 @see wxDataViewListModel for the API.
541 class wxDataViewVirtualListModel
: public wxDataViewListModel
547 wxDataViewVirtualListModel(unsigned int initial_size
= 0);
554 @class wxDataViewItemAttr
556 This class is used to indicate to a wxDataViewCtrl that a certain item
557 (see wxDataViewItem) has extra font attributes for its renderer.
558 For this, it is required to override wxDataViewModel::GetAttr.
560 Attributes are currently only supported by wxDataViewTextRendererText.
565 class wxDataViewItemAttr
571 wxDataViewItemAttr();
574 Call this to indicate that the item shall be displayed in bold text.
576 void SetBold(bool set
);
579 Call this to indicate that the item shall be displayed with that colour.
581 void SetColour(const wxColour
& colour
);
584 Call this to indicate that the item shall be displayed in italic text.
586 void SetItalic(bool set
);
592 @class wxDataViewItem
594 wxDataViewItem is a small opaque class that represents an item in a wxDataViewCtrl
595 in a persistent way, i.e. independent of the position of the item in the control
596 or changes to its contents.
598 It must hold a unique ID of type @e void* in its only field and can be converted
601 If the ID is @NULL the wxDataViewItem is invalid and wxDataViewItem::IsOk will
602 return @false which used in many places in the API of wxDataViewCtrl to
603 indicate that e.g. no item was found. An ID of @NULL is also used to indicate
604 the invisible root. Examples for this are wxDataViewModel::GetParent and
605 wxDataViewModel::GetChildren.
617 wxDataViewItem(void* id
= NULL
);
618 wxDataViewItem(const wxDataViewItem
& item
);
627 Returns @true if the ID is not @NULL.
635 @class wxDataViewCtrl
637 wxDataViewCtrl is a control to display data either in a tree like fashion or
638 in a tabular form or both.
640 If you only need to display a simple tree structure with an API more like the
641 older wxTreeCtrl class, then the specialized wxDataViewTreeCtrl can be used.
642 Likewise, if you only want to display simple table structure you can use
643 the specialized wxDataViewListCtrl class. Both wxDataViewTreeCtrl and
644 wxDataViewListCtrl can be used without defining your own wxDataViewModel.
646 A wxDataViewItem is used to represent a (visible) item in the control.
648 Unlike wxListCtrl, wxDataViewCtrl doesn't get its data from the user through
649 virtual functions or by setting it directly. Instead you need to write your own
650 wxDataViewModel and associate it with this control.
651 Then you need to add a number of wxDataViewColumn to this control to define
652 what each column shall display. Each wxDataViewColumn in turn owns 1 instance
653 of a wxDataViewRenderer to render its cells.
655 A number of standard renderers for rendering text, dates, images, toggle,
656 a progress bar etc. are provided. Additionally, the user can write custom
657 renderers deriving from wxDataViewCustomRenderer for displaying anything.
659 All data transfer from the control to the model and the user code is done
660 through wxVariant which can be extended to support more data formats as necessary.
661 Accordingly, all type information uses the strings returned from wxVariant::GetType.
665 Single selection mode. This is the default.
666 @style{wxDV_MULTIPLE}
667 Multiple selection mode.
668 @style{wxDV_ROW_LINES}
669 Use alternating colours for rows if supported by platform and theme.
670 Currently only supported by the native GTK and OS X implementations
671 but not by the generic one.
672 @style{wxDV_HORIZ_RULES}
673 Display fine rules between row if supported.
674 @style{wxDV_VERT_RULES}
675 Display fine rules between columns is supported.
676 @style{wxDV_VARIABLE_LINE_HEIGHT}
677 Allow variable line heights.
678 This can be inefficient when displaying large number of items.
679 @style{wxDV_NO_HEADER}
680 Do not show column headers (which are shown by default).
683 @beginEventEmissionTable{wxDataViewEvent}
684 @event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)}
685 Process a @c wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event.
686 @event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)}
687 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED event.
688 @event{EVT_DATAVIEW_ITEM_START_EDITING(id, func)}
689 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED event. This
690 event can be vetoed in order to prevent editing on an item by item
691 basis. Still experimental.
692 @event{EVT_DATAVIEW_ITEM_EDITING_STARTED(id, func)}
693 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED event.
694 @event{EVT_DATAVIEW_ITEM_EDITING_DONE(id, func)}
695 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE event.
696 @event{EVT_DATAVIEW_ITEM_COLLAPSING(id, func)}
697 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING event.
698 @event{EVT_DATAVIEW_ITEM_COLLAPSED(id, func)}
699 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED event.
700 @event{EVT_DATAVIEW_ITEM_EXPANDING(id, func)}
701 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING event.
702 @event{EVT_DATAVIEW_ITEM_EXPANDED(id, func)}
703 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED event.
704 @event{EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, func)}
705 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED event.
706 @event{EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, func)}
707 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU event.
708 @event{EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, func)}
709 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICKED event.
710 @event{EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK(id, func)}
711 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED event.
712 @event{EVT_DATAVIEW_COLUMN_SORTED(id, func)}
713 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED event.
714 @event{EVT_DATAVIEW_COLUMN_REORDERED(id, func)}
715 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED event.
716 @event{EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, func)}
717 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG event.
718 @event{EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, func)}
719 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE event.
720 @event{EVT_DATAVIEW_ITEM_DROP(id, func)}
721 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_DROP event.
726 @appearance{dataviewctrl.png}
728 class wxDataViewCtrl
: public wxControl
737 Constructor. Calls Create().
739 wxDataViewCtrl(wxWindow
* parent
, wxWindowID id
,
740 const wxPoint
& pos
= wxDefaultPosition
,
741 const wxSize
& size
= wxDefaultSize
,
743 const wxValidator
& validator
= wxDefaultValidator
,
744 const wxString
& name
= wxDataViewCtrlNameStr
);
749 virtual ~wxDataViewCtrl();
752 Appends a wxDataViewColumn to the control. Returns @true on success.
754 Note that there is a number of short cut methods which implicitly create
755 a wxDataViewColumn and a wxDataViewRenderer for it (see below).
757 virtual bool AppendColumn(wxDataViewColumn
* col
);
760 Prepends a wxDataViewColumn to the control. Returns @true on success.
762 Note that there is a number of short cut methods which implicitly create
763 a wxDataViewColumn and a wxDataViewRenderer for it.
765 virtual bool PrependColumn(wxDataViewColumn
* col
);
768 Inserts a wxDataViewColumn to the control. Returns @true on success.
770 virtual bool InsertColumn(unsigned int pos
, wxDataViewColumn
* col
);
774 Appends a column for rendering a bitmap. Returns the wxDataViewColumn
775 created in the function or @NULL on failure.
777 wxDataViewColumn
* AppendBitmapColumn(const wxString
& label
,
778 unsigned int model_column
,
779 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
781 wxAlignment align
= wxALIGN_CENTER
,
782 int flags
= wxDATAVIEW_COL_RESIZABLE
);
783 wxDataViewColumn
* AppendBitmapColumn(const wxBitmap
& label
,
784 unsigned int model_column
,
785 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
787 wxAlignment align
= wxALIGN_CENTER
,
788 int flags
= wxDATAVIEW_COL_RESIZABLE
);
793 Appends a column for rendering a date. Returns the wxDataViewColumn
794 created in the function or @NULL on failure.
796 @note The @a align parameter is applied to both the column header and
799 wxDataViewColumn
* AppendDateColumn(const wxString
& label
,
800 unsigned int model_column
,
801 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
803 wxAlignment align
= wxALIGN_NOT
,
804 int flags
= wxDATAVIEW_COL_RESIZABLE
);
805 wxDataViewColumn
* AppendDateColumn(const wxBitmap
& label
,
806 unsigned int model_column
,
807 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
809 wxAlignment align
= wxALIGN_NOT
,
810 int flags
= wxDATAVIEW_COL_RESIZABLE
);
815 Appends a column for rendering text with an icon. Returns the wxDataViewColumn
816 created in the function or @NULL on failure.
817 This method uses the wxDataViewIconTextRenderer class.
819 @note The @a align parameter is applied to both the column header and
822 wxDataViewColumn
* AppendIconTextColumn(const wxString
& label
,
823 unsigned int model_column
,
824 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
826 wxAlignment align
= wxALIGN_NOT
,
827 int flags
= wxDATAVIEW_COL_RESIZABLE
);
828 wxDataViewColumn
* AppendIconTextColumn(const wxBitmap
& label
,
829 unsigned int model_column
,
830 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
832 wxAlignment align
= wxALIGN_NOT
,
833 int flags
= wxDATAVIEW_COL_RESIZABLE
);
838 Appends a column for rendering a progress indicator. Returns the
839 wxDataViewColumn created in the function or @NULL on failure.
841 @note The @a align parameter is applied to both the column header and
844 wxDataViewColumn
* AppendProgressColumn(const wxString
& label
,
845 unsigned int model_column
,
846 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
848 wxAlignment align
= wxALIGN_CENTER
,
849 int flags
= wxDATAVIEW_COL_RESIZABLE
);
850 wxDataViewColumn
* AppendProgressColumn(const wxBitmap
& label
,
851 unsigned int model_column
,
852 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
854 wxAlignment align
= wxALIGN_CENTER
,
855 int flags
= wxDATAVIEW_COL_RESIZABLE
);
860 Appends a column for rendering text. Returns the wxDataViewColumn
861 created in the function or @NULL on failure.
863 @note The @a align parameter is applied to both the column header and
866 wxDataViewColumn
* AppendTextColumn(const wxString
& label
,
867 unsigned int model_column
,
868 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
870 wxAlignment align
= wxALIGN_NOT
,
871 int flags
= wxDATAVIEW_COL_RESIZABLE
);
872 wxDataViewColumn
* AppendTextColumn(const wxBitmap
& label
,
873 unsigned int model_column
,
874 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
876 wxAlignment align
= wxALIGN_NOT
,
877 int flags
= wxDATAVIEW_COL_RESIZABLE
);
882 Appends a column for rendering a toggle. Returns the wxDataViewColumn
883 created in the function or @NULL on failure.
885 @note The @a align parameter is applied to both the column header and
888 wxDataViewColumn
* AppendToggleColumn(const wxString
& label
,
889 unsigned int model_column
,
890 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
892 wxAlignment align
= wxALIGN_CENTER
,
893 int flags
= wxDATAVIEW_COL_RESIZABLE
);
894 wxDataViewColumn
* AppendToggleColumn(const wxBitmap
& label
,
895 unsigned int model_column
,
896 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
898 wxAlignment align
= wxALIGN_CENTER
,
899 int flags
= wxDATAVIEW_COL_RESIZABLE
);
903 Associates a wxDataViewModel with the control.
904 This increases the reference count of the model by 1.
906 virtual bool AssociateModel(wxDataViewModel
* model
);
911 virtual bool ClearColumns();
916 virtual void Collapse(const wxDataViewItem
& item
);
919 Create the control. Useful for two step creation.
921 bool Create(wxWindow
* parent
, wxWindowID id
,
922 const wxPoint
& pos
= wxDefaultPosition
,
923 const wxSize
& size
= wxDefaultSize
,
925 const wxValidator
& validator
= wxDefaultValidator
,
926 const wxString
& name
= wxDataViewCtrlNameStr
);
929 Deletes given column.
931 virtual bool DeleteColumn(wxDataViewColumn
* column
);
934 Enable drag operations using the given @a format.
936 virtual bool EnableDragSource( const wxDataFormat
&format
);
939 Enable drop operations using the given @a format.
941 virtual bool EnableDropTarget( const wxDataFormat
&format
);
944 Call this to ensure that the given item is visible.
946 virtual void EnsureVisible(const wxDataViewItem
& item
,
947 const wxDataViewColumn
* column
= NULL
);
952 virtual void Expand(const wxDataViewItem
& item
);
955 Expands all ancestors of the @a item. This method also
956 ensures that the item itself as well as all ancestor
957 items have been read from the model by the control.
959 virtual void ExpandAncestors( const wxDataViewItem
& item
);
962 Returns pointer to the column. @a pos refers to the position in the
963 control which may change after reordering columns by the user.
965 virtual wxDataViewColumn
* GetColumn(unsigned int pos
) const;
968 Returns the number of columns.
970 virtual unsigned int GetColumnCount() const;
973 Returns the position of the column or -1 if not found in the control.
975 virtual int GetColumnPosition(const wxDataViewColumn
* column
) const;
978 Returns column containing the expanders.
980 wxDataViewColumn
* GetExpanderColumn() const;
983 Returns the currently focused item.
985 This is the item that the keyboard commands apply to. It may be invalid
986 if there is no focus currently.
988 This method is mostly useful for the controls with @c wxDV_MULTIPLE
989 style as in the case of single selection it returns the same thing as
992 Notice that under all platforms except Mac OS X the currently focused
993 item may be selected or not but under OS X the current item is always
996 @see SetCurrentItem()
1000 wxDataViewItem
GetCurrentItem() const;
1003 Returns indentation.
1005 int GetIndent() const;
1010 virtual wxRect
GetItemRect(const wxDataViewItem
& item
,
1011 const wxDataViewColumn
* col
= NULL
) const;
1014 Returns pointer to the data model associated with the control (if any).
1016 wxDataViewModel
* GetModel();
1019 Returns first selected item or an invalid item if none is selected.
1021 virtual wxDataViewItem
GetSelection() const;
1024 Fills @a sel with currently selected items and returns their number.
1026 virtual int GetSelections(wxDataViewItemArray
& sel
) const;
1029 Returns the wxDataViewColumn currently responsible for sorting
1030 or @NULL if none has been selected.
1032 virtual wxDataViewColumn
* GetSortingColumn() const;
1037 virtual void HitTest(const wxPoint
& point
, wxDataViewItem
& item
,
1038 wxDataViewColumn
*& col
) const;
1041 Return @true if the item is expanded.
1043 virtual bool IsExpanded(const wxDataViewItem
& item
) const;
1046 Return @true if the item is selected.
1048 virtual bool IsSelected(const wxDataViewItem
& item
) const;
1051 Select the given item.
1053 In single selection mode this changes the (unique) currently selected
1054 item. In multi selection mode, the @a item is selected and the
1055 previously selected items remain selected.
1057 virtual void Select(const wxDataViewItem
& item
);
1062 virtual void SelectAll();
1065 Set which column shall contain the tree-like expanders.
1067 void SetExpanderColumn(wxDataViewColumn
* col
);
1070 Changes the currently focused item.
1072 The @a item parameter must be valid, there is no way to remove the
1073 current item from the control.
1075 In single selection mode, calling this method is the same as calling
1076 Select() and is thus not very useful. In multiple selection mode this
1077 method only moves the current item however without changing the
1078 selection except under OS X where the current item is always selected,
1079 so calling SetCurrentItem() selects @a item if it hadn't been selected
1082 @see GetCurrentItem()
1086 void SetCurrentItem(const wxDataViewItem
& item
);
1089 Sets the indentation.
1091 void SetIndent(int indent
);
1094 Sets the selection to the array of wxDataViewItems.
1096 virtual void SetSelections(const wxDataViewItemArray
& sel
);
1099 Programmatically starts editing the given item on the given column.
1100 Currently not implemented on wxOSX Carbon.
1104 virtual void StartEditor(const wxDataViewItem
& item
, unsigned int column
);
1107 Unselect the given item.
1109 virtual void Unselect(const wxDataViewItem
& item
);
1113 This method only has effect if multiple selections are allowed.
1115 virtual void UnselectAll();
1118 Sets the row height.
1120 This function can only be used when all rows have the same height, i.e.
1121 when wxDV_VARIABLE_LINE_HEIGHT flag is not used.
1123 Currently this is implemented in the generic and native GTK versions
1124 only and nothing is done (and @false returned) when using OS X port.
1126 Also notice that this method can only be used to increase the row
1127 height compared with the default one (as determined by the return value
1128 of wxDataViewRenderer::GetSize()), if it is set to a too small value
1129 then the minimum required by the renderers will be used.
1131 @return @true if the line height was changed or @false otherwise.
1135 virtual bool SetRowHeight(int rowHeight
);
1141 @class wxDataViewModelNotifier
1143 A wxDataViewModelNotifier instance is owned by a wxDataViewModel and mirrors
1144 its notification interface.
1145 See the documentation of that class for further information.
1150 class wxDataViewModelNotifier
1156 wxDataViewModelNotifier();
1161 virtual ~wxDataViewModelNotifier();
1164 Called by owning model.
1166 virtual bool Cleared() = 0;
1169 Get owning wxDataViewModel.
1171 wxDataViewModel
* GetOwner() const;
1174 Called by owning model.
1176 virtual bool ItemAdded(const wxDataViewItem
& parent
,
1177 const wxDataViewItem
& item
) = 0;
1180 Called by owning model.
1182 virtual bool ItemChanged(const wxDataViewItem
& item
) = 0;
1185 Called by owning model.
1187 virtual bool ItemDeleted(const wxDataViewItem
& parent
,
1188 const wxDataViewItem
& item
) = 0;
1191 Called by owning model.
1193 virtual bool ItemsAdded(const wxDataViewItem
& parent
,
1194 const wxDataViewItemArray
& items
);
1197 Called by owning model.
1199 virtual bool ItemsChanged(const wxDataViewItemArray
& items
);
1202 Called by owning model.
1204 virtual bool ItemsDeleted(const wxDataViewItem
& parent
,
1205 const wxDataViewItemArray
& items
);
1208 Called by owning model.
1210 virtual void Resort() = 0;
1213 Set owner of this notifier. Used internally.
1215 void SetOwner(wxDataViewModel
* owner
);
1218 Called by owning model.
1220 virtual bool ValueChanged(const wxDataViewItem
& item
, unsigned int col
) = 0;
1225 The mode of a data-view cell; see wxDataViewRenderer for more info.
1227 enum wxDataViewCellMode
1229 wxDATAVIEW_CELL_INERT
,
1232 Indicates that the user can double click the cell and something will
1233 happen (e.g. a window for editing a date will pop up).
1235 wxDATAVIEW_CELL_ACTIVATABLE
,
1238 Indicates that the user can edit the data in-place, i.e. an control
1239 will show up after a slow click on the cell. This behaviour is best
1240 known from changing the filename in most file managers etc.
1242 wxDATAVIEW_CELL_EDITABLE
1246 The values of this enum controls how a wxDataViewRenderer should display
1247 its contents in a cell.
1249 enum wxDataViewCellRenderState
1251 wxDATAVIEW_CELL_SELECTED
= 1,
1252 wxDATAVIEW_CELL_PRELIT
= 2,
1253 wxDATAVIEW_CELL_INSENSITIVE
= 4,
1254 wxDATAVIEW_CELL_FOCUSED
= 8
1258 @class wxDataViewRenderer
1260 This class is used by wxDataViewCtrl to render the individual cells.
1261 One instance of a renderer class is owned by a wxDataViewColumn.
1262 There is a number of ready-to-use renderers provided:
1263 - wxDataViewTextRenderer,
1264 - wxDataViewIconTextRenderer,
1265 - wxDataViewToggleRenderer,
1266 - wxDataViewProgressRenderer,
1267 - wxDataViewBitmapRenderer,
1268 - wxDataViewDateRenderer,
1269 - wxDataViewSpinRenderer.
1270 - wxDataViewChoiceRenderer.
1272 Additionally, the user can write own renderers by deriving from
1273 wxDataViewCustomRenderer.
1275 The ::wxDataViewCellMode and ::wxDataViewCellRenderState flags accepted
1276 by the constructors respectively controls what actions the cell data allows
1277 and how the renderer should display its contents in a cell.
1282 class wxDataViewRenderer
: public wxObject
1288 wxDataViewRenderer(const wxString
& varianttype
,
1289 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1290 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1293 Enable or disable replacing parts of the item text with ellipsis to
1294 make it fit the column width.
1296 This method only makes sense for the renderers working with text, such
1297 as wxDataViewTextRenderer or wxDataViewIconTextRenderer.
1299 By default wxELLIPSIZE_MIDDLE is used.
1302 Ellipsization mode, use wxELLIPSIZE_NONE to disable.
1306 void EnableEllipsize(wxEllipsizeMode mode
= wxELLIPSIZE_MIDDLE
);
1309 Disable replacing parts of the item text with ellipsis.
1311 If ellipsizing is disabled, the string will be truncated if it doesn't
1314 This is the same as @code EnableEllipsize(wxELLIPSIZE_NONE) @endcode.
1318 void DisableEllipsize();
1321 Returns the alignment. See SetAlignment()
1323 virtual int GetAlignment() const;
1326 Returns the ellipsize mode used by the renderer.
1328 If the return value is wxELLIPSIZE_NONE, the text is simply truncated
1331 @see EnableEllipsize()
1333 wxEllipsizeMode
GetEllipsizeMode() const;
1336 Returns the cell mode.
1338 virtual wxDataViewCellMode
GetMode() const;
1341 Returns pointer to the owning wxDataViewColumn.
1343 wxDataViewColumn
* GetOwner() const;
1346 This methods retrieves the value from the renderer in order to
1347 transfer the value back to the data model.
1349 Returns @false on failure.
1351 virtual bool GetValue(wxVariant
& value
) const = 0;
1354 Returns a string with the type of the wxVariant supported by this renderer.
1356 wxString
GetVariantType() const;
1359 Sets the alignment of the renderer's content.
1360 The default value of @c wxDVR_DEFAULT_ALIGMENT indicates that the content
1361 should have the same alignment as the column header.
1363 The method is not implemented under OS X and the renderer always aligns
1364 its contents as the column header on that platform. The other platforms
1365 support both vertical and horizontal alignment.
1367 virtual void SetAlignment( int align
);
1369 Sets the owning wxDataViewColumn.
1370 This is usually called from within wxDataViewColumn.
1372 void SetOwner(wxDataViewColumn
* owner
);
1375 Set the value of the renderer (and thus its cell) to @a value.
1376 The internal code will then render this cell with this data.
1378 virtual bool SetValue(const wxVariant
& value
) = 0;
1381 Before data is committed to the data model, it is passed to this
1382 method where it can be checked for validity. This can also be
1383 used for checking a valid range or limiting the user input in
1384 a certain aspect (e.g. max number of characters or only alphanumeric
1385 input, ASCII only etc.). Return @false if the value is not valid.
1387 Please note that due to implementation limitations, this validation
1388 is done after the editing control already is destroyed and the
1389 editing process finished.
1391 virtual bool Validate(wxVariant
& value
);
1397 @class wxDataViewTextRenderer
1399 wxDataViewTextRenderer is used for rendering text.
1400 It supports in-place editing if desired.
1405 class wxDataViewTextRenderer
: public wxDataViewRenderer
1411 wxDataViewTextRenderer(const wxString
& varianttype
= "string",
1412 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1413 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1419 @class wxDataViewIconTextRenderer
1421 The wxDataViewIconTextRenderer class is used to display text with
1422 a small icon next to it as it is typically done in a file manager.
1424 This classes uses the wxDataViewIconText helper class to store its data.
1425 wxDataViewIconText can be converted to and from a wxVariant using the left
1431 class wxDataViewIconTextRenderer
: public wxDataViewRenderer
1437 wxDataViewIconTextRenderer(const wxString
& varianttype
= "wxDataViewIconText",
1438 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1439 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1445 @class wxDataViewProgressRenderer
1447 This class is used by wxDataViewCtrl to render progress bars.
1452 class wxDataViewProgressRenderer
: public wxDataViewRenderer
1458 wxDataViewProgressRenderer(const wxString
& label
= wxEmptyString
,
1459 const wxString
& varianttype
= "long",
1460 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1461 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1467 @class wxDataViewSpinRenderer
1469 This is a specialized renderer for rendering integer values.
1470 It supports modifying the values in-place by using a wxSpinCtrl.
1471 The renderer only support variants of type @e long.
1476 class wxDataViewSpinRenderer
: public wxDataViewCustomRenderer
1481 @a min and @a max indicate the minimum and maximum values for the wxSpinCtrl.
1483 wxDataViewSpinRenderer(int min
, int max
,
1484 wxDataViewCellMode mode
= wxDATAVIEW_CELL_EDITABLE
,
1485 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1491 @class wxDataViewToggleRenderer
1493 This class is used by wxDataViewCtrl to render toggle controls.
1498 class wxDataViewToggleRenderer
: public wxDataViewRenderer
1504 wxDataViewToggleRenderer(const wxString
& varianttype
= "bool",
1505 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1506 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1511 @class wxDataViewChoiceRenderer
1513 This class is used by wxDataViewCtrl to render choice controls.
1514 It stores a string so that SetValue() and GetValue() operate
1515 on a variant holding a string.
1521 class wxDataViewChoiceRenderer
: public wxDataViewRenderer
1527 wxDataViewChoiceRenderer( const wxArrayString
&choices
,
1528 wxDataViewCellMode mode
= wxDATAVIEW_CELL_EDITABLE
,
1529 int alignment
= wxDVR_DEFAULT_ALIGNMENT
);
1532 Returns the choice referred to by index.
1534 wxString
GetChoice(size_t index
) const;
1537 Returns all choices.
1539 const wxArrayString
& GetChoices() const;
1544 @class wxDataViewDateRenderer
1546 This class is used by wxDataViewCtrl to render calendar controls.
1551 class wxDataViewDateRenderer
: public wxDataViewRenderer
1557 wxDataViewDateRenderer(const wxString
& varianttype
= "datetime",
1558 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
1559 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1565 @class wxDataViewCustomRenderer
1567 You need to derive a new class from wxDataViewCustomRenderer in
1568 order to write a new renderer.
1570 You need to override at least wxDataViewRenderer::SetValue, wxDataViewRenderer::GetValue,
1571 wxDataViewCustomRenderer::GetSize and wxDataViewCustomRenderer::Render.
1573 If you want your renderer to support in-place editing then you also need to override
1574 wxDataViewCustomRenderer::HasEditorCtrl, wxDataViewCustomRenderer::CreateEditorCtrl
1575 and wxDataViewCustomRenderer::GetValueFromEditorCtrl.
1577 Note that a special event handler will be pushed onto that editor control
1578 which handles @e \<ENTER\> and focus out events in order to end the editing.
1583 class wxDataViewCustomRenderer
: public wxDataViewRenderer
1589 wxDataViewCustomRenderer(const wxString
& varianttype
= "string",
1590 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1591 int align
= -1, bool no_init
= false);
1596 virtual ~wxDataViewCustomRenderer();
1599 Override this to react to double clicks or ENTER.
1600 This method will only be called in wxDATAVIEW_CELL_ACTIVATABLE mode.
1602 virtual bool Activate( const wxRect
& cell
,
1603 wxDataViewModel
* model
,
1604 const wxDataViewItem
& item
,
1608 Override this to create the actual editor control once editing
1611 @a parent is the parent of the editor control, @a labelRect indicates the
1612 position and size of the editor control and @a value is its initial value:
1616 return new wxSpinCtrl( parent, wxID_ANY, wxEmptyString,
1617 labelRect.GetTopLeft(), labelRect.GetSize(), 0, 0, 100, l );
1621 virtual wxWindow
* CreateEditorCtrl(wxWindow
* parent
,
1623 const wxVariant
& value
);
1626 Return the attribute to be used for rendering.
1628 This function may be called from Render() implementation to use the
1629 attributes defined for the item if the renderer supports them.
1631 Notice that when Render() is called, the wxDC object passed to it is
1632 already set up to use the correct attributes (e.g. its font is set to
1633 bold or italic version if wxDataViewItemAttr::GetBold() or GetItalic()
1634 returns true) so it may not be necessary to call it explicitly if you
1635 only want to render text using the items attributes.
1639 const wxDataViewItemAttr
& GetAttr() const;
1642 Return size required to show content.
1644 virtual wxSize
GetSize() const = 0;
1647 Override this so that the renderer can get the value from the editor
1648 control (pointed to by @a editor):
1651 wxSpinCtrl *sc = (wxSpinCtrl*) editor;
1652 long l = sc->GetValue();
1658 virtual bool GetValueFromEditorCtrl(wxWindow
* editor
,
1662 Override this and make it return @true in order to
1663 indicate that this renderer supports in-place editing.
1665 virtual bool HasEditorCtrl() const;
1668 Override this to react to a left click.
1669 This method will only be called in @c wxDATAVIEW_CELL_ACTIVATABLE mode.
1671 virtual bool LeftClick( const wxPoint
& cursor
,
1673 wxDataViewModel
* model
,
1674 const wxDataViewItem
& item
,
1678 Override this to render the cell.
1679 Before this is called, wxDataViewRenderer::SetValue was called
1680 so that this instance knows what to render.
1682 virtual bool Render(wxRect cell
, wxDC
* dc
, int state
) = 0;
1685 This method should be called from within Render() whenever you need to
1687 This will ensure that the correct colour, font and vertical alignment will
1688 be chosen so the text will look the same as text drawn by native renderers.
1690 void RenderText(const wxString
& text
, int xoffset
, wxRect cell
,
1691 wxDC
* dc
, int state
);
1694 Override this to start a drag operation. Not yet supported.
1696 virtual bool StartDrag(const wxPoint
& cursor
,
1698 wxDataViewModel
* model
,
1699 const wxDataViewItem
& item
,
1706 @class wxDataViewBitmapRenderer
1708 This class is used by wxDataViewCtrl to render bitmap controls.
1713 class wxDataViewBitmapRenderer
: public wxDataViewRenderer
1719 wxDataViewBitmapRenderer(const wxString
& varianttype
= "wxBitmap",
1720 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1721 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1726 The flags used by wxDataViewColumn.
1727 Can be combined together.
1729 enum wxDataViewColumnFlags
1731 wxDATAVIEW_COL_RESIZABLE
= 1,
1732 wxDATAVIEW_COL_SORTABLE
= 2,
1733 wxDATAVIEW_COL_REORDERABLE
= 4,
1734 wxDATAVIEW_COL_HIDDEN
= 8
1738 @class wxDataViewColumn
1740 This class represents a column in a wxDataViewCtrl.
1741 One wxDataViewColumn is bound to one column in the data model to which the
1742 wxDataViewCtrl has been associated.
1744 An instance of wxDataViewRenderer is used by this class to render its data.
1749 class wxDataViewColumn
: public wxSettableHeaderColumn
1753 Constructs a text column.
1756 The title of the column.
1758 The class which will render the contents of this column.
1760 The index of the model's column which is associated with this object.
1762 The width of the column.
1763 The @c wxDVC_DEFAULT_WIDTH value is the fixed default value.
1765 The alignment of the column title.
1767 One or more flags of the ::wxDataViewColumnFlags enumeration.
1769 wxDataViewColumn(const wxString
& title
,
1770 wxDataViewRenderer
* renderer
,
1771 unsigned int model_column
,
1772 int width
= wxDVC_DEFAULT_WIDTH
,
1773 wxAlignment align
= wxALIGN_CENTER
,
1774 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1777 Constructs a bitmap column.
1780 The bitmap of the column.
1782 The class which will render the contents of this column.
1784 The index of the model's column which is associated with this object.
1786 The width of the column.
1787 The @c wxDVC_DEFAULT_WIDTH value is the fixed default value.
1789 The alignment of the column title.
1791 One or more flags of the ::wxDataViewColumnFlags enumeration.
1793 wxDataViewColumn(const wxBitmap
& bitmap
,
1794 wxDataViewRenderer
* renderer
,
1795 unsigned int model_column
,
1796 int width
= wxDVC_DEFAULT_WIDTH
,
1797 wxAlignment align
= wxALIGN_CENTER
,
1798 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1801 Returns the index of the column of the model, which this
1802 wxDataViewColumn is displaying.
1804 unsigned int GetModelColumn() const;
1807 Returns the owning wxDataViewCtrl.
1809 wxDataViewCtrl
* GetOwner() const;
1812 Returns the renderer of this wxDataViewColumn.
1814 @see wxDataViewRenderer.
1816 wxDataViewRenderer
* GetRenderer() const;
1822 @class wxDataViewListCtrl
1824 This class is a wxDataViewCtrl which internally uses a wxDataViewListStore
1825 and forwards most of its API to that class.
1827 The purpose of this class is to offer a simple way to display and
1828 edit a small table of data without having to write your own wxDataViewModel.
1831 wxDataViewListCtrl *listctrl = new wxDataViewListCtrl( parent, wxID_ANY );
1833 listctrl->AppendToggleColumn( "Toggle" );
1834 listctrl->AppendTextColumn( "Text" );
1836 wxVector<wxVariant> data;
1837 data.push_back( wxVariant(true) );
1838 data.push_back( wxVariant("row 1") );
1839 listctrl->AppendItem( data );
1842 data.push_back( wxVariant(false) );
1843 data.push_back( wxVariant("row 3") );
1844 listctrl->AppendItem( data );
1848 See wxDataViewCtrl for the list of supported styles.
1851 @beginEventEmissionTable
1852 See wxDataViewCtrl for the list of events emitted by this class.
1858 class wxDataViewListCtrl
: public wxDataViewCtrl
1864 wxDataViewListCtrl();
1867 Constructor. Calls Create().
1869 wxDataViewListCtrl( wxWindow
*parent
, wxWindowID id
,
1870 const wxPoint
& pos
= wxDefaultPosition
,
1871 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
1872 const wxValidator
& validator
= wxDefaultValidator
);
1875 Destructor. Deletes the image list if any.
1877 ~wxDataViewListCtrl();
1880 Creates the control and a wxDataViewListStore as its internal model.
1882 bool Create( wxWindow
*parent
, wxWindowID id
,
1883 const wxPoint
& pos
= wxDefaultPosition
,
1884 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
1885 const wxValidator
& validator
= wxDefaultValidator
);
1891 wxDataViewListStore
*GetStore();
1892 const wxDataViewListStore
*GetStore() const;
1896 Returns the position of given @e item or wxNOT_FOUND if it's
1901 int ItemToRow(const wxDataViewItem
&item
) const;
1904 Returns the wxDataViewItem at the given @e row.
1908 wxDataViewItem
RowToItem(int row
) const;
1912 @name Selection handling functions
1916 Returns index of the selected row or wxNOT_FOUND.
1918 @see wxDataViewCtrl::GetSelection()
1922 int GetSelectedRow() const;
1927 @see wxDataViewCtrl::Select()
1931 void SelectRow(unsigned row
);
1934 Unselects given row.
1936 @see wxDataViewCtrl::Unselect()
1940 void UnselectRow(unsigned row
);
1943 Returns true if @a row is selected.
1945 @see wxDataViewCtrl::IsSelected()
1949 bool IsRowSelected(unsigned row
) const;
1954 @name Column management functions
1959 Appends a column to the control and additionally appends a
1960 column to the store with the type string.
1962 virtual void AppendColumn( wxDataViewColumn
*column
);
1965 Appends a column to the control and additionally appends a
1966 column to the list store with the type @a varianttype.
1968 void AppendColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
1971 Appends a text column to the control and the store.
1973 See wxDataViewColumn::wxDataViewColumn for more info about
1976 wxDataViewColumn
*AppendTextColumn( const wxString
&label
,
1977 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1978 int width
= -1, wxAlignment align
= wxALIGN_LEFT
,
1979 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1982 Appends a toggle column to the control and the store.
1984 See wxDataViewColumn::wxDataViewColumn for more info about
1987 wxDataViewColumn
*AppendToggleColumn( const wxString
&label
,
1988 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
1989 int width
= -1, wxAlignment align
= wxALIGN_LEFT
,
1990 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1993 Appends a progress column to the control and the store.
1995 See wxDataViewColumn::wxDataViewColumn for more info about
1998 wxDataViewColumn
*AppendProgressColumn( const wxString
&label
,
1999 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
2000 int width
= -1, wxAlignment align
= wxALIGN_LEFT
,
2001 int flags
= wxDATAVIEW_COL_RESIZABLE
);
2004 Appends an icon-and-text column to the control and the store.
2006 See wxDataViewColumn::wxDataViewColumn for more info about
2009 wxDataViewColumn
*AppendIconTextColumn( const wxString
&label
,
2010 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
2011 int width
= -1, wxAlignment align
= wxALIGN_LEFT
,
2012 int flags
= wxDATAVIEW_COL_RESIZABLE
);
2015 Inserts a column to the control and additionally inserts a
2016 column to the store with the type string.
2018 virtual void InsertColumn( unsigned int pos
, wxDataViewColumn
*column
);
2021 Inserts a column to the control and additionally inserts a
2022 column to the list store with the type @a varianttype.
2024 void InsertColumn( unsigned int pos
, wxDataViewColumn
*column
,
2025 const wxString
&varianttype
);
2028 Prepends a column to the control and additionally prepends a
2029 column to the store with the type string.
2031 virtual void PrependColumn( wxDataViewColumn
*column
);
2034 Prepends a column to the control and additionally prepends a
2035 column to the list store with the type @a varianttype.
2037 void PrependColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
2043 @name Item management functions
2048 Appends an item (=row) to the control and store.
2050 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2053 Prepends an item (=row) to the control and store.
2055 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2058 Inserts an item (=row) to the control and store.
2060 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2063 Delete the row at position @a row.
2065 void DeleteItem( unsigned row
);
2068 Delete all items (= all rows).
2070 void DeleteAllItems();
2073 Sets the value in the store and update the control.
2075 void SetValue( const wxVariant
&value
, unsigned int row
, unsigned int col
);
2078 Returns the value from the store.
2080 void GetValue( wxVariant
&value
, unsigned int row
, unsigned int col
);
2083 Sets the value in the store and update the control.
2085 This method assumes that the string is stored in respective
2088 void SetTextValue( const wxString
&value
, unsigned int row
, unsigned int col
);
2091 Returns the value from the store.
2093 This method assumes that the string is stored in respective
2096 wxString
GetTextValue( unsigned int row
, unsigned int col
) const;
2099 Sets the value in the store and update the control.
2101 This method assumes that the boolean value is stored in
2104 void SetToggleValue( bool value
, unsigned int row
, unsigned int col
);
2107 Returns the value from the store.
2109 This method assumes that the boolean value is stored in
2112 bool GetToggleValue( unsigned int row
, unsigned int col
) const;
2119 @class wxDataViewTreeCtrl
2121 This class is a wxDataViewCtrl which internally uses a wxDataViewTreeStore
2122 and forwards most of its API to that class.
2123 Additionally, it uses a wxImageList to store a list of icons.
2125 The main purpose of this class is to provide a simple upgrade path for code
2129 See wxDataViewCtrl for the list of supported styles.
2132 @beginEventEmissionTable
2133 See wxDataViewCtrl for the list of events emitted by this class.
2138 @appearance{dataviewtreectrl.png}
2140 class wxDataViewTreeCtrl
: public wxDataViewCtrl
2146 wxDataViewTreeCtrl();
2153 wxDataViewTreeCtrl(wxWindow
* parent
, wxWindowID id
,
2154 const wxPoint
& pos
= wxDefaultPosition
,
2155 const wxSize
& size
= wxDefaultSize
,
2156 long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
2157 const wxValidator
& validator
= wxDefaultValidator
);
2160 Destructor. Deletes the image list if any.
2162 virtual ~wxDataViewTreeCtrl();
2165 Appends a container to the given @a parent.
2167 wxDataViewItem
AppendContainer(const wxDataViewItem
& parent
,
2168 const wxString
& text
,
2171 wxClientData
* data
= NULL
);
2174 Appends an item to the given @a parent.
2176 wxDataViewItem
AppendItem(const wxDataViewItem
& parent
,
2177 const wxString
& text
,
2179 wxClientData
* data
= NULL
);
2182 Creates the control and a wxDataViewTreeStore as its internal model.
2184 The default tree column created by this method is an editable column
2185 using wxDataViewIconTextRenderer as its renderer.
2187 bool Create(wxWindow
* parent
, wxWindowID id
,
2188 const wxPoint
& pos
= wxDefaultPosition
,
2189 const wxSize
& size
= wxDefaultSize
,
2190 long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
2191 const wxValidator
& validator
= wxDefaultValidator
);
2194 Calls the identical method from wxDataViewTreeStore.
2196 void DeleteAllItems();
2199 Calls the identical method from wxDataViewTreeStore.
2201 void DeleteChildren(const wxDataViewItem
& item
);
2204 Calls the identical method from wxDataViewTreeStore.
2206 void DeleteItem(const wxDataViewItem
& item
);
2209 Calls the identical method from wxDataViewTreeStore.
2211 int GetChildCount(const wxDataViewItem
& parent
) const;
2214 Returns the image list.
2216 wxImageList
* GetImageList();
2219 Calls the identical method from wxDataViewTreeStore.
2221 wxClientData
* GetItemData(const wxDataViewItem
& item
) const;
2224 Calls the identical method from wxDataViewTreeStore.
2226 const wxIcon
& GetItemExpandedIcon(const wxDataViewItem
& item
) const;
2229 Calls the identical method from wxDataViewTreeStore.
2231 const wxIcon
& GetItemIcon(const wxDataViewItem
& item
) const;
2234 Calls the identical method from wxDataViewTreeStore.
2236 wxString
GetItemText(const wxDataViewItem
& item
) const;
2239 Calls the identical method from wxDataViewTreeStore.
2241 wxDataViewItem
GetNthChild(const wxDataViewItem
& parent
,
2242 unsigned int pos
) const;
2248 wxDataViewTreeStore
* GetStore();
2249 const wxDataViewTreeStore
* GetStore() const;
2253 Calls the same method from wxDataViewTreeStore but uses
2254 an index position in the image list instead of a wxIcon.
2256 wxDataViewItem
InsertContainer(const wxDataViewItem
& parent
,
2257 const wxDataViewItem
& previous
,
2258 const wxString
& text
,
2261 wxClientData
* data
= NULL
);
2264 Calls the same method from wxDataViewTreeStore but uses
2265 an index position in the image list instead of a wxIcon.
2267 wxDataViewItem
InsertItem(const wxDataViewItem
& parent
,
2268 const wxDataViewItem
& previous
,
2269 const wxString
& text
,
2271 wxClientData
* data
= NULL
);
2274 Returns true if item is a container.
2276 bool IsContainer( const wxDataViewItem
& item
);
2279 Calls the same method from wxDataViewTreeStore but uses
2280 an index position in the image list instead of a wxIcon.
2282 wxDataViewItem
PrependContainer(const wxDataViewItem
& parent
,
2283 const wxString
& text
,
2286 wxClientData
* data
= NULL
);
2289 Calls the same method from wxDataViewTreeStore but uses
2290 an index position in the image list instead of a wxIcon.
2292 wxDataViewItem
PrependItem(const wxDataViewItem
& parent
,
2293 const wxString
& text
,
2295 wxClientData
* data
= NULL
);
2298 Sets the image list.
2300 void SetImageList(wxImageList
* imagelist
);
2303 Calls the identical method from wxDataViewTreeStore.
2305 void SetItemData(const wxDataViewItem
& item
, wxClientData
* data
);
2308 Calls the identical method from wxDataViewTreeStore.
2310 void SetItemExpandedIcon(const wxDataViewItem
& item
,
2311 const wxIcon
& icon
);
2314 Calls the identical method from wxDataViewTreeStore.
2316 void SetItemIcon(const wxDataViewItem
& item
, const wxIcon
& icon
);
2319 Calls the identical method from wxDataViewTreeStore.
2321 void SetItemText(const wxDataViewItem
& item
,
2322 const wxString
& text
);
2327 @class wxDataViewListStore
2329 wxDataViewListStore is a specialised wxDataViewModel for storing
2330 a simple table of data. Since it derives from wxDataViewIndexListModel
2331 its data is be accessed by row (i.e. by index) instead of only
2334 This class actually stores the values (therefore its name)
2335 and implements all virtual methods from the base classes so it can be
2336 used directly without having to derive any class from it, but it is
2337 mostly used from within wxDataViewListCtrl.
2343 class wxDataViewListStore
: public wxDataViewIndexListModel
2349 wxDataViewListStore();
2354 ~wxDataViewListStore();
2357 Prepends a data column.
2359 @a variantype indicates the type of values store in the column.
2361 This does not automatically fill in any (default) values in
2362 rows which exist in the store already.
2364 void PrependColumn( const wxString
&varianttype
);
2367 Inserts a data column before @a pos.
2369 @a variantype indicates the type of values store in the column.
2371 This does not automatically fill in any (default) values in
2372 rows which exist in the store already.
2374 void InsertColumn( unsigned int pos
, const wxString
&varianttype
);
2377 Appends a data column.
2379 @a variantype indicates the type of values store in the column.
2381 This does not automatically fill in any (default) values in
2382 rows which exist in the store already.
2384 void AppendColumn( const wxString
&varianttype
);
2387 Appends an item (=row) and fills it with @a values.
2389 The values must match the values specifies in the column
2390 in number and type. No (default) values are filled in
2393 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2396 Prepends an item (=row) and fills it with @a values.
2398 The values must match the values specifies in the column
2399 in number and type. No (default) values are filled in
2402 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2405 Inserts an item (=row) and fills it with @a values.
2407 The values must match the values specifies in the column
2408 in number and type. No (default) values are filled in
2411 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2414 Delete the item (=row) at position @a pos.
2416 void DeleteItem( unsigned pos
);
2419 Delete all item (=all rows) in the store.
2421 void DeleteAllItems();
2424 Overridden from wxDataViewModel
2426 virtual unsigned int GetColumnCount() const;
2429 Overridden from wxDataViewModel
2431 virtual wxString
GetColumnType( unsigned int col
) const;
2434 Overridden from wxDataViewIndexListModel
2436 virtual void GetValueByRow( wxVariant
&value
,
2437 unsigned int row
, unsigned int col
) const;
2440 Overridden from wxDataViewIndexListModel
2442 virtual bool SetValueByRow( const wxVariant
&value
,
2443 unsigned int row
, unsigned int col
);
2448 @class wxDataViewTreeStore
2450 wxDataViewTreeStore is a specialised wxDataViewModel for storing simple
2451 trees very much like wxTreeCtrl does and it offers a similar API.
2453 This class actually stores the entire tree and the values (therefore its name)
2454 and implements all virtual methods from the base class so it can be used directly
2455 without having to derive any class from it, but it is mostly used from within
2461 class wxDataViewTreeStore
: public wxDataViewModel
2465 Constructor. Creates the invisible root node internally.
2467 wxDataViewTreeStore();
2472 virtual ~wxDataViewTreeStore();
2477 wxDataViewItem
AppendContainer(const wxDataViewItem
& parent
,
2478 const wxString
& text
,
2479 const wxIcon
& icon
= wxNullIcon
,
2480 const wxIcon
& expanded
= wxNullIcon
,
2481 wxClientData
* data
= NULL
);
2486 wxDataViewItem
AppendItem(const wxDataViewItem
& parent
,
2487 const wxString
& text
,
2488 const wxIcon
& icon
= wxNullIcon
,
2489 wxClientData
* data
= NULL
);
2492 Delete all item in the model.
2494 void DeleteAllItems();
2497 Delete all children of the item, but not the item itself.
2499 void DeleteChildren(const wxDataViewItem
& item
);
2504 void DeleteItem(const wxDataViewItem
& item
);
2507 Return the number of children of item.
2509 int GetChildCount(const wxDataViewItem
& parent
) const;
2512 Returns the client data associated with the item.
2514 wxClientData
* GetItemData(const wxDataViewItem
& item
) const;
2517 Returns the icon to display in expanded containers.
2519 const wxIcon
& GetItemExpandedIcon(const wxDataViewItem
& item
) const;
2522 Returns the icon of the item.
2524 const wxIcon
& GetItemIcon(const wxDataViewItem
& item
) const;
2527 Returns the text of the item.
2529 wxString
GetItemText(const wxDataViewItem
& item
) const;
2532 Returns the nth child item of item.
2534 wxDataViewItem
GetNthChild(const wxDataViewItem
& parent
,
2535 unsigned int pos
) const;
2538 Inserts a container after @a previous.
2540 wxDataViewItem
InsertContainer(const wxDataViewItem
& parent
,
2541 const wxDataViewItem
& previous
,
2542 const wxString
& text
,
2543 const wxIcon
& icon
= wxNullIcon
,
2544 const wxIcon
& expanded
= wxNullIcon
,
2545 wxClientData
* data
= NULL
);
2548 Inserts an item after @a previous.
2550 wxDataViewItem
InsertItem(const wxDataViewItem
& parent
,
2551 const wxDataViewItem
& previous
,
2552 const wxString
& text
,
2553 const wxIcon
& icon
= wxNullIcon
,
2554 wxClientData
* data
= NULL
);
2557 Inserts a container before the first child item or @a parent.
2559 wxDataViewItem
PrependContainer(const wxDataViewItem
& parent
,
2560 const wxString
& text
,
2561 const wxIcon
& icon
= wxNullIcon
,
2562 const wxIcon
& expanded
= wxNullIcon
,
2563 wxClientData
* data
= NULL
);
2566 Inserts an item before the first child item or @a parent.
2568 wxDataViewItem
PrependItem(const wxDataViewItem
& parent
,
2569 const wxString
& text
,
2570 const wxIcon
& icon
= wxNullIcon
,
2571 wxClientData
* data
= NULL
);
2574 Sets the client data associated with the item.
2576 void SetItemData(const wxDataViewItem
& item
, wxClientData
* data
);
2579 Sets the expanded icon for the item.
2581 void SetItemExpandedIcon(const wxDataViewItem
& item
,
2582 const wxIcon
& icon
);
2585 Sets the icon for the item.
2587 void SetItemIcon(const wxDataViewItem
& item
, const wxIcon
& icon
);
2592 @class wxDataViewIconText
2594 wxDataViewIconText is used by wxDataViewIconTextRenderer for data transfer.
2595 This class can be converted to and from a wxVariant.
2600 class wxDataViewIconText
: public wxObject
2607 wxDataViewIconText(const wxString
& text
= wxEmptyString
,
2608 const wxIcon
& icon
= wxNullIcon
);
2609 wxDataViewIconText(const wxDataViewIconText
& other
);
2615 const wxIcon
& GetIcon() const;
2620 wxString
GetText() const;
2625 void SetIcon(const wxIcon
& icon
);
2630 void SetText(const wxString
& text
);
2636 @class wxDataViewEvent
2638 This is the event class for the wxDataViewCtrl notifications.
2640 @beginEventTable{wxDataViewEvent}
2641 @event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)}
2642 Process a @c wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event.
2643 @event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)}
2644 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED event.
2645 @event{EVT_DATAVIEW_ITEM_EDITING_STARTED(id, func)}
2646 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED event.
2647 @event{EVT_DATAVIEW_ITEM_EDITING_DONE(id, func)}
2648 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE event.
2649 @event{EVT_DATAVIEW_ITEM_COLLAPSING(id, func)}
2650 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING event.
2651 @event{EVT_DATAVIEW_ITEM_COLLAPSED(id, func)}
2652 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED event.
2653 @event{EVT_DATAVIEW_ITEM_EXPANDING(id, func)}
2654 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING event.
2655 @event{EVT_DATAVIEW_ITEM_EXPANDED(id, func)}
2656 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED event.
2657 @event{EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, func)}
2658 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED event.
2659 @event{EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, func)}
2660 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU event.
2661 @event{EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, func)}
2662 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICKED event.
2663 @event{EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK(id, func)}
2664 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED event.
2665 @event{EVT_DATAVIEW_COLUMN_SORTED(id, func)}
2666 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED event.
2667 @event{EVT_DATAVIEW_COLUMN_REORDERED(id, func)}
2668 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED event.
2669 @event{EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, func)}
2670 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG event.
2671 @event{EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, func)}
2672 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE event.
2673 @event{EVT_DATAVIEW_ITEM_DROP(id, func)}
2674 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_DROP event.
2675 @event{EVT_DATAVIEW_CACHE_HINT(id, func)}
2676 Process a @c wxEVT_COMMAND_DATAVIEW_CACHE_HINT event.
2680 @category{events,dvc}
2682 class wxDataViewEvent
: public wxNotifyEvent
2686 Constructor. Typically used by wxWidgets internals only.
2688 wxDataViewEvent(wxEventType commandType
= wxEVT_NULL
,
2692 Returns the position of the column in the control or -1
2693 if no column field was set by the event emitter.
2695 int GetColumn() const;
2698 Returns a pointer to the wxDataViewColumn from which
2699 the event was emitted or @NULL.
2701 wxDataViewColumn
* GetDataViewColumn() const;
2704 Returns the wxDataViewModel associated with the event.
2706 wxDataViewModel
* GetModel() const;
2709 Returns the position of a context menu event in screen coordinates.
2711 wxPoint
GetPosition() const;
2714 Returns a reference to a value.
2716 const wxVariant
& GetValue() const;
2719 Can be used to determine whether the new value is going to be accepted
2720 in wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE handler.
2722 Returns @true if editing the item was cancelled or if the user tried to
2723 enter an invalid value (refused by wxDataViewRenderer::Validate()). If
2724 this method returns @false, it means that the value in the model is
2725 about to be changed to the new one.
2727 Notice that wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE event handler can
2728 call wxNotifyEvent::Veto() to prevent this from happening.
2730 Currently support for setting this field and for vetoing the change is
2731 only available in the generic version of wxDataViewCtrl, i.e. under MSW
2732 but not GTK nor OS X.
2736 bool IsEditCancelled() const;
2739 Sets the column index associated with this event.
2741 void SetColumn(int col
);
2744 For @c wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only.
2746 void SetDataViewColumn(wxDataViewColumn
* col
);
2749 Sets the dataview model associated with this event.
2751 void SetModel(wxDataViewModel
* model
);
2754 Sets the value associated with this event.
2756 void SetValue(const wxVariant
& value
);
2759 Set wxDataObject for data transfer within a drag operation.
2761 void SetDataObject( wxDataObject
*obj
);
2764 Used internally. Gets associated wxDataObject for data transfer
2765 within a drag operation.
2767 wxDataObject
*GetDataObject() const;
2770 Used internally. Sets the wxDataFormat during a drop operation.
2772 void SetDataFormat( const wxDataFormat
&format
);
2775 Gets the wxDataFormat during a drop operation.
2777 wxDataFormat
GetDataFormat() const;
2780 Used internally. Sets the data size for a drop data transfer.
2782 void SetDataSize( size_t size
);
2785 Gets the data size for a drop data transfer.
2787 size_t GetDataSize() const;
2790 Used internally. Sets the data buffer for a drop data transfer.
2792 void SetDataBuffer( void* buf
);
2795 Gets the data buffer for a drop data transfer.
2797 void *GetDataBuffer() const;
2800 Return the first row that will be displayed.
2802 int GetCacheFrom() const;
2805 Return the last row that will be displayed.
2807 int GetCacheTo() const;