Changeset View
Changeset View
Standalone View
Standalone View
kdevplatform/services/interfaces/iprojectservicehookupconfiguration.h
- This file was added.
1 | /* This file is part of KDevelop | ||||
---|---|---|---|---|---|
2 | Copyright 2017 Friedrich W. H. Kossebau <kossebau@kde.org> | ||||
3 | | ||||
4 | This library is free software; you can redistribute it and/or | ||||
5 | modify it under the terms of the GNU Library General Public | ||||
6 | License as published by the Free Software Foundation; either | ||||
7 | version 2 of the License, or (at your option) any later version. | ||||
8 | | ||||
9 | This library is distributed in the hope that it will be useful, | ||||
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||||
12 | Library General Public License for more details. | ||||
13 | | ||||
14 | You should have received a copy of the GNU Library General Public License | ||||
15 | along with this library; see the file COPYING.LIB. If not, write to | ||||
16 | the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | ||||
17 | Boston, MA 02110-1301, USA. | ||||
18 | */ | ||||
19 | | ||||
20 | #ifndef KDEVPLATFORM_IPROJECTSERVICEHOOKUPCONFIGURATION_H | ||||
21 | #define KDEVPLATFORM_IPROJECTSERVICEHOOKUPCONFIGURATION_H | ||||
22 | | ||||
23 | #include "servicesexport.h" | ||||
24 | | ||||
25 | class QString; | ||||
26 | | ||||
27 | namespace KDevelop | ||||
28 | { | ||||
29 | | ||||
30 | /** | ||||
31 | * Interface for configuration for a hook-up of a project to a service. | ||||
32 | * Used for passing the config data in the working memory in an abstract way | ||||
33 | * between the plugin providing the service hook up, thus implementing @c IProjectServiceHookup, | ||||
34 | * and the config editing pages, being matching @c ProjectServiceHookupConfigPage subclasses. | ||||
35 | */ | ||||
36 | class KDEVPLATFORMSERVICES_EXPORT IProjectServiceHookupConfiguration | ||||
37 | { | ||||
38 | public: | ||||
39 | virtual ~IProjectServiceHookupConfiguration(); | ||||
40 | | ||||
41 | /** | ||||
42 | * Provide a unique identifier for the given configuration of a | ||||
43 | * hook up between a service and a project. | ||||
44 | * Is e.g. used for the config group in the hookup configurations storage. | ||||
45 | * @return a unique identifier for this service hookup configuration | ||||
46 | */ | ||||
47 | virtual QString id() const = 0; | ||||
48 | | ||||
49 | /** | ||||
50 | * Sets unique identifier for the given configuration. | ||||
51 | * @param id the new id | ||||
52 | */ | ||||
53 | virtual void setId(const QString& id) = 0; | ||||
54 | | ||||
55 | /** | ||||
56 | * The user-chosen name for the project service configuration. | ||||
57 | * @return the display name for the project service configuration | ||||
58 | */ | ||||
59 | virtual QString displayName() const = 0; | ||||
60 | | ||||
61 | /** | ||||
62 | * Sets the user-chosen name for the project service configuration. | ||||
63 | * @param displayName the new display name | ||||
64 | */ | ||||
65 | virtual void setDisplayName(const QString& displayName) = 0; | ||||
66 | | ||||
67 | /** | ||||
68 | * @return the id of the project service hookup this configuration is for | ||||
69 | */ | ||||
70 | virtual QString projectServiceId() const = 0; | ||||
71 | }; | ||||
72 | | ||||
73 | } | ||||
74 | | ||||
75 | #endif |