MauiKit Controls
mauimodel.h
33 * The MauiModel is a template model to be uses with MauiList, it aims to be a simple data model to quickly setup string based models using the FMH::MODEL_LIST and FMH::MODEL_KEY types.
45 * Now, to get the right items keep in mind: MauiList::get() gets the item at the original list index, while MauiModel::get() will get the item at the model index, if it is filtered or sorted, then that's the item you'd get.
47 * If you want to get a item from the source list and the model has been filtered or sorted you will need to use the MauiModel::mappedToSource() to map the index to the right index from the source list.
49 * Now, if you have a index from the source list and the model has been filtered or ordered you will use MauiModel::mappedFromSource() to get the right index from the model.
51 * <a href="https://invent.kde.org/maui/mauikit/-/blob/qt6-2/examples/mauilist/">You can find a more complete example at this link.</a>
60 * The data list to be consumed by the model. All the operations and features of this class depend on having an actual MauiList to act upon.
66 * A single filter string. To clear the filter just set it to a empty string or invoke the `clearFilters()`method.
78 * The key to be used for filtering. The sort keys can be found in the FMH::MODEL_NAME map of keys.
81 Q_PROPERTY(QString filterRole READ getFilterRoleName WRITE setFilterRoleName NOTIFY filterRoleNameChanged)
117 bool moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild) override;
118 bool moveRow(const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild);
144 * @brief Returns an item in the model. This method correctly maps the given index in case the model has been sorted or filtered.
151 * @brief Returns all the items in the list represented as a QVariantList to be able to be used in QML. This operation performs a transformation from FMH::MODEL_LIST to QVariantList
157 * @brief Maps a given index from the base list to the model, in case the model has been filtered or sorted, this gives you the right mapped index
164 * @brief Given an index from the filtered or sorted model it returns the mapped index to the original list index.
void clearFilters()
Restores the model if filtered, and clears all the filters set with the filter and filters properties...
Definition mauimodel.cpp:98
int mappedFromSource(const int &index) const
Maps a given index from the base list to the model, in case the model has been filtered or sorted,...
Definition mauimodel.cpp:157
int mappedToSource(const int &) const
Given an index from the filtered or sorted model it returns the mapped index to the original list ind...
Definition mauimodel.cpp:162
QVariantList getAll() const
Returns all the items in the list represented as a QVariantList to be able to be used in QML.
Definition mauimodel.cpp:45
Q_SCRIPTABLE bool setFilter(const QString &filter)
bool moveRow(const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)
virtual bool moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)
Q_OBJECTQ_OBJECT
Q_PROPERTY(...)
Q_SIGNALSQ_SIGNALS
Q_SLOTSQ_SLOTS
QSortFilterProxyModel(QObject *parent)
virtual bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const const
virtual QModelIndex index(int row, int column, const QModelIndex &parent) const const override
virtual QModelIndex parent(const QModelIndex &child) const const override
DisplayRole
typedef ItemFlags
SortOrder
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 11:57:11 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 11:57:11 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.