PluginConstants Struct Reference

#include <Libs/PluginFramework/ctkPluginConstants.h>

List of all members.

Static Public Attributes

static const QString ACTIVATION_EAGER = "eager"
static const QString FRAMEWORK_STORAGE = "org.commontk.pluginfw.storage"
static const QString OBJECTCLASS = "objectclass"
static const QString PLUGIN_ACTIVATIONPOLICY = "Plugin-ActivationPolicy"
static const QString PLUGIN_COPYRIGHT = "Plugin-Copyright"
static const QString PLUGIN_DESCRIPTION = "Plugin-Description"
static const QString PLUGIN_LOCALIZATION = "Plugin-Localization"
static const QString PLUGIN_LOCALIZATION_DEFAULT_BASENAME = "CTK-INF/l10n/plugin"
static const QString PLUGIN_NAME = "Plugin-Name"
static const QString PLUGIN_SYMBOLICNAME = "Plugin-SymbolicName"
static const QString PLUGIN_VERSION = "Plugin-Version"
static const QString PLUGIN_VERSION_ATTRIBUTE = "plugin-version"
static const QString REQUIRE_PLUGIN = "Require-Plugin"
static const QString RESOLUTION_DIRECTIVE = "resolution"
static const QString RESOLUTION_MANDATORY = "mandatory"
static const QString RESOLUTION_OPTIONAL = "optional"
static const QString SERVICE_ID = "service.id"
static const QString SERVICE_RANKING = "service.ranking"
static const QString SYSTEM_PLUGIN_LOCATION = "System Plugin"
static const QString SYSTEM_PLUGIN_SYMBOLICNAME = "system.plugin"

Detailed Description

Definition at line 30 of file ctkPluginConstants.h.


Member Data Documentation

const QString PluginConstants::ACTIVATION_EAGER = "eager" [static]

Plugin activation policy declaring the plugin must be activated when the first object is instantiated from the plugin.

A plugin with the lazy (default) activation policy will wait in the ctkPlugin::STARTING state until the first class instantiation from the plugin occurs. The plugin will then be activated before the instance is returned to the requester.

A plugin with the eager activation policy that is started with the ctkPlugin::START_ACTIVATION_POLICY option will be activating immediately when the framework is started.

The activation policy value is specified as in the Plugin-ActivationPolicy manifest header like:

       Plugin-ActivationPolicy: eager
 
See also:
PLUGIN_ACTIVATIONPOLICY
ctkPlugin::start(int)
ctkPlugin::START_ACTIVATION_POLICY

Definition at line 194 of file ctkPluginConstants.h.

const QString PluginConstants::FRAMEWORK_STORAGE = "org.commontk.pluginfw.storage" [static]

Specifies the persistent storage area used by the framework. The value of this property must be a valid file path in the file system to a directory. If the specified directory does not exist then the framework will create the directory. If the specified path exists but is not a directory or if the framework fails to create the storage directory, then framework initialization must fail. The framework is free to use this directory as it sees fit. This area can not be shared with anything else.

If this property is not set, the framework should use a reasonable platform default for the persistent storage area.

Definition at line 58 of file ctkPluginConstants.h.

const QString PluginConstants::OBJECTCLASS = "objectclass" [static]

Service property identifying all of the class names under which a service was registered in the Framework. The value of this property must be of type QStringList.

This property is set by the Framework when a service is registered.

Definition at line 261 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_ACTIVATIONPOLICY = "Plugin-ActivationPolicy" [static]

Manifest header identifying the plugin's activation policy.

The attribute value may be retrieved from the QHash object returned by the Plugin::getHeaders() method.

See also:
ACTIVATION_EAGER

Definition at line 168 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_COPYRIGHT = "Plugin-Copyright" [static]

Manifest header identifying the plugin's copyright information.

The attribute value may be retrieved from the QHash object returned by the ctkPlugin::getHeaders method.

Definition at line 76 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_DESCRIPTION = "Plugin-Description" [static]

Manifest header containing a brief description of the plugin's functionality.

The attribute value may be retrieved from the QHash object returned by the ctkPlugin::getHeaders method.

Definition at line 85 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_LOCALIZATION = "Plugin-Localization" [static]

Manifest header identifying the base name of the plugin's Qt .qm files.

The attribute value may be retrieved from the QHash object returned by the Plugin::getHeaders method.

See also:
PLUGIN_LOCALIZATION_DEFAULT_BASENAME

Definition at line 106 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_LOCALIZATION_DEFAULT_BASENAME = "CTK-INF/l10n/plugin" [static]

Default value for the ctkPlugin-Localization manifest header.

See also:
PLUGIN_LOCALIZATION

Definition at line 113 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_NAME = "Plugin-Name" [static]

Manifest header identifying the plugin's name.

The attribute value may be retrieved from the QHash object returned by the ctkPlugin::getHeaders method.

