Plasma
Plasma::RunnerManager Class Reference
The RunnerManager class decides what installed runners are runnable, and their ratings. More...
#include <Plasma/RunnerManager>

Public Slots | |
bool | execQuery (const QString &term) |
bool | execQuery (const QString &term, const QString &runnerName) |
void | launchQuery (const QString &term) |
void | launchQuery (const QString &term, const QString &runnerName) |
void | reset () |
Signals | |
void | matchesChanged (const QList< Plasma::QueryMatch > &matches) |
Public Member Functions | |
QList< QAction * > | actionsForMatch (const QueryMatch &match) |
QList< QueryMatch > | matches () const |
QString | query () const |
void | reloadConfiguration () |
void | run (const QString &id) |
void | run (const QueryMatch &match) |
AbstractRunner * | runner (const QString &name) const |
RunnerManager (KConfigGroup &config, QObject *parent=0) | |
RunnerManager (QObject *parent=0) | |
QList< AbstractRunner * > | runners () const |
RunnerContext * | searchContext () const |
~RunnerManager () |
Detailed Description
The RunnerManager class decides what installed runners are runnable, and their ratings.
It is the main proxy to the runners.
Definition at line 47 of file runnermanager.h.
Constructor & Destructor Documentation
Plasma::RunnerManager::RunnerManager | ( | QObject * | parent = 0 |
) | [explicit] |
Definition at line 230 of file runnermanager.cpp.
Plasma::RunnerManager::RunnerManager | ( | KConfigGroup & | config, | |
QObject * | parent = 0 | |||
) | [explicit] |
Definition at line 239 of file runnermanager.cpp.
Plasma::RunnerManager::~RunnerManager | ( | ) |
Definition at line 250 of file runnermanager.cpp.
Member Function Documentation
QList< QAction * > Plasma::RunnerManager::actionsForMatch | ( | const QueryMatch & | match | ) |
Retrieves the list of actions, if any, for a match.
Definition at line 319 of file runnermanager.cpp.
bool Plasma::RunnerManager::execQuery | ( | const QString & | term | ) | [slot] |
Convenience version of above.
Definition at line 384 of file runnermanager.cpp.
bool Plasma::RunnerManager::execQuery | ( | const QString & | term, | |
const QString & | runnerName | |||
) | [slot] |
Execute a query, this method will only return when the query is executed This means that the method may be dangerous as it wait a variable amount of time for the runner to finish.
The runner parameter is mandatory, to avoid launching unwanted runners.
- term the term we want to find matches for
- runner the runner we will use, it is mandatory
- Returns:
- 0 if nothing was launched, 1 if launched.
Definition at line 389 of file runnermanager.cpp.
void Plasma::RunnerManager::launchQuery | ( | const QString & | term | ) | [slot] |
Convenience version of above.
Definition at line 329 of file runnermanager.cpp.
void Plasma::RunnerManager::launchQuery | ( | const QString & | term, | |
const QString & | runnerName | |||
) | [slot] |
Launch a query, this will create threads and return inmediately.
When the information will be available can be known using the matchesChanged signal.
- term the term we want to find matches for
- runner optional, if only one specific runner is to be used
Definition at line 334 of file runnermanager.cpp.
QList< QueryMatch > Plasma::RunnerManager::matches | ( | ) | const |
Retrieves all available matches found so far for the previously launched query.
- Returns:
- List of matches
Definition at line 285 of file runnermanager.cpp.
void Plasma::RunnerManager::matchesChanged | ( | const QList< Plasma::QueryMatch > & | matches | ) | [signal] |
Emitted each time a new match is added to the list.
QString Plasma::RunnerManager::query | ( | ) | const |
- Returns:
- the current query term
Definition at line 429 of file runnermanager.cpp.
void Plasma::RunnerManager::reloadConfiguration | ( | ) |
Causes a reload of the current configuration.
Definition at line 259 of file runnermanager.cpp.
void Plasma::RunnerManager::reset | ( | ) | [slot] |
Reset the current data and stops the query.
Definition at line 434 of file runnermanager.cpp.
void Plasma::RunnerManager::run | ( | const QString & | id | ) |
void Plasma::RunnerManager::run | ( | const QueryMatch & | match | ) |
Runs a given match.
- match the match to be executed
Definition at line 295 of file runnermanager.cpp.
AbstractRunner * Plasma::RunnerManager::runner | ( | const QString & | name | ) | const |
Finds and returns a loaded runner or NULL.
- name the name of the runner
- Returns:
- Pointer to the runner
Definition at line 265 of file runnermanager.cpp.
QList< AbstractRunner * > Plasma::RunnerManager::runners | ( | ) | const |
- Returns:
- the list of all currently loaded runners
Definition at line 274 of file runnermanager.cpp.
RunnerContext * Plasma::RunnerManager::searchContext | ( | ) | const |
Retrieves the current context.
- Returns:
- pointer to the current context
Definition at line 279 of file runnermanager.cpp.
The documentation for this class was generated from the following files: