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 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 futher 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 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 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 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 @style{wxDV_HORIZ_RULES}
671 Display fine rules between row if supported.
672 @style{wxDV_VERT_RULES}
673 Display fine rules between columns is supported.
674 @style{wxDV_VARIABLE_LINE_HEIGHT}
675 Allow variable line heights.
676 This can be inefficient when displaying large number of items.
677 @style{wxDV_NO_HEADER}
678 Do not show column headers (which are shown by default).
681 @beginEventEmissionTable{wxDataViewEvent}
682 @event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)}
683 Process a @c wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event.
684 @event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)}
685 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED event.
686 @event{EVT_DATAVIEW_ITEM_START_EDITING(id, func)}
687 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED event. This
688 event can be vetoed in order to prevent editing on an item by item
689 basis. Still experimental.
690 @event{EVT_DATAVIEW_ITEM_EDITING_STARTED(id, func)}
691 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED event.
692 @event{EVT_DATAVIEW_ITEM_EDITING_DONE(id, func)}
693 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE event.
694 @event{EVT_DATAVIEW_ITEM_COLLAPSING(id, func)}
695 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING event.
696 @event{EVT_DATAVIEW_ITEM_COLLAPSED(id, func)}
697 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED event.
698 @event{EVT_DATAVIEW_ITEM_EXPANDING(id, func)}
699 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING event.
700 @event{EVT_DATAVIEW_ITEM_EXPANDED(id, func)}
701 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED event.
702 @event{EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, func)}
703 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED event.
704 @event{EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, func)}
705 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU event.
706 @event{EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, func)}
707 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICKED event.
708 @event{EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK(id, func)}
709 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED event.
710 @event{EVT_DATAVIEW_COLUMN_SORTED(id, func)}
711 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED event.
712 @event{EVT_DATAVIEW_COLUMN_REORDERED(id, func)}
713 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED event.
714 @event{EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, func)}
715 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG event.
716 @event{EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, func)}
717 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE event.
718 @event{EVT_DATAVIEW_ITEM_DROP(id, func)}
719 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_DROP event.
724 @appearance{dataviewctrl.png}
726 class wxDataViewCtrl
: public wxControl
735 Constructor. Calls Create().
737 wxDataViewCtrl(wxWindow
* parent
, wxWindowID id
,
738 const wxPoint
& pos
= wxDefaultPosition
,
739 const wxSize
& size
= wxDefaultSize
,
741 const wxValidator
& validator
= wxDefaultValidator
,
742 const wxString
& name
= wxDataViewCtrlNameStr
);
747 virtual ~wxDataViewCtrl();
750 Appends a wxDataViewColumn to the control. Returns @true on success.
752 Note that there is a number of short cut methods which implicitly create
753 a wxDataViewColumn and a wxDataViewRenderer for it (see below).
755 virtual bool AppendColumn(wxDataViewColumn
* col
);
758 Prepends a wxDataViewColumn to the control. Returns @true on success.
760 Note that there is a number of short cut methods which implicitly create
761 a wxDataViewColumn and a wxDataViewRenderer for it.
763 virtual bool PrependColumn(wxDataViewColumn
* col
);
766 Inserts a wxDataViewColumn to the control. Returns @true on success.
768 virtual bool InsertColumn(unsigned int pos
, wxDataViewColumn
* col
);
772 Appends a column for rendering a bitmap. Returns the wxDataViewColumn
773 created in the function or @NULL on failure.
775 wxDataViewColumn
* AppendBitmapColumn(const wxString
& label
,
776 unsigned int model_column
,
777 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
779 wxAlignment align
= wxALIGN_CENTER
,
780 int flags
= wxDATAVIEW_COL_RESIZABLE
);
781 wxDataViewColumn
* AppendBitmapColumn(const wxBitmap
& label
,
782 unsigned int model_column
,
783 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
785 wxAlignment align
= wxALIGN_CENTER
,
786 int flags
= wxDATAVIEW_COL_RESIZABLE
);
791 Appends a column for rendering a date. Returns the wxDataViewColumn
792 created in the function or @NULL on failure.
794 @note The @a align parameter is applied to both the column header and
797 wxDataViewColumn
* AppendDateColumn(const wxString
& label
,
798 unsigned int model_column
,
799 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
801 wxAlignment align
= wxALIGN_NOT
,
802 int flags
= wxDATAVIEW_COL_RESIZABLE
);
803 wxDataViewColumn
* AppendDateColumn(const wxBitmap
& label
,
804 unsigned int model_column
,
805 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
807 wxAlignment align
= wxALIGN_NOT
,
808 int flags
= wxDATAVIEW_COL_RESIZABLE
);
813 Appends a column for rendering text with an icon. Returns the wxDataViewColumn
814 created in the function or @NULL on failure.
815 This method uses the wxDataViewIconTextRenderer class.
817 @note The @a align parameter is applied to both the column header and
820 wxDataViewColumn
* AppendIconTextColumn(const wxString
& label
,
821 unsigned int model_column
,
822 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
824 wxAlignment align
= wxALIGN_NOT
,
825 int flags
= wxDATAVIEW_COL_RESIZABLE
);
826 wxDataViewColumn
* AppendIconTextColumn(const wxBitmap
& label
,
827 unsigned int model_column
,
828 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
830 wxAlignment align
= wxALIGN_NOT
,
831 int flags
= wxDATAVIEW_COL_RESIZABLE
);
836 Appends a column for rendering a progress indicator. Returns the
837 wxDataViewColumn created in the function or @NULL on failure.
839 @note The @a align parameter is applied to both the column header and
842 wxDataViewColumn
* AppendProgressColumn(const wxString
& label
,
843 unsigned int model_column
,
844 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
846 wxAlignment align
= wxALIGN_CENTER
,
847 int flags
= wxDATAVIEW_COL_RESIZABLE
);
848 wxDataViewColumn
* AppendProgressColumn(const wxBitmap
& label
,
849 unsigned int model_column
,
850 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
852 wxAlignment align
= wxALIGN_CENTER
,
853 int flags
= wxDATAVIEW_COL_RESIZABLE
);
858 Appends a column for rendering text. Returns the wxDataViewColumn
859 created in the function or @NULL on failure.
861 @note The @a align parameter is applied to both the column header and
864 wxDataViewColumn
* AppendTextColumn(const wxString
& label
,
865 unsigned int model_column
,
866 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
868 wxAlignment align
= wxALIGN_NOT
,
869 int flags
= wxDATAVIEW_COL_RESIZABLE
);
870 wxDataViewColumn
* AppendTextColumn(const wxBitmap
& label
,
871 unsigned int model_column
,
872 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
874 wxAlignment align
= wxALIGN_NOT
,
875 int flags
= wxDATAVIEW_COL_RESIZABLE
);
880 Appends a column for rendering a toggle. Returns the wxDataViewColumn
881 created in the function or @NULL on failure.
883 @note The @a align parameter is applied to both the column header and
886 wxDataViewColumn
* AppendToggleColumn(const wxString
& label
,
887 unsigned int model_column
,
888 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
890 wxAlignment align
= wxALIGN_CENTER
,
891 int flags
= wxDATAVIEW_COL_RESIZABLE
);
892 wxDataViewColumn
* AppendToggleColumn(const wxBitmap
& label
,
893 unsigned int model_column
,
894 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
896 wxAlignment align
= wxALIGN_CENTER
,
897 int flags
= wxDATAVIEW_COL_RESIZABLE
);
901 Associates a wxDataViewModel with the control.
902 This increases the reference count of the model by 1.
904 virtual bool AssociateModel(wxDataViewModel
* model
);
909 virtual bool ClearColumns();
914 virtual void Collapse(const wxDataViewItem
& item
);
917 Create the control. Useful for two step creation.
919 bool Create(wxWindow
* parent
, wxWindowID id
,
920 const wxPoint
& pos
= wxDefaultPosition
,
921 const wxSize
& size
= wxDefaultSize
,
923 const wxValidator
& validator
= wxDefaultValidator
,
924 const wxString
& name
= wxDataViewCtrlNameStr
);
927 Deletes given column.
929 virtual bool DeleteColumn(wxDataViewColumn
* column
);
932 Enable drag operations using the given @a format.
934 virtual bool EnableDragSource( const wxDataFormat
&format
);
937 Enable drop operations using the given @a format.
939 virtual bool EnableDropTarget( const wxDataFormat
&format
);
942 Call this to ensure that the given item is visible.
944 virtual void EnsureVisible(const wxDataViewItem
& item
,
945 const wxDataViewColumn
* column
= NULL
);
950 virtual void Expand(const wxDataViewItem
& item
);
953 Expands all ancestors of the @a item. This method also
954 ensures that the item itself as well as all ancestor
955 items have been read from the model by the control.
957 virtual void ExpandAncestors( const wxDataViewItem
& item
);
960 Returns pointer to the column. @a pos refers to the position in the
961 control which may change after reordering columns by the user.
963 virtual wxDataViewColumn
* GetColumn(unsigned int pos
) const;
966 Returns the number of columns.
968 virtual unsigned int GetColumnCount() const;
971 Returns the position of the column or -1 if not found in the control.
973 virtual int GetColumnPosition(const wxDataViewColumn
* column
) const;
976 Returns column containing the expanders.
978 wxDataViewColumn
* GetExpanderColumn() const;
981 Returns the currently focused item.
983 This is the item that the keyboard commands apply to. It may be invalid
984 if there is no focus currently.
986 This method is mostly useful for the controls with @c wxDV_MULTIPLE
987 style as in the case of single selection it returns the same thing as
990 Notice that under all platforms except Mac OS X the currently focused
991 item may be selected or not but under OS X the current item is always
994 @see SetCurrentItem()
998 wxDataViewItem
GetCurrentItem() const;
1001 Returns indentation.
1003 int GetIndent() const;
1008 virtual wxRect
GetItemRect(const wxDataViewItem
& item
,
1009 const wxDataViewColumn
* col
= NULL
) const;
1012 Returns pointer to the data model associated with the control (if any).
1014 wxDataViewModel
* GetModel();
1017 Returns first selected item or an invalid item if none is selected.
1019 virtual wxDataViewItem
GetSelection() const;
1022 Fills @a sel with currently selected items and returns their number.
1024 virtual int GetSelections(wxDataViewItemArray
& sel
) const;
1027 Returns the wxDataViewColumn currently responsible for sorting
1028 or @NULL if none has been selected.
1030 virtual wxDataViewColumn
* GetSortingColumn() const;
1035 virtual void HitTest(const wxPoint
& point
, wxDataViewItem
& item
,
1036 wxDataViewColumn
*& col
) const;
1039 Return @true if the item is expanded.
1041 virtual bool IsExpanded(const wxDataViewItem
& item
) const;
1044 Return @true if the item is selected.
1046 virtual bool IsSelected(const wxDataViewItem
& item
) const;
1049 Select the given item.
1051 In single selection mode this changes the (unique) currently selected
1052 item. In multi selection mode, the @a item is selected and the
1053 previously selected items remain selected.
1055 virtual void Select(const wxDataViewItem
& item
);
1060 virtual void SelectAll();
1063 Set which column shall contain the tree-like expanders.
1065 void SetExpanderColumn(wxDataViewColumn
* col
);
1068 Changes the currently focused item.
1070 The @a item parameter must be valid, there is no way to remove the
1071 current item from the control.
1073 In single selection mode, calling this method is the same as calling
1074 Select() and is thus not very useful. In multiple selection mode this
1075 method only moves the current item however without changing the
1076 selection except under OS X where the current item is always selected,
1077 so calling SetCurrentItem() selects @a item if it hadn't been selected
1080 @see GetCurrentItem()
1084 void SetCurrentItem(const wxDataViewItem
& item
);
1087 Sets the indendation.
1089 void SetIndent(int indent
);
1092 Sets the selection to the array of wxDataViewItems.
1094 virtual void SetSelections(const wxDataViewItemArray
& sel
);
1097 Unselect the given item.
1099 virtual void Unselect(const wxDataViewItem
& item
);
1103 This method only has effect if multiple selections are allowed.
1105 virtual void UnselectAll();
1111 @class wxDataViewModelNotifier
1113 A wxDataViewModelNotifier instance is owned by a wxDataViewModel and mirrors
1114 its notification interface.
1115 See the documentation of that class for further information.
1120 class wxDataViewModelNotifier
1126 wxDataViewModelNotifier();
1131 virtual ~wxDataViewModelNotifier();
1134 Called by owning model.
1136 virtual bool Cleared() = 0;
1139 Get owning wxDataViewModel.
1141 wxDataViewModel
* GetOwner() const;
1144 Called by owning model.
1146 virtual bool ItemAdded(const wxDataViewItem
& parent
,
1147 const wxDataViewItem
& item
) = 0;
1150 Called by owning model.
1152 virtual bool ItemChanged(const wxDataViewItem
& item
) = 0;
1155 Called by owning model.
1157 virtual bool ItemDeleted(const wxDataViewItem
& parent
,
1158 const wxDataViewItem
& item
) = 0;
1161 Called by owning model.
1163 virtual bool ItemsAdded(const wxDataViewItem
& parent
,
1164 const wxDataViewItemArray
& items
);
1167 Called by owning model.
1169 virtual bool ItemsChanged(const wxDataViewItemArray
& items
);
1172 Called by owning model.
1174 virtual bool ItemsDeleted(const wxDataViewItem
& parent
,
1175 const wxDataViewItemArray
& items
);
1178 Called by owning model.
1180 virtual void Resort() = 0;
1183 Set owner of this notifier. Used internally.
1185 void SetOwner(wxDataViewModel
* owner
);
1188 Called by owning model.
1190 virtual bool ValueChanged(const wxDataViewItem
& item
, unsigned int col
) = 0;
1195 The mode of a data-view cell; see wxDataViewRenderer for more info.
1197 enum wxDataViewCellMode
1199 wxDATAVIEW_CELL_INERT
,
1202 Indicates that the user can double click the cell and something will
1203 happen (e.g. a window for editing a date will pop up).
1205 wxDATAVIEW_CELL_ACTIVATABLE
,
1208 Indicates that the user can edit the data in-place, i.e. an control
1209 will show up after a slow click on the cell. This behaviour is best
1210 known from changing the filename in most file managers etc.
1212 wxDATAVIEW_CELL_EDITABLE
1216 The values of this enum controls how a wxDataViewRenderer should display
1217 its contents in a cell.
1219 enum wxDataViewCellRenderState
1221 wxDATAVIEW_CELL_SELECTED
= 1,
1222 wxDATAVIEW_CELL_PRELIT
= 2,
1223 wxDATAVIEW_CELL_INSENSITIVE
= 4,
1224 wxDATAVIEW_CELL_FOCUSED
= 8
1228 @class wxDataViewRenderer
1230 This class is used by wxDataViewCtrl to render the individual cells.
1231 One instance of a renderer class is owned by a wxDataViewColumn.
1232 There is a number of ready-to-use renderers provided:
1233 - wxDataViewTextRenderer,
1234 - wxDataViewIconTextRenderer,
1235 - wxDataViewToggleRenderer,
1236 - wxDataViewProgressRenderer,
1237 - wxDataViewBitmapRenderer,
1238 - wxDataViewDateRenderer,
1239 - wxDataViewSpinRenderer.
1240 - wxDataViewChoiceRenderer.
1242 Additionally, the user can write own renderers by deriving from
1243 wxDataViewCustomRenderer.
1245 The ::wxDataViewCellMode and ::wxDataViewCellRenderState flags accepted
1246 by the constructors respectively controls what actions the cell data allows
1247 and how the renderer should display its contents in a cell.
1252 class wxDataViewRenderer
: public wxObject
1258 wxDataViewRenderer(const wxString
& varianttype
,
1259 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1260 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1263 Enable or disable replacing parts of the item text with ellipsis to
1264 make it fit the column width.
1266 This method only makes sense for the renderers working with text, such
1267 as wxDataViewTextRenderer or wxDataViewIconTextRenderer.
1269 By default wxELLIPSIZE_MIDDLE is used.
1272 Ellipsization mode, use wxELLIPSIZE_NONE to disable.
1276 void EnableEllipsize(wxEllipsizeMode mode
= wxELLIPSIZE_MIDDLE
);
1279 Disable replacing parts of the item text with ellipsis.
1281 If ellipsizing is disabled, the string will be truncated if it doesn't
1284 This is the same as @code EnableEllipsize(wxELLIPSIZE_NONE) @endcode.
1288 void DisableEllipsize();
1291 Returns the alignment. See SetAlignment()
1293 virtual int GetAlignment() const;
1296 Returns the ellipsize mode used by the renderer.
1298 If the return value is wxELLIPSIZE_NONE, the text is simply truncated
1301 @see EnableEllipsize()
1303 wxEllipsizeMode
GetEllipsizeMode() const;
1306 Returns the cell mode.
1308 virtual wxDataViewCellMode
GetMode() const;
1311 Returns pointer to the owning wxDataViewColumn.
1313 wxDataViewColumn
* GetOwner() const;
1316 This methods retrieves the value from the renderer in order to
1317 transfer the value back to the data model.
1319 Returns @false on failure.
1321 virtual bool GetValue(wxVariant
& value
) const = 0;
1324 Returns a string with the type of the wxVariant supported by this renderer.
1326 wxString
GetVariantType() const;
1329 Sets the alignment of the renderer's content.
1330 The default value of @c wxDVR_DEFAULT_ALIGMENT indicates that the content
1331 should have the same alignment as the column header.
1333 The method is not implemented under OS X and the renderer always aligns
1334 its contents as the column header on that platform. The other platforms
1335 support both vertical and horizontal alignment.
1337 virtual void SetAlignment( int align
);
1339 Sets the owning wxDataViewColumn.
1340 This is usually called from within wxDataViewColumn.
1342 void SetOwner(wxDataViewColumn
* owner
);
1345 Set the value of the renderer (and thus its cell) to @a value.
1346 The internal code will then render this cell with this data.
1348 virtual bool SetValue(const wxVariant
& value
) = 0;
1351 Before data is committed to the data model, it is passed to this
1352 method where it can be checked for validity. This can also be
1353 used for checking a valid range or limiting the user input in
1354 a certain aspect (e.g. max number of characters or only alphanumeric
1355 input, ASCII only etc.). Return @false if the value is not valid.
1357 Please note that due to implementation limitations, this validation
1358 is done after the editing control already is destroyed and the
1359 editing process finished.
1361 virtual bool Validate(wxVariant
& value
);
1367 @class wxDataViewTextRenderer
1369 wxDataViewTextRenderer is used for rendering text.
1370 It supports in-place editing if desired.
1375 class wxDataViewTextRenderer
: public wxDataViewRenderer
1381 wxDataViewTextRenderer(const wxString
& varianttype
= "string",
1382 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1383 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1389 @class wxDataViewIconTextRenderer
1391 The wxDataViewIconTextRenderer class is used to display text with
1392 a small icon next to it as it is typically done in a file manager.
1394 This classes uses the wxDataViewIconText helper class to store its data.
1395 wxDataViewIconText can be converted to and from a wxVariant using the left
1401 class wxDataViewIconTextRenderer
: public wxDataViewRenderer
1407 wxDataViewIconTextRenderer(const wxString
& varianttype
= "wxDataViewIconText",
1408 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1409 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1415 @class wxDataViewProgressRenderer
1417 This class is used by wxDataViewCtrl to render progress bars.
1422 class wxDataViewProgressRenderer
: public wxDataViewRenderer
1428 wxDataViewProgressRenderer(const wxString
& label
= wxEmptyString
,
1429 const wxString
& varianttype
= "long",
1430 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1431 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1437 @class wxDataViewSpinRenderer
1439 This is a specialized renderer for rendering integer values.
1440 It supports modifying the values in-place by using a wxSpinCtrl.
1441 The renderer only support variants of type @e long.
1446 class wxDataViewSpinRenderer
: public wxDataViewCustomRenderer
1451 @a min and @a max indicate the minimum and maximum values for the wxSpinCtrl.
1453 wxDataViewSpinRenderer(int min
, int max
,
1454 wxDataViewCellMode mode
= wxDATAVIEW_CELL_EDITABLE
,
1455 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1461 @class wxDataViewToggleRenderer
1463 This class is used by wxDataViewCtrl to render toggle controls.
1468 class wxDataViewToggleRenderer
: public wxDataViewRenderer
1474 wxDataViewToggleRenderer(const wxString
& varianttype
= "bool",
1475 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1476 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1481 @class wxDataViewChoiceRenderer
1483 This class is used by wxDataViewCtrl to render choice controls.
1484 It stores a string so that SetValue() and GetValue() operate
1485 on a variant holding a string.
1491 class wxDataViewChoiceRenderer
: public wxDataViewRenderer
1497 wxDataViewChoiceRenderer( const wxArrayString
&choices
,
1498 wxDataViewCellMode mode
= wxDATAVIEW_CELL_EDITABLE
,
1499 int alignment
= wxDVR_DEFAULT_ALIGNMENT
);
1502 Returns the choice referred to by index.
1504 wxString
GetChoice(size_t index
) const;
1507 Returns all choices.
1509 const wxArrayString
& GetChoices() const;
1514 @class wxDataViewDateRenderer
1516 This class is used by wxDataViewCtrl to render calendar controls.
1521 class wxDataViewDateRenderer
: public wxDataViewRenderer
1527 wxDataViewDateRenderer(const wxString
& varianttype
= "datetime",
1528 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
1529 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1535 @class wxDataViewCustomRenderer
1537 You need to derive a new class from wxDataViewCustomRenderer in
1538 order to write a new renderer.
1540 You need to override at least wxDataViewRenderer::SetValue, wxDataViewRenderer::GetValue,
1541 wxDataViewCustomRenderer::GetSize and wxDataViewCustomRenderer::Render.
1543 If you want your renderer to support in-place editing then you also need to override
1544 wxDataViewCustomRenderer::HasEditorCtrl, wxDataViewCustomRenderer::CreateEditorCtrl
1545 and wxDataViewCustomRenderer::GetValueFromEditorCtrl.
1547 Note that a special event handler will be pushed onto that editor control
1548 which handles @e \<ENTER\> and focus out events in order to end the editing.
1553 class wxDataViewCustomRenderer
: public wxDataViewRenderer
1559 wxDataViewCustomRenderer(const wxString
& varianttype
= "string",
1560 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1561 int align
= -1, bool no_init
= false);
1566 virtual ~wxDataViewCustomRenderer();
1569 Override this to react to double clicks or ENTER.
1570 This method will only be called in wxDATAVIEW_CELL_ACTIVATABLE mode.
1572 virtual bool Activate( wxRect cell
,
1573 wxDataViewModel
* model
,
1574 const wxDataViewItem
& item
,
1578 Override this to create the actual editor control once editing
1581 @a parent is the parent of the editor control, @a labelRect indicates the
1582 position and size of the editor control and @a value is its initial value:
1586 return new wxSpinCtrl( parent, wxID_ANY, wxEmptyString,
1587 labelRect.GetTopLeft(), labelRect.GetSize(), 0, 0, 100, l );
1591 virtual wxControl
* CreateEditorCtrl(wxWindow
* parent
,
1593 const wxVariant
& value
);
1596 Return the attribute to be used for rendering.
1598 This function may be called from Render() implementation to use the
1599 attributes defined for the item if the renderer supports them.
1601 Notice that when Render() is called, the wxDC object passed to it is
1602 already set up to use the correct attributes (e.g. its font is set to
1603 bold or italic version if wxDataViewItemAttr::GetBold() or GetItalic()
1604 returns true) so it may not be necessary to call it explicitly if you
1605 only want to render text using the items attributes.
1609 const wxDataViewItemAttr
& GetAttr() const;
1612 Return size required to show content.
1614 virtual wxSize
GetSize() const = 0;
1617 Override this so that the renderer can get the value from the editor
1618 control (pointed to by @a editor):
1621 wxSpinCtrl *sc = (wxSpinCtrl*) editor;
1622 long l = sc->GetValue();
1628 virtual bool GetValueFromEditorCtrl(wxControl
* editor
,
1632 Override this and make it return @true in order to
1633 indicate that this renderer supports in-place editing.
1635 virtual bool HasEditorCtrl() const;
1638 Override this to react to a left click.
1639 This method will only be called in @c wxDATAVIEW_CELL_ACTIVATABLE mode.
1641 virtual bool LeftClick( wxPoint cursor
,
1643 wxDataViewModel
* model
,
1644 const wxDataViewItem
& item
,
1648 Override this to render the cell.
1649 Before this is called, wxDataViewRenderer::SetValue was called
1650 so that this instance knows what to render.
1652 virtual bool Render(wxRect cell
, wxDC
* dc
, int state
) = 0;
1655 This method should be called from within Render() whenever you need to
1657 This will ensure that the correct colour, font and vertical alignment will
1658 be chosen so the text will look the same as text drawn by native renderers.
1660 void RenderText(const wxString
& text
, int xoffset
, wxRect cell
,
1661 wxDC
* dc
, int state
);
1664 Override this to start a drag operation. Not yet supported.
1666 virtual bool StartDrag(wxPoint cursor
, wxRect cell
,
1667 wxDataViewModel
* model
,
1668 const wxDataViewItem
& item
,
1675 @class wxDataViewBitmapRenderer
1677 This class is used by wxDataViewCtrl to render bitmap controls.
1682 class wxDataViewBitmapRenderer
: public wxDataViewRenderer
1688 wxDataViewBitmapRenderer(const wxString
& varianttype
= "wxBitmap",
1689 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1690 int align
= wxDVR_DEFAULT_ALIGNMENT
);
1695 The flags used by wxDataViewColumn.
1696 Can be combined together.
1698 enum wxDataViewColumnFlags
1700 wxDATAVIEW_COL_RESIZABLE
= 1,
1701 wxDATAVIEW_COL_SORTABLE
= 2,
1702 wxDATAVIEW_COL_REORDERABLE
= 4,
1703 wxDATAVIEW_COL_HIDDEN
= 8
1707 @class wxDataViewColumn
1709 This class represents a column in a wxDataViewCtrl.
1710 One wxDataViewColumn is bound to one column in the data model to which the
1711 wxDataViewCtrl has been associated.
1713 An instance of wxDataViewRenderer is used by this class to render its data.
1718 class wxDataViewColumn
: public wxSettableHeaderColumn
1722 Constructs a text column.
1725 The title of the column.
1727 The class which will render the contents of this column.
1729 The index of the model's column which is associated with this object.
1731 The width of the column.
1732 The @c wxDVC_DEFAULT_WIDTH value is the fixed default value.
1734 The alignment of the column title.
1736 One or more flags of the ::wxDataViewColumnFlags enumeration.
1738 wxDataViewColumn(const wxString
& title
,
1739 wxDataViewRenderer
* renderer
,
1740 unsigned int model_column
,
1741 int width
= wxDVC_DEFAULT_WIDTH
,
1742 wxAlignment align
= wxALIGN_CENTER
,
1743 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1746 Constructs a bitmap column.
1749 The bitmap of the column.
1751 The class which will render the contents of this column.
1753 The index of the model's column which is associated with this object.
1755 The width of the column.
1756 The @c wxDVC_DEFAULT_WIDTH value is the fixed default value.
1758 The alignment of the column title.
1760 One or more flags of the ::wxDataViewColumnFlags enumeration.
1762 wxDataViewColumn(const wxBitmap
& bitmap
,
1763 wxDataViewRenderer
* renderer
,
1764 unsigned int model_column
,
1765 int width
= wxDVC_DEFAULT_WIDTH
,
1766 wxAlignment align
= wxALIGN_CENTER
,
1767 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1770 Returns the index of the column of the model, which this
1771 wxDataViewColumn is displaying.
1773 unsigned int GetModelColumn() const;
1776 Returns the owning wxDataViewCtrl.
1778 wxDataViewCtrl
* GetOwner() const;
1781 Returns the renderer of this wxDataViewColumn.
1783 @see wxDataViewRenderer.
1785 wxDataViewRenderer
* GetRenderer() const;
1791 @class wxDataViewListCtrl
1793 This class is a wxDataViewCtrl which internally uses a wxDataViewListStore
1794 and forwards most of its API to that class.
1796 The purpose of this class is to offer a simple way to display and
1797 edit a small table of data without having to write your own wxDataViewModel.
1800 wxDataViewListCtrl *listctrl = new wxDataViewListCtrl( parent, wxID_ANY );
1802 listctrl->AppendToggleColumn( "Toggle" );
1803 listctrl->AppendTextColumn( "Text" );
1805 wxVector<wxVariant> data;
1806 data.push_back( wxVariant(true) );
1807 data.push_back( wxVariant("row 1") );
1808 listctrl->AppendItem( data );
1811 data.push_back( wxVariant(false) );
1812 data.push_back( wxVariant("row 3") );
1813 listctrl->AppendItem( data );
1817 See wxDataViewCtrl for the list of supported styles.
1820 @beginEventEmissionTable
1821 See wxDataViewCtrl for the list of events emitted by this class.
1827 class wxDataViewListCtrl
: public wxDataViewCtrl
1833 wxDataViewListCtrl();
1836 Constructor. Calls Create().
1838 wxDataViewListCtrl( wxWindow
*parent
, wxWindowID id
,
1839 const wxPoint
& pos
= wxDefaultPosition
,
1840 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
1841 const wxValidator
& validator
= wxDefaultValidator
);
1844 Destructor. Deletes the image list if any.
1846 ~wxDataViewListCtrl();
1849 Creates the control and a wxDataViewListStore as its internal model.
1851 bool Create( wxWindow
*parent
, wxWindowID id
,
1852 const wxPoint
& pos
= wxDefaultPosition
,
1853 const wxSize
& size
= wxDefaultSize
, long style
= wxDV_ROW_LINES
,
1854 const wxValidator
& validator
= wxDefaultValidator
);
1860 wxDataViewListStore
*GetStore();
1861 const wxDataViewListStore
*GetStore() const;
1865 Returns the position of given @e item or wxNOT_FOUND if it's
1870 int ItemToRow(const wxDataViewItem
&item
) const;
1873 Returns the wxDataViewItem at the given @e row.
1877 wxDataViewItem
RowToItem(int row
) const;
1881 @name Selection handling functions
1885 Returns index of the selected row or wxNOT_FOUND.
1887 @see wxDataViewCtrl::GetSelection()
1891 int GetSelectedRow() const;
1896 @see wxDataViewCtrl::Select()
1900 void SelectRow(unsigned row
);
1903 Unselects given row.
1905 @see wxDataViewCtrl::Unselect()
1909 void UnselectRow(unsigned row
);
1912 Returns true if @a row is selected.
1914 @see wxDataViewCtrl::IsSelected()
1918 bool IsRowSelected(unsigned row
) const;
1923 @name Column management functions
1928 Appends a column to the control and additionally appends a
1929 column to the store with the type string.
1931 virtual void AppendColumn( wxDataViewColumn
*column
);
1934 Appends a column to the control and additionally appends a
1935 column to the list store with the type @a varianttype.
1937 void AppendColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
1940 Appends a text column to the control and the store.
1942 See wxDataViewColumn::wxDataViewColumn for more info about
1945 wxDataViewColumn
*AppendTextColumn( const wxString
&label
,
1946 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1947 int width
= -1, wxAlignment align
= wxALIGN_LEFT
,
1948 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1951 Appends a toggle column to the control and the store.
1953 See wxDataViewColumn::wxDataViewColumn for more info about
1956 wxDataViewColumn
*AppendToggleColumn( const wxString
&label
,
1957 wxDataViewCellMode mode
= wxDATAVIEW_CELL_ACTIVATABLE
,
1958 int width
= -1, wxAlignment align
= wxALIGN_LEFT
,
1959 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1962 Appends a progress column to the control and the store.
1964 See wxDataViewColumn::wxDataViewColumn for more info about
1967 wxDataViewColumn
*AppendProgressColumn( const wxString
&label
,
1968 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1969 int width
= -1, wxAlignment align
= wxALIGN_LEFT
,
1970 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1973 Appends an icon-and-text column to the control and the store.
1975 See wxDataViewColumn::wxDataViewColumn for more info about
1978 wxDataViewColumn
*AppendIconTextColumn( const wxString
&label
,
1979 wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
,
1980 int width
= -1, wxAlignment align
= wxALIGN_LEFT
,
1981 int flags
= wxDATAVIEW_COL_RESIZABLE
);
1984 Inserts a column to the control and additionally inserts a
1985 column to the store with the type string.
1987 virtual void InsertColumn( unsigned int pos
, wxDataViewColumn
*column
);
1990 Inserts a column to the control and additionally inserts a
1991 column to the list store with the type @a varianttype.
1993 void InsertColumn( unsigned int pos
, wxDataViewColumn
*column
,
1994 const wxString
&varianttype
);
1997 Prepends a column to the control and additionally prepends a
1998 column to the store with the type string.
2000 virtual void PrependColumn( wxDataViewColumn
*column
);
2003 Prepends a column to the control and additionally prepends a
2004 column to the list store with the type @a varianttype.
2006 void PrependColumn( wxDataViewColumn
*column
, const wxString
&varianttype
);
2012 @name Item management functions
2017 Appends an item (=row) to the control and store.
2019 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2022 Prepends an item (=row) to the control and store.
2024 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2027 Inserts an item (=row) to the control and store.
2029 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2032 Delete the row at position @a row.
2034 void DeleteItem( unsigned row
);
2037 Delete all items (= all rows).
2039 void DeleteAllItems();
2042 Sets the value in the store and update the control.
2044 void SetValue( const wxVariant
&value
, unsigned int row
, unsigned int col
);
2047 Returns the value from the store.
2049 void GetValue( wxVariant
&value
, unsigned int row
, unsigned int col
);
2052 Sets the value in the store and update the control.
2054 This method assumes that the a string is stored in respective
2057 void SetTextValue( const wxString
&value
, unsigned int row
, unsigned int col
);
2060 Returns the value from the store.
2062 This method assumes that the a string is stored in respective
2065 wxString
GetTextValue( unsigned int row
, unsigned int col
) const;
2068 Sets the value in the store and update the control.
2070 This method assumes that the a boolean value is stored in
2073 void SetToggleValue( bool value
, unsigned int row
, unsigned int col
);
2076 Returns the value from the store.
2078 This method assumes that the a boolean value is stored in
2081 bool GetToggleValue( unsigned int row
, unsigned int col
) const;
2088 @class wxDataViewTreeCtrl
2090 This class is a wxDataViewCtrl which internally uses a wxDataViewTreeStore
2091 and forwards most of its API to that class.
2092 Additionally, it uses a wxImageList to store a list of icons.
2094 The main purpose of this class is to provide a simple upgrade path for code
2098 See wxDataViewCtrl for the list of supported styles.
2101 @beginEventEmissionTable
2102 See wxDataViewCtrl for the list of events emitted by this class.
2107 @appearance{dataviewtreectrl.png}
2109 class wxDataViewTreeCtrl
: public wxDataViewCtrl
2115 wxDataViewTreeCtrl();
2122 wxDataViewTreeCtrl(wxWindow
* parent
, wxWindowID id
,
2123 const wxPoint
& pos
= wxDefaultPosition
,
2124 const wxSize
& size
= wxDefaultSize
,
2125 long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
2126 const wxValidator
& validator
= wxDefaultValidator
);
2129 Destructor. Deletes the image list if any.
2131 virtual ~wxDataViewTreeCtrl();
2134 Appends a container to the given @a parent.
2136 wxDataViewItem
AppendContainer(const wxDataViewItem
& parent
,
2137 const wxString
& text
,
2140 wxClientData
* data
= NULL
);
2143 Appends an item to the given @a parent.
2145 wxDataViewItem
AppendItem(const wxDataViewItem
& parent
,
2146 const wxString
& text
,
2148 wxClientData
* data
= NULL
);
2151 Creates the control and a wxDataViewTreeStore as its internal model.
2153 The default tree column created by this method is an editable column
2154 using wxDataViewIconTextRenderer as its renderer.
2156 bool Create(wxWindow
* parent
, wxWindowID id
,
2157 const wxPoint
& pos
= wxDefaultPosition
,
2158 const wxSize
& size
= wxDefaultSize
,
2159 long style
= wxDV_NO_HEADER
| wxDV_ROW_LINES
,
2160 const wxValidator
& validator
= wxDefaultValidator
);
2163 Calls the identical method from wxDataViewTreeStore.
2165 void DeleteAllItems();
2168 Calls the identical method from wxDataViewTreeStore.
2170 void DeleteChildren(const wxDataViewItem
& item
);
2173 Calls the identical method from wxDataViewTreeStore.
2175 void DeleteItem(const wxDataViewItem
& item
);
2178 Calls the identical method from wxDataViewTreeStore.
2180 int GetChildCount(const wxDataViewItem
& parent
) const;
2183 Returns the image list.
2185 wxImageList
* GetImageList();
2188 Calls the identical method from wxDataViewTreeStore.
2190 wxClientData
* GetItemData(const wxDataViewItem
& item
) const;
2193 Calls the identical method from wxDataViewTreeStore.
2195 const wxIcon
& GetItemExpandedIcon(const wxDataViewItem
& item
) const;
2198 Calls the identical method from wxDataViewTreeStore.
2200 const wxIcon
& GetItemIcon(const wxDataViewItem
& item
) const;
2203 Calls the identical method from wxDataViewTreeStore.
2205 wxString
GetItemText(const wxDataViewItem
& item
) const;
2208 Calls the identical method from wxDataViewTreeStore.
2210 wxDataViewItem
GetNthChild(const wxDataViewItem
& parent
,
2211 unsigned int pos
) const;
2217 wxDataViewTreeStore
* GetStore();
2218 const wxDataViewTreeStore
* GetStore() const;
2222 Calls the same method from wxDataViewTreeStore but uses
2223 an index position in the image list instead of a wxIcon.
2225 wxDataViewItem
InsertContainer(const wxDataViewItem
& parent
,
2226 const wxDataViewItem
& previous
,
2227 const wxString
& text
,
2230 wxClientData
* data
= NULL
);
2233 Calls the same method from wxDataViewTreeStore but uses
2234 an index position in the image list instead of a wxIcon.
2236 wxDataViewItem
InsertItem(const wxDataViewItem
& parent
,
2237 const wxDataViewItem
& previous
,
2238 const wxString
& text
,
2240 wxClientData
* data
= NULL
);
2243 Returns true if item is a container.
2245 bool IsContainer( const wxDataViewItem
& item
);
2248 Calls the same method from wxDataViewTreeStore but uses
2249 an index position in the image list instead of a wxIcon.
2251 wxDataViewItem
PrependContainer(const wxDataViewItem
& parent
,
2252 const wxString
& text
,
2255 wxClientData
* data
= NULL
);
2258 Calls the same method from wxDataViewTreeStore but uses
2259 an index position in the image list instead of a wxIcon.
2261 wxDataViewItem
PrependItem(const wxDataViewItem
& parent
,
2262 const wxString
& text
,
2264 wxClientData
* data
= NULL
);
2267 Sets the image list.
2269 void SetImageList(wxImageList
* imagelist
);
2272 Calls the identical method from wxDataViewTreeStore.
2274 void SetItemData(const wxDataViewItem
& item
, wxClientData
* data
);
2277 Calls the identical method from wxDataViewTreeStore.
2279 void SetItemExpandedIcon(const wxDataViewItem
& item
,
2280 const wxIcon
& icon
);
2283 Calls the identical method from wxDataViewTreeStore.
2285 void SetItemIcon(const wxDataViewItem
& item
, const wxIcon
& icon
);
2288 Calls the identical method from wxDataViewTreeStore.
2290 void SetItemText(const wxDataViewItem
& item
,
2291 const wxString
& text
);
2296 @class wxDataViewListStore
2298 wxDataViewListStore is a specialised wxDataViewModel for storing
2299 a simple table of data. Since it derives from wxDataViewIndexListModel
2300 its data is be accessed by row (i.e. by index) instead of only
2303 This class actually stores the values (therefore its name)
2304 and implements all virtual methods from the base classes so it can be
2305 used directly without having to derive any class from it, but it is
2306 mostly used from within wxDataViewListCtrl.
2312 class wxDataViewListStore
: public wxDataViewIndexListModel
2318 wxDataViewListStore();
2323 ~wxDataViewListStore();
2326 Prepends a data column.
2328 @a variantype indicates the type of values store in the column.
2330 This does not automatically fill in any (default) values in
2331 rows which exist in the store already.
2333 void PrependColumn( const wxString
&varianttype
);
2336 Inserts a data column before @a pos.
2338 @a variantype indicates the type of values store in the column.
2340 This does not automatically fill in any (default) values in
2341 rows which exist in the store already.
2343 void InsertColumn( unsigned int pos
, const wxString
&varianttype
);
2346 Appends a data column.
2348 @a variantype indicates the type of values store in the column.
2350 This does not automatically fill in any (default) values in
2351 rows which exist in the store already.
2353 void AppendColumn( const wxString
&varianttype
);
2356 Appends an item (=row) and fills it with @a values.
2358 The values must match the values specifies in the column
2359 in number and type. No (default) values are filled in
2362 void AppendItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2365 Prepends an item (=row) and fills it with @a values.
2367 The values must match the values specifies in the column
2368 in number and type. No (default) values are filled in
2371 void PrependItem( const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2374 Inserts an item (=row) and fills it with @a values.
2376 The values must match the values specifies in the column
2377 in number and type. No (default) values are filled in
2380 void InsertItem( unsigned int row
, const wxVector
<wxVariant
> &values
, wxClientData
*data
= NULL
);
2383 Delete the item (=row) at position @a pos.
2385 void DeleteItem( unsigned pos
);
2388 Delete all item (=all rows) in the store.
2390 void DeleteAllItems();
2393 Overriden from wxDataViewModel
2395 virtual unsigned int GetColumnCount() const;
2398 Overriden from wxDataViewModel
2400 virtual wxString
GetColumnType( unsigned int col
) const;
2403 Overriden from wxDataViewIndexListModel
2405 virtual void GetValueByRow( wxVariant
&value
,
2406 unsigned int row
, unsigned int col
) const;
2409 Overriden from wxDataViewIndexListModel
2411 virtual bool SetValueByRow( const wxVariant
&value
,
2412 unsigned int row
, unsigned int col
);
2417 @class wxDataViewTreeStore
2419 wxDataViewTreeStore is a specialised wxDataViewModel for stroing simple
2420 trees very much like wxTreeCtrl does and it offers a similar API.
2422 This class actually stores the entire tree and the values (therefore its name)
2423 and implements all virtual methods from the base class so it can be used directly
2424 without having to derive any class from it, but it is mostly used from within
2430 class wxDataViewTreeStore
: public wxDataViewModel
2434 Constructor. Creates the invisible root node internally.
2436 wxDataViewTreeStore();
2441 virtual ~wxDataViewTreeStore();
2446 wxDataViewItem
AppendContainer(const wxDataViewItem
& parent
,
2447 const wxString
& text
,
2448 const wxIcon
& icon
= wxNullIcon
,
2449 const wxIcon
& expanded
= wxNullIcon
,
2450 wxClientData
* data
= NULL
);
2455 wxDataViewItem
AppendItem(const wxDataViewItem
& parent
,
2456 const wxString
& text
,
2457 const wxIcon
& icon
= wxNullIcon
,
2458 wxClientData
* data
= NULL
);
2461 Delete all item in the model.
2463 void DeleteAllItems();
2466 Delete all children of the item, but not the item itself.
2468 void DeleteChildren(const wxDataViewItem
& item
);
2473 void DeleteItem(const wxDataViewItem
& item
);
2476 Return the number of children of item.
2478 int GetChildCount(const wxDataViewItem
& parent
) const;
2481 Returns the client data asoociated with the item.
2483 wxClientData
* GetItemData(const wxDataViewItem
& item
) const;
2486 Returns the icon to display in expanded containers.
2488 const wxIcon
& GetItemExpandedIcon(const wxDataViewItem
& item
) const;
2491 Returns the icon of the item.
2493 const wxIcon
& GetItemIcon(const wxDataViewItem
& item
) const;
2496 Returns the text of the item.
2498 wxString
GetItemText(const wxDataViewItem
& item
) const;
2501 Returns the nth child item of item.
2503 wxDataViewItem
GetNthChild(const wxDataViewItem
& parent
,
2504 unsigned int pos
) const;
2507 Inserts a container after @a previous.
2509 wxDataViewItem
InsertContainer(const wxDataViewItem
& parent
,
2510 const wxDataViewItem
& previous
,
2511 const wxString
& text
,
2512 const wxIcon
& icon
= wxNullIcon
,
2513 const wxIcon
& expanded
= wxNullIcon
,
2514 wxClientData
* data
= NULL
);
2517 Inserts an item after @a previous.
2519 wxDataViewItem
InsertItem(const wxDataViewItem
& parent
,
2520 const wxDataViewItem
& previous
,
2521 const wxString
& text
,
2522 const wxIcon
& icon
= wxNullIcon
,
2523 wxClientData
* data
= NULL
);
2526 Inserts a container before the first child item or @a parent.
2528 wxDataViewItem
PrependContainer(const wxDataViewItem
& parent
,
2529 const wxString
& text
,
2530 const wxIcon
& icon
= wxNullIcon
,
2531 const wxIcon
& expanded
= wxNullIcon
,
2532 wxClientData
* data
= NULL
);
2535 Inserts an item before the first child item or @a parent.
2537 wxDataViewItem
PrependItem(const wxDataViewItem
& parent
,
2538 const wxString
& text
,
2539 const wxIcon
& icon
= wxNullIcon
,
2540 wxClientData
* data
= NULL
);
2543 Sets the client data associated with the item.
2545 void SetItemData(const wxDataViewItem
& item
, wxClientData
* data
);
2548 Sets the expanded icon for the item.
2550 void SetItemExpandedIcon(const wxDataViewItem
& item
,
2551 const wxIcon
& icon
);
2554 Sets the icon for the item.
2556 void SetItemIcon(const wxDataViewItem
& item
, const wxIcon
& icon
);
2561 @class wxDataViewIconText
2563 wxDataViewIconText is used by wxDataViewIconTextRenderer for data transfer.
2564 This class can be converted to and from a wxVariant.
2569 class wxDataViewIconText
: public wxObject
2576 wxDataViewIconText(const wxString
& text
= wxEmptyString
,
2577 const wxIcon
& icon
= wxNullIcon
);
2578 wxDataViewIconText(const wxDataViewIconText
& other
);
2584 const wxIcon
& GetIcon() const;
2589 wxString
GetText() const;
2594 void SetIcon(const wxIcon
& icon
);
2599 void SetText(const wxString
& text
);
2605 @class wxDataViewEvent
2607 This is the event class for the wxDataViewCtrl notifications.
2609 @beginEventTable{wxDataViewEvent}
2610 @event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)}
2611 Process a @c wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event.
2612 @event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)}
2613 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED event.
2614 @event{EVT_DATAVIEW_ITEM_EDITING_STARTED(id, func)}
2615 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED event.
2616 @event{EVT_DATAVIEW_ITEM_EDITING_DONE(id, func)}
2617 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE event.
2618 @event{EVT_DATAVIEW_ITEM_COLLAPSING(id, func)}
2619 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING event.
2620 @event{EVT_DATAVIEW_ITEM_COLLAPSED(id, func)}
2621 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED event.
2622 @event{EVT_DATAVIEW_ITEM_EXPANDING(id, func)}
2623 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING event.
2624 @event{EVT_DATAVIEW_ITEM_EXPANDED(id, func)}
2625 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED event.
2626 @event{EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, func)}
2627 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED event.
2628 @event{EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, func)}
2629 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU event.
2630 @event{EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, func)}
2631 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICKED event.
2632 @event{EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK(id, func)}
2633 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED event.
2634 @event{EVT_DATAVIEW_COLUMN_SORTED(id, func)}
2635 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED event.
2636 @event{EVT_DATAVIEW_COLUMN_REORDERED(id, func)}
2637 Process a @c wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED event.
2638 @event{EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, func)}
2639 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG event.
2640 @event{EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, func)}
2641 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE event.
2642 @event{EVT_DATAVIEW_ITEM_DROP(id, func)}
2643 Process a @c wxEVT_COMMAND_DATAVIEW_ITEM_DROP event.
2644 @event{EVT_DATAVIEW_CACHE_HINT(id, func)}
2645 Process a @c wxEVT_COMMAND_DATAVIEW_CACHE_HINT event.
2649 @category{events,dvc}
2651 class wxDataViewEvent
: public wxNotifyEvent
2655 Constructor. Typically used by wxWidgets internals only.
2657 wxDataViewEvent(wxEventType commandType
= wxEVT_NULL
,
2661 Returns the position of the column in the control or -1
2662 if no column field was set by the event emitter.
2664 int GetColumn() const;
2667 Returns a pointer to the wxDataViewColumn from which
2668 the event was emitted or @NULL.
2670 wxDataViewColumn
* GetDataViewColumn() const;
2673 Returns the wxDataViewModel associated with the event.
2675 wxDataViewModel
* GetModel() const;
2678 Returns a the position of a context menu event in screen coordinates.
2680 wxPoint
GetPosition() const;
2683 Returns a reference to a value.
2685 const wxVariant
& GetValue() const;
2688 Sets the column index associated with this event.
2690 void SetColumn(int col
);
2693 For wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only.
2695 void SetDataViewColumn(wxDataViewColumn
* col
);
2698 Sets the dataview model associated with this event.
2700 void SetModel(wxDataViewModel
* model
);
2703 Sets the value associated with this event.
2705 void SetValue(const wxVariant
& value
);
2708 Set wxDataObject for data transfer within a drag operation.
2710 void SetDataObject( wxDataObject
*obj
);
2713 Used internally. Gets associated wxDataObject for data transfer
2714 within a drag operation.
2716 wxDataObject
*GetDataObject() const;
2719 Used internally. Sets the wxDataFormat during a drop operation.
2721 void SetDataFormat( const wxDataFormat
&format
);
2724 Gets the wxDataFormat during a drop operation.
2726 wxDataFormat
GetDataFormat() const;
2729 Used internally. Sets the data size for a drop data transfer.
2731 void SetDataSize( size_t size
);
2734 Gets the data size for a drop data transfer.
2736 size_t GetDataSize() const;
2739 Used internally. Sets the data buffer for a drop data transfer.
2741 void SetDataBuffer( void* buf
);
2744 Gets the data buffer for a drop data transfer.
2746 void *GetDataBuffer() const;
2749 Return the first row that will be displayed.
2751 int GetCacheFrom() const;
2754 Return the last row that will be displayed.
2756 int GetCacheTo() const;