KRunner
abstractrunner.h
71 Q_PROPERTY(bool matchingSuspended READ isMatchingSuspended WRITE suspendMatching NOTIFY matchingSuspended)
209 * @deprecated Since 5.76, feature is unused. You can still set the category property in the QueryMatch
233 KRUNNER_DEPRECATED_VERSION(5, 81, "the concept of delayed runners is deprecated, see method docs of setSpeed(Speed) for details")
256 * Sets the types this runner will ignore. If the value from RunnerContext::type() is contained in the ignored types
257 * the match() method won't be called. This way there is no unnecessary thread spawned. The same RunnerContext from
258 * which the type gets read is later passed into the match(Plasma::RunnerContext &context) method call.
260 * @deprecated feature is deprecated. Consider using the minLetterCount and matchRegex properties instead. These
269 * The minLetterCount and matchRegex can be set with a similar version check or added to the desktop file.
270 * If an older KRunner version loads such a desktop file these unknown properties are just ignored.
274 KRUNNER_DEPRECATED_VERSION(5, 76, "feature is deprecated. Consider using the minLetterCount and matchRegex properties instead")
296 * @deprecated since 5.72, use metaData(Plasma::RunnerReturnPluginMetaDataConstant) instead, see its API docs
298 KRUNNER_DEPRECATED_VERSION(5, 72, "Use metaData(Plasma::RunnerReturnPluginMetaDataConstant) instead, see its API docs")
309 * If you disable the deprecated version using the KRUNNER_DISABLE_DEPRECATED_BEFORE_AND_AT macro,
320 KPluginMetaData metadata(RunnerReturnPluginMetaDataConstant = RunnerReturnPluginMetaData) const;
327 #if KRUNNER_ENABLE_DEPRECATED_SINCE(5, 65) // not 5.28 here, this KRUNNER visibility control only added at 5.65
374 * and KRunner is not in the singleRunnerMode, the performMatch and consequently match method is not called.
375 * This can be set using the X-Plasma-Runner-Min-Letter-Count property or the setMinLetterCount method.
394 * Just like the minLetterCount property this check is ignored when the runner is in the singleRunnerMode.
461 * @param args for compatibility with KPluginFactory, should be passed on to the parent constructor
464 AbstractRunner(QObject *parent, const KPluginMetaData &pluginMetaData, const QVariantList &args);
467 KRUNNER_DEPRECATED_VERSION(5, 77, "use AbstractRunner(QObject *, const KPluginMetaData &, const QVariantList &)")
485 /// @deprecated Since 5.77, use AbstractRunner(QObject *, const KPluginMetaData &, const QVariantList &)
486 KRUNNER_DEPRECATED_VERSION(5, 77, "use AbstractRunner(QObject *, const KPluginMetaData &, const QVariantList &)")
518 * Otherwise you can set the priority of the runner to LowPriority and implement the wait using a QTimer and an
519 * event loop. It is important to check if the RunnerContext is still valid after the waiting interval.
521 KRUNNER_DEPRECATED_VERSION(5, 81, "the concept of delayed runners is deprecated, see method docs for porting instructions")
593 * @deprecated Since 5.86, create the QAction instances manually and store them in a custom container instead
595 KRUNNER_DEPRECATED_VERSION(5, 86, "create the QAction instances manually and store them in a custom container instead")
600 * @deprecated Since 5.86, create the QAction instances manually and store them in a custom container instead
602 KRUNNER_DEPRECATED_VERSION(5, 86, "create the QAction instances manually and store them in a custom container instead")
610 KRUNNER_DEPRECATED_VERSION(5, 86, "use a custom container to store the QAction instances instead")
688 * @deprecated Since 5.73, DataEngines are deprecated, use e.g. a shared library to provide the data instead.
690 KRUNNER_DEPRECATED_VERSION(5, 73, "DataEngines are deprecated, use e.g. a shared library to provide the data instead.")
721 // Boilerplate to emit a version-controlled warning about the deprecated macro at least with GCC
The RunnerManager class decides what installed runners are runnable, and their ratings....
Definition: runnermanager.h:46
void addSyntax(const QString &exampleQuery, const QString &description)
Utility overload for creating a syntax based on the given parameters.
Definition: abstractrunner.h:649
A match returned by an AbstractRunner in response to a given RunnerContext.
Definition: querymatch.h:34
An abstract base class for Plasma Runner plugins.
Definition: abstractrunner.h:68
void addSyntax(const QStringList &exampleQueries, const QString &description)
Utility overload for creating a syntax based on the given parameters.
Definition: abstractrunner.h:655
void suspend()
KSharedConfigPtr config()
Definition: runnersyntax.h:41
The RunnerContext class provides information related to a search, including the search term,...
Definition: runnercontext.h:31
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.