summaryrefslogtreecommitdiffstats
path: root/src/interfaceframework/qifserviceinterface.cpp
blob: 31fa9fe3ce9ab24770105c199724c829bdf1b1e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include "qifserviceinterface.h"

QT_BEGIN_NAMESPACE

/*!
    \fn template <class T> T qif_interface_cast(QObject *backend)
    \relates QIfServiceInterface

    Casts the given \a 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.

    \sa qobject_cast
*/

/*!
    \class QIfServiceInterface
    \inmodule QtInterfaceFramework
    \brief Defines the interface for services.

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

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

    \sa QIfServiceObject
*/

/*!
    Destructs the QIfServiceInterface instance.
*/
QIfServiceInterface::~QIfServiceInterface()
{
}

/*!
    Returns the unique ID for the service object instance.
    \since 6.5
*/
QString QIfServiceInterface::id() const
{
    return QString();
}

/*!
    Returns the configuration ID for the service object instance.
    \since 6.5

    \sa QIfConfiguration
*/
QString QIfServiceInterface::configurationId() const
{
    return QString();
}

/*!
    Updates the service settings with the given \a settings.
    \since 6.5
*/
void QIfServiceInterface::updateServiceSettings(const QVariantMap &settings)
{
    Q_UNUSED(settings);
}

/*!
    \fn QStringList QIfServiceInterface::interfaces() const

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

/*!
    \fn QObject* QIfServiceInterface::interfaceInstance(const QString& interfaceName) const

    Returns an object implementing the service interface requested through \a interfaceName.
*/

QT_END_NAMESPACE