korganizer Library API Documentation

KNewStuff Class Reference

This class provides the functionality to download and upload "new stuff". More...

#include <knewstuff.h>

List of all members.

Public Member Functions

 KNewStuff (const QString &type, QWidget *parentWidget=0)
 Constructor.

void download ()
 Start download process.

void upload ()
 Start upload process.

virtual bool install (const QString &fileName)=0
 Install file to application.

virtual bool createUploadFile (const QString &fileName)=0
 Create a file to be uploaded to a "new stuff provider" and return the filename.

virtual QString downloadDestination (KNS::Entry *entry)
 Return a filename which should be used as destination for downloading the specified new stuff entry.


Detailed Description

This class provides the functionality to download and upload "new stuff".

Applications have to subclass KNewStuff, implement the pure virtual functions and link to against libknewstuff.

By calling download() the download process is started which means that a list of "providers" is fetched from a "master server", information about new stuff is collected from the providers and presented to the user. Selected entries get downloaded and installed to the application. The required functions to install new stuff are provided by implementing install(). The location where the downloaded files are stored can be customized by reimplementing downloadDestination().

By calling upload() the upload process is started which means the user has to select a provider from the list fetched from the master server and to put in infomration about the entry to be uploaded. Then the file to be uploaded is fetched from the application by calling createUploadFile() and transfered to the upload destination specified in the provider list.

Definition at line 52 of file knewstuff.h.


Constructor & Destructor Documentation

KNewStuff::KNewStuff const QString type,
QWidget parentWidget = 0
 

Constructor.

Parameters:
type Type of data to be handled, should be something like korganizer/calendar, kword/template, kdesktop/wallpaper.
parentWidget Parent widget of dialogs opened by the KNewStuff engine.

Definition at line 32 of file knewstuff.cpp.


Member Function Documentation

void KNewStuff::download  ) 
 

Start download process.

Definition at line 42 of file knewstuff.cpp.

void KNewStuff::upload  ) 
 

Start upload process.

Definition at line 53 of file knewstuff.cpp.

virtual bool KNewStuff::install const QString fileName  )  [pure virtual]
 

Install file to application.

The given fileName points to the file downloaded by the KNewStuff engine. This is a temporary file by default. The application can do whatever is needed to handle the information contained in the file.

The function returns true, when the installation was successful and false if were errors.

Parameters:
fileName Name of downloaded file.

virtual bool KNewStuff::createUploadFile const QString fileName  )  [pure virtual]
 

Create a file to be uploaded to a "new stuff provider" and return the filename.

The format of the file is application specific. The only constraint is that the corresponding install() implementation is able to use the file.

Parameters:
fileName Name of the file to be written.
Returns:
true on success, false on error.

QString KNewStuff::downloadDestination KNS::Entry *  entry  )  [virtual]
 

Return a filename which should be used as destination for downloading the specified new stuff entry.

Reimplement this function, if you don't want the new stuff to be downloaded to a temporary file.

Definition at line 47 of file knewstuff.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sat Oct 18 02:47:32 2003 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001