.TH "KScriptClientInterface" 3 "28 Jan 2004" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KScriptClientInterface \- This class is used for allowing feedback to the main system.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <scriptclientinterface.h>\fP
.PP
Inherited by \fBKScriptManager\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBResult\fP { \fBResultSuccess\fP, \fBResultFailure\fP, \fBResultContinue\fP, \fBResultBreak\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBerror\fP (const  \fBQString\fP &msg)=0"
.br
.RI "\fIThis function will allow the main application of any errors that have occured during processing of the script. \fP"
.ti -1c
.RI "virtual void \fBwarning\fP (const  \fBQString\fP &msg)=0"
.br
.RI "\fIThis function will allow the main application of any warnings that have occured during the processing of the script. \fP"
.ti -1c
.RI "virtual void \fBoutput\fP (const  \fBQString\fP &msg)=0"
.br
.RI "\fIThis function will allow the main application of any normal output that has occured during the processing of the script. \fP"
.ti -1c
.RI "virtual void \fBprogress\fP (int percent)=0"
.br
.RI "\fIThis function will allow feedback to any progress bars in the main application as to how far along the script is. \fP"
.ti -1c
.RI "virtual void \fBdone\fP (KScriptClientInterface::Result result, const  \fBQVariant\fP &returned)=0"
.br
.RI "\fIThis function will allow feedback on completion of the script. \fP"
.in -1c
.SH "Detailed Description"
.PP 
This class is used for allowing feedback to the main system. 

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

.PP
Definition at line 32 of file scriptclientinterface.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual void KScriptClientInterface::error (const \fBQString\fP & msg)\fC [pure virtual]\fP"
.PP
This function will allow the main application of any errors that have occured during processing of the script. Implemented in \fBKScriptManager\fP.
.SS "virtual void KScriptClientInterface::warning (const \fBQString\fP & msg)\fC [pure virtual]\fP"
.PP
This function will allow the main application of any warnings that have occured during the processing of the script. Implemented in \fBKScriptManager\fP.
.SS "virtual void KScriptClientInterface::output (const \fBQString\fP & msg)\fC [pure virtual]\fP"
.PP
This function will allow the main application of any normal output that has occured during the processing of the script. Implemented in \fBKScriptManager\fP.
.SS "virtual void KScriptClientInterface::progress (int percent)\fC [pure virtual]\fP"
.PP
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.Implemented in \fBKScriptManager\fP.
.SS "virtual void KScriptClientInterface::done (KScriptClientInterface::Result result, const \fBQVariant\fP & returned)\fC [pure virtual]\fP"
.PP
This function will allow feedback on completion of the script. It turns the result as a \fBKScriptInteface::Result\fP, and a return value as a \fBQVariant\fPImplemented in \fBKScriptManager\fP.

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