KNSCore::KPackageJob

#include <kpackagejob.h>

Inheritance diagram for KNSCore::KPackageJob:

Public Member Functions
Q_SLOT void	start () override

Public Member Functions inherited from KJob
	KJob (QObject *parent=nullptr)

Capabilities	capabilities () const

int	error () const

virtual QString	errorString () const

QString	errorText () const

bool	exec ()

bool	isAutoDelete () const

bool	isFinishedNotificationHidden () const

bool	isStartedWithExec () const

bool	isSuspended () const

unsigned long	percent () const

Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const

void	setAutoDelete (bool autodelete)

void	setFinishedNotificationHidden (bool hide=true)

void	setUiDelegate (KJobUiDelegate *delegate)

Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const

KJobUiDelegate *	uiDelegate () const

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

Static Public Member Functions
static KPackageJob *	install (const QString &sourcePackage, const QString &packageRoot, const QString &serviceType)

static KPackageJob *	uninstall (const QString &packageName, const QString &packageRoot, const QString &serviceType)

static KPackageJob *	update (const QString &sourcePackage, const QString &packageRoot, const QString &serviceType)

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)

Additional Inherited Members
Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities

enum	Capability

enum	Unit

Properties inherited from QObject
	objectName

Signals inherited from KJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >())

void	finished (KJob *job)

void	infoMessage (KJob *job, const QString &plain, const QString &rich=QString())

void	percent (KJob *job, unsigned long percent)

void	percentChanged (KJob *job, unsigned long percent)

void	processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)

void	processedAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)

void	processedSize (KJob *job, qulonglong size)

void	result (KJob *job)

void	resumed (KJob *job)

void	speed (KJob *job, unsigned long speed)

void	suspended (KJob *job)

void	totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)

void	totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)

void	totalSize (KJob *job, qulonglong size)

void	warning (KJob *job, const QString &plain, const QString &rich=QString())

Public Slots inherited from KJob
bool	kill (KillVerbosity verbosity=Quietly)

bool	resume ()

bool	suspend ()

Public Attributes inherited from KJob
	Bytes

	Directories

	Files

	Items

	Killable

	NoCapabilities

	Suspendable

	UnitsCount

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from KJob
virtual bool	doKill ()

virtual bool	doResume ()

virtual bool	doSuspend ()

void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)

void	emitResult ()

void	emitSpeed (unsigned long speed)

bool	isFinished () const

void	setCapabilities (Capabilities capabilities)

void	setError (int errorCode)

void	setErrorText (const QString &errorText)

void	setPercent (unsigned long percentage)

void	setProcessedAmount (Unit unit, qulonglong amount)

void	setProgressUnit (Unit unit)

void	setTotalAmount (Unit unit, qulonglong amount)

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

A job for performing basic actions on KPackage packages asynchronously.

The internals of KPackage's Package functions are synchronous, which makes it easy to work with in some cases, but has the unfortunate side effect of blocking the UI. This job will perform those operations in a separate thread, which allows you to perform the work in a fire-and-forget fashion (as suggested by KJob's documentation).

Since: 5.71

Definition at line 24 of file kpackagejob.h.

Member Function Documentation

◆ install()

KNSCore::KPackageJob * KNSCore::KPackageJob::install	(	const QString &	sourcePackage,
		const QString &	packageRoot,
		const QString &	serviceType
	)

static

Create a job for installing the given package into the package root, and treat it as the given service type.

Parameters

sourcePackage	The full path name to the package you wish to install (e.g. /tmp/downloaded-archive.tar.xz)
packageRoot	The full path name to the location the package should be installed into (e.g. /home/username/.share/plasma/desktoptheme/)
serviceType	The name of the type of KPackage you intend to install (e.g. Plasma/Theme)

Returns: A job which you can use to track the completion of the process (there will be useful details in error() and errorText() on failures)

Definition at line 179 of file kpackagejob.cpp.

◆ start()

void KPackageJob::start ( )

overridevirtual

Start the process asynchronously.

See also: KJob::start()

Implements KJob.

Definition at line 148 of file kpackagejob.cpp.

◆ uninstall()

KPackageJob * KPackageJob::uninstall	(	const QString &	packageName,
		const QString &	packageRoot,
		const QString &	serviceType
	)

static

Create a job for removing the given installed package.

Parameters

packageName	The name to the package you wish to remove (this is the plugin name, not the full path name, e.g. The.Package.Name)
packageRoot	The full path name to the location the package is currently installed (e.g. /home/username/.share/plasma/desktoptheme/The.Package.Name)
serviceType	The name of the type of KPackage you intend to remove (e.g. Plasma/Theme)

Returns: A job which you can use to track the completion of the process (there will be useful details in error() and errorText() on failures)

Definition at line 201 of file kpackagejob.cpp.

◆ update()

KPackageJob * KPackageJob::update	(	const QString &	sourcePackage,
		const QString &	packageRoot,
		const QString &	serviceType
	)

static

Create a job for updating the given package, or installing it if it is not already, the given package into the package root, and treat it as the given service type.

Parameters

sourcePackage	The full path name to the package you wish to update (e.g. /tmp/downloaded-archive.tar.xz)
packageRoot	The full path name to the location the package should be installed into (e.g. /home/username/.share/plasma/desktoptheme/)
serviceType	The name of the type of KPackage you intend to update (e.g. Plasma/Theme)

Returns: A job which you can use to track the completion of the process (there will be useful details in error() and errorText() on failures)

Definition at line 190 of file kpackagejob.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KNewStuff

KNSCore::KPackageJob

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ install()

◆ start()

◆ uninstall()

◆ update()