KRunner
abstractrunner.cpp
59 AbstractRunner::AbstractRunner(QObject *parent, const KPluginMetaData &pluginMetaData, const QVariantList &args)
490 minLetterCount = runnerDescription.value(QStringLiteral("X-Plasma-Runner-Min-Letter-Count"), 0);
494 matchRegex = QRegularExpression(rawData.value(QStringLiteral("X-Plasma-Runner-Match-Regex")).toString());
497 hasUniqueResults = runnerDescription.value(QStringLiteral("X-Plasma-Runner-Unique-Results"), false);
QString pattern() const const
QHash< QString, QAction * > actions() const
Returns all registered actions.
Definition: abstractrunner.cpp:219
int size() const const
void setUrls(const QList< QUrl > &urls)
Q_EMITQ_EMIT
virtual void reloadConfiguration()
Signal runner to reload its configuration.
Definition: abstractrunner.cpp:111
void setTriggerWords(const QStringList &triggerWords)
Constructs internally a regex which requires the query to start with the trigger words.
Definition: abstractrunner.cpp:445
KConfigGroup config() const
Provides access to the runner's configuration object.
Definition: abstractrunner.cpp:100
QAction * addAction(const QString &id, const QIcon &icon, const QString &text)
Creates and then adds an action to the action registry.
Definition: abstractrunner.cpp:196
A match returned by an AbstractRunner in response to a given RunnerContext.
Definition: querymatch.h:34
QIcon fromTheme(const QString &name)
void setHasRunOptions(bool hasRunOptions)
Sets whether or not the runner has options for matches.
Definition: abstractrunner.cpp:249
bool hasMatchRegex() const
If the runner has a valid regex and non empty regex.
Definition: abstractrunner.cpp:465
An abstract base class for Plasma Runner plugins.
Definition: abstractrunner.h:68
QString escape(const QString &str)
virtual QMimeData * mimeDataForMatch(const Plasma::QueryMatch &match)
Reimplement this slot if you want your runner to support serialization and drag and drop.
Definition: abstractrunner.cpp:231
static KPluginInfo fromMetaData(const KPluginMetaData &meta)
Package package() const
Accessor for the associated Package object if any.
Definition: abstractrunner.cpp:387
void addSyntax(const RunnerSyntax &syntax)
Adds a registered syntax that this runner understands.
Definition: abstractrunner.cpp:115
virtual QIcon categoryIcon(const QString &category) const
Returns the icon which accurately describes the category category.
Definition: abstractrunner.cpp:325
virtual void createRunOptions(QWidget *widget)
If hasRunOptions() returns true, this method may be called to get a widget displaying the options the...
Definition: abstractrunner.cpp:256
bool isEmpty() const const
int length() const const
virtual void match(Plasma::RunnerContext &context)
This is the main query method.
Definition: abstractrunner.cpp:331
RunnerContext::Types ignoredTypes() const
Returns the OR'ed value of all the Information types (as defined in RunnerContext::Type) this runner ...
Definition: abstractrunner.cpp:298
void suspend()
QAction * action(const QString &id) const
Returns the action associated with the id.
Definition: abstractrunner.cpp:214
bool isMatchingSuspended() const
Definition: abstractrunner.cpp:409
qint64 elapsed() const const
void suspendMatching(bool suspend)
Sets whether or not the runner is available for match requests.
Definition: abstractrunner.cpp:414
void setMatchRegex(const QRegularExpression ®ex)
Set the matchRegex property.
Definition: abstractrunner.cpp:439
bool value(const QString &key, bool defaultValue) const
virtual QStringList categories() const
Return a list of categories that this runner provides.
Definition: abstractrunner.cpp:318
Q_INVOKABLE DataEngine * dataEngine(const QString &name) const
Loads the given DataEngine.
Definition: abstractrunner.cpp:403
Definition: runnersyntax.h:41
RunnerSyntax * defaultSyntax() const
Definition: abstractrunner.cpp:149
static Ptr serviceByStorageId(const QString &_storageId)
void init(KXmlGuiWindow *window, KGameDifficulty *difficulty=nullptr)
objectName
bool hasRunOptions()
If the runner has options that the user can interact with to modify what happens when run or one of t...
Definition: abstractrunner.cpp:242
virtual void init()
Reimplement this slot to run any initialization routines on first load.
Definition: abstractrunner.cpp:397
The RunnerContext class provides information related to a search, including the search term,...
Definition: runnercontext.h:31
void setSyntaxes(const QList< RunnerSyntax > &syns)
Sets the list of syntaxes; passing in an empty list effectively clears the syntaxes.
Definition: abstractrunner.cpp:138
void setDefaultSyntax(const RunnerSyntax &syntax)
Set syntax as the default syntax for the runner; the default syntax will be substituted to the empty ...
Definition: abstractrunner.cpp:131
void removeAction(const QString &id)
Removes the action from the action registry.
Definition: abstractrunner.cpp:208
void setPriority(Priority newPriority)
Sets the priority of the runner.
Definition: abstractrunner.cpp:292
virtual void run(const Plasma::RunnerContext &context, const Plasma::QueryMatch &match)
Called whenever an exact or possible match associated with this runner is triggered.
Definition: abstractrunner.cpp:311
AbstractRunner(QObject *parent, const KPluginMetaData &pluginMetaData, const QVariantList &args)
Constructor for a KRunner plugin.
Definition: abstractrunner.cpp:59
void setIgnoredTypes(RunnerContext::Types types)
Sets the types this runner will ignore.
Definition: abstractrunner.cpp:305
QList< RunnerSyntax > syntaxes() const
Definition: abstractrunner.cpp:143
void performMatch(Plasma::RunnerContext &context)
Triggers a call to match.
Definition: abstractrunner.cpp:156
void setSpeed(Speed newSpeed)
Sets the nominal speed of the runner.
Definition: abstractrunner.cpp:279
virtual QList< QAction * > actionsForMatch(const Plasma::QueryMatch &match)
A given match can have more than action that can be performed on it.
Definition: abstractrunner.cpp:190
QObject * parent() const const
bool isValid() const const
char * toString(const EngineQuery &query)
void start()
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Dec 2 2023 03:50:59 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Dec 2 2023 03:50:59 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.