GammaRay  2.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Pages
toolfactory.h
Go to the documentation of this file.
1 /*
2  toolfactory.h
3 
4  This file is part of GammaRay, the Qt application inspection and
5  manipulation tool.
6 
7  Copyright (C) 2010-2014 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
8  Author: Volker Krause <volker.krause@kdab.com>
9 
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation, either version 2 of the License, or
13  (at your option) any later version.
14 
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  GNU General Public License for more details.
19 
20  You should have received a copy of the GNU General Public License
21  along with this program. If not, see <http://www.gnu.org/licenses/>.
22 */
33 #ifndef GAMMARAY_TOOLFACTORY_H
34 #define GAMMARAY_TOOLFACTORY_H
35 
36 #include "probeinterface.h"
37 #include <ui/tooluifactory.h>
38 
39 #include <QMetaType>
40 #include <QStringList>
41 #include <QtPlugin>
42 
43 namespace GammaRay {
44 
45 class ProbeInterface;
46 
54 {
55  public:
56  virtual inline ~ToolFactory()
57  {
58  }
59 
64  virtual QString id() const = 0;
65 
70  virtual QString name() const = 0;
71 
78  virtual QStringList supportedTypes() const = 0;
79 
86  virtual void init(ProbeInterface *probe) = 0;
87 
94  virtual bool isHidden() const = 0;
95 };
96 
100 template <typename Type, typename Tool>
102 {
103 public:
104  virtual inline QStringList supportedTypes() const
105  {
106  return QStringList(Type::staticMetaObject.className());
107  }
108 
109  virtual inline QString id() const
110  {
111  return Tool::staticMetaObject.className();
112  }
113 
114  virtual inline void init(ProbeInterface *probe)
115  {
116  new Tool(probe, probe->probe());
117  }
118 
119  inline bool isHidden() const
120  {
121  return false;
122  }
123 };
124 
128 // TODO: split this completely, this is just a migration aid
129 template <typename Type, typename Tool, typename ToolUi>
130 class StandardToolFactory2 : public ToolFactory, public ToolUiFactory
131 {
132  public:
133  virtual inline QStringList supportedTypes() const
134  {
135  return QStringList(Type::staticMetaObject.className());
136  }
137 
138  virtual inline QString id() const
139  {
140  return Tool::staticMetaObject.className();
141  }
142 
143  virtual inline void init(ProbeInterface *probe)
144  {
145  new Tool(probe, probe->probe());
146  }
147 
148  inline bool isHidden() const
149  {
150  return false;
151  }
152 
153  virtual inline QWidget *createWidget(QWidget *parentWidget)
154  {
155  return new ToolUi(parentWidget);
156  }
157 
158  virtual bool remotingSupported() const
159  {
160  return true;
161  }
162 };
163 
164 }
165 
166 Q_DECLARE_INTERFACE(GammaRay::ToolFactory, "com.kdab.GammaRay.ToolFactory/1.0")
167 Q_DECLARE_METATYPE(GammaRay::ToolFactory *)
168 
169 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
170 #define Q_PLUGIN_METADATA(x)
171 #endif
172 
173 #endif

Klarälvdalens Datakonsult AB (KDAB)
"The Qt Experts"
http://www.kdab.com/
GammaRay
Qt-application inspection and manipulation tool
http://www.kdab.com/kdab-products/gammaray/