WidgetManager Class Reference

#include <mw/wac/wacWidgetManager.h>

Link against: wacWidgetUtils.lib

class WidgetManager : public QObject, public QObject

Install and uninstall web applications. Public class for installing widgets for 3rd party.

Inherits from

WidgetManager

Public Member Functions
	WidgetManager(QWidget *, bool)
	~WidgetManager()
void	asyncInstall(const QString &, bool, const QString &, bool)
bool	backupRestoreInstall(const QString &, bool)
void	cancel(int)
bool	getContentType(QString &)
WidgetProperties *	getProperties(const QString &)
WidgetProperties *	getProperties()
WidgetInstallError	install(const QString &, QString &, bool, bool, const QString &)
QString	installSisx(const QString &, const QString &)
int	installWidget(const QString &, const QMap< QString, QVariant > &)
bool	isRegistered(const QString &)
bool	isValidWidgetType(const QString &, const QString &)
bool	isValidWidgetType(const QString &)
QString	launcherPath(const QString &)
QHash< QString, uint >	readSisxWidgetList()
void	removeWidgetFromCache(const QString &)
void	setContentType(const QString &)
void	setInstallationAttributes(const WAC::InstallationAttributes &)
QString	sisxWidgetFile()
WidgetUninstallError	uninstall(const QString &, bool)
void	uninstallProgress(int)
WidgetUninstallError	uninstallSisx(const QString &, bool)
void	writeSisxWidgetList(QHash< QString, uint > &)

Protected Member Functions
bool	createDir(const QString &)
SuperWidget *	getWidgetFromCache(const QString &)
QString	getWidgetInstallPath(const QString &)
WidgetInstallError	install(const QString &, QString &, const QString &, const QString &, bool, bool, const QString &)
void	setWidgetIntoCache(const QString &, SuperWidget *)

Public Slots
void	cancelInstallation()
void	handleAborted(int, WidgetErrorType)
void	handleCompleted(int)
void	handleInteractiveRequest(int, QMap< WidgetPropertyType, QVariant > &)
void	handleProgress(int, int, WidgetOperationType)
void	tryContinueInstallation()

Public Signals
void	aborted(int, WidgetErrorType)
void	aboutToInstallUntrustedWidget(WidgetInstallError)
void	aboutToInstallWidgetWithFeatures(QList< QString >)
void	aboutToReplaceExistingWidget(QString)
void	completed(int)
void	installComplete(QString, WidgetInstallError)
void	installProgress(int)
void	installationCancelled()
void	installationError(WidgetInstallError)
void	installationSucceed()
void	interactiveRequest(int, QMap< WidgetPropertyType, QVariant > &)
void	progress(int, int, WidgetOperationType)
void	queryConfirmation()
void	queryInstallationDestination(unsigned long, bool)

Inherited Attributes
	QObject::d_ptr
	QObject::objectName
	QObject::staticQtMetaObject

Inherited Functions
	QObject::QObject(QObjectPrivate &,QObject *)
	QObject::blockSignals(bool)
	QObject::childEvent(QChildEvent *)
	QObject::children()const
	QObject::connect(const QObject ,const QMetaMethod &,const QObject ,const QMetaMethod &,Qt::ConnectionType)
	QObject::connect(const QObject ,const char ,const QObject ,const char ,Qt::ConnectionType)
	QObject::connect(const QObject ,const char ,const char *,Qt::ConnectionType)const
	QObject::connectNotify(const char *)
	QObject::customEvent(QEvent *)
	QObject::deleteLater
	QObject::destroyed
	QObject::disconnect(const QObject ,const QMetaMethod &,const QObject ,const QMetaMethod &)
	QObject::disconnect(const QObject ,const char )
	QObject::disconnect(const QObject ,const char ,const QObject ,const char )
	QObject::disconnect(const char ,const QObject ,const char *)
	QObject::disconnectNotify(const char *)
	QObject::dumpObjectInfo()
	QObject::dumpObjectTree()
	QObject::dynamicPropertyNames()const
	QObject::event(QEvent *)
	QObject::eventFilter(QObject ,QEvent )
	QObject::findChild(const QString &)const
	QObject::findChildren(const QRegExp &)const
	QObject::findChildren(const QString &)const
	QObject::inherits(const char *)const
	QObject::installEventFilter(QObject *)
	QObject::isWidgetType()const
	QObject::killTimer(int)
	QObject::moveToThread(QThread *)
	QObject::objectName()const
	QObject::parent()const
	QObject::property(const char *)const
	QObject::receivers(const char *)const
	QObject::registerUserData()
	QObject::removeEventFilter(QObject *)
	QObject::sender()const
	QObject::senderSignalIndex()const
	QObject::setObjectName(const QString &)
	QObject::setParent(QObject *)
	QObject::setProperty(const char *,const QVariant &)
	QObject::setUserData(uint,QObjectUserData *)
	QObject::signalsBlocked()const
	QObject::startTimer(int)
	QObject::thread()const
	QObject::timerEvent(QTimerEvent *)
	QObject::userData(uint)const
	QObject::~QObject()

