An abstract list model for use with Wt's view classes. More...

#include <Wt/WAbstractListModel>

Inheritance diagram for Wt::WAbstractListModel:

Public Member Functions
	WAbstractListModel (WObject *parent=0)
	Create a new abstract list model.

	~WAbstractListModel ()
	Destructor.

virtual WModelIndex	parent (const WModelIndex &index) const
	Returns the parent for a model index. More...

virtual WModelIndex	index (int row, int column=0, const WModelIndex &parent=WModelIndex()) const
	Returns the child index for the given row and column. More...

virtual int	columnCount (const WModelIndex &parent=WModelIndex()) const
	Returns the number of columns. More...

Public Member Functions inherited from Wt::WAbstractItemModel
	WAbstractItemModel (WObject *parent=0)
	Creates a new data model.

virtual int	rowCount (const WModelIndex &parent=WModelIndex()) const =0
	Returns the number of rows. More...

virtual WFlags< ItemFlag >	flags (const WModelIndex &index) const
	Returns the flags for an item. More...

virtual WFlags< HeaderFlag >	headerFlags (int section, Orientation orientation=Horizontal) const
	Returns the flags for a header. More...

virtual bool	hasChildren (const WModelIndex &index) const
	Returns if there are children at an index. More...

virtual boost::any	data (const WModelIndex &index, int role=DisplayRole) const =0
	Returns data at a specific model index. More...

virtual DataMap	itemData (const WModelIndex &index) const
	Returns all data at a specific index. More...

virtual boost::any	headerData (int section, Orientation orientation=Horizontal, int role=DisplayRole) const
	Returns the row or column header data. More...

virtual WModelIndexList	match (const WModelIndex &start, int role, const boost::any &value, int hits=-1, WFlags< MatchFlag > flags=WFlags< MatchFlag >(MatchStartsWith\|MatchWrap)) const
	Returns an index list for data items that match. More...

boost::any	data (int row, int column, int role=DisplayRole, const WModelIndex &parent=WModelIndex()) const
	Returns the data item at the given column and row. More...

virtual bool	hasIndex (int row, int column, const WModelIndex &parent=WModelIndex()) const
	Returns if an index at the given position is valid (i.e. falls within the column-row bounds). More...

virtual bool	insertColumns (int column, int count, const WModelIndex &parent=WModelIndex())
	Inserts one or more columns. More...

virtual bool	insertRows (int row, int count, const WModelIndex &parent=WModelIndex())
	Inserts one or more rows. More...

virtual bool	removeColumns (int column, int count, const WModelIndex &parent=WModelIndex())
	Removes columns. More...

virtual bool	removeRows (int row, int count, const WModelIndex &parent=WModelIndex())
	Removes rows. More...

virtual bool	setData (const WModelIndex &index, const boost::any &value, int role=EditRole)
	Sets data at the given model index. More...

virtual bool	setItemData (const WModelIndex &index, const DataMap &values)
	Sets data at the given model index. More...

virtual bool	setHeaderData (int section, Orientation orientation, const boost::any &value, int role=EditRole)
	Sets header data for a column or row. More...

bool	setHeaderData (int section, const boost::any &value)
	Sets column header data. More...

virtual void	sort (int column, SortOrder order=AscendingOrder)
	Sorts the model according to a particular column. More...

virtual void	expandColumn (int column)
	Expands a column. More...

virtual void	collapseColumn (int column)
	Collapses a column. More...

virtual void *	toRawIndex (const WModelIndex &index) const
	Converts a model index to a raw pointer that remains valid while the model's layout is changed. More...

virtual WModelIndex	fromRawIndex (void *rawIndex) const
	Converts a raw pointer to a model index. More...

virtual std::string	mimeType () const
	Returns a mime-type for dragging a set of indexes. More...

virtual std::vector< std::string >	acceptDropMimeTypes () const
	Returns a list of mime-types that could be accepted for a drop event. More...

virtual void	dropEvent (const WDropEvent &e, DropAction action, int row, int column, const WModelIndex &parent)
	Handles a drop event. More...

bool	insertColumn (int column, const WModelIndex &parent=WModelIndex())
	Inserts one column. More...

bool	insertRow (int row, const WModelIndex &parent=WModelIndex())
	Inserts one row. More...

bool	removeColumn (int column, const WModelIndex &parent=WModelIndex())
	Removes one column. More...

bool	removeRow (int row, const WModelIndex &parent=WModelIndex())
	Removes one row. More...

bool	setData (int row, int column, const boost::any &value, int role=EditRole, const WModelIndex &parent=WModelIndex())
	Sets data at the given row and column. More...

virtual Signal< WModelIndex, int, int > &	columnsAboutToBeInserted ()
	Signal emitted before a number of columns will be inserted. More...

virtual Signal< WModelIndex, int, int > &	columnsAboutToBeRemoved ()
	Signal emitted before a number of columns will be removed. More...

virtual Signal< WModelIndex, int, int > &	columnsInserted ()
	Signal emitted after a number of columns were inserted. More...

