korganizer Library API Documentation

KNewStuffGeneric Class Reference

Basic KNewStuff class with predefined actions. More...

#include <knewstuffgeneric.h>

Inheritance diagram for KNewStuffGeneric:

Inheritance graph
[legend]
Collaboration diagram for KNewStuffGeneric:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 KNewStuffGeneric (const QString &type, QWidget *parent=0)
bool install (const QString &fileName)
bool createUploadFile (const QString &fileName)
QString downloadDestination (KNS::Entry *entry)

Detailed Description

Basic KNewStuff class with predefined actions.

This class is used for data uploads and installation.

 QString payload, preview;
 KNewStuffGeneric *ns = new KNewStuffGeneric("kamikaze/level", this);
 ns->upload(payload, preview);

Author:
Cornelius Schumacher (schumacher@kde.org)
Maintainer:
Josef Spillner (spillner@kde.org)

Definition at line 42 of file knewstuffgeneric.h.


Constructor & Destructor Documentation

KNewStuffGeneric::KNewStuffGeneric const QString type,
QWidget parent = 0
 

Constructor.

Parameters:
type a Hotstuff data type such as "korganizer/calendar"
parent the parent window.

Definition at line 38 of file knewstuffgeneric.cpp.


Member Function Documentation

bool KNewStuffGeneric::install const QString fileName  )  [virtual]
 

Installs a downloaded file according to the application's configuration.

Parameters:
fileName filename of the donwloaded file
Returns:
true in case of installation success, false otherwise

Implements KNewStuff.

Definition at line 50 of file knewstuffgeneric.cpp.

bool KNewStuffGeneric::createUploadFile const QString fileName  )  [virtual]
 

Creates a file suitable for upload.

Note that this method always fails, since using KNewStuffGeneric means that the provided file must already be in a usable format.

Parameters:
fileName the name of the file to upload after its creation
Returns:
true in case of creation success, false otherwise

Implements KNewStuff.

Definition at line 70 of file knewstuffgeneric.cpp.

QString KNewStuffGeneric::downloadDestination KNS::Entry entry  )  [virtual]
 

Queries the preferred destination file for a download.

Parameters:
entry a Hotstuff data entry
Returns:
destination filename

Reimplemented from KNewStuff.

Definition at line 75 of file knewstuffgeneric.cpp.

References KNewStuff::downloadDestination(), KNS::Entry::fullName(), and KNewStuff::parentWidget().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for korganizer Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jul 25 11:21:08 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003