KScriptManager Class Reference
This class is the base for all script engines. More...
#include <scriptmanager.h>
Inheritance diagram for KScriptManager:


Public Slots | |
| void | runScript (const QString &scriptName, QObject *context=0, const QVariant &arg=0) |
Signals | |
| void | scriptError (const QString &msg) |
| void | scriptWarning (const QString &msg) |
| void | scriptOutput (const QString &msg) |
| void | scriptProgress (int percent) |
| void | scriptDone (KScriptClientInterface::Result result, const QVariant &returned) |
Public Member Functions | |
| KScriptManager (QObject *parent, const char *name) | |
| virtual | ~KScriptManager () |
| bool | addScript (const QString &scriptDesktopFile) |
| bool | removeScript (const QString &scriptName) |
| QStringList | scripts () |
| void | clear () |
| void | error (const QString &msg) |
| void | warning (const QString &msg) |
| void | output (const QString &msg) |
| void | progress (int percent) |
| void | done (KScriptClientInterface::Result result, const QVariant &returned) |
Protected Attributes | |
| QDict< ScriptInfo > | m_scripts |
| QDict< KScriptInterface > | m_scriptCache |
| QString | m_currentScript |
Friends | |
| class | KScriptInterface |
Detailed Description
This class is the base for all script engines.
- Author:
- Ian Reinhart Geiser <geiseri@kde.org>
Definition at line 39 of file scriptmanager.h.
Constructor & Destructor Documentation
|
||||||||||||
|
Create a new instance of the script engine.
Definition at line 28 of file scriptmanager.cpp. |
|
|
Destroy the current script engine.
Definition at line 33 of file scriptmanager.cpp. References QDict::setAutoDelete(). |
Member Function Documentation
|
|
Add a new script instance to the script engine. This should be the full name and path to the desktop file. Definition at line 39 of file scriptmanager.cpp. References QDict::insert(), KDesktopFile::isDesktopFile(), locate(), KConfigBase::readEntry(), KDesktopFile::readName(), and KDesktopFile::readType(). |
|
|
Remove a script instance from the script engine.
Definition at line 61 of file scriptmanager.cpp. References QDict::remove(). |
|
|
Access the names of script instances from the script engine.
Definition at line 67 of file scriptmanager.cpp. References QDictIterator::current(), and QDictIterator::currentKey(). |
|
|
Clear all script intstances in memory.
Definition at line 79 of file scriptmanager.cpp. References QDict::clear(). |
|
|
This function will allow the main application of any errors that have occurred during processing of the script.
Implements KScriptClientInterface. Definition at line 76 of file scriptmanager.h. |
|
|
This function will allow the main application of any warnings that have occurred during the processing of the script.
Implements KScriptClientInterface. Definition at line 81 of file scriptmanager.h. |
|
|
This function will allow the main application of any normal output that has occurred during the processing of the script.
Implements KScriptClientInterface. Definition at line 86 of file scriptmanager.h. |
|
|
This function will allow feedback to any progress bars in the main application as to how far along the script is. This is very useful when a script is processing files or doing some long operation that is of a known duration. Implements KScriptClientInterface. Definition at line 93 of file scriptmanager.h. |
|
||||||||||||
|
This function will allow feedback on completion of the script. It turns the result as a KScriptInteface::Result, and a return value as a QVariant Implements KScriptClientInterface. Definition at line 99 of file scriptmanager.h. |
|
||||||||||||||||
|
Run the selected script.
Definition at line 84 of file scriptmanager.cpp. References endl(), QDict::insert(), kdDebug(), QDict::remove(), and KMessageBox::sorry(). |
|
|
Send out a signal of the error message from the current running script.
|
|
|
Send out a signal of the warning message from the current running script.
|
|
|
Send out a signal of the output message from the current running script.
|
|
|
Send out a signal of the progress of the current running script.
|
|
||||||||||||
|
Send out a signal of the exit status of the script.
|
The documentation for this class was generated from the following files:
