Version: 3.0.4
wxDataViewListModel Class Referenceabstract

#include <wx/dataview.h>

+ Inheritance diagram for wxDataViewListModel:

Detailed Description

Base class with abstract API for wxDataViewIndexListModel and wxDataViewVirtualListModel.

Library:  wxAdvanced
Category:  wxDataViewCtrl Related Classes

Public Member Functions

virtual ~wxDataViewListModel ()
 Destructor. More...
 
int Compare (const wxDataViewItem &item1, const wxDataViewItem &item2, unsigned int column, bool ascending) const
 Compare method that sorts the items by their index. More...
 
virtual bool GetAttrByRow (unsigned int row, unsigned int col, wxDataViewItemAttr &attr) const
 Override this to indicate that the row has special font attributes. More...
 
virtual bool IsEnabledByRow (unsigned int row, unsigned int col) const
 Override this if you want to disable specific items. More...
 
unsigned int GetCount () const =0
 Returns the number of items (or rows) in the list. More...
 
unsigned int GetRow (const wxDataViewItem &item) const =0
 Returns the position of given item. More...
 
virtual void GetValueByRow (wxVariant &variant, unsigned int row, unsigned int col) const =0
 Override this to allow getting values from the model. More...
 
virtual bool SetValueByRow (const wxVariant &variant, unsigned int row, unsigned int col)=0
 Called in order to set a value in the model. More...
 
- Public Member Functions inherited from wxDataViewModel
 wxDataViewModel ()
 Constructor. More...
 
void AddNotifier (wxDataViewModelNotifier *notifier)
 Adds a wxDataViewModelNotifier to the model. More...
 
bool ChangeValue (const wxVariant &variant, const wxDataViewItem &item, unsigned int col)
 Change the value of the given item and update the control to reflect it. More...
 
virtual bool Cleared ()
 Called to inform the model that all data has been cleared. More...
 
virtual bool GetAttr (const wxDataViewItem &item, unsigned int col, wxDataViewItemAttr &attr) const
 Override this to indicate that the item has special font attributes. More...
 
virtual bool IsEnabled (const wxDataViewItem &item, unsigned int col) const
 Override this to indicate that the item should be disabled. More...
 
virtual unsigned int GetChildren (const wxDataViewItem &item, wxDataViewItemArray &children) const =0
 Override this so the control can query the child items of an item. More...
 
virtual unsigned int GetColumnCount () const =0
 Override this to indicate the number of columns in the model. More...
 
virtual wxString GetColumnType (unsigned int col) const =0
 Override this to indicate what type of data is stored in the column specified by col. More...
 
virtual wxDataViewItem GetParent (const wxDataViewItem &item) const =0
 Override this to indicate which wxDataViewItem representing the parent of item or an invalid wxDataViewItem if the root item is the parent item. More...
 
virtual void GetValue (wxVariant &variant, const wxDataViewItem &item, unsigned int col) const =0
 Override this to indicate the value of item. More...
 
virtual bool HasContainerColumns (const wxDataViewItem &item) const
 Override this method to indicate if a container item merely acts as a headline (or for categorisation) or if it also acts a normal item with entries for further columns. More...
 
virtual bool HasDefaultCompare () const
 Override this to indicate that the model provides a default compare function that the control should use if no wxDataViewColumn has been chosen for sorting. More...
 
bool HasValue (const wxDataViewItem &item, unsigned col) const
 Return true if there is a value in the given column of this item. More...
 
virtual bool IsContainer (const wxDataViewItem &item) const =0
 Override this to indicate of item is a container, i.e. if it can have child items. More...
 
bool ItemAdded (const wxDataViewItem &parent, const wxDataViewItem &item)
 Call this to inform the model that an item has been added to the data. More...
 
bool ItemChanged (const wxDataViewItem &item)
 Call this to inform the model that an item has changed. More...
 
bool ItemDeleted (const wxDataViewItem &parent, const wxDataViewItem &item)
 Call this to inform the model that an item has been deleted from the data. More...
 
bool ItemsAdded (const wxDataViewItem &parent, const wxDataViewItemArray &items)
 Call this to inform the model that several items have been added to the data. More...
 
bool ItemsChanged (const wxDataViewItemArray &items)
 Call this to inform the model that several items have changed. More...
 
bool ItemsDeleted (const wxDataViewItem &parent, const wxDataViewItemArray &items)
 Call this to inform the model that several items have been deleted. More...
 
void RemoveNotifier (wxDataViewModelNotifier *notifier)
 Remove the notifier from the list of notifiers. More...
 
virtual void Resort ()
 Call this to initiate a resort after the sort function has been changed. More...
 
virtual bool SetValue (const wxVariant &variant, const wxDataViewItem &item, unsigned int col)=0
 This gets called in order to set a value in the data model. More...
 
virtual bool ValueChanged (const wxDataViewItem &item, unsigned int col)
 Call this to inform this model that a value in the model has been changed. More...
 
virtual bool IsListModel () const
 
virtual bool IsVirtualListModel () const
 
- Public Member Functions inherited from wxRefCounter
 wxRefCounter ()
 Default constructor. More...
 
void DecRef ()
 Decrements the reference count associated with this shared data and, if it reaches zero, destroys this instance of wxRefCounter releasing its memory. More...
 
int GetRefCount () const
 Returns the reference count associated with this shared data. More...
 
void IncRef ()
 Increments the reference count associated with this shared data. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxDataViewModel
virtual ~wxDataViewModel ()
 Destructor. More...
 
- Protected Member Functions inherited from wxRefCounter
virtual ~wxRefCounter ()
 Destructor. More...
 

Constructor & Destructor Documentation

virtual wxDataViewListModel::~wxDataViewListModel ( )
virtual

Destructor.

Member Function Documentation

int wxDataViewListModel::Compare ( const wxDataViewItem item1,
const wxDataViewItem item2,
unsigned int  column,
bool  ascending 
) const
virtual

Compare method that sorts the items by their index.

Reimplemented from wxDataViewModel.

virtual bool wxDataViewListModel::GetAttrByRow ( unsigned int  row,
unsigned int  col,
wxDataViewItemAttr attr 
) const
virtual

Override this to indicate that the row has special font attributes.

This only affects the wxDataViewTextRendererText() renderer.

The base class version always simply returns false.

See also
wxDataViewItemAttr.
Parameters
rowThe row for which the attribute is requested.
colThe column for which the attribute is requested.
attrThe attribute to be filled in if the function returns true.
Returns
true if this item has an attribute or false otherwise.
unsigned int wxDataViewListModel::GetCount ( ) const
pure virtual

Returns the number of items (or rows) in the list.

unsigned int wxDataViewListModel::GetRow ( const wxDataViewItem item) const
pure virtual

Returns the position of given item.

virtual void wxDataViewListModel::GetValueByRow ( wxVariant variant,
unsigned int  row,
unsigned int  col 
) const
pure virtual

Override this to allow getting values from the model.

Implemented in wxDataViewListStore.

virtual bool wxDataViewListModel::IsEnabledByRow ( unsigned int  row,
unsigned int  col 
) const
virtual

Override this if you want to disable specific items.

The base class version always returns true, thus making all items enabled by default.

Parameters
rowThe row of the item whose enabled status is requested.
colThe column of the item whose enabled status is requested.
Returns
true if the item at this row and column should be enabled, false otherwise.
Note
See wxDataViewModel::IsEnabled() for the current status of support for disabling the items under different platforms.
Since
2.9.2
virtual bool wxDataViewListModel::SetValueByRow ( const wxVariant variant,
unsigned int  row,
unsigned int  col 
)
pure virtual

Called in order to set a value in the model.

Implemented in wxDataViewListStore.