QIfServiceObject Class

Provides the connection point to a Backend Service. More...

Header: #include <QIfServiceObject>
qmake: QT += interfaceframework
In QML: ServiceObject
Inherits: QObject and QIfServiceInterface
Inherited By:

QIfProxyServiceObject

Properties

Public Functions

QIfServiceObject(QObject *parent = nullptr)
const QVariantMap &serviceSettings() const

Reimplemented Public Functions

virtual QString id() const override
virtual void updateServiceSettings(const QVariantMap &settings) override

Signals

Detailed Description

QIfServiceObject provides you with a list of interfaces that the Backend implements.

Use interfaceInstance() to obtain a QObject that implements this interface. The interface returned may contain signals that a Feature implementing this interface needs to be connected to.

See also QIfAbstractFeature.

Property Documentation

[read-only, since 6.5] configurationId : const QString

Holds the id to determine which configuration this service object belongs to.

Once the id has been set, it is possible to change certain values using the QIfConfiguration API.

Note: Values set in the matching QIfConfiguration can override the initial values set during the component creation.

This property was introduced in Qt 6.5.

See also QIfConfiguration.

[read-only] id : const QString

This property holds a unique ID for the service object instance.

Each service object has a unique ID. When subclassing, the id() function can be overloaded to modify how this ID is generated.

Access functions:

virtual QString id() const override

[since 6.5] serviceSettings : QVariantMap

This property holds the settings for the service object instance.

The serviceSettings property contains a map of settings for the service object instance.

This property was introduced in Qt 6.5.

Access functions:

const QVariantMap &serviceSettings() const
virtual void updateServiceSettings(const QVariantMap &settings) override

Notifier signal:

void serviceSettingsChanged()

See also Backend specific configuration option.

Member Function Documentation

[explicit] QIfServiceObject::QIfServiceObject(QObject *parent = nullptr)

Constructor.

parent is passed on to QObject.

[override virtual] QString QIfServiceObject::id() const

Reimplements: QIfServiceInterface::id() const.

The id() function can be overloaded to modify how the unique ID is generated, for use by this service object.

By default, QUuid::createUuid() is used.

Note: Getter function for property id.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.