lib
Kross::Api::ScriptAction Class Reference
#include <scriptaction.h>
Inheritance diagram for Kross::Api::ScriptAction:

Detailed Description
A ScriptAction extends a KAction by providing a wrapper around a ScriptContainer to execute scripting code on activation.
Definition at line 39 of file scriptaction.h.
Public Types | |
typedef KSharedPtr< ScriptAction > | Ptr |
Public Slots | |
virtual void | activate () |
void | finalize () |
Signals | |
void | activated (const Kross::Api::ScriptAction *) |
void | success () |
void | failed (const QString &errormessage, const QString &tracedetails) |
Public Member Functions | |
ScriptAction (const QString &file) | |
ScriptAction (const QString &scriptconfigfile, const QDomElement &element) | |
virtual | ~ScriptAction () |
int | version () const |
const QString | getDescription () const |
void | setDescription (const QString &description) |
void | setInterpreterName (const QString &name) |
const QString | getPackagePath () const |
const QStringList & | getLogs () const |
void | attach (ScriptActionCollection *collection) |
void | detach (ScriptActionCollection *collection) |
void | detachAll () |
Properties | |
QString | description |
Member Typedef Documentation
|
Shared pointer to implement reference-counting.
Reimplemented from Kross::Api::ScriptContainer. Definition at line 60 of file scriptaction.h. |
Constructor & Destructor Documentation
|
Constructor.
Definition at line 86 of file scriptaction.cpp. |
|
Constructor.
Definition at line 107 of file scriptaction.cpp. |
|
Destructor.
Definition at line 175 of file scriptaction.cpp. |
Member Function Documentation
|
If the ScriptAction got activated the ScriptContainer got executed. Once this slot got executed it will emit a success() or failed() signal. Reimplemented from KAction. Definition at line 231 of file scriptaction.cpp. |
|
This signal got emitted when this action is emitted before execution.
|
|
Attach this ScriptAction to the ScriptActionCollection
Definition at line 215 of file scriptaction.cpp. |
|
Detach this ScriptAction from the ScriptActionCollection
Definition at line 220 of file scriptaction.cpp. |
|
Detach this ScriptAction from all ScriptActionCollection instance his ScriptAction is attached to.
Definition at line 225 of file scriptaction.cpp. |
|
This signal got emitted after the try to execute this ScriptAction failed.
The |
|
This slot finalizes the ScriptContainer and tries to clean any still running script.
Reimplemented from Kross::Api::ScriptContainer. Definition at line 248 of file scriptaction.cpp. |
|
Definition at line 187 of file scriptaction.cpp. |
|
Definition at line 210 of file scriptaction.cpp. |
|
Definition at line 205 of file scriptaction.cpp. |
|
Set the description
Definition at line 192 of file scriptaction.cpp. |
|
Set the name of the interpreter which will be used on activation to execute the scripting code.
Reimplemented from Kross::Api::ScriptContainer. Definition at line 199 of file scriptaction.cpp. |
|
This signal got emitted after this ScriptAction got executed successfully.
|
|
Definition at line 182 of file scriptaction.cpp. |
Property Documentation
|
The description for this ScriptAction .
Definition at line 55 of file scriptaction.h. |
The documentation for this class was generated from the following files: