KRunner 5.109.0
|
A match returned by an AbstractRunner in response to a given RunnerContext. More...
#include <KRunner/QueryMatch>
Public Types | |
enum | Type { NoMatch = 0 , CompletionMatch = 10 , PossibleMatch = 30 , HelperMatch = 70 , ExactMatch = 100 } |
The type of match. More... | |
Public Member Functions | |
QueryMatch (AbstractRunner *runner=nullptr) | |
Constructs a PossibleMatch associated with a given RunnerContext and runner. | |
QueryMatch (const QueryMatch &other) | |
Copy constructor. | |
QList< QAction * > | actions () const |
List of actions set for this match. | |
void | addAction (QAction *actions) |
Adds an action to this match. | |
QVariant | data () const |
QIcon | icon () const |
QString | iconName () const |
QString | id () const |
bool | isEnabled () const |
bool | isMultiLine () const |
If the text should be displayed as a multiLine string If no explicit value is set set using setMultiline it will default to false. | |
bool | isValid () const |
QString | matchCategory () const |
Extra information about the match which can be used to categorize the type. | |
bool | operator!= (const QueryMatch &other) const |
bool | operator< (const QueryMatch &other) const |
QueryMatch & | operator= (const QueryMatch &other) |
bool | operator== (const QueryMatch &other) const |
qreal | relevance () const |
The relevance of this action to the search. | |
void | run (const RunnerContext &context) const |
Requests this match to activae using the given context. | |
AbstractRunner * | runner () const |
QAction * | selectedAction () const |
The current action. | |
void | setActions (const QList< QAction * > &actions) |
Set the actions for this match. | |
void | setData (const QVariant &data) |
Sets data to be used internally by the associated AbstractRunner. | |
void | setEnabled (bool enable) |
Sets whether or not this match can be activited. | |
void | setIcon (const QIcon &icon) |
Sets the icon associated with this match. | |
void | setIconName (const QString &iconName) |
Sets the icon name associated with this match. | |
void | setId (const QString &id) |
Sets the id for this match; useful if the id does not match data().toString(). | |
void | setMatchCategory (const QString &category) |
Sets information about the type of the match which can be used to categorize the match. | |
void | setMultiLine (bool multiLine) |
Set if the text should be displayed as a multiLine string. | |
void | setRelevance (qreal relevance) |
Sets the relevance of this action for the search it was created for. | |
void | setSelectedAction (QAction *action) |
Sets the selected action. | |
void | setSubtext (const QString &text) |
Sets the descriptive text for this match; can be longer than the main title text. | |
void | setText (const QString &text) |
Sets the main title text for this match; should be short enough to fit nicely on one line in a user interface. | |
void | setType (Type type) |
Sets the type of match this action represents. | |
void | setUrls (const QList< QUrl > &urls) |
Sets the urls, if any, associated with this match. | |
QString | subtext () const |
QString | text () const |
Type | type () const |
The type of action this is. | |
QList< QUrl > | urls () const |
A match returned by an AbstractRunner in response to a given RunnerContext.
The type of match.
Value is important here as it is used for sorting
|
explicit |
Constructs a PossibleMatch associated with a given RunnerContext and runner.
runner | the runner this match belongs to |
Plasma::QueryMatch::QueryMatch | ( | const QueryMatch & | other | ) |
Copy constructor.
QList< QAction * > Plasma::QueryMatch::actions | ( | ) | const |
List of actions set for this match.
void Plasma::QueryMatch::addAction | ( | QAction * | actions | ) |
QVariant Plasma::QueryMatch::data | ( | ) | const |
QIcon Plasma::QueryMatch::icon | ( | ) | const |
QString Plasma::QueryMatch::iconName | ( | ) | const |
QString Plasma::QueryMatch::id | ( | ) | const |
bool Plasma::QueryMatch::isEnabled | ( | ) | const |
bool Plasma::QueryMatch::isMultiLine | ( | ) | const |
If the text should be displayed as a multiLine string If no explicit value is set set using setMultiline it will default to false.
bool Plasma::QueryMatch::isValid | ( | ) | const |
QString Plasma::QueryMatch::matchCategory | ( | ) | const |
Extra information about the match which can be used to categorize the type.
By default this returns the internal name of the runner which returned this result
qreal Plasma::QueryMatch::relevance | ( | ) | const |
The relevance of this action to the search.
By default, the relevance is 1.
void Plasma::QueryMatch::run | ( | const RunnerContext & | context | ) | const |
Requests this match to activae using the given context.
context | the context to use in conjunction with this run |
AbstractRunner * Plasma::QueryMatch::runner | ( | ) | const |
QAction * Plasma::QueryMatch::selectedAction | ( | ) | const |
The current action.
void Plasma::QueryMatch::setActions | ( | const QList< QAction * > & | actions | ) |
Set the actions for this match.
This method allows you to set the actions inside of the AbstractRunner::match() method and the default implementation of AbstractRunner::actionsForMatch() will return these.
void Plasma::QueryMatch::setData | ( | const QVariant & | data | ) |
Sets data to be used internally by the associated AbstractRunner.
When set, it is also used to form part of the id() for this match. If that is inappropriate as an id, the runner may generate its own id and set that with setId(const QString&) directly after calling setData
void Plasma::QueryMatch::setEnabled | ( | bool | enable | ) |
Sets whether or not this match can be activited.
enable | true if the match is enabled and therefore runnable |
void Plasma::QueryMatch::setIcon | ( | const QIcon & | icon | ) |
Sets the icon associated with this match.
Prefer using setIconName.
icon | the icon to show along with the match |
void Plasma::QueryMatch::setIconName | ( | const QString & | iconName | ) |
Sets the icon name associated with this match.
icon | the name of the icon to show along with the match |
void Plasma::QueryMatch::setId | ( | const QString & | id | ) |
Sets the id for this match; useful if the id does not match data().toString().
The id must be unique to all matches from this runner, and should remain constant for the same query for best results.
id | the new identifying string to use to refer to this entry |
void Plasma::QueryMatch::setMatchCategory | ( | const QString & | category | ) |
Sets information about the type of the match which can be used to categorize the match.
This string should be translated as it can be displayed in an UI
void Plasma::QueryMatch::setMultiLine | ( | bool | multiLine | ) |
Set if the text should be displayed as a multiLine string.
multiLine |
void Plasma::QueryMatch::setRelevance | ( | qreal | relevance | ) |
Sets the relevance of this action for the search it was created for.
relevance | a number between 0 and 1. |
void Plasma::QueryMatch::setSelectedAction | ( | QAction * | action | ) |
Sets the selected action.
void Plasma::QueryMatch::setSubtext | ( | const QString & | text | ) |
Sets the descriptive text for this match; can be longer than the main title text.
text | the text to use as the description |
void Plasma::QueryMatch::setText | ( | const QString & | text | ) |
Sets the main title text for this match; should be short enough to fit nicely on one line in a user interface.
text | the text to use as the title |
void Plasma::QueryMatch::setType | ( | Type | type | ) |
Sets the type of match this action represents.
void Plasma::QueryMatch::setUrls | ( | const QList< QUrl > & | urls | ) |
Sets the urls, if any, associated with this match.
QString Plasma::QueryMatch::subtext | ( | ) | const |
QString Plasma::QueryMatch::text | ( | ) | const |
Type Plasma::QueryMatch::type | ( | ) | const |
The type of action this is.
Defaults to PossibleMatch.
QList< QUrl > Plasma::QueryMatch::urls | ( | ) | const |