Wt  4.0.2
Classes | Public Member Functions | Protected Types | Protected Member Functions | List of all members
Wt::WAbstractProxyModel Class Referenceabstract

An abstract proxy model for Wt's item models. More...

#include <Wt/WAbstractProxyModel.h>

Inheritance diagram for Wt::WAbstractProxyModel:
Inheritance graph
[legend]

Classes

struct  BaseItem
 A base class for an item modeling a source index parent. More...
 

Public Member Functions

 WAbstractProxyModel ()
 Constructor.
 
virtual WModelIndex mapFromSource (const WModelIndex &sourceIndex) const =0
 Maps a source model index to the proxy model. More...
 
virtual WModelIndex mapToSource (const WModelIndex &proxyIndex) const =0
 Maps a proxy model index to the source model. More...
 
virtual void setSourceModel (const std::shared_ptr< WAbstractItemModel > &sourceModel)
 Sets the source model. More...
 
std::shared_ptr< WAbstractItemModelsourceModel () const
 Returns the source model. More...
 
virtual cpp17::any data (const WModelIndex &index, ItemDataRole role=ItemDataRole::Display) const override
 Returns the data at a specific model index. More...
 
virtual cpp17::any headerData (int section, Orientation orientation=Orientation::Horizontal, ItemDataRole role=ItemDataRole::Display) const override
 Returns the row or column header data. More...
 
virtual bool setData (const WModelIndex &index, const cpp17::any &value, ItemDataRole role=ItemDataRole::Edit) override
 Sets the data at the given model index. More...
 
virtual bool setItemData (const WModelIndex &index, const DataMap &values) override
 Sets the data at the given model index. More...
 
virtual WFlags< ItemFlagflags (const WModelIndex &index) const override
 Returns the flags for an item. More...
 
virtual WFlags< HeaderFlagheaderFlags (int section, Orientation orientation=Orientation::Horizontal) const override
 Returns the flags for a header. More...
 
virtual bool insertColumns (int column, int count, const WModelIndex &parent=WModelIndex()) override
 Inserts one or more columns. More...
 
virtual bool removeColumns (int column, int count, const WModelIndex &parent=WModelIndex()) override
 Removes columns. More...
 
virtual std::string mimeType () const override
 Returns a mime-type for dragging a set of indexes. More...
 
virtual std::vector< std::string > acceptDropMimeTypes () const override
 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) override
 Handles a drop event. More...
 
virtual void * toRawIndex (const WModelIndex &index) const override
 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 override
 Converts a raw pointer to a model index. More...
 
- Public Member Functions inherited from Wt::WAbstractItemModel
 WAbstractItemModel ()
 Creates a new data model.
 
virtual int columnCount (const WModelIndex &parent=WModelIndex()) const =0
 Returns the number of columns. More...
 
virtual int rowCount (const WModelIndex &parent=WModelIndex()) const =0
 Returns the number of rows. More...
 
virtual bool hasChildren (const WModelIndex &index) const
 Returns if there are children at an index. More...
 
virtual WModelIndex parent (const WModelIndex &index) const =0
 Returns the parent for a model index. More...
 
virtual DataMap itemData (const WModelIndex &index) const
 Returns all data at a specific index. More...
 
virtual WModelIndex index (int row, int column, const WModelIndex &parent=WModelIndex()) const =0
 Returns the child index for the given row and column. More...
 
virtual WModelIndexList match (const WModelIndex &start, ItemDataRole role, const cpp17::any &value, int hits=-1, WFlags< MatchFlag > flags=WFlags< MatchFlag >(MatchFlag::StartsWith|MatchFlag::Wrap)) const
 Returns an index list for data items that match. More...
 
