#include <Libs/PluginFramework/service/application/ctkApplicationDescriptor.h>
A service that represents an installed application and stores information about it. The application descriptor can be used for instance creation.
Definition at line 42 of file ctkApplicationDescriptor.h.
◆ ~ctkApplicationDescriptor()
virtual ctkApplicationDescriptor::~ctkApplicationDescriptor |
( |
| ) |
|
|
inlinevirtual |
◆ getApplicationId()
virtual QString ctkApplicationDescriptor::getApplicationId |
( |
| ) |
const |
|
pure virtual |
Returns the identifier of the represented application.
- Returns
- the identifier of the represented application
◆ getProperties() [1/2]
virtual ctkProperties ctkApplicationDescriptor::getProperties |
( |
| ) |
const |
|
pure virtual |
Returns the properties of the application descriptor as key-value pairs. The return value contains the raw (non-localized) property values. The returned QHash
will include the service properties of this ctkApplicationDescriptor
as well.
The returned QHash
will contain the standard CTK service properties as well (e.g. service.id, service.vendor etc.) and specialized application descriptors may offer further service properties. The returned QHash contains a snapshot of the properties. It will not reflect further changes in the property values nor will the update of the Map change the corresponding service property.
- Returns
- copy of the non-localized service properties of this application descriptor service.
- Exceptions
-
◆ getProperties() [2/2]
virtual ctkProperties ctkApplicationDescriptor::getProperties |
( |
const QLocale & |
locale | ) |
const |
|
pure virtual |
Returns the properties of the application descriptor as key-value pairs. The return value contains the locale aware and unaware properties as well. The returned QHash
will include the service properties of this ctkApplicationDescriptor
as well.
The returned QHash
will contain the standard CTK service properties as well (e.g. service.id, service.vendor etc.) and specialized application descriptors may offer further service properties. The returned Map contains a snapshot of the properties. It will not reflect further changes in the property values nor will the update of the Map change the corresponding service property.
- Parameters
-
locale | the locale, defaults to the default constructed QLocale() . |
- Returns
- copy of the service properties of this application descriptor service, according to the specified locale.
- Exceptions
-
◆ launch()
Launches a new instance of an application. The arguments
parameter specifies the startup parameters for the instance to be launched, it may be empty.
The following steps are made:
The QHash
argument of the launch method contains startup arguments for the application. The keys used in the QHash must be non-empty QString
objects. They can be standard or application specific. CTK defines the org.commontk.triggeringevent
key to be used to pass the triggering event to a scheduled application, however in the future it is possible that other well-known keys will be defined. To avoid unwanted clashes of keys, the following rules should be applied:
-
The keys starting with the dash (-) character are application specific, no well-known meaning should be associated with them.
-
Well-known keys should follow the reverse domain name based naming. In particular, the keys standardized in CTK should start with
org.commontk.
.
The method is synchronous, it returns only when the application instance was successfully started or the attempt to start it failed.
This method never returns null
. If launching an application fails, the appropriate exception is thrown.
- Parameters
-
arguments | Arguments for the newly launched application, may be null |
- Returns
- the registered ctkApplicationHandle, which represents the newly launched application instance. Never returns
null
.
- Exceptions
-
◆ APPLICATION_CONTAINER
const QString ctkApplicationDescriptor::APPLICATION_CONTAINER |
|
static |
◆ APPLICATION_COPYRIGHT
const QString ctkApplicationDescriptor::APPLICATION_COPYRIGHT |
|
static |
◆ APPLICATION_DESCRIPTION
const QString ctkApplicationDescriptor::APPLICATION_DESCRIPTION |
|
static |
◆ APPLICATION_DOCUMENTATION
const QString ctkApplicationDescriptor::APPLICATION_DOCUMENTATION |
|
static |
◆ APPLICATION_ICON
const QString ctkApplicationDescriptor::APPLICATION_ICON |
|
static |
◆ APPLICATION_LAUNCHABLE
const QString ctkApplicationDescriptor::APPLICATION_LAUNCHABLE |
|
static |
◆ APPLICATION_LICENSE
const QString ctkApplicationDescriptor::APPLICATION_LICENSE |
|
static |
◆ APPLICATION_LOCATION
const QString ctkApplicationDescriptor::APPLICATION_LOCATION |
|
static |
◆ APPLICATION_LOCKED
const QString ctkApplicationDescriptor::APPLICATION_LOCKED |
|
static |
◆ APPLICATION_NAME
const QString ctkApplicationDescriptor::APPLICATION_NAME |
|
static |
◆ APPLICATION_PID
const QString ctkApplicationDescriptor::APPLICATION_PID |
|
static |
◆ APPLICATION_VENDOR
const QString ctkApplicationDescriptor::APPLICATION_VENDOR |
|
static |
◆ APPLICATION_VERSION
const QString ctkApplicationDescriptor::APPLICATION_VERSION |
|
static |
◆ APPLICATION_VISIBLE
const QString ctkApplicationDescriptor::APPLICATION_VISIBLE |
|
static |
The documentation for this struct was generated from the following file: