KRunner::ResultsModel
#include <KRunner/ResultsModel>
Public Types | |
enum | Roles { IdRole = Qt::UserRole + 1 , CategoryRelevanceRole , RelevanceRole , EnabledRole , CategoryRole , SubtextRole , ActionsRole , MultiLineRole , UrlsRole , QueryMatchRole , FavoriteIndexRole , FavoriteCountRole } |
Public Types inherited from QAbstractItemModel | |
enum | CheckIndexOption |
typedef | CheckIndexOptions |
enum | LayoutChangeHint |
Public Types inherited from QObject | |
typedef | QObjectList |
Properties | |
QStringList | favoriteIds |
int | limit |
bool | querying |
QString | queryString |
KRunner::RunnerManager * | runnerManager |
QString | singleRunner |
KPluginMetaData | singleRunnerMetaData |
Properties inherited from QSortFilterProxyModel | |
autoAcceptChildRows | |
dynamicSortFilter | |
filterCaseSensitivity | |
filterKeyColumn | |
filterRegularExpression | |
filterRole | |
isSortLocaleAware | |
recursiveFilteringEnabled | |
sortCaseSensitivity | |
sortRole | |
Properties inherited from QAbstractProxyModel | |
sourceModel | |
Properties inherited from QObject | |
objectName | |
Signals | |
void | queryStringChangeRequested (const QString &queryString, int pos) |
Public Member Functions | |
ResultsModel (const KConfigGroup &configGroup, const KConfigGroup &stateConfigGroup, QObject *parent=nullptr) | |
ResultsModel (QObject *parent=nullptr) | |
Q_INVOKABLE void | clear () |
QStringList | favoriteIds () const |
Q_SIGNAL void | favoriteIdsChanged () |
Q_INVOKABLE QMimeData * | getMimeData (const QModelIndex &idx) const |
KRunner::QueryMatch | getQueryMatch (const QModelIndex &idx) const |
int | limit () const |
Q_SIGNAL void | limitChanged () |
bool | querying () const |
Q_SIGNAL void | queryingChanged () |
QString | queryString () const |
Q_SIGNAL void | queryStringChanged (const QString &queryString) |
void | resetLimit () |
QHash< int, QByteArray > | roleNames () const override |
Q_INVOKABLE bool | run (const QModelIndex &idx) |
Q_INVOKABLE bool | runAction (const QModelIndex &idx, int actionNumber) |
KRunner::RunnerManager * | runnerManager () const |
void | setFavoriteIds (const QStringList &ids) |
void | setLimit (int limit) |
void | setQueryString (const QString &queryString) |
void | setSingleRunner (const QString &runner) |
QString | singleRunner () const |
Q_SIGNAL void | singleRunnerChanged () |
KPluginMetaData | singleRunnerMetaData () const |
Public Member Functions inherited from QSortFilterProxyModel | |
QSortFilterProxyModel (QObject *parent) | |
bool | autoAcceptChildRows () const const |
void | autoAcceptChildRowsChanged (bool autoAcceptChildRows) |
QBindable< bool > | bindableAutoAcceptChildRows () |
QBindable< bool > | bindableDynamicSortFilter () |
QBindable< Qt::CaseSensitivity > | bindableFilterCaseSensitivity () |
QBindable< int > | bindableFilterKeyColumn () |
QBindable< QRegularExpression > | bindableFilterRegularExpression () |
QBindable< int > | bindableFilterRole () |
QBindable< bool > | bindableIsSortLocaleAware () |
QBindable< bool > | bindableRecursiveFilteringEnabled () |
QBindable< Qt::CaseSensitivity > | bindableSortCaseSensitivity () |
QBindable< int > | bindableSortRole () |
virtual QModelIndex | buddy (const QModelIndex &index) const const override |
virtual bool | canFetchMore (const QModelIndex &parent) const const override |
virtual int | columnCount (const QModelIndex &parent) const const override |
virtual QVariant | data (const QModelIndex &index, int role) const const override |
virtual bool | dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override |
bool | dynamicSortFilter () const const |
virtual void | fetchMore (const QModelIndex &parent) override |
Qt::CaseSensitivity | filterCaseSensitivity () const const |
void | filterCaseSensitivityChanged (Qt::CaseSensitivity filterCaseSensitivity) |
int | filterKeyColumn () const const |
QRegularExpression | filterRegularExpression () const const |
int | filterRole () const const |
void | filterRoleChanged (int filterRole) |
virtual Qt::ItemFlags | flags (const QModelIndex &index) const const override |
virtual bool | hasChildren (const QModelIndex &parent) const const override |
virtual QVariant | headerData (int section, Qt::Orientation orientation, int role) const const override |
virtual QModelIndex | index (int row, int column, const QModelIndex &parent) const const override |
virtual bool | insertColumns (int column, int count, const QModelIndex &parent) override |
virtual bool | insertRows (int row, int count, const QModelIndex &parent) override |
void | invalidate () |
bool | isRecursiveFilteringEnabled () const const |
bool | isSortLocaleAware () const const |
virtual QModelIndex | mapFromSource (const QModelIndex &sourceIndex) const const override |
virtual QItemSelection | mapSelectionFromSource (const QItemSelection &sourceSelection) const const override |
virtual QItemSelection | mapSelectionToSource (const QItemSelection &proxySelection) const const override |
virtual QModelIndex | mapToSource (const QModelIndex &proxyIndex) const const override |
virtual QModelIndexList | match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const override |
virtual QMimeData * | mimeData (const QModelIndexList &indexes) const const override |
virtual QStringList | mimeTypes () const const override |
virtual QModelIndex | parent (const QModelIndex &child) const const override |
void | recursiveFilteringEnabledChanged (bool recursiveFilteringEnabled) |
virtual bool | removeColumns (int column, int count, const QModelIndex &parent) override |
virtual bool | removeRows (int row, int count, const QModelIndex &parent) override |
virtual int | rowCount (const QModelIndex &parent) const const override |
void | setAutoAcceptChildRows (bool accept) |
virtual bool | setData (const QModelIndex &index, const QVariant &value, int role) override |
void | setDynamicSortFilter (bool enable) |
void | setFilterCaseSensitivity (Qt::CaseSensitivity cs) |
void | setFilterFixedString (const QString &pattern) |
void | setFilterKeyColumn (int column) |
void | setFilterRegularExpression (const QRegularExpression ®ularExpression) |
void | setFilterRegularExpression (const QString &pattern) |
void | setFilterRole (int role) |
void | setFilterWildcard (const QString &pattern) |
virtual bool | setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override |
void | setRecursiveFilteringEnabled (bool recursive) |
void | setSortCaseSensitivity (Qt::CaseSensitivity cs) |
void | setSortLocaleAware (bool on) |
void | setSortRole (int role) |
virtual void | setSourceModel (QAbstractItemModel *sourceModel) override |
virtual QModelIndex | sibling (int row, int column, const QModelIndex &idx) const const override |
virtual void | sort (int column, Qt::SortOrder order) override |
Qt::CaseSensitivity | sortCaseSensitivity () const const |
void | sortCaseSensitivityChanged (Qt::CaseSensitivity sortCaseSensitivity) |
int | sortColumn () const const |
void | sortLocaleAwareChanged (bool sortLocaleAware) |
Qt::SortOrder | sortOrder () const const |
int | sortRole () const const |
void | sortRoleChanged (int sortRole) |
virtual QSize | span (const QModelIndex &index) const const override |
virtual Qt::DropActions | supportedDropActions () const const override |
Public Member Functions inherited from QAbstractProxyModel | |
QAbstractProxyModel (QObject *parent) | |
QBindable< QAbstractItemModel * > | bindableSourceModel () |
virtual bool | canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const override |
virtual bool | clearItemData (const QModelIndex &index) override |
virtual QMap< int, QVariant > | itemData (const QModelIndex &proxyIndex) const const override |
virtual void | revert () override |
virtual bool | setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override |
QAbstractItemModel * | sourceModel () const const |
void | sourceModelChanged () |
virtual bool | submit () override |
virtual Qt::DropActions | supportedDragActions () const const override |
Public Member Functions inherited from QAbstractItemModel | |
QAbstractItemModel (QObject *parent) | |
bool | checkIndex (const QModelIndex &index, CheckIndexOptions options) const const |
void | columnsAboutToBeInserted (const QModelIndex &parent, int first, int last) |
void | columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn) |
void | columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last) |
void | columnsInserted (const QModelIndex &parent, int first, int last) |
void | columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn) |
void | columnsRemoved (const QModelIndex &parent, int first, int last) |
void | dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles) |
bool | hasIndex (int row, int column, const QModelIndex &parent) const const |
void | headerDataChanged (Qt::Orientation orientation, int first, int last) |
bool | insertColumn (int column, const QModelIndex &parent) |
bool | insertRow (int row, const QModelIndex &parent) |
void | layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint) |
void | layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint) |
void | modelAboutToBeReset () |
void | modelReset () |
bool | moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild) |
virtual bool | moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild) |
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) |
virtual void | multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const |
bool | removeColumn (int column, const QModelIndex &parent) |
bool | removeRow (int row, const QModelIndex &parent) |
void | rowsAboutToBeInserted (const QModelIndex &parent, int start, int end) |
void | rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow) |
void | rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last) |
void | rowsInserted (const QModelIndex &parent, int first, int last) |
void | rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow) |
void | rowsRemoved (const QModelIndex &parent, int first, int last) |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Additional Inherited Members | |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Public Attributes inherited from QAbstractItemModel | |
DoNotUseParent | |
HorizontalSortHint | |
IndexIsValid | |
NoLayoutChangeHint | |
NoOption | |
ParentIsInvalid | |
VerticalSortHint | |
Protected Member Functions inherited from QSortFilterProxyModel | |
virtual bool | filterAcceptsColumn (int source_column, const QModelIndex &source_parent) const const |
virtual bool | filterAcceptsRow (int source_row, const QModelIndex &source_parent) const const |
void | invalidateColumnsFilter () |
void | invalidateFilter () |
void | invalidateRowsFilter () |
virtual bool | lessThan (const QModelIndex &source_left, const QModelIndex &source_right) const const |
Protected Member Functions inherited from QAbstractProxyModel | |
QModelIndex | createSourceIndex (int row, int col, void *internalPtr) const const |
Protected Member Functions inherited from QAbstractItemModel | |
void | beginInsertColumns (const QModelIndex &parent, int first, int last) |
void | beginInsertRows (const QModelIndex &parent, int first, int last) |
bool | beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild) |
bool | beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild) |
void | beginRemoveColumns (const QModelIndex &parent, int first, int last) |
void | beginRemoveRows (const QModelIndex &parent, int first, int last) |
void | beginResetModel () |
void | changePersistentIndex (const QModelIndex &from, const QModelIndex &to) |
void | changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to) |
QModelIndex | createIndex (int row, int column, const void *ptr) const const |
QModelIndex | createIndex (int row, int column, quintptr id) const const |
void | endInsertColumns () |
void | endInsertRows () |
void | endMoveColumns () |
void | endMoveRows () |
void | endRemoveColumns () |
void | endRemoveRows () |
void | endResetModel () |
QModelIndexList | persistentIndexList () const const |
virtual void | resetInternalData () |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
A model that exposes and sorts results for a given query.
- Since
- 6.0
Definition at line 30 of file resultsmodel.h.
Member Enumeration Documentation
◆ Roles
Enumerator | |
---|---|
FavoriteIndexRole | |
FavoriteCountRole |
Definition at line 70 of file resultsmodel.h.
Property Documentation
◆ favoriteIds
|
readwrite |
Definition at line 63 of file resultsmodel.h.
◆ limit
|
readwrite |
The preferred maximum number of matches in the model.
If there are lots of results from different categories, the limit can be slightly exceeded.
Default is 0, which means no limit.
Definition at line 46 of file resultsmodel.h.
◆ querying
|
read |
Whether the query is currently being run.
This can be used to show a busy indicator
Definition at line 52 of file resultsmodel.h.
◆ queryString
|
readwrite |
The query string to run.
Definition at line 37 of file resultsmodel.h.
◆ runnerManager
|
read |
Definition at line 62 of file resultsmodel.h.
◆ singleRunner
|
readwrite |
The single runner to use for querying in single runner mode.
Defaults to empty string which means all runners
Definition at line 59 of file resultsmodel.h.
◆ singleRunnerMetaData
|
read |
Definition at line 60 of file resultsmodel.h.
Constructor & Destructor Documentation
◆ ResultsModel() [1/2]
|
explicit |
Definition at line 256 of file resultsmodel.cpp.
◆ ResultsModel() [2/2]
|
explicit |
Definition at line 252 of file resultsmodel.cpp.
Member Function Documentation
◆ clear()
void ResultsModel::clear | ( | ) |
Clears the model content and resets the runner context, i.e.
no new items will appear.
Definition at line 378 of file resultsmodel.cpp.
◆ favoriteIds()
QStringList ResultsModel::favoriteIds | ( | ) | const |
Definition at line 307 of file resultsmodel.cpp.
◆ getMimeData()
QMimeData * ResultsModel::getMimeData | ( | const QModelIndex & | idx | ) | const |
Get mime data for the result at given model index idx
.
Definition at line 403 of file resultsmodel.cpp.
◆ getQueryMatch()
KRunner::QueryMatch ResultsModel::getQueryMatch | ( | const QModelIndex & | idx | ) | const |
Get match for the result at given model index idx
.
Definition at line 416 of file resultsmodel.cpp.
◆ limit()
int ResultsModel::limit | ( | ) | const |
Definition at line 322 of file resultsmodel.cpp.
◆ querying()
bool ResultsModel::querying | ( | ) | const |
Definition at line 337 of file resultsmodel.cpp.
◆ queryString()
QString ResultsModel::queryString | ( | ) | const |
Definition at line 312 of file resultsmodel.cpp.
◆ queryStringChangeRequested
|
signal |
This signal is emitted when a an InformationalMatch is run, and it is advised to update the search term, e.g.
used for calculator runner results
◆ resetLimit()
void ResultsModel::resetLimit | ( | ) |
Definition at line 332 of file resultsmodel.cpp.
◆ roleNames()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 365 of file resultsmodel.cpp.
◆ run()
bool ResultsModel::run | ( | const QModelIndex & | idx | ) |
Run the result at the given model index idx
.
Definition at line 383 of file resultsmodel.cpp.
◆ runAction()
bool ResultsModel::runAction | ( | const QModelIndex & | idx, |
int | actionNumber ) |
Run the action actionNumber
at given model index idx
.
Definition at line 393 of file resultsmodel.cpp.
◆ runnerManager()
KRunner::RunnerManager * ResultsModel::runnerManager | ( | ) | const |
Definition at line 411 of file resultsmodel.cpp.
◆ setFavoriteIds()
void ResultsModel::setFavoriteIds | ( | const QStringList & | ids | ) |
IDs of favorite plugins.
Those plugins are always in a fixed order before the other ones.
- Parameters
-
ids KPluginMetaData::pluginId values of plugins
Definition at line 301 of file resultsmodel.cpp.
◆ setLimit()
void ResultsModel::setLimit | ( | int | limit | ) |
Definition at line 327 of file resultsmodel.cpp.
◆ setQueryString()
void ResultsModel::setQueryString | ( | const QString & | queryString | ) |
Definition at line 317 of file resultsmodel.cpp.
◆ setSingleRunner()
void ResultsModel::setSingleRunner | ( | const QString & | runner | ) |
Definition at line 347 of file resultsmodel.cpp.
◆ singleRunner()
QString ResultsModel::singleRunner | ( | ) | const |
Definition at line 342 of file resultsmodel.cpp.
◆ singleRunnerMetaData()
KPluginMetaData ResultsModel::singleRunnerMetaData | ( | ) | const |
Definition at line 360 of file resultsmodel.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:29:56 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.