Plasma::Package Class Reference

#include <Plasma/Package>

List of all members.

Public Member Functions
	Package ()
	Package (const QString &packageRoot, const QString &package, PackageStructure::Ptr structure)
	Package (const QString &packagePath, PackageStructure::Ptr structure)
	Package (const Package &other)
	~Package ()
QString	contentsHash () const
QStringList	entryList (const char *fileType) const
QString	filePath (const char *fileType, const QString &filename) const
QString	filePath (const char *fileType) const
bool	isPublished () const
bool	isValid () const
PackageMetadata	metadata () const
Package &	operator= (const Package &rhs)
const QString	path () const
void	publish (AnnouncementMethods methods, const QString &name)
void	setPath (const QString &path)
const PackageStructure::Ptr	structure () const
void	unpublish (const QString &name=QString())
Static Public Member Functions
static bool	createPackage (const PackageMetadata &metadata, const QString &source, const QString &destination, const QString &icon=QString())
static bool	installPackage (const QString &package, const QString &packageRoot, const QString &servicePrefix)
static QStringList	listInstalled (const QString &packageRoot)
static QStringList	listInstalledPaths (const QString &packageRoot)
static bool	registerPackage (const PackageMetadata &data, const QString &iconPath)
static bool	uninstallPackage (const QString &package, const QString &packageRoot, const QString &servicePrefix)

---

Detailed Description

object representing an installed Plasmagik package

---

Constructor & Destructor Documentation

Plasma::Package::Package

(

)

[explicit]

Default constructor that creates an invalid Package.

Since:

4.6

Definition at line 124 of file package.cpp.

Plasma::Package::Package	(	const QString &	packageRoot,
		const QString &	package,
		PackageStructure::Ptr	structure
	)

Construct a Package object.

Parameters:

packageRoot	path to the package installation root
package	the name of the package
structure	the package structure describing this package

Definition at line 129 of file package.cpp.

Plasma::Package::Package	(	const QString &	packagePath,
		PackageStructure::Ptr	structure
	)

Construct a Package object.

Parameters:

packagePath	full path to the package directory
structure	the package structure describing this package

Definition at line 135 of file package.cpp.

Plasma::Package::Package

(

const Package &

other

)

Copy constructore.

Since:

4.6

Definition at line 140 of file package.cpp.

Plasma::Package::~Package

(

)

Definition at line 145 of file package.cpp.

---

Member Function Documentation

QString Plasma::Package::contentsHash

(

)

const

Returns:

a SHA1 hash digest of the contents of the package in hexadecimal form

Since:

4.4

Definition at line 376 of file package.cpp.

bool Plasma::Package::createPackage	(	const PackageMetadata &	metadata,
		const QString &	source,
		const QString &	destination,
		const QString &	icon = QString()
	)		[static]

Creates a package based on the metadata from the files contained in the source directory.

Parameters:

metadata	description of the package to create
source	path to local directory containing the individual files to be added to the package
destination	path to the package that should be created
icon	path to the package icon

Definition at line 724 of file package.cpp.

QStringList Plasma::Package::entryList

(

const char *

fileType

)

const

Get the list of files of a given type.

Parameters:

fileType

the type of file to look for, as defined in the package structure.

Returns:

list of files by name, suitable for passing to filePath

Definition at line 286 of file package.cpp.

QString Plasma::Package::filePath	(	const char *	fileType,
		const QString &	filename
	)		const

Get the path to a given file.

Parameters:

fileType	the type of file to look for, as defined in the package structure
filename	the name of the file

Returns:

path to the file on disk. QString() if not found.

Definition at line 218 of file package.cpp.

QString Plasma::Package::filePath

(

const char *

fileType

)

const

Get the path to a given file.

Parameters:

fileType

the type of file to look for, as defined in the package structure. The type must refer to a file in the package structure and not a directory.

Returns:

path to the file on disk. QString() if not found

Definition at line 281 of file package.cpp.

bool Plasma::Package::installPackage	(	const QString &	package,
		const QString &	packageRoot,
		const QString &	servicePrefix
	)		[static]

Installs a package.

Parameters:

package	path to the Plasmagik package
packageRoot	path to the directory where the package should be installed to
servicePrefix	the prefix for the desktop file, so as not to interfere with unrelated services (eg: "plasma-applet-"). If no prefix is set (e.g. a QString() is passed in), then the package will NOT be registered as a service

Returns:

true on successful installation, false otherwise

Definition at line 472 of file package.cpp.

bool Plasma::Package::isPublished

(

)

const

Returns:

whether or not this service is currently published on the network.

bool Plasma::Package::isValid

(

)

const

Returns:

true if all the required components as defined in the PackageStructure exist

Definition at line 159 of file package.cpp.

QStringList Plasma::Package::listInstalled

(

const QString &

packageRoot

)

[static]

Returns a list of all installed packages by name.

Parameters:

packageRoot

path to the directory where Plasmagik packages have been installed to

Returns:

a list of installed Plasmagik packages

Definition at line 431 of file package.cpp.

QStringList Plasma::Package::listInstalledPaths

(

const QString &

packageRoot

)

[static]

Returns a list of all paths of installed packages in the given root.

Parameters:

packageRoot

path to the directory where Plasmagik packages have been installed to

Returns:

a list of installed Plasmagik packages by path

Definition at line 452 of file package.cpp.

PackageMetadata Plasma::Package::metadata

(

)

const

Returns:

the package metadata object.

Definition at line 295 of file package.cpp.

Package & Plasma::Package::operator=

(

const Package &

rhs

)

Assignment operator.

Since:

4.6

Definition at line 150 of file package.cpp.

const QString Plasma::Package::path

(

)

const

Returns:

the path to the root of this particular package

Definition at line 312 of file package.cpp.

void Plasma::Applet::publish	(	AnnouncementMethods	methods,
		const QString &	name
	)

Publish this package on the network.

Parameters:

methods

the ways to announce this package on the network.

Definition at line 1670 of file applet.cpp.

bool Plasma::Package::registerPackage	(	const PackageMetadata &	data,
		const QString &	iconPath
	)		[static]

Registers a package described by the given desktop file.

Parameters:

the	full path to the desktop file (must be KPluginInfo compatible)

Returns:

true on success, false on failure

Definition at line 687 of file package.cpp.

void Plasma::Package::setPath

(

const QString &

path

)

Sets the path to the root of this package.

Parameters:

path	and absolute path

Since:

4.3

Definition at line 304 of file package.cpp.

const PackageStructure::Ptr Plasma::Package::structure

(

)

const

Returns:

the PackageStructure use in this Package

Definition at line 317 of file package.cpp.

bool Plasma::Package::uninstallPackage	(	const QString &	package,
		const QString &	packageRoot,
		const QString &	servicePrefix
	)		[static]

Uninstalls a package.

Parameters:

package	path to the Plasmagik package
packageRoot	path to the directory where the package should be installed to
servicePrefix	the prefix for the desktop file, so as not to interfere with unrelated services (eg: "plasma-applet-")

Returns:

true on successful uninstallation, false otherwise

Definition at line 648 of file package.cpp.

void Plasma::Package::unpublish

(

const QString &

name = QString()

)

Remove this package from the network.

---

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

• package.h
• applet.cpp
• package.cpp