QIfServiceInterface Class

Defines the interface for services. More...

Header: #include <QIfServiceInterface>
qmake: QT += interfaceframework
Inherited By:

QIfServiceObject

Public Functions

virtual ~QIfServiceInterface()
(since 6.5) virtual QString configurationId() const
(since 6.5) virtual QString id() const
virtual QIfFeatureInterface *interfaceInstance(const QString &interfaceName) const = 0
virtual QStringList interfaces() const = 0
(since 6.5) virtual void updateServiceSettings(const QVariantMap &settings)
T qif_interface_cast(QObject *backend)

Detailed Description

The QIfServiceInterface class defines the interface for services registered with QIfServiceManager.

Typically, service objects inherit the concrete class, QIfServiceObject, instead of using QIfServiceInterface directly.

See also QIfServiceObject.

Member Function Documentation

[virtual noexcept] QIfServiceInterface::~QIfServiceInterface()

Destructs the QIfServiceInterface instance.

[virtual, since 6.5] QString QIfServiceInterface::configurationId() const

Returns the configuration ID for the service object instance.

This function was introduced in Qt 6.5.

See also QIfConfiguration.

[virtual, since 6.5] QString QIfServiceInterface::id() const

Returns the unique ID for the service object instance.

This function was introduced in Qt 6.5.

[pure virtual] QIfFeatureInterface *QIfServiceInterface::interfaceInstance(const QString &interfaceName) const

Returns an object implementing the service interface requested through interfaceName.

[pure virtual] QStringList QIfServiceInterface::interfaces() const

Returns a list of service interface names supported by the service object instance.

[virtual, since 6.5] void QIfServiceInterface::updateServiceSettings(const QVariantMap &settings)

Updates the service settings with the given settings.

This function was introduced in Qt 6.5.

Related Non-Members

template <typename T> T qif_interface_cast(QObject *backend)

Casts the given backend to the interface type T.

When implementing a QtInterfaceFramework Feature, use this function as it shows a meaningful error message when the cast fails.

See also qobject_cast.

© 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.