#include <Libs/PluginFramework/ctkServiceRegistration.h>
|
ctkServiceRegistrationPrivate * | d_ptr |
|
A registered service.
The Framework returns a ctkServiceRegistration
object when a ctkPluginContext::registerService()
method invocation is successful. The ctkServiceRegistration
object is for the private use of the registering plugin and should not be shared with other plugins.
The ctkServiceRegistration
object may be used to update the properties of the service or to unregister the service.
- See also
- ctkPluginContext::registerService()
Definition at line 50 of file ctkServiceRegistration.h.
◆ ctkServiceRegistration() [1/4]
ctkServiceRegistration::ctkServiceRegistration |
( |
| ) |
|
Creates an invalid ctkServiceRegistration object. You can use this object in boolean expressions and it will evaluate to false
.
◆ ctkServiceRegistration() [2/4]
◆ ~ctkServiceRegistration()
ctkServiceRegistration::~ctkServiceRegistration |
( |
| ) |
|
◆ ctkServiceRegistration() [3/4]
ctkServiceRegistration::ctkServiceRegistration |
( |
ctkServiceRegistrationPrivate * |
registrationPrivate | ) |
|
|
protected |
◆ ctkServiceRegistration() [4/4]
ctkServiceRegistration::ctkServiceRegistration |
( |
ctkPluginPrivate * |
plugin, |
|
|
QObject * |
service, |
|
|
const ctkDictionary & |
props |
|
) |
| |
|
protected |
◆ getReference()
◆ operator bool()
ctkServiceRegistration::operator bool |
( |
| ) |
const |
◆ operator<()
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ operator==()
◆ setProperties()
void ctkServiceRegistration::setProperties |
( |
const ctkDictionary & |
properties | ) |
|
Updates the properties associated with a service.
The ctkPluginConstants#OBJECTCLASS and ctkPluginConstants#SERVICE_ID keys cannot be modified by this method. These values are set by the Framework when the service is registered in the environment.
The following steps are required to modify service properties:
-
The service's properties are replaced with the provided properties.
-
A service event of type ctkServiceEvent#MODIFIED is fired.
- Parameters
-
properties | The properties for this service. See ctkPluginConstants for a list of standard service property keys. Changes should not be made to this object after calling this method. To update the service's properties this method should be called again. |
- Exceptions
-
◆ unregister()
void ctkServiceRegistration::unregister |
( |
| ) |
|
◆ ctkServiceReferencePrivate
friend class ctkServiceReferencePrivate |
|
friend |
◆ ctkServices
◆ qHash
◆ d_ptr
ctkServiceRegistrationPrivate* ctkServiceRegistration::d_ptr |
|
protected |
The documentation for this class was generated from the following file: