KNSCore::Installation Class Reference

#include <installation.h>

Inheritance diagram for KNSCore::Installation:

Public Types
enum	Policy { CheckNever, CheckIfPossible, CheckAlways }
enum	Scope { ScopeUser, ScopeSystem }
enum	UncompressionOptions {   NeverUncompress, AlwaysUncompress, UncompressIfArchive, UncompressIntoSubdirIfArchive,   UncompressIntoSubdir, UseKPackageUncompression }

Signals
void	signalEntryChanged (const KNSCore::EntryInternal &entry)
void	signalError (const QString &) const
void	signalInformation (const QString &) const
void	signalInstallationError (const QString &message)
void	signalInstallationFailed (const QString &message)
void	signalInstallationFinished ()
void	signalPayloadLoaded (QUrl payload)

Public Slots
void	downloadPayload (const KNSCore::EntryInternal &entry)
void	install (const KNSCore::EntryInternal &entry)
void	slotInstallationVerification (int result)
void	slotPayloadResult (KJob *job)
QString	targetInstallationPath () const
UncompressionOptions	uncompressionSetting () const
void	uninstall (KNSCore::EntryInternal entry)

Public Member Functions
	Installation (QObject *parent=nullptr)
bool	isRemote () const
bool	readConfig (const KConfigGroup &group)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

KNewStuff entry installation.

The installation class stores all information related to an entry's installation.

Author

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

Definition at line 37 of file installation.h.

Member Enumeration Documentation

UncompressionOptions

enum KNSCore::Installation::UncompressionOptions

Enumerator
AlwaysUncompress	< Never attempt to decompress a file, whatever format it is. Matches "never" knsrc setting
UncompressIfArchive	< Assume all downloaded files are archives, and attempt to decompress them. Will cause failure if decompression fails. Matches "always" knsrc setting
UncompressIntoSubdirIfArchive	< If the file is an archive, decompress it, otherwise just pass it on. Matches "archive" knsrc setting
UncompressIntoSubdir	< If the file is an archive, decompress it in a subdirectory if it contains multiple files, otherwise just pass it on. Matches "subdir-archive" knsrc setting
UseKPackageUncompression	< As Archive, except that if there is more than an item in the file, put contents in a subdirectory with the same name as the file. Matches "subdir" knsrc setting

Definition at line 58 of file installation.h.

Constructor & Destructor Documentation

Installation()

Installation::Installation ( QObject *  parent = nullptr )

explicit

Constructor.

Definition at line 43 of file installation.cpp.

Member Function Documentation

downloadPayload

void Installation::downloadPayload ( const KNSCore::EntryInternal &  entry )

slot

Downloads a payload file.

The payload file matching most closely the current user language preferences will be downloaded. The file will not be installed set, for this install must be called.

Parameters

entry

Entry to download payload file for

See also

signalPayloadLoaded

signalPayloadFailed

Definition at line 208 of file installation.cpp.

install

void Installation::install ( const KNSCore::EntryInternal &  entry )

slot

Installs an entry's payload file.

This includes verification, if necessary, as well as decompression and other steps according to the application's *.knsrc file. Note that this method is asynchronous and thus the return value will only report the successful start of the installation. Note also that while entry is const at this point, it will change later during the actual installation (the installedFiles list will change, as will its status)

Parameters

entry

Entry to be installed

See also

signalInstallationFinished

signalInstallationFailed

Definition at line 203 of file installation.cpp.

signalInstallationError

void KNSCore::Installation::signalInstallationError ( const QString &  message )

signal

An informational signal fired when a serious error occurs during the installation.

Parameters

message

The description of the error (a message intended to be human readable)

Since

5.69

targetInstallationPath

QString Installation::targetInstallationPath ( ) const

slot

Returns

the installation path

Since

5.31

Definition at line 342 of file installation.cpp.

uncompressionSetting

Installation::UncompressionOptions Installation::uncompressionSetting ( ) const

slot

Returns the uncompression setting, in a computer-readable format.

Returns

The value of this setting

Since

5.71

Definition at line 982 of file installation.cpp.

uninstall

void Installation::uninstall ( KNSCore::EntryInternal  entry )

slot

Uninstalls an entry.

It reverses the steps which were performed during the installation.

The entry emitted by signalEntryChanged will be updated with any new information, in particular the following:

• Status will be set to Deleted, unless the uninstall script exists with an error and the user chooses to cancel the uninstallation
• uninstalledFiles will list files which were removed during uninstallation
• installedFiles will become empty

Parameters

entry

The entry to deinstall

Definition at line 751 of file installation.cpp.

---

The documentation for this class was generated from the following files:

• installation.h
• installation.cpp