ctkPluginArchive Class Reference

#include <Libs/PluginFramework/ctkPluginArchive_p.h>

Collaboration diagram for ctkPluginArchive:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ctkPluginArchive (ctkPluginStorage *pluginStorage, const QUrl &pluginLocation, const QString &localPluginPath, int pluginId)
QStringList findResourcesPath (const QString &path) const
QString getAttribute (const QString &key) const
int getAutostartSetting () const
qtimestamp getLastModified () const
QString getLibLocation () const
int getPluginId () const
QUrl getPluginLocation () const
QByteArray getPluginResource (const QString &component) const
int getStartLevel () const
QHash< QString, QString > getUnlocalizedAttributes () const
void purge ()
void setAutostartSetting (int setting)
void setLastModified (qtimestamp timemillisecs)
void setStartLevel (int level)

Static Public Attributes

static const QString AUTOSTART_SETTING_ACTIVATION_POLICY
static const QString AUTOSTART_SETTING_EAGER
static const QString AUTOSTART_SETTING_STOPPED

Private Attributes

int autostartSetting
int id
qtimestamp lastModified
QString localPluginPath
QUrl location
ctkPluginManifest manifest
ctkPluginStoragestorage

Detailed Description

Class for managing plugin data.

Definition at line 43 of file ctkPluginArchive_p.h.


Constructor & Destructor Documentation

ctkPluginArchive::ctkPluginArchive ( ctkPluginStorage pluginStorage,
const QUrl &  pluginLocation,
const QString &  localPluginPath,
int  pluginId 
)

Construct new plugin archive.

Definition at line 35 of file ctkPluginArchive.cpp.


Member Function Documentation

QStringList ctkPluginArchive::findResourcesPath ( const QString &  path  )  const

Returns a QStringList of all the paths to entries within the plugin whose longest sub-path matches the supplied path argument.

Parameters:
name 
Returns:

Definition at line 80 of file ctkPluginArchive.cpp.

QString ctkPluginArchive::getAttribute ( const QString &  key  )  const

Get an attribute from the manifest of a plugin.

Not localized

Parameters:
key Name of attribute to get.
Returns:
A string with result or null if the entry doesn't exists.

Definition at line 50 of file ctkPluginArchive.cpp.

int ctkPluginArchive::getAutostartSetting (  )  const

Get auto-start setting.

Returns:
the autostart setting. "-1" if the plugin is not started.

Definition at line 113 of file ctkPluginArchive.cpp.

qtimestamp ctkPluginArchive::getLastModified (  )  const

Get last modified timestamp.

Definition at line 101 of file ctkPluginArchive.cpp.

QString ctkPluginArchive::getLibLocation (  )  const

Get the path to the plugin library on the local file system

Returns:
Path to the plugin library

Definition at line 70 of file ctkPluginArchive.cpp.

int ctkPluginArchive::getPluginId (  )  const

Get plugin identifier for this plugin archive.

Returns:
ctkPlugin identifier.

Definition at line 60 of file ctkPluginArchive.cpp.

QUrl ctkPluginArchive::getPluginLocation (  )  const

Get plugin location for this plugin archive.

Returns:
Bundle location.

Definition at line 65 of file ctkPluginArchive.cpp.

QByteArray ctkPluginArchive::getPluginResource ( const QString &  component  )  const

Get a Qt resource as a byte array from a plugin. The resource is cached and may be aquired even if the plugin is not active.

Parameters:
component Resource to get the byte array from.
Returns:
QByteArray to the entry (empty if it doesn't exist).

Definition at line 75 of file ctkPluginArchive.cpp.

int ctkPluginArchive::getStartLevel (  )  const

Get stored plugin start level.

Definition at line 85 of file ctkPluginArchive.cpp.

QHash< QString, QString > ctkPluginArchive::getUnlocalizedAttributes (  )  const
Returns:
the (raw/unlocalized) attributes

Definition at line 55 of file ctkPluginArchive.cpp.

void ctkPluginArchive::purge (  ) 

Get certificate chains associated with a plugin.

Parameters:
onlyTrusted Only return trusted certificates.
Returns:
All certificates or null if bundle is unsigned. Mark certificate associated with the plugin as trusted. Remove plugin from persistent storage. This will delete the current ctkPluginArchive instance.

Definition at line 128 of file ctkPluginArchive.cpp.

void ctkPluginArchive::setAutostartSetting ( int  setting  ) 

Set the auto-start setting.

Parameters:
setting the autostart setting to use.

Definition at line 118 of file ctkPluginArchive.cpp.

void ctkPluginArchive::setLastModified ( qtimestamp  timemillisecs  ) 

Set stored last modified timestamp.

Definition at line 106 of file ctkPluginArchive.cpp.

void ctkPluginArchive::setStartLevel ( int  level  ) 

Set stored plugin start level.

Definition at line 91 of file ctkPluginArchive.cpp.


Member Data Documentation

Autostart setting declared activation policy.

See also:
PluginArchiveInterface::setAutostartSetting(const QString&)

Definition at line 63 of file ctkPluginArchive_p.h.

Autostart setting eager.

See also:
PluginArchiveInterface::setAutostartSetting(const QString&)

Definition at line 57 of file ctkPluginArchive_p.h.

Autostart setting stopped.

See also:
PluginArchiveInterface::setAutostartSetting(const QString&)

Definition at line 51 of file ctkPluginArchive_p.h.

Definition at line 67 of file ctkPluginArchive_p.h.

int ctkPluginArchive::id [private]

Definition at line 68 of file ctkPluginArchive_p.h.

Definition at line 69 of file ctkPluginArchive_p.h.

Definition at line 71 of file ctkPluginArchive_p.h.

Definition at line 70 of file ctkPluginArchive_p.h.

Definition at line 72 of file ctkPluginArchive_p.h.

Definition at line 73 of file ctkPluginArchive_p.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated on 21 May 2010 for CTK by  doxygen 1.6.1