Constructor & Destructor Documentation

WidgetManager ( QWidget *, bool )

WidgetManager	(	QWidget *	parent,
		bool	isChromeless = false
	)	[explicit]

Widget manager deletes all temporary created files on destructor

widget pointer for displaying confirmation

~WidgetManager ( )

~WidgetManager

(

)

Member Function Documentation

aborted ( int, WidgetErrorType )

void	aborted	(	int	transId,
			WidgetErrorType	errCode
		)	[signal]

aboutToInstallUntrustedWidget ( WidgetInstallError )

void

aboutToInstallUntrustedWidget

(

WidgetInstallError

errorCode

)

[signal]

This signal is emitted when a not signed widget is being installed.

If you intend to install the widget when this message is signaled, you should invoke tryContinueInstallation() method when you're handling this signal.

Parameters
errorCode	tells reasons for installed widget being untrusted

aboutToInstallWidgetWithFeatures ( QList< QString > )

void

aboutToInstallWidgetWithFeatures

(

QList< QString >

capList

)

[signal]

This signal is emitted whenever a widget with features is about to be installed.

If you intend to install the widget when this message is signaled, you should tryContinueInstallation() method when you're handling this signal.

aboutToReplaceExistingWidget ( QString )

void

aboutToReplaceExistingWidget

(

QString

widgetTitle

)

[signal]

This signal is emitted whenever an existing widget is about to be replaced during installation phase.

If you intend to replace the widget when this message is signaled, you should tryContinueInstallation() method when you're handling this signal.

asyncInstall ( const QString &, bool, const QString &, bool )

void	asyncInstall	(	const QString &	pkgPath,
			bool	silent,
			const QString &	rootDirectory = "",
			bool	update = false
		)

backupRestoreInstall ( const QString &, bool )

bool	backupRestoreInstall	(	const QString &	pkgPath,
			bool	disableUnsigWidgetSignCheck
		)

cancel ( int )

void

cancel

(

int

trxId

)

cancelInstallation ( )

void

cancelInstallation

(

)

[slot]

completed ( int )

void

completed

(

int

transId

)

[signal]

createDir ( const QString & )

bool

createDir

(

const QString &

path

)

[protected]

getContentType ( QString & )

bool

getContentType

(

QString &

contentType

)

getProperties ( const QString & )

WidgetProperties *

getProperties

(

const QString &

pkgPath

)

getProperties ( )

WidgetProperties *

getProperties

(

)

getWidgetFromCache ( const QString & )

SuperWidget *

getWidgetFromCache

(

const QString &

pkgPath

)

[protected]

getWidgetInstallPath ( const QString & )

QString

getWidgetInstallPath

(

const QString &

rootDirectory

)

[protected]

handleAborted ( int, WidgetErrorType )

void	handleAborted	(	int	transId,
			WidgetErrorType	errCode
		)	[slot]

handleCompleted ( int )

void

handleCompleted

(

int

transId

)

[slot]

handleInteractiveRequest ( int, QMap< WidgetPropertyType, QVariant > & )

void	handleInteractiveRequest	(	int	transId,
			QMap< WidgetPropertyType, QVariant > &
		)	[slot]

handleProgress ( int, int, WidgetOperationType )

void	handleProgress	(	int	transId,
			int	percentCompleted,
			WidgetOperationType	operationType
		)	[slot]

install ( const QString &, QString &, bool, bool, const QString & )

WidgetInstallError	install	(	const QString &	pkgPath,
			QString &	widgetId,
			bool	silent = false,
			bool	update = false,
			const QString &	rootDirectory = ""
		)

install ( const QString &, QString &, const QString &, const QString &, bool, bool, const QString & )

WidgetInstallError	install	(	const QString &	pkgPath,
			QString &	widgetId,
			const QString &	contentType,
			const QString &	rootDirectory = "",
			bool	silent = false,
			bool	update = false,
			const QString &	sigId = ""
		)	[protected]

installComplete ( QString, WidgetInstallError )

void	installComplete	(	QString	widgetId,
			WidgetInstallError	status
		)	[signal]

installProgress ( int )

void

installProgress

(

int

percentComplete

)

[signal]

installSisx ( const QString &, const QString & )

QString	installSisx	(	const QString &	pkgPath,
			const QString &	rootDirectory = ""
		)

install's the SISX package file passed. Registers the application in registry if package file is valid pkgPath package file path

Return Value: UID of installed widget

installWidget ( const QString &, const QMap< QString, QVariant > & )

int	installWidget	(	const QString &	pkgPath,
			const QMap< QString, QVariant > &	configDetails
		)

install's the package file passed. Registers the application in registry if package file is valid o pkgPath package file path

Return Value: returns true if installation is successful

installationCancelled ( )

void

installationCancelled

(

)

[signal]

This signal is emitted when installation process is cancelled by the user

installationError ( WidgetInstallError )

void

installationError

(

WidgetInstallError

error

)

[signal]

This signal is emitted whenever an error occurs during installation phase.

If you intend to continue installation when error is signaled, you should invoke tryContinueInstallation() method when you're handling installation error.

installationSucceed ( )

void

installationSucceed

(

)

[signal]

This signal is emitted whenever an existing widget is about to be replaced during installation phase.

interactiveRequest ( int, QMap< WidgetPropertyType, QVariant > & )

void	interactiveRequest	(	int	transId,
			QMap< WidgetPropertyType, QVariant > &
		)	[signal]

isRegistered ( const QString & )

bool

isRegistered

(

const QString &

pkgPath

)

pkgPath package file path

Return Value: returns true if pkgPath is already installed

isValidWidgetType ( const QString &, const QString & )

bool	isValidWidgetType	(	const QString &	widgetPath,
			const QString &	contentType
		)

isValidWidgetType ( const QString & )

bool

isValidWidgetType

(

const QString &

widgetPath

)

launcherPath ( const QString & )

QString

launcherPath

(

const QString &

pkgPath

)

already installed web applications executable file/path

pkgPath package file path

Return Value: returns launcher file path (html file path for widgets) or link for web applications

progress ( int, int, WidgetOperationType )

void	progress	(	int	transId,
			int	percentComplete,
			WidgetOperationType	operationType
		)	[signal]

queryConfirmation ( )

void

queryConfirmation

(

)

[signal]

queryInstallationDestination ( unsigned long, bool )

void	queryInstallationDestination	(	unsigned long	spaceRequired,
			bool	allowRemovableInstallation
		)	[signal]

This signal is emitted whenever a widget destination is to be selected

If you intend to continue installation of the widget when this message is signaled, you should tryContinueInstallation) method when you're handling this signal.

readSisxWidgetList ( )

QHash< QString, uint >

readSisxWidgetList

(

)

Reads the SISX widget list from file

removeWidgetFromCache ( const QString & )

void

removeWidgetFromCache

(

const QString &

pkgPath

)

setContentType ( const QString & )

void

setContentType

(

const QString &

contentType

)

setInstallationAttributes ( const WAC::InstallationAttributes & )

void

setInstallationAttributes

(

const WAC::InstallationAttributes &

attributes

)

setWidgetIntoCache ( const QString &, SuperWidget * )

void	setWidgetIntoCache	(	const QString &	pkgPath,
			SuperWidget *	widget
		)	[protected]

sisxWidgetFile ( )

QString

sisxWidgetFile

(

)

Gets the name of the SISX widget list file

tryContinueInstallation ( )

void

tryContinueInstallation

(

)

[slot]

Try to continue installation process when and installation is about to do something.

uninstall ( const QString &, bool )

WidgetUninstallError	uninstall	(	const QString &	uniqueIdentifier,
			bool	silent = false
		)

uninstall's the web app. Removes the entry from registry.

pkgPath package file path

Return Value: returns true if uninstallation is successful

uninstallProgress ( int )

void

uninstallProgress

(

int

progress

)

uninstallSisx ( const QString &, bool )

WidgetUninstallError	uninstallSisx	(	const QString &	uniqueIdentifier,
			bool	aRemoveFromList
		)

Uninstall's the SISX package file passed. uniqueIdentifier ID of the widget to uninstall aRemoveFromlist Flag to remove widget from installed list

Return Value: returns An error code from WidgetUninstallError enum

writeSisxWidgetList ( QHash< QString, uint > & )

void

writeSisxWidgetList

(

QHash< QString, uint > &

aWidgetList

)

Writes the SISX widget list to file