diff options
| author | Dominik Holland <dominik.holland@qt.io> | 2021-06-14 10:31:03 +0200 |
|---|---|---|
| committer | Dominik Holland <dominik.holland@qt.io> | 2021-06-16 09:40:47 +0000 |
| commit | f9016ae603cbfbfd7165626ff7eabbeeacb6f1f3 (patch) | |
| tree | 80a86a01f67bfa5bbb2a79cacdb2e8209b4721df /src/interfaceframework/qiffeatureinterface.cpp | |
| parent | 59c60668ada002c3c4d77e30520be840bed758f6 (diff) | |
Rename all files to match the new module name
This is a follow-up of the previous commit.
Task-number: AUTOSUITE-1633
Change-Id: I6feb63a346a4c94c434df83cd1255904fe8acc68
Reviewed-by: Robert Griebl <robert.griebl@qt.io>
Diffstat (limited to 'src/interfaceframework/qiffeatureinterface.cpp')
| -rw-r--r-- | src/interfaceframework/qiffeatureinterface.cpp | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/src/interfaceframework/qiffeatureinterface.cpp b/src/interfaceframework/qiffeatureinterface.cpp new file mode 100644 index 00000000..a4a2bb7c --- /dev/null +++ b/src/interfaceframework/qiffeatureinterface.cpp @@ -0,0 +1,104 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Copyright (C) 2019 Luxoft Sweden AB +** Copyright (C) 2018 Pelagicore AG +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the QtInterfaceFramework module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qiffeatureinterface.h" + +QT_BEGIN_NAMESPACE + +/*! + \class QIfFeatureInterface + \inmodule QtInterfaceFramework + \ingroup backends + + \brief QIfFeatureInterface defines the base class for all backends. + + To implement a backend for a specific feature you need to derive from this class. + There's a one-to-one mapping between a spezialized feature API and its corresponding feature interface + class. + + The feature interface class specifies which functions and signals need to be implemented by a backend + to work with a specific feature. + + This base class contains the generic error handling, which is common between all interfaces. + + See the full example backend implementation from \c {src/plugins/ifvehiclefunctions/climate_simulator}. + \sa QIfAbstractFeature, QIfServiceInterface +*/ + +QIfFeatureInterface::QIfFeatureInterface(QObject *parent) + : QObject(parent) +{ +} + +QIfFeatureInterface::QIfFeatureInterface(QObjectPrivate &dd, QObject *parent) + : QObject(dd, parent) +{ +} + +/*! + \fn void QIfFeatureInterface::initialize() + + Initializes the backend. This function is called after a feature connected to the backend. + It is expected that this function will inform about the current state of the backend by + emitting signals with the current status. + + The last signal which needs to be sent is the initializationDone() signal. + + \sa initializationDone() +*/ + +/*! + \fn void QIfFeatureInterface::errorChanged(QIfAbstractFeature::Error error, const QString &message = QString()) + + The signal is emitted when \a error occurs in the backend. + Error \a message is optional. +*/ + +/*! + \fn void QIfFeatureInterface::initializationDone() + + The signal is emitted once the current backend state has been sent to the feature after + a call to initialize() + + \sa initialize +*/ + +QT_END_NAMESPACE |