.TH "KScriptInterface" 3 "28 Jan 2004" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KScriptInterface \- This class is the base for all script engines.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <scriptinterface.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
Inherited by ShellScript.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBQString\fP \fBscript\fP () const =0"
.br
.RI "\fIReturn the current script code data. \fP"
.ti -1c
.RI "virtual void \fBsetScript\fP (const  \fBQString\fP &scriptFile)=0"
.br
.RI "\fISets the path to the script library that we are going to embed. \fP"
.ti -1c
.RI "virtual void \fBsetScript\fP (const  \fBQString\fP &scriptLibFile, const  \fBQString\fP &method)=0"
.br
.RI "\fISets the path to the script library that we are going to embed. \fP"
.ti -1c
.RI "virtual void \fBrun\fP (\fBQObject\fP *context=0, const  \fBQVariant\fP &arg=0)=0"
.br
.RI "\fIRun 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. \fP"
.ti -1c
.RI "virtual void \fBkill\fP ()=0"
.br
.RI "\fIAbort the scripts run. \fP"
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBKScriptClientInterface\fP * \fBScriptClientInterface\fP"
.br
.RI "\fIThis is the method for sending feedback to applications. \fP"
.in -1c
.SH "Detailed Description"
.PP 
This class is the base for all script engines. 

\fBAuthor:\fP
.RS 4
Ian Reinhart Geiser <geiseri@kde.org> 
.RE
.PP

.PP
Definition at line 45 of file scriptinterface.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual \fBQString\fP KScriptInterface::script () const\fC [pure virtual]\fP"
.PP
Return the current script code data. \fBReturns:\fP
.RS 4
\fBQString\fP containing the currenly runable code 
.RE
.PP

.SS "virtual void KScriptInterface::setScript (const \fBQString\fP & scriptFile)\fC [pure virtual]\fP"
.PP
Sets the path to the script library that we are going to embed. 
.SS "virtual void KScriptInterface::setScript (const \fBQString\fP & scriptLibFile, const \fBQString\fP & method)\fC [pure virtual]\fP"
.PP
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. 
.SS "virtual void KScriptInterface::run (\fBQObject\fP * context = 0, const \fBQVariant\fP & arg = 0)\fC [pure virtual]\fP"
.PP
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. 
.SS "virtual void KScriptInterface::kill ()\fC [pure virtual]\fP"
.PP
Abort the scripts run. 
.SH "Member Data Documentation"
.PP 
.SS "\fBKScriptClientInterface\fP* \fBKScriptInterface::ScriptClientInterface\fP"
.PP
This is the method for sending feedback to applications. example of how this works: 
.PP
.nf

		ScriptClientInterface->error( message_to_send_back_to_the_main_application );
	
.PP
 Will send the error message back to the main application. Definition at line 83 of file scriptinterface.h.

.SH "Author"
.PP 
Generated automatically by Doxygen for interfaces Library from the source code.
