/**
@class wxDataViewIconText
- @wxheader{dataview.h}
wxDataViewIconText is used by
wxDataViewIconTextRenderer
/**
@class wxDataViewEvent
- @wxheader{dataview.h}
wxDataViewEvent - the event class for the wxDataViewCtrl notifications
Returns a pointer to the wxDataViewColumn from which
the event was emitted or @NULL.
*/
- wxDataViewColumn* GetDataViewColumn();
+ wxDataViewColumn* GetDataViewColumn() const;
/**
Returns the wxDataViewModel associated with the event.
/**
@class wxDataViewModel
- @wxheader{dataview.h}
wxDataViewModel is the base class for all data model to be
displayed by a wxDataViewCtrl.
/**
@class wxDataViewIndexListModel
- @wxheader{dataview.h}
wxDataViewIndexListModel is a specialized data model which lets
you address an item by its position (row) rather than its
/**
Destructor.
*/
- ~wxDataViewIndexListModel();
+ virtual ~wxDataViewIndexListModel();
/**
Compare method that sorts the items by their index.
/**
@class wxDataViewVirtualListModel
- @wxheader{dataview.h}
wxDataViewVirtualListModel is a specialized data model which lets
you address an item by its position (row) rather than its
/**
@class wxDataViewItemAttr
- @wxheader{dataview.h}
This class is used to indicate to a wxDataViewCtrl
that a certain Item() has extra font attributes
/**
@class wxDataViewItem
- @wxheader{dataview.h}
wxDataViewItem is a small opaque class that represents an
item in a wxDataViewCtrl in a
/**
@class wxDataViewCtrl
- @wxheader{dataview.h}
wxDataViewCtrl is a control to display data either
in a tree like fashion or in a tabular form or both.
Allow variable line heights. This can be inefficient when displaying large number of items.
@endStyleTable
+ @beginEventTable{wxDataViewEvent}
+ @event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event.
+ @event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED event.
+ @event{EVT_DATAVIEW_ITEM_EDITING_STARTED(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED event.
+ @event{EVT_DATAVIEW_ITEM_EDITING_DONE(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE event.
+ @event{EVT_DATAVIEW_ITEM_COLLAPSING(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING event.
+ @event{EVT_DATAVIEW_ITEM_COLLAPSED(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED event.
+ @event{EVT_DATAVIEW_ITEM_EXPANDING(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING event.
+ @event{EVT_DATAVIEW_ITEM_EXPANDED(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED event.
+ @event{EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED event.
+ @event{EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU event.
+ @event{EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICKED event.
+ @event{EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED event.
+ @event{EVT_DATAVIEW_COLUMN_SORTED(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED event.
+ @event{EVT_DATAVIEW_COLUMN_REORDERED(id, func)}
+ Process a wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED event.
+ @endEventTable
+
@library{wxadv}
@category{ctrl,dvc}
<!-- @appearance{dataviewctrl.png} -->
/**
Destructor.
*/
- ~wxDataViewCtrl();
+ virtual ~wxDataViewCtrl();
/**
Appends a wxDataViewColumn to the control. Returns @true on success.
/**
Collapses the item.
*/
- void Collapse(const wxDataViewItem& item);
+ virtual void Collapse(const wxDataViewItem& item);
/**
Create the control. Useful for two step creation.
/**
Expands the item.
*/
- void Expand(const wxDataViewItem& item);
+ virtual void Expand(const wxDataViewItem& item);
/**
Returns pointer to the column. @a pos refers to the
Returns pointer to the data model associated with the
control (if any).
*/
- virtual wxDataViewModel* GetModel() const;
+ wxDataViewModel* GetModel();
/**
Returns first selected item or an invalid item if none is selected.
*/
- wxDataViewItem GetSelection() const;
+ virtual wxDataViewItem GetSelection() const;
/**
Fills @a sel with currently selected items and returns
their number.
*/
- int GetSelections(wxDataViewItemArray& sel) const;
+ virtual int GetSelections(wxDataViewItemArray& sel) const;
/**
Returns the wxDataViewColumn currently responsible for sorting
/**
Return @true if the item is selected.
*/
- bool IsSelected(const wxDataViewItem& item) const;
+ virtual bool IsSelected(const wxDataViewItem& item) const;
/**
Select the given item.
*/
- void Select(const wxDataViewItem& item);
+ virtual void Select(const wxDataViewItem& item);
/**
Select all items.
*/
- void SelectAll();
+ virtual void SelectAll();
/**
Set which column shall contain the tree-like expanders.
/**
Sets the selection to the array of wxDataViewItems.
*/
- void SetSelections(const wxDataViewItemArray& sel);
+ virtual void SetSelections(const wxDataViewItemArray& sel);
/**
Unselect the given item.
*/
- void Unselect(const wxDataViewItem& item);
+ virtual void Unselect(const wxDataViewItem& item);
/**
Unselect all item. This method only has effect if multiple
selections are allowed.
*/
- void UnselectAll();
+ virtual void UnselectAll();
};
/**
@class wxDataViewModelNotifier
- @wxheader{dataview.h}
A wxDataViewModelNotifier instance is owned by a
wxDataViewModel
/**
Destructor.
*/
- ~wxDataViewModelNotifier();
+ virtual ~wxDataViewModelNotifier();
/**
Called by owning model.
/**
Called by owning model.
*/
- bool ItemsChanged(const wxDataViewItemArray& items);
+ virtual bool ItemsChanged(const wxDataViewItemArray& items);
/**
Called by owning model.
/**
@class wxDataViewRenderer
- @wxheader{dataview.h}
This class is used by wxDataViewCtrl to render the individual cells.
One instance of a renderer class is owned by a wxDataViewColumn. There
/**
Returns the cell mode.
*/
- virtual wxDataViewCellMode GetMode();
+ virtual wxDataViewCellMode GetMode() const;
/**
Returns pointer to the owning wxDataViewColumn.
*/
- virtual wxDataViewColumn* GetOwner() const;
+ wxDataViewColumn* GetOwner() const;
/**
This methods retrieves the value from the renderer in order to
Returns a string with the type of the wxVariant
supported by this renderer.
*/
- virtual wxString GetVariantType();
+ wxString GetVariantType() const;
/**
Sets the alignment of the renderer's content. The default value
Sets the owning wxDataViewColumn. This
is usually called from within wxDataViewColumn.
*/
- virtual void SetOwner(wxDataViewColumn* owner);
+ void SetOwner(wxDataViewColumn* owner);
/**
Set the value of the renderer (and thus its cell) to @e value.
/**
@class wxDataViewTextRenderer
- @wxheader{dataview.h}
wxDataViewTextRenderer is used for rendering text. It supports
in-place editing if desired.
/**
@class wxDataViewIconTextRenderer
- @wxheader{dataview.h}
The wxDataViewIconTextRenderer class is used to display text with
a small icon next to it as it is typically done in a file manager.
/**
@class wxDataViewProgressRenderer
- @wxheader{dataview.h}
wxDataViewProgressRenderer
/**
@class wxDataViewSpinRenderer
- @wxheader{dataview.h}
This is a specialized renderer for rendering integer values. It
supports modifying the values in-place by using a wxSpinCtrl.
/**
@class wxDataViewToggleRenderer
- @wxheader{dataview.h}
wxDataViewToggleRenderer
/**
@class wxDataViewDateRenderer
- @wxheader{dataview.h}
wxDataViewDateRenderer
/**
@class wxDataViewTextRendererAttr
- @wxheader{dataview.h}
The same as wxDataViewTextRenderer but with
support for font attributes. Font attributes are currently only supported
/**
@class wxDataViewCustomRenderer
- @wxheader{dataview.h}
You need to derive a new class from wxDataViewCustomRenderer in
order to write a new renderer. You need to override at least
/**
Destructor.
*/
- ~wxDataViewCustomRenderer();
+ virtual ~wxDataViewCustomRenderer();
/**
Override this to react to double clicks or ENTER. This method will
/**
@class wxDataViewBitmapRenderer
- @wxheader{dataview.h}
wxDataViewBitmapRenderer
/**
@class wxDataViewColumn
- @wxheader{dataview.h}
This class represents a column in a wxDataViewCtrl.
One wxDataViewColumn is bound to one column in the data model,
/**
Destructor.
*/
- ~wxDataViewColumn();
+ virtual ~wxDataViewColumn();
/**
Returns the bitmap in the header of the column, if any.
Returns the index of the column of the model, which this
wxDataViewColumn is displaying.
*/
- unsigned int GetModelColumn();
+ unsigned int GetModelColumn() const;
/**
Returns the owning wxDataViewCtrl.
Returns the renderer of this wxDataViewColumn.
See also wxDataViewRenderer.
*/
- wxDataViewRenderer* GetRenderer();
+ wxDataViewRenderer* GetRenderer() const;
/**
Returns @true if the column is reorderable.
/**
Returns the width of the column.
*/
- int GetWidth();
+ virtual int GetWidth() const;
/**
Returns @true, if the sort order is ascending.
See also SetSortOrder()
*/
- bool IsSortOrderAscending();
+ virtual bool IsSortOrderAscending() const;
/**
Set the alignment of the column header.
*/
- void SetAlignment(wxAlignment align);
+ virtual void SetAlignment(wxAlignment align);
/**
Set the bitmap of the column header.
*/
- void SetBitmap(const wxBitmap& bitmap);
+ virtual void SetBitmap(const wxBitmap& bitmap);
/**
Indicate wether the column can be reordered by the
user using the mouse. This is typically implemented
visually by dragging the header button around.
*/
- void SetReorderable(bool reorderable);
+ virtual void SetReorderable(bool reorderable);
/**
Indicate the sort order if the implementation of the
wxDataViewCtrl supports it, most commonly by showing
a little arrow.
*/
- void SetSortOrder(bool ascending);
+ virtual void SetSortOrder(bool ascending);
/**
Indicate that the column is sortable. This does
no longer clickable and the sort indicator (little
arrow) will disappear.
*/
- void SetSortable(bool sortable);
+ virtual void SetSortable(bool sortable);
/**
Set the title of the column header to @e title.
*/
- void SetTitle(const wxString& title);
+ virtual void SetTitle(const wxString& title);
};
/**
@class wxDataViewTreeCtrl
- @wxheader{dataview.h}
This class is a wxDataViewCtrl which internally
uses a wxDataViewTreeStore and forwards
/**
Destructor. Deletes the image list if any.
*/
- ~wxDataViewTreeCtrl();
+ virtual ~wxDataViewTreeCtrl();
/**
/**
@class wxDataViewTreeStore
- @wxheader{dataview.h}
wxDataViewTreeStore is a specialised wxDataViewModel
for displaying simple trees very much like wxTreeCtrl
/**
Destructor.
*/
- ~wxDataViewTreeStore();
+ virtual ~wxDataViewTreeStore();
/**
Append a container.
projects / wxWidgets.git / blobdiff