\section{KScript\-Interface Class Reference}
\label{classKScriptInterface}\index{KScriptInterface@{KScriptInterface}}
This class is the base for all script engines.  


{\tt \#include $<$scriptinterface.h$>$}

Inheritance diagram for KScript\-Interface:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=61pt]{classKScriptInterface__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KScript\-Interface:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=126pt]{classKScriptInterface__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
virtual {\bf QString} {\bf script} () const =0
\item 
virtual void {\bf set\-Script} (const {\bf QString} \&script\-File)=0
\item 
virtual void {\bf set\-Script} (const {\bf QString} \&script\-Lib\-File, const {\bf QString} \&method)=0
\item 
virtual void {\bf run} ({\bf QObject} $\ast$context=0, const {\bf QVariant} \&arg=0)=0
\item 
virtual void {\bf kill} ()=0
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
{\bf KScript\-Client\-Interface} $\ast$ {\bf Script\-Client\-Interface}
\end{CompactItemize}


\subsection{Detailed Description}
This class is the base for all script engines. 

\begin{Desc}
\item[Author:]Ian Reinhart Geiser $<${\tt geiseri@kde.org}$>$ \end{Desc}




Definition at line 47 of file scriptinterface.h.

\subsection{Member Function Documentation}
\index{KScriptInterface@{KScript\-Interface}!script@{script}}
\index{script@{script}!KScriptInterface@{KScript\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QString} KScript\-Interface::script () const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKScriptInterface_a0}


Return the current script code data. 

\begin{Desc}
\item[Returns:]{\bf QString} containing the currenly runable code \end{Desc}
\index{KScriptInterface@{KScript\-Interface}!setScript@{setScript}}
\index{setScript@{setScript}!KScriptInterface@{KScript\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KScript\-Interface::set\-Script (const {\bf QString} \& {\em script\-File})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKScriptInterface_a1}


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

\index{KScriptInterface@{KScript\-Interface}!setScript@{setScript}}
\index{setScript@{setScript}!KScriptInterface@{KScript\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KScript\-Interface::set\-Script (const {\bf QString} \& {\em script\-Lib\-File}, const {\bf QString} \& {\em method})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKScriptInterface_a2}


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. \index{KScriptInterface@{KScript\-Interface}!run@{run}}
\index{run@{run}!KScriptInterface@{KScript\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KScript\-Interface::run ({\bf QObject} $\ast$ {\em context} = {\tt 0}, const {\bf QVariant} \& {\em arg} = {\tt 0})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKScriptInterface_a3}


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. 

\index{KScriptInterface@{KScript\-Interface}!kill@{kill}}
\index{kill@{kill}!KScriptInterface@{KScript\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KScript\-Interface::kill ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKScriptInterface_a4}


Abort the scripts run. 



\subsection{Member Data Documentation}
\index{KScriptInterface@{KScript\-Interface}!ScriptClientInterface@{ScriptClientInterface}}
\index{ScriptClientInterface@{ScriptClientInterface}!KScriptInterface@{KScript\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KScript\-Client\-Interface}$\ast$ {\bf KScript\-Interface::Script\-Client\-Interface}}\label{classKScriptInterface_o0}


This is the method for sending feedback to applications. 

example of how this works: 

\footnotesize\begin{verbatim}        ScriptClientInterface->error( message_to_send_back_to_the_main_application );
\end{verbatim}
\normalsize
 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:\begin{CompactItemize}
\item 
scriptinterface.h\end{CompactItemize}