Definition at line 93 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_SYMBOLICNAME = "Plugin-SymbolicName" [static]

Manifest header identifying the plugin's symbolic name.

The attribute value may be retrieved from the QHash object returned by the Plugin::getHeaders() method.

Definition at line 68 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_VERSION = "Plugin-Version" [static]

Manifest header identifying the plugin's version.

The attribute value may be retrieved from the QHash object returned by the ctkPlugin::getHeaders() method.

Definition at line 158 of file ctkPluginConstants.h.

const QString PluginConstants::PLUGIN_VERSION_ATTRIBUTE = "plugin-version" [static]

Manifest header attribute identifying a range of versions for a plugin specified in the Require-Plugin manifest headers. The default value is 0.0.0.

The attribute value is encoded in the Require-Plugin manifest header like:

     Require-Plugin: com.acme.module.test; plugin-version="1.1"
     Require-Plugin: com.acme.module.test; plugin-version="[1.0,2.0)"
 

The plugin-version attribute value uses a mathematical interval notation to specify a range of plugin versions. A plugin-version attribute value specified as a single version means a version range that includes any plugin version greater than or equal to the specified version.

See also:
REQUIRE_PLUGIN

Definition at line 148 of file ctkPluginConstants.h.

const QString PluginConstants::REQUIRE_PLUGIN = "Require-Plugin" [static]

Manifest header identifying the symbolic names of other plugins required by the plugin.

The attribute value may be retrieved from the QHash object returned by the ctkPlugin::getHeaders method.

Definition at line 124 of file ctkPluginConstants.h.

const QString PluginConstants::RESOLUTION_DIRECTIVE = "resolution" [static]

Manifest header directive identifying the resolution type in the Require-Plugin manifest header. The default value is mandatory.

The directive value is encoded in the Require-Plugin manifest header like:

     Require-Plugin: com.acme.module.test; resolution:="optional"
 
See also:
REQUIRE_PLUGIN
RESOLUTION_MANDATORY
RESOLUTION_OPTIONAL

Definition at line 213 of file ctkPluginConstants.h.

const QString PluginConstants::RESOLUTION_MANDATORY = "mandatory" [static]

Manifest header directive value identifying a mandatory resolution type. A mandatory resolution type indicates that the required plugin must be resolved when the plugin is resolved. If such a require plugin cannot be resolved, the module fails to resolve.

The directive value is encoded in the Require-Plugin manifest header like:

     Require-Plugin: com.acme.module.test; resolution:="manditory"
 
See also:
RESOLUTION_DIRECTIVE

Definition at line 231 of file ctkPluginConstants.h.

const QString PluginConstants::RESOLUTION_OPTIONAL = "optional" [static]

Manifest header directive value identifying an optional resolution type. An optional resolution type indicates that the require plugin is optional and the plugin may be resolved without the require plugin being resolved. If the require plugin is not resolved when the plugin is resolved, therequire plugin may not be resolved before the plugin is refreshed.

The directive value is encoded in the Require-Plugin manifest header like:

     Require-Plugin: com.acme.module.test; resolution:="optional"
 
See also:
RESOLUTION_DIRECTIVE

Definition at line 251 of file ctkPluginConstants.h.

const QString PluginConstants::SERVICE_ID = "service.id" [static]

Service property identifying a service's registration number. The value of this property must be of type qlonglong.

The value of this property is assigned by the Framework when a service is registered. The Framework assigns a unique value that is larger than all previously assigned values since the Framework was started. These values are NOT persistent across restarts of the Framework.

Definition at line 273 of file ctkPluginConstants.h.

const QString PluginConstants::SERVICE_RANKING = "service.ranking" [static]

Service property identifying a service's ranking number.

This property may be supplied in the ServiceProperties object passed to the ctkPluginContext::registerService method. The value of this property must be of type int.

The service ranking is used by the Framework to determine the natural order of services, see <(const ctkServiceReference&), and the default service to be returned from a call to the ctkPluginContext::getServiceReference method.

The default ranking is zero (0). A service with a ranking of std::numeric_limits<int>::max() is very likely to be returned as the default service, whereas a service with a ranking of std::numeric_limits<int>::min() is very unlikely to be returned.

If the supplied property value is not of type int, it is deemed to have a ranking value of zero.

Definition at line 300 of file ctkPluginConstants.h.

const QString PluginConstants::SYSTEM_PLUGIN_LOCATION = "System Plugin" [static]

Location identifier of the CTK system plugin, which is defined to be "System Plugin".

Definition at line 36 of file ctkPluginConstants.h.

const QString PluginConstants::SYSTEM_PLUGIN_SYMBOLICNAME = "system.plugin" [static]

Alias for the symbolic name of the CTK system plugin. It is defined to be "system.plugin".

Definition at line 43 of file ctkPluginConstants.h.


The documentation for this struct 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