KNS::Engine Class Reference

Central class combining all possible KNewStuff operations. More...

#include <engine.h>

Inheritance diagram for KNS::Engine:

QObject

List of all members.


Signals

void uploadFinished (bool result)

Public Member Functions

 Engine (KNewStuff *newStuff, const QString &type, QWidget *parentWidget=0)
 Engine (KNewStuff *newStuff, const QString &type, const QString &providerList, QWidget *parentWidget=0)
virtual ~Engine ()
QString type () const
QWidgetparentWidget () const
void download ()
void upload (const QString &fileName=QString::null, const QString &previewName=QString::null)
void download (Entry *entry)
void requestMetaInformation (Provider *provider)
void upload (Entry *entry)
void ignoreInstallResult (bool ignore)

Protected Slots

void getMetaInformation (Provider::List *providers)
void selectUploadProvider (Provider::List *providers)
void slotNewStuffJobData (KIO::Job *job, const QByteArray &data)
void slotNewStuffJobResult (KIO::Job *job)
void slotDownloadJobResult (KIO::Job *job)
void slotUploadPayloadJobResult (KIO::Job *job)
void slotUploadPreviewJobResult (KIO::Job *job)
void slotUploadMetaJobResult (KIO::Job *job)

Protected Member Functions

bool createMetaFile (Entry *)

Detailed Description

Central class combining all possible KNewStuff operations.

In most cases, Engine objects are built and used internally. Using this class explicitely does however give fine-grained control about the upload and download operations.

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

Definition at line 51 of file engine.h.


Constructor & Destructor Documentation

Engine::Engine ( KNewStuff newStuff,
const QString type,
QWidget parentWidget = 0 
)

Constructor.

Parameters:
newStuff a KNewStuff object
type the Hotstuff data type such as "korganizer/calendar"
parentWidget the parent window

Definition at line 48 of file engine.cpp.

Engine::Engine ( KNewStuff newStuff,
const QString type,
const QString providerList,
QWidget parentWidget = 0 
)

Constructor.

Parameters:
newStuff a KNewStuff object
type the Hotstuff data type such as "korganizer/calendar"
providerList the URL of the provider list
parentWidget the parent window

Definition at line 59 of file engine.cpp.

Engine::~Engine (  )  [virtual]

Destructor.

Definition at line 72 of file engine.cpp.


Member Function Documentation

void Engine::download ( Entry entry  ) 

Downloads the specified data file.

Parameters:
entry the Hotstuff data object to be downloaded

Definition at line 185 of file engine.cpp.

void Engine::download (  ) 

Initiates the download process, retrieving provider lists and invoking the download dialog.

Definition at line 81 of file engine.cpp.

void Engine::ignoreInstallResult ( bool  ignore  ) 

Ignores the return value of the install method.

Used internally to avoid showing of the success/failure dialog when installation is done in another place, like in KNewStuffSecure

Definition at line 425 of file engine.cpp.

QWidget* KNS::Engine::parentWidget (  )  const [inline]

Returns the previously set parent widget.

Returns:
parent widget

Definition at line 91 of file engine.h.

void Engine::requestMetaInformation ( Provider provider  ) 

Asynchronous lookup of provider information such as upload and download locations, icon etc.

Parameters:
provider the Hotstuff provider to request information from

Definition at line 258 of file engine.cpp.

QString KNS::Engine::type (  )  const [inline]

Returns the previously set data type.

Returns:
the Hotstuff data type

Definition at line 84 of file engine.h.

void Engine::upload ( Entry entry  ) 

Uploads the specified data file to the provider-dependent location.

Parameters:
entry the Hotstuff data object to be uploaded

Definition at line 271 of file engine.cpp.

void Engine::upload ( const QString fileName = QString::null,
const QString previewName = QString::null 
)

Initiates the upload process, invoking the provider selection dialog and the file upload dialog.

Parameters:
fileName name of the payload data file
previewName name of the preview image file

Definition at line 227 of file engine.cpp.

void KNS::Engine::uploadFinished ( bool  result  )  [signal]

Emitted when the upload has finished.

Parameters:
result indicates the success/failure of the upload


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys