.TH "KNS::Engine" kde3 "11 Jun 2005" "Version Version 3.4.1" "knewstuff Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KNS::Engine \- Central class combining all possible \fBKNewStuff\fP operations.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <engine.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBuploadFinished\fP (bool result)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBEngine\fP (\fBKNewStuff\fP *newStuff, const \fBQString\fP &type, \fBQWidget\fP *parentWidget=0)"
.br
.ti -1c
.RI "\fBEngine\fP (\fBKNewStuff\fP *newStuff, const \fBQString\fP &type, const \fBQString\fP &providerList, \fBQWidget\fP *parentWidget=0)"
.br
.ti -1c
.RI "virtual \fB~Engine\fP ()"
.br
.ti -1c
.RI "\fBQString\fP \fBtype\fP () const "
.br
.ti -1c
.RI "\fBQWidget\fP * \fBparentWidget\fP () const "
.br
.ti -1c
.RI "void \fBdownload\fP ()"
.br
.ti -1c
.RI "void \fBupload\fP (const \fBQString\fP &fileName=QString::null, const \fBQString\fP &previewName=QString::null)"
.br
.ti -1c
.RI "void \fBdownload\fP (\fBEntry\fP *entry)"
.br
.ti -1c
.RI "void \fBrequestMetaInformation\fP (\fBProvider\fP *provider)"
.br
.ti -1c
.RI "void \fBupload\fP (\fBEntry\fP *entry)"
.br
.ti -1c
.RI "void \fBignoreInstallResult\fP (bool ignore)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBgetMetaInformation\fP (\fBProvider::List\fP *providers)"
.br
.ti -1c
.RI "void \fBselectUploadProvider\fP (\fBProvider::List\fP *providers)"
.br
.ti -1c
.RI "void \fBslotNewStuffJobData\fP (KIO::Job *job, const \fBQByteArray\fP &data)"
.br
.ti -1c
.RI "void \fBslotNewStuffJobResult\fP (KIO::Job *job)"
.br
.ti -1c
.RI "void \fBslotDownloadJobResult\fP (KIO::Job *job)"
.br
.ti -1c
.RI "void \fBslotUploadPayloadJobResult\fP (KIO::Job *job)"
.br
.ti -1c
.RI "void \fBslotUploadPreviewJobResult\fP (KIO::Job *job)"
.br
.ti -1c
.RI "void \fBslotUploadMetaJobResult\fP (KIO::Job *job)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "bool \fBcreateMetaFile\fP (\fBEntry\fP *)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Central class combining all possible \fBKNewStuff\fP operations. 

In most cases, \fBEngine\fP objects are built and used internally. Using this class explicitely does however give fine-grained control about the upload and download operations.
.PP
\fBAuthor:\fP
.RS 4
Cornelius Schumacher (schumacher@kde.org) 
.RE
.PP
\fBMaintainer:\fP.RS 4
Josef Spillner (spillner@kde.org) 
.RE
.PP

.PP
Definition at line 51 of file engine.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KNS::Engine::Engine (\fBKNewStuff\fP * newStuff, const \fBQString\fP & type, \fBQWidget\fP * parentWidget = \fC0\fP)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fInewStuff\fP a \fBKNewStuff\fP object 
.br
\fItype\fP the Hotstuff data type such as 'korganizer/calendar' 
.br
\fIparentWidget\fP the parent window 
.RE
.PP

.SS "KNS::Engine::Engine (\fBKNewStuff\fP * newStuff, const \fBQString\fP & type, const \fBQString\fP & providerList, \fBQWidget\fP * parentWidget = \fC0\fP)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fInewStuff\fP a \fBKNewStuff\fP object 
.br
\fItype\fP the Hotstuff data type such as 'korganizer/calendar' 
.br
\fIproviderList\fP the URL of the provider list 
.br
\fIparentWidget\fP the parent window 
.RE
.PP

.SS "virtual KNS::Engine::~\fBEngine\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
.SH "Member Function Documentation"
.PP 
.SS "\fBQString\fP KNS::Engine::type () const\fC [inline]\fP"
.PP
Returns the previously set data type. 
.PP
\fBReturns:\fP
.RS 4
the Hotstuff data type 
.RE
.PP

.PP
Definition at line 84 of file engine.h.
.PP
Referenced by KNewStuff::type().
.SS "\fBQWidget\fP* KNS::Engine::parentWidget () const\fC [inline]\fP"
.PP
Returns the previously set parent widget. 
.PP
\fBReturns:\fP
.RS 4
parent widget 
.RE
.PP

.PP
Definition at line 91 of file engine.h.
.PP
Referenced by KNewStuff::parentWidget().
.SS "void KNS::Engine::download ()"
.PP
Initiates the download process, retrieving provider lists and invoking the download dialog. 
.PP
Referenced by KNewStuff::download().
.SS "void KNS::Engine::upload (const \fBQString\fP & fileName = \fCQString::null\fP, const \fBQString\fP & previewName = \fCQString::null\fP)"
.PP
Initiates the upload process, invoking the provider selection dialog and the file upload dialog. 
.PP
\fBParameters:\fP
.RS 4
\fIfileName\fP name of the payload data file 
.br
\fIpreviewName\fP name of the preview image file 
.RE
.PP

.PP
Referenced by KNewStuff::upload().
.SS "void KNS::Engine::download (\fBEntry\fP * entry)"
.PP
Downloads the specified data file. 
.PP
\fBParameters:\fP
.RS 4
\fIentry\fP the Hotstuff data object to be downloaded 
.RE
.PP

.SS "void KNS::Engine::requestMetaInformation (\fBProvider\fP * provider)"
.PP
Asynchronous lookup of provider information such as upload and download locations, icon etc. 
.PP
\fBParameters:\fP
.RS 4
\fIprovider\fP the Hotstuff provider to request information from 
.RE
.PP

.SS "void KNS::Engine::upload (\fBEntry\fP * entry)"
.PP
Uploads the specified data file to the provider-dependent location. 
.PP
\fBParameters:\fP
.RS 4
\fIentry\fP the Hotstuff data object to be uploaded 
.RE
.PP

.SS "void KNS::Engine::ignoreInstallResult (bool ignore)"
.PP
Ignores the return value of the install method. 
.PP
Used internally to avoid showing of the success/failure dialog when installation is done in another place, like in \fBKNewStuffSecure\fP 
.PP
Referenced by KNewStuffSecure::downloadResource().
.SS "void KNS::Engine::uploadFinished (bool result)\fC [signal]\fP"
.PP
Emitted when the upload has finished. 
.PP
\fBParameters:\fP
.RS 4
\fIresult\fP indicates the success/failure of the upload 
.RE
.PP


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