C# Class Plasma.Package

Inheritance: Object, IDisposable
Datei anzeigen Open project: 0xd34df00d/Qross

Protected Properties

Property Type Description
interceptor Qyoto.SmokeInvocation

Public Methods

Method Description
ContentsHash ( ) : string
CreatePackage ( Plasma metadata, string source, string destination ) : bool
CreatePackage ( Plasma metadata, string source, string destination, string icon ) : bool Creates a package based on the metadata from the files contained in the source directory @arg metadata description of the package to create @arg source path to local directory containing the individual files to be added to the package @arg destination path to the package that should be created @arg icon path to the package icon
Dispose ( ) : void
EntryList ( string fileType ) : List Get the list of files of a given type. @arg fileType the type of file to look for, as defined in the package structure.
FilePath ( string fileType ) : string Get the path to a given file. @arg 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.
FilePath ( string fileType, string filename ) : string Get the path to a given file. @arg fileType the type of file to look for, as defined in the package structure @arg filename the name of the file
InstallPackage ( string package, string packageRoot, string servicePrefix ) : bool Installs a package. name="package" path to the Plasmagik package name="packageRoot" path to the directory where the package should be installed to name="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 string() is passed in), then the package will NOT be registered as a service
IsPublished ( ) : bool
IsValid ( ) : bool
ListInstalled ( string packageRoot ) : List Returns a list of all installed packages by name name="packageRoot" path to the directory where Plasmagik packages have been installed to
ListInstalledPaths ( string packageRoot ) : List Returns a list of all paths of installed packages in the given root name="packageRoot" path to the directory where Plasmagik packages have been installed to
Metadata ( ) : PackageMetadata
Package ( string packagePath, Plasma structure ) : System Construct a Package object. @arg packagePath full path to the package directory @arg structure the package structure describing this package
Package ( string packageRoot, string package, Plasma structure ) : System Default constructor @arg packageRoot path to the package installation root @arg package the name of the package @arg structure the package structure describing this package
Path ( ) : string
Publish ( uint methods, string name ) : void Publish this package on the network. name="methods" the ways to announce this package on the network.
RegisterPackage ( Plasma data, string iconPath ) : bool Registers a package described by the given desktop file @arg the full path to the desktop file (must be KPluginInfo compatible)
SetPath ( string path ) : void Sets the path to the root of this package @arg path and absolute path
Structure ( ) : Plasma.PackageStructure
UninstallPackage ( string package, string packageRoot, string servicePrefix ) : bool Uninstalls a package. name="package" path to the Plasmagik package name="packageRoot" path to the directory where the package should be installed to name="servicePrefix" the prefix for the desktop file, so as not to interfere with unrelated services (eg: "plasma-applet-")
Unpublish ( ) : void
Unpublish ( string name ) : void Remove this package from the network.

Protected Methods

Method Description
CreateProxy ( ) : void
Package ( Type dummy ) : System

Private Methods

Method Description
Package ( ) : System

Method Details

ContentsHash() public method

public ContentsHash ( ) : string
return string

CreatePackage() public static method

public static CreatePackage ( Plasma metadata, string source, string destination ) : bool
metadata Plasma
source string
destination string
return bool

CreatePackage() public static method

Creates a package based on the metadata from the files contained in the source directory @arg metadata description of the package to create @arg source path to local directory containing the individual files to be added to the package @arg destination path to the package that should be created @arg icon path to the package icon
public static CreatePackage ( Plasma metadata, string source, string destination, string icon ) : bool
metadata Plasma
source string
destination string
icon string
return bool

CreateProxy() protected method

protected CreateProxy ( ) : void
return void

Dispose() public method

public Dispose ( ) : void
return void

EntryList() public method

Get the list of files of a given type. @arg fileType the type of file to look for, as defined in the package structure.
public EntryList ( string fileType ) : List
fileType string
return List

FilePath() public method

Get the path to a given file. @arg 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.
public FilePath ( string fileType ) : string
fileType string
return string

FilePath() public method

Get the path to a given file. @arg fileType the type of file to look for, as defined in the package structure @arg filename the name of the file
public FilePath ( string fileType, string filename ) : string
fileType string
filename string
return string

InstallPackage() public static method

Installs a package. name="package" path to the Plasmagik package name="packageRoot" path to the directory where the package should be installed to name="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 string() is passed in), then the package will NOT be registered as a service
public static InstallPackage ( string package, string packageRoot, string servicePrefix ) : bool
package string
packageRoot string
servicePrefix string
return bool

IsPublished() public method

public IsPublished ( ) : bool
return bool

IsValid() public method

public IsValid ( ) : bool
return bool

ListInstalled() public static method

Returns a list of all installed packages by name name="packageRoot" path to the directory where Plasmagik packages have been installed to
public static ListInstalled ( string packageRoot ) : List
packageRoot string
return List

ListInstalledPaths() public static method

Returns a list of all paths of installed packages in the given root name="packageRoot" path to the directory where Plasmagik packages have been installed to
public static ListInstalledPaths ( string packageRoot ) : List
packageRoot string
return List

Metadata() public method

public Metadata ( ) : PackageMetadata
return PackageMetadata

Package() protected method

protected Package ( Type dummy ) : System
dummy System.Type
return System

Package() public method

Construct a Package object. @arg packagePath full path to the package directory @arg structure the package structure describing this package
public Package ( string packagePath, Plasma structure ) : System
packagePath string
structure Plasma
return System

Package() public method

Default constructor @arg packageRoot path to the package installation root @arg package the name of the package @arg structure the package structure describing this package
public Package ( string packageRoot, string package, Plasma structure ) : System
packageRoot string
package string
structure Plasma
return System

Path() public method

public Path ( ) : string
return string

Publish() public method

Publish this package on the network. name="methods" the ways to announce this package on the network.
public Publish ( uint methods, string name ) : void
methods uint
name string
return void

RegisterPackage() public static method

Registers a package described by the given desktop file @arg the full path to the desktop file (must be KPluginInfo compatible)
public static RegisterPackage ( Plasma data, string iconPath ) : bool
data Plasma
iconPath string
return bool

SetPath() public method

Sets the path to the root of this package @arg path and absolute path
public SetPath ( string path ) : void
path string
return void

Structure() public method

public Structure ( ) : Plasma.PackageStructure
return Plasma.PackageStructure

UninstallPackage() public static method

Uninstalls a package. name="package" path to the Plasmagik package name="packageRoot" path to the directory where the package should be installed to name="servicePrefix" the prefix for the desktop file, so as not to interfere with unrelated services (eg: "plasma-applet-")
public static UninstallPackage ( string package, string packageRoot, string servicePrefix ) : bool
package string
packageRoot string
servicePrefix string
return bool

Unpublish() public method

public Unpublish ( ) : void
return void

Unpublish() public method

Remove this package from the network.
public Unpublish ( string name ) : void
name string
return void

Property Details

interceptor protected_oe property

protected SmokeInvocation,Qyoto interceptor
return Qyoto.SmokeInvocation