lib
Kross::Api::ScriptGUIClient Class Reference
#include <scriptguiclient.h>
Inheritance diagram for Kross::Api::ScriptGUIClient:

Detailed Description
The ScriptGUIClient class provides abstract access to scripting code used to extend an applications functionality.
Definition at line 43 of file scriptguiclient.h.
Public Types | |
typedef QPtrList< KAction > | List |
Public Slots | |
KURL | openScriptFile (const QString &caption=QString::null) |
bool | loadScriptFile () |
bool | executeScriptFile () |
bool | executeScriptFile (const QString &file) |
bool | executeScriptAction (ScriptAction::Ptr action) |
void | showScriptManager () |
Signals | |
void | collectionChanged (ScriptActionCollection *) |
void | executionStarted (const Kross::Api::ScriptAction *) |
void | executionFinished (const Kross::Api::ScriptAction *) |
Public Member Functions | |
ScriptGUIClient (KXMLGUIClient *guiclient, QWidget *parent=0) | |
virtual | ~ScriptGUIClient () |
bool | hasActionCollection (const QString &name) |
ScriptActionCollection * | getActionCollection (const QString &name) |
QMap< QString, ScriptActionCollection * > | getActionCollections () |
void | addActionCollection (const QString &name, ScriptActionCollection *collection) |
bool | removeActionCollection (const QString &name) |
void | reloadInstalledScripts () |
bool | installScriptPackage (const QString &scriptpackagefile) |
bool | uninstallScriptPackage (const QString &scriptpackagepath) |
bool | loadScriptConfigFile (const QString &scriptconfigfile) |
bool | loadScriptConfigDocument (const QString &scriptconfigfile, const QDomDocument &document) |
virtual void | setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true) |
virtual void | setDOMDocument (const QDomDocument &document, bool merge=false) |
Member Typedef Documentation
|
Definition at line 53 of file scriptguiclient.h. |
Constructor & Destructor Documentation
|
Constructor.
Definition at line 67 of file scriptguiclient.cpp. |
|
Destructor.
Definition at line 96 of file scriptguiclient.cpp. |
Member Function Documentation
|
Add a new ScriptActionCollection with the name
Definition at line 119 of file scriptguiclient.cpp. |
|
Emitted if a ScriptActionCollection instances changed.
|
|
This method executes the ScriptAction Internaly we just call ScriptAction::activate and redirect the success/failed signals to our internal slots. Definition at line 363 of file scriptguiclient.cpp. |
|
Execute the scriptfile Internaly we try to use the defined filename to auto-detect the Interpreter which should be used for the execution. Definition at line 355 of file scriptguiclient.cpp. |
|
A KFileDialog will be displayed to let the user choose the scriptfile that should be executed. The executed ScriptAction will be added to the ScriptActionCollection of executed scripts. Definition at line 347 of file scriptguiclient.cpp. |
|
This signal is emited when the execution of a script is finished.
|
|
This signal is emited when the execution of a script is started.
|
|
Definition at line 109 of file scriptguiclient.cpp. |
|
Definition at line 114 of file scriptguiclient.cpp. |
|
Definition at line 104 of file scriptguiclient.cpp. |
|
Install the packagefile Those packagefile should be a tar.gz-archive which will be extracted and to the users script-directory. Definition at line 149 of file scriptguiclient.cpp. |
|
Load the
Definition at line 219 of file scriptguiclient.cpp. |
|
Load the scriptpackage's configurationfile
Definition at line 199 of file scriptguiclient.cpp. |
|
A KFileDialog will be displayed to let the user choose a scriptfile that should be loaded. Those loaded ScriptAction will be added to the ScriptActionCollection of loaded scripts. Definition at line 326 of file scriptguiclient.cpp. |
|
A KFileDialog will be displayed to let the user choose a scriptfile. The choosen file will be returned as KURL. Definition at line 305 of file scriptguiclient.cpp. |
|
Reload the list of installed scripts.
Definition at line 136 of file scriptguiclient.cpp. |
|
Remove the ScriptActionCollection defined with name
Definition at line 125 of file scriptguiclient.cpp. |
|
KXMLGUIClient overloaded method to set the XML DOM-document.
Reimplemented from KXMLGUIClient. Definition at line 269 of file scriptguiclient.cpp. |
|
KXMLGUIClient overloaded method to set the XML file.
Reimplemented from KXMLGUIClient. Definition at line 264 of file scriptguiclient.cpp. |
|
The ScriptManagerGUI dialog will be displayed to let the user manage the scriptfiles.
Definition at line 376 of file scriptguiclient.cpp. |
|
Uninstall the scriptpackage located in the path This just deletes the whole directory. Definition at line 189 of file scriptguiclient.cpp. |
The documentation for this class was generated from the following files: