---

KScriptManager Class Reference

#include <scriptmanager.h>

Inheritance diagram for KScriptManager:

List of all members.

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 Methods
	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)

---

Detailed Description

This class is the base for all script engines.

Author:

Ian Reinhart Geiser <geiseri@kde.org>

Definition at line 37 of file scriptmanager.h.

---

Constructor & Destructor Documentation

KScriptManager::KScriptManager (  QObject *    parent, const char *    name )

Create a new instance of the script engine.

virtual KScriptManager::~KScriptManager (    )  [virtual]

Destroy the current script engine.

---

Member Function Documentation

bool KScriptManager::addScript (  const QString &    scriptDesktopFile )

Add a new script instance to the script engine. This should be the full name and path to the desktop file.

void KScriptManager::clear (    )

Clear all script intstances in memory

void KScriptManager::done (  KScriptClientInterface::Result    result, const QVariant &    returned )  [inline, virtual]

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 97 of file scriptmanager.h. References scriptDone().

void KScriptManager::error (  const QString &    msg )  [inline, virtual]

This function will allow the main application of any errors that have occured during processing of the script. Implements KScriptClientInterface. Definition at line 74 of file scriptmanager.h. References scriptError().

void KScriptManager::output (  const QString &    msg )  [inline, virtual]

This function will allow the main application of any normal output that has occured during the processing of the script. Implements KScriptClientInterface. Definition at line 84 of file scriptmanager.h. References scriptOutput().

void KScriptManager::progress (  int    percent )  [inline, virtual]

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 91 of file scriptmanager.h. References scriptProgress().

bool KScriptManager::removeScript (  const QString &    scriptName )

Remove a script instance from the script engine. Returns: the success of the operation.

void KScriptManager::runScript (  const QString &    scriptName, QObject *    context = 0, const QVariant &    arg = 0 )  [slot]

Run the selected script

void KScriptManager::scriptDone (  KScriptClientInterface::Result    result, const QVariant &    returned )  [signal]

Send out a signal of the exit status of the script Referenced by done().

void KScriptManager::scriptError (  const QString &    msg )  [signal]

Send out a signal of the error message from the current running script. Referenced by error().

void KScriptManager::scriptOutput (  const QString &    msg )  [signal]

Send out a signal of the output message from the current running script. Referenced by output().

void KScriptManager::scriptProgress (  int    percent )  [signal]

Send out a signal of the progress of the current running script. Referenced by progress().

QStringList KScriptManager::scripts (    )

Access the names of script instances from the script engine. Returns: a QStringList of the current scripts.

void KScriptManager::scriptWarning (  const QString &    msg )  [signal]

Send out a signal of the warning message from the current running script. Referenced by warning().

void KScriptManager::warning (  const QString &    msg )  [inline, virtual]

This function will allow the main application of any warnings that have occured during the processing of the script. Implements KScriptClientInterface. Definition at line 79 of file scriptmanager.h. References scriptWarning().

---

The documentation for this class was generated from the following file:

• scriptmanager.h

---