virtual Signal< WModelIndex, int, int > &	columnsRemoved ()
	Signal emitted after a number of columns were removed. More...

virtual Signal< WModelIndex, int, int > &	rowsAboutToBeInserted ()
	Signal emitted before a number of rows will be inserted. More...

virtual Signal< WModelIndex, int, int > &	rowsAboutToBeRemoved ()
	Signal emitted before a number of rows will be removed. More...

virtual Signal< WModelIndex, int, int > &	rowsInserted ()
	Signal emitted after a number of rows were inserted. More...

virtual Signal< WModelIndex, int, int > &	rowsRemoved ()
	Signal emitted after a number of rows were removed. More...

virtual Signal< WModelIndex, WModelIndex > &	dataChanged ()
	Signal emitted when some data was changed. More...

virtual Signal< Orientation, int, int > &	headerDataChanged ()
	Signal emitted when some header data was changed. More...

virtual Signal &	layoutAboutToBeChanged ()
	Signal emitted when the layout is about to be changed. More...

virtual Signal &	layoutChanged ()
	Signal emitted when the layout is changed. More...

virtual Signal &	modelReset ()
	Signal emitted when the model was reset. More...

Public Member Functions inherited from Wt::WObject
	WObject (WObject *parent=0)
	Create a WObject with a given parent object. More...

virtual	~WObject ()
	Destructor. More...

virtual const std::string	id () const
	Returns the (unique) identifier for this object. More...

virtual void	setObjectName (const std::string &name)
	Sets an object name. More...

virtual std::string	objectName () const
	Returns the object name. More...

void	resetLearnedSlots ()
	Resets learned stateless slot implementations. More...

template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::method)(), void(T::undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance. More...

void	isNotStateless ()
	Marks the current function as not stateless. More...

template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method. More...

void	addChild (WObject *child)
	Adds a child object. More...

virtual void	removeChild (WObject *child)
	Removes a child object. More...

const std::vector< WObject * > &	children () const
	Returns the children.

WObject *	parent () const
	Returns the parent object.

Additional Inherited Members
Public Types inherited from Wt::WAbstractItemModel
typedef std::map< int, boost::any >	DataMap
	Data map. More...

Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.

Protected Member Functions inherited from Wt::WAbstractItemModel
void	reset ()
	Resets the model and invalidate any data. More...

WModelIndex	createIndex (int row, int column, void *ptr) const
	Creates a model index for the given row and column. More...

WModelIndex	createIndex (int row, int column,::uint64_t id) const
	Creates a model index for the given row and column. More...

void	beginInsertColumns (const WModelIndex &parent, int first, int last)
	Method to be called before inserting columns. More...

void	beginInsertRows (const WModelIndex &parent, int first, int last)
	Method to be called before inserting rows. More...

void	beginRemoveColumns (const WModelIndex &parent, int first, int last)
	Method to be called before removing columns. More...

void	beginRemoveRows (const WModelIndex &parent, int first, int last)
	Method to be called before removing rows. More...

void	endInsertColumns ()
	Method to be called after inserting columns. More...

void	endInsertRows ()
	Method to be called after inserting rows. More...

void	endRemoveColumns ()
	Method to be called after removing columns. More...

void	endRemoveRows ()
	Method to be called after removing rows. More...

Protected Member Functions inherited from Wt::WObject
virtual WStatelessSlot *	getStateless (Method method)
	On-demand stateless slot implementation. More...

Static Protected Member Functions inherited from Wt::WObject
static WObject *	sender ()
	Returns the sender of the current slot call. More...

Detailed Description

An abstract list model for use with Wt's view classes.

An abstract list model specializes WAbstractItemModel for one-dimensional lists (i.e. a model with 1 column and no children).

It cannot be used directly but must be subclassed. Subclassed models must at least reimplement rowCount() to return the number of rows, and data() to return data.

Member Function Documentation

int Wt::WAbstractListModel::columnCount ( const WModelIndex & parent = WModelIndex() ) const

virtual

Returns the number of columns.

This returns the number of columns at index parent.

See also: rowCount()

Implements Wt::WAbstractItemModel.

WModelIndex Wt::WAbstractListModel::index	(	int	row,
		int	column = `0`,
		const WModelIndex &	parent = `WModelIndex()`
	)		const

virtual

Returns the child index for the given row and column.

When implementing this method, you can use createIndex() to create an index that corresponds to the item at row and column within parent.

If the location is invalid (out of bounds at the parent), then an invalid index must be returned.

See also: parent()

Implements Wt::WAbstractItemModel.

WModelIndex Wt::WAbstractListModel::parent ( const WModelIndex & index ) const

virtual

Returns the parent for a model index.

An implementation should use createIndex() to create a model index that corresponds to the parent of a given index.

Note that the index itself may be stale (referencing a row/column within the parent that is outside the model geometry), but its parent (identified by the WModelIndex::internalPointer()) is referencing an existing parent. A stale index can only be used while the model geometry is being updated, i.e. during the emission of the corresponding [rows/columns](Being)[Removed/Inserted]() signals.

See also: index()

Implements Wt::WAbstractItemModel.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation