Template Class Model

Inheritance Relationships

Derived Types

Class Documentation

template<typename ModelData>
class Model

A Model is providing Data for Slint Models or ListView elements of the .slint language

This is typically used in a std::shared_ptr<slint::Model>. Model is an abstract class and you can derive from it to provide your own data model, or use one of the provided models such as slint::VectorModel

An implementation of the Model can provide data to slint by re-implementing the row_count and row_data functions. It is the responsibility of the Model implementation to call the Model::notify_row_changed(), Model::notify_row_added(), Model::notify_row_removed(), or Model::notify_reset() functions when the underlying data changes.

Note that the Model is not thread-safe. All Model operations need to be done in the main thread. If you need to update the model data from another thread, use the slint::invoke_from_event_loop() function to send the data to the main thread and update the model.

Subclassed by slint::FilterModel< ModelData >, slint::MapModel< SourceModelData, MappedModelData >, slint::ReverseModel< ModelData >, slint::SortModel< ModelData >, slint::VectorModel< ModelData >

Public Functions

virtual ~Model() = default
Model() = default
Model(const Model&) = delete
Model &operator=(const Model&) = delete
virtual size_t row_count() const = 0

The amount of row in the model.

virtual std::optional<ModelData> row_data(size_t i) const = 0

Returns the data for a particular row. This function should be called with row < row_count().

inline virtual void set_row_data(size_t, const ModelData&)

Sets the data for a particular row.

This function should only be called with row < row_count().

If the model cannot support data changes, then it is ok to do nothing. The default implementation will print a warning to stderr.

If the model can update the data, it should also call row_changed

Protected Functions

inline void notify_row_changed(size_t row)

Notify the views that a specific row was changed

Your model implementation should call this function after the data of a row changes.

inline void notify_row_added(size_t index, size_t count)

Notify the views that rows were added

Your model implementation should call this function after the row were added.

inline void notify_row_removed(size_t index, size_t count)

Notify the views that rows were removed

Your model implementation should call this function after the row were removed.

inline void notify_reset()

Notify the views that the model has been changed and that everything needs to be reloaded

Your model implementation should call this function after the model has been changed.

inline void row_changed(size_t row)

Deprecated:

inline void row_added(size_t index, size_t count)

Deprecated:

inline void row_removed(size_t index, size_t count)

Deprecated:

inline void reset()

Deprecated: