| 1 | /**************************************************************************** |
| 2 | ** |
| 3 | ** Copyright (C) 2015 The Qt Company Ltd and/or its subsidiary(-ies). |
| 4 | ** Contact: http://www.qt-project.org/legal |
| 5 | ** |
| 6 | ** This file is part of the QtSystems module of the Qt Toolkit. |
| 7 | ** |
| 8 | ** $QT_BEGIN_LICENSE:LGPL21$ |
| 9 | ** Commercial License Usage |
| 10 | ** Licensees holding valid commercial Qt licenses may use this file in |
| 11 | ** accordance with the commercial license agreement provided with the |
| 12 | ** Software or, alternatively, in accordance with the terms contained in |
| 13 | ** a written agreement between you and The Qt Company. For licensing terms |
| 14 | ** and conditions see http://www.qt.io/terms-conditions. For further |
| 15 | ** information use the contact form at http://www.qt.io/contact-us. |
| 16 | ** |
| 17 | ** GNU Lesser General Public License Usage |
| 18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
| 19 | ** General Public License version 2.1 or version 3 as published by the Free |
| 20 | ** Software Foundation and appearing in the file LICENSE.LGPLv21 and |
| 21 | ** LICENSE.LGPLv3 included in the packaging of this file. Please review the |
| 22 | ** following information to ensure the GNU Lesser General Public License |
| 23 | ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and |
| 24 | ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
| 25 | ** |
| 26 | ** As a special exception, The Qt Company gives you certain additional |
| 27 | ** rights. These rights are described in The Qt Company LGPL Exception |
| 28 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
| 29 | ** |
| 30 | ** $QT_END_LICENSE$ |
| 31 | ** |
| 32 | ****************************************************************************/ |
| 33 | |
| 34 | #include "qserviceplugininterface.h" |
| 35 | |
| 36 | QT_BEGIN_NAMESPACE |
| 37 | /*! |
| 38 | \class QServicePluginInterface |
| 39 | \ingroup servicefw |
| 40 | \inmodule QtServiceFramework |
| 41 | \brief The QServicePluginInterface class defines the interface |
| 42 | that every plug-in based service must implement. |
| 43 | */ |
| 44 | |
| 45 | /*! |
| 46 | \internal |
| 47 | */ |
| 48 | QServicePluginInterface::QServicePluginInterface() |
| 49 | { |
| 50 | } |
| 51 | |
| 52 | /*! |
| 53 | \internal |
| 54 | */ |
| 55 | QServicePluginInterface::~QServicePluginInterface() |
| 56 | { |
| 57 | } |
| 58 | |
| 59 | /*! |
| 60 | \fn QObject* QServicePluginInterface::createInstance(const QServiceInterfaceDescriptor& descriptor) |
| 61 | |
| 62 | Creates a new instance of the service specified by \a descriptor. |
| 63 | |
| 64 | This function returns a null pointer if the plug-in doesn't |
| 65 | support the given \a descriptor. |
| 66 | */ |
| 67 | |
| 68 | /*! |
| 69 | \fn bool QServicePluginInterface::installService() |
| 70 | |
| 71 | This function is called by QServiceManager as part of the service registration process. It can be |
| 72 | used to initialize the environment or the creation of external settings files which may be required |
| 73 | during the execution of the service. |
| 74 | |
| 75 | The default implementation for this function does nothing. |
| 76 | |
| 77 | \sa QServiceManager::addService() |
| 78 | */ |
| 79 | void QServicePluginInterface::installService() |
| 80 | { |
| 81 | } |
| 82 | |
| 83 | /*! |
| 84 | \fn bool QServicePluginInterface::uninstallService() |
| 85 | |
| 86 | This function is called bu QServiceManager as part of the deregistration process for services. This |
| 87 | gives the service the possibility to perform cleanup operations such as the removal of setting files |
| 88 | on the hard drive. |
| 89 | |
| 90 | The default implementation for this function does nothing. |
| 91 | |
| 92 | \sa QServiceManager::removeService() |
| 93 | */ |
| 94 | |
| 95 | void QServicePluginInterface::uninstallService() |
| 96 | { |
| 97 | } |
| 98 | |
| 99 | QT_END_NAMESPACE |
| 100 | |