C# Class Plasma.AbstractRunner

Inheritance: Qyoto.QObject
Afficher le fichier Open project: 0xd34df00d/Qross

Méthodes publiques

Méthode Description
AbstractRunner ( ) : System
AbstractRunner ( QObject parent ) : System
AbstractRunner ( QObject parent, List args ) : System
AbstractRunner ( QObject parent, string serviceId ) : System Constructs a Runner object. Since AbstractRunner has pure virtuals, this constructor can not be called directly. Rather a subclass must be created
DefaultSyntax ( ) : Plasma.RunnerSyntax
Description ( ) : string
HasRunOptions ( ) : bool If the runner has options that the user can interact with to modify what happens when run or one of the actions created in match is called, the runner should return true
Icon ( ) : Qyoto.QIcon
Id ( ) : string
IgnoredTypes ( ) : uint Returns the OR'ed value of all the Information types (as defined in RunnerContext.Type) this runner is not interested in.
Name ( ) : string
Package ( ) : Package Accessor for the associated Package object if any. Note that the returned pointer is only valid for the lifetime of the runner.
PerformMatch ( Plasma context ) : void Triggers a call to match. This will call match() internally. @arg context the search context used in executing this match.
SetIgnoredTypes ( uint types ) : void Sets the types this runner will ignore name="types" OR'ed listed of ignored types
Syntaxes ( ) : List
priority ( ) : Plasma.AbstractRunner.Priority The priority of the runner.
speed ( ) : Plasma.AbstractRunner.Speed The nominal speed of the runner.

Méthodes protégées

Méthode Description
AbstractRunner ( Type dummy ) : System
Action ( string id ) : Qyoto.QAction Returns the action associated with the id
Actions ( ) : string Returns all registered actions
AddAction ( string id, Qyoto.QIcon icon, string text ) : Qyoto.QAction Creates and then adds an action to the action registry. AbstractRunner assumes ownership of the created action. name="id" A unique identifier string name="icon" The icon to display name="text" The text to display
AddAction ( string id, Qyoto.QAction action ) : void Adds an action to the runner's action registry. The QAction must be created within the GUI thread; do not create it within the match method of AbstractRunner. name="id" A unique identifier string name="action" The QAction to be stored
AddSyntax ( Plasma syntax ) : void Adds a registered syntax that this runner understands. This is used to display to the user what this runner can understand and how it can be used. name="syntax" the syntax to register
ClearActions ( ) : void Clears the action registry. The action pool deletes the actions.
Config ( ) : Kimono.KConfigGroup Provides access to the runner's configuration object.
CreateProxy ( ) : void
DataEngine ( string name ) : DataEngine Loads the given DataEngine Tries to load the data engine given by name. Each engine is only loaded once, and that instance is re-used on all subsequent requests. If the data engine was not found, an invalid data engine is returned (see DataEngine.IsValid()). Note that you should not delete the returned engine. name="name" Name of the data engine to load
RemoveAction ( string id ) : void Removes the action from the action registry. AbstractRunner deletes the action once removed. name="id" The id of the action to be removed
SetDefaultSyntax ( Plasma syntax ) : void Set syntax as the default syntax for the runner; the default syntax will be substituted to the empty query in single runner mode. This is also used to display to the user what this runner can understand and how it can be used. The default syntax is automatically added to the list of registered syntaxes, there is no need to add it using addSyntax. Note that there can be only one default syntax; if called more than once, the last call will determine the default syntax. A default syntax (even trivial) is required to advertise single runner mode name="syntax" the syntax to register and to set as default
SetHasRunOptions ( bool hasRunOptions ) : void Sets whether or not the runner has options for matches
SetPriority ( Plasma newPriority ) : void Sets the priority of the runner. Lower priority runners are executed only after higher priority runners.
SetSpeed ( Plasma newSpeed ) : void Sets the nominal speed of the runner. Only slow runners need to call this within their constructor because the default speed is NormalSpeed. Runners that use DBUS should call this within their constructors.
SetSyntaxes ( List syns ) : void Sets the list of syntaxes; passing in an empty list effectively clears the syntaxes. name="the" syntaxes to register for this runner

Private Methods

Méthode Description
ActionsForMatch ( Plasma match ) : List
CreateRunOptions ( QWidget widget ) : void
Init ( ) : void
Match ( Plasma context ) : void
ReloadConfiguration ( ) : void
Run ( Plasma context, Plasma match ) : void

Method Details

AbstractRunner() public méthode

public AbstractRunner ( ) : System
Résultat System

AbstractRunner() public méthode

public AbstractRunner ( QObject parent ) : System
parent Qyoto.QObject
Résultat System

AbstractRunner() public méthode

public AbstractRunner ( QObject parent, List args ) : System
parent Qyoto.QObject
args List
Résultat System

AbstractRunner() public méthode

Constructs a Runner object. Since AbstractRunner has pure virtuals, this constructor can not be called directly. Rather a subclass must be created
public AbstractRunner ( QObject parent, string serviceId ) : System
parent Qyoto.QObject
serviceId string
Résultat System

AbstractRunner() protected méthode

protected AbstractRunner ( Type dummy ) : System
dummy System.Type
Résultat System

Action() protected méthode

Returns the action associated with the id
protected Action ( string id ) : Qyoto.QAction
id string
Résultat Qyoto.QAction

