KScriptInterface Class Reference

#include <scriptinterface.h>

Inherits TQObject.

Inherited by ShellScript.

Public Member Functions
virtual TQString	script () const =0
virtual void	setScript (const TQString &scriptFile)=0
virtual void	setScript (const TQString &scriptLibFile, const TQString &method)=0
virtual void	run (TQObject *context=0, const TQVariant &arg=0)=0
virtual void	kill ()=0

Public Attributes
KScriptClientInterface *	ScriptClientInterface

Detailed Description

This class is the base for all script engines.

Author

Ian Reinhart Geiser geise.nosp@m.ri@k.nosp@m.de.or.nosp@m.g

Definition at line 47 of file scriptinterface.h.

Member Function Documentation

kill()

virtual void KScriptInterface::kill ( )

pure virtual

Abort the scripts run.

run()

virtual void KScriptInterface::run ( TQObject *  context = 0, const TQVariant &  arg = 0  )

pure virtual

Run the actual script code This can both take a context object that will be shared between the main application and a variant that will contain the arguments.

script()

virtual TQString KScriptInterface::script ( ) const

pure virtual

Return the current script code data.

Returns

TQString containing the currenly runable code

setScript() [1/2]

virtual void KScriptInterface::setScript ( const TQString &  scriptFile )

pure virtual

Sets the path to the script library that we are going to embed.

setScript() [2/2]

virtual void KScriptInterface::setScript ( const TQString &  scriptLibFile, const TQString &  method  )

pure virtual

Sets the path to the script library that we are going to embed.

The second argument is the function from the script library that we wish to call.

Member Data Documentation

ScriptClientInterface

KScriptClientInterface* KScriptInterface::ScriptClientInterface

This is the method for sending feedback to applications.

example of how this works:

ScriptClientInterface->error( message_to_send_back_to_the_main_application );

Will send the error message back to the main application.

Definition at line 85 of file scriptinterface.h.

---

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

• scriptinterface.h