cpp17::any data (int row, int column, ItemDataRole role=ItemDataRole::Display, 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 insertRows (int row, int count, const WModelIndex &parent=WModelIndex())
 Inserts one or more rows. More...
 
virtual bool removeRows (int row, int count, const WModelIndex &parent=WModelIndex())
 Removes rows. More...
 
virtual bool setHeaderData (int section, Orientation orientation, const cpp17::any &value, ItemDataRole role=ItemDataRole::Edit)
 Sets header data for a column or row. More...
 
bool setHeaderData (int section, const cpp17::any &value)
 Sets column header data. More...
 
virtual void sort (int column, SortOrder order=SortOrder::Ascending)
 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...
 
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 cpp17::any &value, ItemDataRole role=ItemDataRole::Edit, 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 SignallayoutAboutToBeChanged ()
 Signal emitted when the layout is about to be changed. More...
 
virtual SignallayoutChanged ()
 Signal emitted when the layout is changed. More...
 
virtual SignalmodelReset ()
 Signal emitted when the model was reset. More...
 
- Public Member Functions inherited from Wt::WObject
void addChild (std::unique_ptr< WObject > child)
 Add a child WObject whose lifetime is determined by this WObject.
 
template<typename Child >
Child * addChild (std::unique_ptr< Child > child)
 Add a child WObject, returning a raw pointer. More...
 
std::unique_ptr< WObjectremoveChild (WObject *child)
 Remove a child WObject, so its lifetime is no longer determined by this WObject.
 
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...
 
- Public Member Functions inherited from Wt::Core::observable
 observable () noexcept
 Default constructor.
 
virtual ~observable ()
 Destructor. More...
 

Protected Types

typedef std::map< WModelIndex, BaseItem * > ItemMap
 A map for items. More...
 

Protected Member Functions

WModelIndex createSourceIndex (int row, int column, void *ptr) const
 Create a source model index. More...
 
void startShiftModelIndexes (const WModelIndex &sourceParent, int start, int count, ItemMap &items)
 Utility methods to shift items in an item map. More...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from Wt::WAbstractItemModel
typedef std::map< ItemDataRole, cpp17::any > DataMap
 Data map. More...
 
- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 

Detailed Description

An abstract proxy model for Wt's item models.

A proxy model does not store data, but presents data from a source model in another way. It may provide filtering, sorting, or other computed changes to the source model. A proxy model may be a fully functional model, that also allows modification of the underlying model.

This abstract proxy model may be used as a starting point for implementing a custom proxy model, when WSortFilterProxyModel is not adequate. It implements data access and manipulation using the a virtual mapping method (mapToSource()) to access and manipulate the underlying sourceModel().

Member Typedef Documentation

typedef std::map<WModelIndex, BaseItem *> Wt::WAbstractProxyModel::ItemMap
protected

A map for items.

See also
BaseItem

Member Function Documentation

virtual std::vector<std::string> Wt::WAbstractProxyModel::acceptDropMimeTypes ( ) const
overridevirtual

Returns a list of mime-types that could be accepted for a drop event.

The default proxy implementation calls sourceModel()->acceptDropMimeTypes()

Reimplemented from Wt::WAbstractItemModel.

WModelIndex Wt::WAbstractProxyModel::createSourceIndex ( int  row,
int  column,
void *  ptr 
) const
protected

Create a source model index.

This is a utility function that allows you to create indexes in the source model. In this way, you can reuse the internal pointers of the source model in proxy model indexes, and convert a proxy model index back to the source model index using this method.

virtual cpp17::any Wt::WAbstractProxyModel::data ( const WModelIndex index,
ItemDataRole  role = ItemDataRole::Display 
) const
overridevirtual

Returns the data at a specific model index.

The default proxy implementation translates the index to the source model, and calls sourceModel()->data() with this index.

Implements Wt::WAbstractItemModel.

Reimplemented in Wt::WBatchEditProxyModel.

virtual void Wt::WAbstractProxyModel::dropEvent ( const WDropEvent e,
DropAction  action,
int  row,
int  column,
const WModelIndex parent 
)
overridevirtual

Handles a drop event.

The default proxy implementation maps the given row and parent to the row and parent in the source model, and forwards the dropEvent call to the source model.

Reimplemented from Wt::WAbstractItemModel.

Reimplemented in Wt::WReadOnlyProxyModel.

virtual WFlags<ItemFlag> Wt::WAbstractProxyModel::flags ( const WModelIndex index) const
overridevirtual

Returns the flags for an item.

The default proxy implementation calls sourceModel()->flags(mapToSource(index))

Reimplemented from Wt::WAbstractItemModel.

Reimplemented in Wt::WBatchEditProxyModel.

virtual WModelIndex Wt::WAbstractProxyModel::fromRawIndex ( void *  rawIndex) const
overridevirtual

Converts a raw pointer to a model index.

The default proxy implementation calls mapFromSource(sourceModel()->fromRawIndex(rawIndex))

Reimplemented from Wt::WAbstractItemModel.

virtual cpp17::any Wt::WAbstractProxyModel::headerData ( int  section,
Orientation  orientation = Orientation::Horizontal,
ItemDataRole  role = ItemDataRole::Display 
) const
overridevirtual

Returns the row or column header data.

The default proxy implementation constructs a dummy WModelIndex with the row set to 0 and column set to section if the orientation is Wt::Orientation::Horizontal, or with the row set to section and the column set to 0 if the orientation is Wt::Orientation::Vertical.

The resulting section that is forwarded to sourceModel()->headerData() depends on how the WModelIndex is transformed with mapToSource().

Reimplemented from Wt::WAbstractItemModel.

Reimplemented in Wt::WSortFilterProxyModel, Wt::WAggregateProxyModel, and Wt::WBatchEditProxyModel.

virtual WFlags<HeaderFlag> Wt::WAbstractProxyModel::headerFlags ( int  section,
Orientation  orientation = Orientation::Horizontal 
) const
overridevirtual

Returns the flags for a header.

The default proxy implementation constructs a dummy WModelIndex with the row set to 0 and column set to section if the orientation is Wt::Orientation::Horizontal, or with the row set to section and the column set to 0 if the orientation is Wt::Orientation::Vertical.

The resulting section that is forwarded to sourceModel()->headerFlags() depends on how the WModelIndex is transformed with mapToSource().

Reimplemented from Wt::WAbstractItemModel.

Reimplemented in Wt::WSortFilterProxyModel, and Wt::WAggregateProxyModel.

virtual bool Wt::WAbstractProxyModel::insertColumns ( int  column,
int  count,
const WModelIndex parent = WModelIndex() 
)
overridevirtual

Inserts one or more columns.

The default proxy implementation calls sourceModel()->insertColumns(column, count, parent)

Reimplemented from Wt::WAbstractItemModel.

Reimplemented in Wt::WBatchEditProxyModel, Wt::WReadOnlyProxyModel, and Wt::WIdentityProxyModel.

virtual WModelIndex Wt::WAbstractProxyModel::mapFromSource ( const WModelIndex sourceIndex) const
pure virtual

Maps a source model index to the proxy model.

This method returns a model index in the proxy model that corresponds to the model index sourceIndex in the source model. This method must only be implemented for source model indexes that are mapped and thus are the result of mapToSource().

See also
mapToSource()

Implemented in Wt::WAggregateProxyModel, Wt::WSortFilterProxyModel, Wt::WBatchEditProxyModel, Wt::WIdentityProxyModel, and Wt::WReadOnlyProxyModel.

virtual WModelIndex Wt::WAbstractProxyModel::mapToSource ( const WModelIndex proxyIndex) const
pure virtual

Maps a proxy model index to the source model.

This method returns a model index in the source model that corresponds to the proxy model index proxyIndex.

See also
mapFromSource()

Implemented in Wt::WAggregateProxyModel, Wt::WBatchEditProxyModel, Wt::WSortFilterProxyModel, Wt::WIdentityProxyModel, and Wt::WReadOnlyProxyModel.

virtual std::string Wt::WAbstractProxyModel::mimeType ( ) const
overridevirtual

Returns a mime-type for dragging a set of indexes.

The default proxy implementation calls sourceModel()->mimeType()

Reimplemented from Wt::WAbstractItemModel.

virtual bool Wt::WAbstractProxyModel::removeColumns ( int  column,
int  count,
const WModelIndex parent = WModelIndex() 
)
overridevirtual

Removes columns.

The default proxy implementation calls sourceModel()->removeColumns(column, count, parent)

Reimplemented from Wt::WAbstractItemModel.

Reimplemented in Wt::WBatchEditProxyModel, Wt::WIdentityProxyModel, and Wt::WReadOnlyProxyModel.

virtual bool Wt::WAbstractProxyModel::setData ( const WModelIndex index,
const cpp17::any &  value,
ItemDataRole  role = ItemDataRole::Edit 
)
overridevirtual

Sets the data at the given model index.

The default proxy implementation calls sourceModel()->setData(mapToSource(index), value, role)

Reimplemented from Wt::WAbstractItemModel.

Reimplemented in Wt::WBatchEditProxyModel, and Wt::WReadOnlyProxyModel.

virtual bool Wt::WAbstractProxyModel::setItemData ( const WModelIndex index,
const DataMap values 
)
overridevirtual

Sets the data at the given model index.

The default proxy implementation calls sourceModel()->setData(mapToSource(index), values)

Reimplemented from Wt::WAbstractItemModel.

Reimplemented in Wt::WReadOnlyProxyModel.

virtual void Wt::WAbstractProxyModel::setSourceModel ( const std::shared_ptr< WAbstractItemModel > &  sourceModel)
virtual

Sets the source model.

The source model provides the actual data for the proxy model.

Ownership of the source model is not transferred.

Note that the source model's signals are not forwarded to the proxy model by default, but some specializations, like WBatchEditProxyModel and WSortFilterProxyModel do. If you want to reimplement data() with no changes to row or column indices, consider the use of WIdentityProxyModel.

Reimplemented in Wt::WAggregateProxyModel, Wt::WBatchEditProxyModel, Wt::WSortFilterProxyModel, and Wt::WIdentityProxyModel.

std::shared_ptr<WAbstractItemModel> Wt::WAbstractProxyModel::sourceModel ( ) const

Returns the source model.

See also
setSourceModel()
void Wt::WAbstractProxyModel::startShiftModelIndexes ( const WModelIndex sourceParent,
int  start,
int  count,
ItemMap items 
)
protected

Utility methods to shift items in an item map.

You can use this method to adjust an item map after the source model has inserted or removed rows. When removing rows (count < 0), items may possibly be removed and deleted.

virtual void* Wt::WAbstractProxyModel::toRawIndex ( const WModelIndex index) const
overridevirtual

Converts a model index to a raw pointer that remains valid while the model's layout is changed.

The default proxy implementation calls sourceModel()->toRawIndex(mapToSource(index))

Reimplemented from Wt::WAbstractItemModel.


Generated on Fri Nov 24 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11