KNS::Engine Class Reference

#include <engine.h>

Signals
void	uploadFinished (bool result)

Public Member Functions
	Engine (TDENewStuff *newStuff, const TQString &type, TQWidget *parentWidget=0)
	Engine (TDENewStuff *newStuff, const TQString &type, const TQString &providerList, TQWidget *parentWidget=0)
virtual	~Engine ()
TQString	type () const
TQWidget *	parentWidget () const
void	download ()
void	upload (const TQString &fileName=TQString::null, const TQString &previewName=TQString::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 (TDEIO::Job *job, const TQByteArray &data)
void	slotNewStuffJobResult (TDEIO::Job *job)
void	slotDownloadJobResult (TDEIO::Job *job)
void	slotUploadPayloadJobResult (TDEIO::Job *job)
void	slotUploadPreviewJobResult (TDEIO::Job *job)
void	slotUploadMetaJobResult (TDEIO::Job *job)

Protected Member Functions
bool	createMetaFile (Entry *)

Detailed Description

Central class combining all possible TDENewStuff 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 (schum.nosp@m.ache.nosp@m.r@kde.nosp@m..org)

Maintainer:

Josef Spillner (spill.nosp@m.ner@.nosp@m.kde.o.nosp@m.rg)

Definition at line 52 of file engine.h.

Constructor & Destructor Documentation

Engine() [1/2]

Engine::Engine	(	TDENewStuff *	newStuff,
		const TQString &	type,
		TQWidget *	parentWidget = 0 )

Constructor.

Parameters

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

Definition at line 49 of file engine.cpp.

Engine() [2/2]

Engine::Engine	(	TDENewStuff *	newStuff,
		const TQString &	type,
		const TQString &	providerList,
		TQWidget *	parentWidget = 0 )

Constructor.

Parameters

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

Definition at line 60 of file engine.cpp.

~Engine()

Engine::~Engine ( )

virtual

Destructor.

Definition at line 73 of file engine.cpp.

Member Function Documentation

createMetaFile()

bool Engine::createMetaFile ( Entry * entry )

protected

Definition at line 351 of file engine.cpp.

download() [1/2]

void Engine::download

(

)

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

Definition at line 82 of file engine.cpp.

download() [2/2]

void Engine::download

(

Entry *

entry

)

Downloads the specified data file.

Parameters

entry

the Hotstuff data object to be downloaded

Definition at line 203 of file engine.cpp.

getMetaInformation

void Engine::getMetaInformation ( Provider::List * providers )

protectedslot

Definition at line 92 of file engine.cpp.

ignoreInstallResult()

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 TDENewStuffSecure

Definition at line 443 of file engine.cpp.

parentWidget()

TQWidget * KNS::Engine::parentWidget ( ) const

inline

Returns the previously set parent widget.

Returns

parent widget

Definition at line 92 of file engine.h.

requestMetaInformation()

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 276 of file engine.cpp.

selectUploadProvider

void Engine::selectUploadProvider ( Provider::List * providers )

protectedslot

Definition at line 256 of file engine.cpp.

slotDownloadJobResult

void Engine::slotDownloadJobResult ( TDEIO::Job * job )

protectedslot

Definition at line 225 of file engine.cpp.

slotNewStuffJobData

void Engine::slotNewStuffJobData ( TDEIO::Job * job, const TQByteArray & data )

protectedslot

Definition at line 119 of file engine.cpp.

slotNewStuffJobResult

void Engine::slotNewStuffJobResult ( TDEIO::Job * job )

protectedslot

Definition at line 130 of file engine.cpp.

slotUploadMetaJobResult

void Engine::slotUploadMetaJobResult ( TDEIO::Job * job )

protectedslot

Definition at line 428 of file engine.cpp.

slotUploadPayloadJobResult

void Engine::slotUploadPayloadJobResult ( TDEIO::Job * job )

protectedslot

Definition at line 385 of file engine.cpp.

slotUploadPreviewJobResult

void Engine::slotUploadPreviewJobResult ( TDEIO::Job * job )

protectedslot

Definition at line 409 of file engine.cpp.

type()

TQString KNS::Engine::type ( ) const

inline

Returns the previously set data type.

Returns

the Hotstuff data type

Definition at line 85 of file engine.h.

upload() [1/2]

void Engine::upload	(	const TQString &	fileName = TQString::null,
		const TQString &	previewName = TQString::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 245 of file engine.cpp.

upload() [2/2]

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 289 of file engine.cpp.

uploadFinished

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:

• engine.h
• engine.cpp