Tulip  4.8.0
Better Visualization Through Research
 All Classes Files Functions Variables Enumerations Enumerator Properties Groups Pages
PluginManager.h
1 /*
2  *
3  * This file is part of Tulip (www.tulip-software.org)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux
7  *
8  * Tulip is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *
13  * Tulip is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  */
19 ///@cond DOXYGEN_HIDDEN
20 
21 #ifndef PLUGINMANAGER_H
22 #define PLUGINMANAGER_H
23 
24 #include <QObject>
25 #include <QStringList>
26 
27 #include <tulip/tulipconf.h>
28 
29 class QNetworkReply;
30 
31 namespace tlp {
32 
33 class Plugin;
34 
35 struct TLP_QT_SCOPE PluginVersionInformation {
36  bool isValid;
37 
38  QString libraryLocation;
39  QString author;
40  QString version;
41  QString icon;
42  QString description;
43  QString date;
44 
45  QStringList dependencies;
46 
47  PluginVersionInformation();
48  PluginVersionInformation(const PluginVersionInformation& copy);
49 };
50 
51 // deprecated name
52 _DEPRECATED_TYPEDEF(PluginVersionInformation, PluginVersionInformations);
53 
54 struct TLP_QT_SCOPE PluginInformation {
55  QString name;
56  QString category;
57  PluginVersionInformation installedVersion;
58  PluginVersionInformation availableVersion;
59 
60  PluginInformation();
61  PluginInformation(const PluginInformation& copy);
62 
63  void fillLocalInfos(const tlp::Plugin& info);
64 };
65 
66 // deprecated name
67 _DEPRECATED_TYPEDEF(PluginInformation, PluginInformations);
68 
69 class TLP_QT_SCOPE PluginManager {
70  static QStringList _markedForInstallation;
71 
72 public:
73  enum PluginLocation {
74  Remote = 0x01,
75  Local = 0x02
76  };
77  Q_DECLARE_FLAGS(PluginLocations, PluginLocation)
78 
79  static const QString STABLE_LOCATION;
80  static const QString TESTING_LOCATION;
81 
82  typedef QList<PluginVersionInformation> PluginVersionInformationList;
83  _DEPRECATED_TYPEDEF(QList<PluginVersionInformation>, PluginVersionInformationsList);
84 
85  typedef QList<PluginInformation> PluginInformationList;
86  _DEPRECATED_TYPEDEF(QList<PluginInformation>, PluginInformationsList);
87 
88  static void addRemoteLocation(const QString& location);
89  static void removeRemoteLocation(const QString& location);
90  static QStringList remoteLocations();
91 
92  static PluginInformationList listPlugins(PluginLocations locations,const QString& nameFilter = QString(),const QString& categoryFilter = QString());
93 
94  static void markForRemoval(const QString& plugin);
95  static void markForInstallation(const QString& plugin, QObject *recv, const char* progressSlot);
96 
97  static QStringList markedForInstallation();
98  static QStringList markedForRemoval();
99  static void unmarkForRemoval(const QString& file);
100 };
101 
102 Q_DECLARE_OPERATORS_FOR_FLAGS(PluginManager::PluginLocations)
103 }
104 
105 #endif //PLUGINMANAGER_H
106 ///@endcond
Top-level interface for plug-ins.
Definition: Plugin.h:79