KRunner

Deprecated List
Member K_EXPORT_PLASMA_RUNNER
Since 5.72, use K_EXPORT_PLASMA_RUNNER_WITH_JSON(classname, jsonFile) instead
Member K_EXPORT_PLASMA_RUNNER_WITH_JSON
Since 5.88 use K_PLUGIN_CLASS_WITH_JSON instead
Member Plasma::AbstractRunner::AbstractRunner (QObject *parent, const QVariantList &args)
Since 5.77, use AbstractRunner(QObject *, const KPluginMetaData &, const QVariantList &)
Member Plasma::AbstractRunner::AbstractRunner (const KService::Ptr service, QObject *parent=nullptr)
Since 5.72, use AbstractRunner(const KPluginMetaData &, QObject *)
Member Plasma::AbstractRunner::action (const QString &id) const
Since 5.86, create the QAction instances manually and store them in a custom container instead
Member Plasma::AbstractRunner::actions () const
Since 5.86, create the QAction instances manually and store them in a custom container instead
Member Plasma::AbstractRunner::addAction (const QString &id, const QIcon &icon, const QString &text)
Since 5.86 create the QAction instance manually
Member Plasma::AbstractRunner::addAction (const QString &id, QAction *action)
Since 5.86, create the QAction instance manually
Member Plasma::AbstractRunner::categories () const
Since 5.76, feature is unused. You can still set the category property in the QueryMatch
Member Plasma::AbstractRunner::categoryIcon (const QString &category) const
Since 5.0, feature removed
Member Plasma::AbstractRunner::clearActions ()
Since 5.86, use a custom container to store the QAction instances instead
Member Plasma::AbstractRunner::createRunOptions (QWidget *widget)
Since 5.0, this feature has been defunct
Member Plasma::AbstractRunner::dataEngine (const QString &name) const
Since 5.73, DataEngines are deprecated, use e.g. a shared library to provide the data instead.
Member Plasma::AbstractRunner::defaultSyntax () const
Since 5.76, feature is unused.
Member Plasma::AbstractRunner::hasRunOptions ()
Since 5.0, this feature has been defunct
Member Plasma::AbstractRunner::ignoredTypes () const
This feature is deprecated
Member Plasma::AbstractRunner::metadata () const
since 5.72, use metaData(Plasma::RunnerReturnPluginMetaDataConstant) instead, see its API docs
Member Plasma::AbstractRunner::package () const
since 5.28, use KPackage::Package instead, no accessor in this class
Member Plasma::AbstractRunner::performMatch (Plasma::RunnerContext &context)
Since 5.81, use match(Plasma::RunnerContext &context) instead. This method contains logic to delay slow runners, which is now deprecated. Consequently you should call match(Plasma::RunnerContext &context) directly.
Member Plasma::AbstractRunner::removeAction (const QString &id)
Since 5.86, deprecated for lack of usage
Member Plasma::AbstractRunner::setDefaultSyntax (const RunnerSyntax &syntax)
Since 5.76, feature is unused. Use addSyntax() instead.
Member Plasma::AbstractRunner::setHasRunOptions (bool hasRunOptions)
Since 5.0, this feature has been defunct
Member Plasma::AbstractRunner::setIgnoredTypes (RunnerContext::Types types)
feature is deprecated. Consider using the minLetterCount and matchRegex properties instead. These properties also prevent thread spawning, but can be used far more precise. If you want to have this kind of optimization for older KRunner versions you could wrap this inside of an version if statement:
Member Plasma::AbstractRunner::setSpeed (Speed newSpeed)
Since 5.81, the concept of delayed runners is deprecated. If you have resource or memory intensive tasks consider porting the runner to a D-Bus runner. Otherwise you can set the priority of the runner to LowPriority and implement the wait using a QTimer and an event loop. It is important to check if the RunnerContext is still valid after the waiting interval.
Member Plasma::QueryMatch::createConfigurationInterface (QWidget *parent)
Since 5.0, this feature has been defunct
Member Plasma::QueryMatch::hasConfigurationInterface () const
Since 5.0, this feature has been defunct
Member Plasma::QueryMatch::InformationalMatch
Since 5.99, call RunnerContext::requestQueryStringUpdate in AbstractRunner::run method instead
Member Plasma::QueryMatch::mimeType () const
Since 5.82, deprecated for lack of usage
Member Plasma::QueryMatch::setMimeType (const QString &mimeType)
Since 5.82, deprecated for lack of usage
Member Plasma::RunnerContext::enabledCategories () const
Since 5.76, feature is unused and not supported by most runners
Member Plasma::RunnerContext::match (const QString &id) const
Since 5.79, deprecated due to lack of usage. Instead filter the matches manually based on the id
Member Plasma::RunnerContext::mimeType () const
feature is unused, determine the mime type manually if needed
Member Plasma::RunnerContext::removeMatch (const QString matchId)
Since 5.81, feature is unused, aggregate and filter the matches before adding them to the runnercontext instead
Member Plasma::RunnerContext::removeMatches (const QStringList matchIdList)
Since 5.81, feature is unused, aggregate and filter the matches before adding them to the runnercontext instead
Member Plasma::RunnerContext::removeMatches (AbstractRunner *runner)
Since 5.81, feature is unused, aggregate and filter the matches before adding them to the runnercontext instead
Member Plasma::RunnerContext::setEnabledCategories (const QStringList &categories)
Since 5.76, feature is unused and not supported by most runners
Member Plasma::RunnerContext::type () const
feature is deprecated. Do the checks manually inside of the match logic
Member Plasma::RunnerManager::allowedRunners () const
Since 5.88, reading allowed runners from the config is deprecated, use runners() and get their AbstractRunner::id instead
Member Plasma::RunnerManager::enabledCategories () const
Since 5.76, feature is unused and not supported by most runners
Member Plasma::RunnerManager::listRunnerInfo (const QString &parentApp=QString())
since 5.72, use runnerMetaDataList() instead
Member Plasma::RunnerManager::loadRunner (const QString &path)
Since 5.0, the KPackage support was removed in Plasma 5.0
Member Plasma::RunnerManager::loadRunner (const KService::Ptr service)
Since 5.72, use loadRunner(const KPluginMetaData &)
Member Plasma::RunnerManager::mimeDataForMatch (const QString &matchId) const
Since 5.79, use mimeDataForMatch(const QueryMatch &match) instead
Member Plasma::RunnerManager::run (const QString &id)
Since 5.79, use run(const QueryMatch &match) instead
Member Plasma::RunnerManager::RunnerManager (KConfigGroup &config, QObject *parent=nullptr)
Since 5.76, use "RunnerManager(const QString &configFile, QObject *parent)" instead.
Member Plasma::RunnerManager::runnerMetaDataList (const QString &parentApp)
Since 5.85, the concept of parent apps for runners is deprecated, use no-arg overload instead
Member Plasma::RunnerManager::runnerName (const QString &id) const
Since 5.81, call runner(const QString &id) and fetch the name from the returned object instead
Member Plasma::RunnerManager::setEnabledCategories (const QStringList &categories)
Since 5.76, feature is unused and not supported by most runners
Member Plasma::RunnerManager::setSingleMode (bool singleMode)
Since 5.82, the dedicated singleRunnerMode methods are deprecated, the single mode is set to true when launchQuery is called with a non empty and existing runnerId
Member Plasma::RunnerManager::setSingleModeRunnerId (const QString &id)
Since 5.82, the dedicated singleRunnerMode methods are deprecated, pass in the singleModeRunnerId into the launchQuery overload instead
Member Plasma::RunnerManager::singleMode () const
Since 5.82, the dedicated singleRunnerMode methods are deprecated, call the RunnerContext::singleRunnerQueryMode on the searchContext instead
Member Plasma::RunnerManager::singleModeAdvertisedRunnerIds () const
Since 5.81, filter the runners manually using the X-Plasma-AdvertiseSingleRunnerQueryMode of the metadata
Member Plasma::RunnerManager::singleModeRunner () const
Since 5.81, the dedicated singleRunnerMode methods are deprecated, use runner(const QString &pluginName) with the singleRunnerId instead"
Member Plasma::RunnerManager::singleModeRunnerId () const
Since 5.82, the dedicated singleRunnerMode methods are deprecated, use runner(const QString &pluginName) with the singleRunnerId instead
Member Plasma::RunnerSyntax::exampleQueriesWithTermDescription () const
Since 5.76, the description should be directly set when creating the example query. To display the queries in the user interface. Use exampleQueries() instead.
Member Plasma::RunnerSyntax::searchTermDescription () const
Since 5.76, the description should be directly set when creating the example query.
Member Plasma::RunnerSyntax::setSearchTermDescription (const QString &description)
Since 5.76, set the description directly when creating the example query. Use <my query description> instead of :q: when creating the string
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Nov 27 2022 04:13:32 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.