Actions() protected méthode

Returns all registered actions
protected Actions ( ) : string
Résultat string

AddAction() protected méthode

Creates and then adds an action to the action registry. AbstractRunner assumes ownership of the created action. name="id" A unique identifier string name="icon" The icon to display name="text" The text to display
protected AddAction ( string id, Qyoto.QIcon icon, string text ) : Qyoto.QAction
id string
icon Qyoto.QIcon
text string
Résultat Qyoto.QAction

AddAction() protected méthode

Adds an action to the runner's action registry. The QAction must be created within the GUI thread; do not create it within the match method of AbstractRunner. name="id" A unique identifier string name="action" The QAction to be stored
protected AddAction ( string id, Qyoto.QAction action ) : void
id string
action Qyoto.QAction
Résultat void

AddSyntax() protected méthode

Adds a registered syntax that this runner understands. This is used to display to the user what this runner can understand and how it can be used. name="syntax" the syntax to register
protected AddSyntax ( Plasma syntax ) : void
syntax Plasma
Résultat void

ClearActions() protected méthode

Clears the action registry. The action pool deletes the actions.
protected ClearActions ( ) : void
Résultat void

Config() protected méthode

Provides access to the runner's configuration object.
protected Config ( ) : Kimono.KConfigGroup
Résultat Kimono.KConfigGroup

CreateProxy() protected méthode

protected CreateProxy ( ) : void
Résultat void

DataEngine() protected méthode

Loads the given DataEngine Tries to load the data engine given by name. Each engine is only loaded once, and that instance is re-used on all subsequent requests. If the data engine was not found, an invalid data engine is returned (see DataEngine.IsValid()). Note that you should not delete the returned engine. name="name" Name of the data engine to load
protected DataEngine ( string name ) : DataEngine
name string
Résultat DataEngine

DefaultSyntax() public méthode

public DefaultSyntax ( ) : Plasma.RunnerSyntax
Résultat Plasma.RunnerSyntax

Description() public méthode

public Description ( ) : string
Résultat string

HasRunOptions() public méthode

If the runner has options that the user can interact with to modify what happens when run or one of the actions created in match is called, the runner should return true
public HasRunOptions ( ) : bool
Résultat bool

Icon() public méthode

public Icon ( ) : Qyoto.QIcon
Résultat Qyoto.QIcon

Id() public méthode

public Id ( ) : string
Résultat string

IgnoredTypes() public méthode

Returns the OR'ed value of all the Information types (as defined in RunnerContext.Type) this runner is not interested in.
public IgnoredTypes ( ) : uint
Résultat uint

Name() public méthode

public Name ( ) : string
Résultat string

Package() public méthode

Accessor for the associated Package object if any. Note that the returned pointer is only valid for the lifetime of the runner.
public Package ( ) : Package
Résultat Package

PerformMatch() public méthode

Triggers a call to match. This will call match() internally. @arg context the search context used in executing this match.
public PerformMatch ( Plasma context ) : void
context Plasma
Résultat void

RemoveAction() protected méthode

Removes the action from the action registry. AbstractRunner deletes the action once removed. name="id" The id of the action to be removed
protected RemoveAction ( string id ) : void
id string
Résultat void

SetDefaultSyntax() protected méthode

Set syntax as the default syntax for the runner; the default syntax will be substituted to the empty query in single runner mode. This is also used to display to the user what this runner can understand and how it can be used. The default syntax is automatically added to the list of registered syntaxes, there is no need to add it using addSyntax. Note that there can be only one default syntax; if called more than once, the last call will determine the default syntax. A default syntax (even trivial) is required to advertise single runner mode name="syntax" the syntax to register and to set as default
protected SetDefaultSyntax ( Plasma syntax ) : void
syntax Plasma
Résultat void

SetHasRunOptions() protected méthode

Sets whether or not the runner has options for matches
protected SetHasRunOptions ( bool hasRunOptions ) : void
hasRunOptions bool
Résultat void

SetIgnoredTypes() public méthode

Sets the types this runner will ignore name="types" OR'ed listed of ignored types
public SetIgnoredTypes ( uint types ) : void
types uint
Résultat void

SetPriority() protected méthode

Sets the priority of the runner. Lower priority runners are executed only after higher priority runners.
protected SetPriority ( Plasma newPriority ) : void
newPriority Plasma
Résultat void

SetSpeed() protected méthode

Sets the nominal speed of the runner. Only slow runners need to call this within their constructor because the default speed is NormalSpeed. Runners that use DBUS should call this within their constructors.
protected SetSpeed ( Plasma newSpeed ) : void
newSpeed Plasma
Résultat void

SetSyntaxes() protected méthode

Sets the list of syntaxes; passing in an empty list effectively clears the syntaxes. name="the" syntaxes to register for this runner
protected SetSyntaxes ( List syns ) : void
syns List
Résultat void

Syntaxes() public méthode

public Syntaxes ( ) : List
Résultat List

priority() public méthode

The priority of the runner.
public priority ( ) : Plasma.AbstractRunner.Priority
Résultat Plasma.AbstractRunner.Priority

speed() public méthode

The nominal speed of the runner.
public speed ( ) : Plasma.AbstractRunner.Speed
Résultat Plasma.AbstractRunner.Speed