KPackage::PackageStructure

#include <KPackage/PackageStructure>

Inheritance diagram for KPackage::PackageStructure:

Public Member Functions
	PackageStructure (QObject *parent=nullptr, const QVariantList &args=QVariantList())

virtual void	initPackage (Package *package)

virtual KJob *	install (Package *package, const QString &archivePath, const QString &packageRoot)

virtual void	pathChanged (Package *package)

virtual KJob *	uninstall (Package *package, const QString &packageRoot)

virtual KJob *	update (Package *package, const QString &archivePath, const QString &packageRoot)

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

This class is used to define the filesystem structure of a package type. A PackageStructure is implemented as a dynamically loaded plugin, in the reimplementation of initPackage the allowed fines and directories in the package are set into the package, for instance:

package->addFileDefinition("mainscript", QStringLiteral("ui/main.qml"), i18n("Main Script File"));
package->setDefaultPackageRoot(QStringLiteral("plasma/wallpapers/"));
package->addDirectoryDefinition("images", QStringLiteral("images"), i18n("Images"));
package->addDirectoryDefinition("theme", QStringLiteral("theme"), i18n("Themed Images"));
QStringList mimetypes;
mimetypes << QStringLiteral("image/svg+xml") << QStringLiteral("image/png") << QStringLiteral("image/jpeg");
package->setMimeTypes("images", mimetypes);

Author: Aaron Seigo

Definition at line 41 of file packagestructure.h.

Member Function Documentation

◆ initPackage()

void KPackage::PackageStructure::initPackage ( Package * package )

virtual

Called when a the PackageStructure should initialize a Package with the initial structure.

This allows setting paths before setPath is called.

Note: one special value is "metadata" which can be set to the location of KPluginMetaData compatible .desktop file within the package. If not defined, it is assumed that this file exists under the top level directory of the package.

Parameters

package the Package to set up. The object is empty of all definition when first passed in.

Definition at line 25 of file packagestructure.cpp.

◆ install()

KJob * KPackage::PackageStructure::install	(	Package *	package,
		const QString &	archivePath,
		const QString &	packageRoot
	)

virtual

Installs a package matching this package structure.

By default installs a native KPackage::Package.

Parameters

package	the instance of Package that is being used for the install; useful for accessing file paths
archivePath	path to the package archive file
packageRoot	path to the directory where the package should be installed to

Returns: KJob* to track the installation status

Definition at line 35 of file packagestructure.cpp.

◆ pathChanged()

void KPackage::PackageStructure::pathChanged ( Package * package )

virtual

Called whenever the path changes so that subclasses may take package specific actions.

Definition at line 30 of file packagestructure.cpp.

◆ uninstall()

KJob * KPackage::PackageStructure::uninstall	(	Package *	package,
		const QString &	packageRoot
	)

virtual

Uninstalls a package matching this package structure.

Parameters

package	the instance of Package that is being used for the install; useful for accessing file paths
packageName	the name of the package to remove
packageRoot	path to the directory where the package should be installed to

Returns: KJob* to track the installation status

Definition at line 49 of file packagestructure.cpp.

◆ update()

KJob * KPackage::PackageStructure::update	(	Package *	package,
		const QString &	archivePath,
		const QString &	packageRoot
	)

virtual

Updates a package matching this package structure.

By default installs a native KPackage::Package. If an older version is already installed, it removes the old one. If the installed one is newer, an error will occur.

Parameters

package	the instance of Package that is being used for the install; useful for accessing file paths
archivePath	path to the package archive file
packageRoot	path to the directory where the package should be installed to

Returns: KJob* to track the installation status

Since: 5.17

Definition at line 42 of file packagestructure.cpp.

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

i18n

QString i18n(const char *text, const TYPE &arg...)

QStringList

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KPackage

KPackage::PackageStructure

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ initPackage()

◆ install()

◆ pathChanged()

◆ uninstall()

◆ update()