GammaRay  2.3.0
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-2015 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
8  Author: Volker Krause <volker.krause@kdab.com>
9 
10  Licensees holding valid commercial KDAB GammaRay licenses may use this file in
11  accordance with GammaRay Commercial License Agreement provided with the Software.
12 
13  Contact info@kdab.com if any conditions of this licensing are not clear to you.
14 
15  This program is free software; you can redistribute it and/or modify
16  it under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 2 of the License, or
18  (at your option) any later version.
19 
20  This program is distributed in the hope that it will be useful,
21  but WITHOUT ANY WARRANTY; without even the implied warranty of
22  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23  GNU General Public License for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with this program. If not, see <http://www.gnu.org/licenses/>.
27 */
38 #ifndef GAMMARAY_TOOLFACTORY_H
39 #define GAMMARAY_TOOLFACTORY_H
40 
41 #include "probeinterface.h"
42 
43 #include <QMetaType>
44 #include <QStringList>
45 #include <QtPlugin>
46 
47 namespace GammaRay {
48 
49 class ProbeInterface;
50 
58 {
59  public:
60  virtual inline ~ToolFactory()
61  {
62  }
63 
68  virtual QString id() const = 0;
69 
74  virtual QString name() const = 0;
75 
82  virtual QStringList supportedTypes() const = 0;
83 
90  virtual void init(ProbeInterface *probe) = 0;
91 
98  virtual bool isHidden() const = 0;
99 };
100 
104 template <typename Type, typename Tool>
106 {
107 public:
108  virtual inline QStringList supportedTypes() const
109  {
110  return QStringList(Type::staticMetaObject.className());
111  }
112 
113  virtual inline QString id() const
114  {
115  return Tool::staticMetaObject.className();
116  }
117 
118  virtual inline void init(ProbeInterface *probe)
119  {
120  new Tool(probe, probe->probe());
121  }
122 
123  inline bool isHidden() const
124  {
125  return false;
126  }
127 };
128 
129 }
130 
131 Q_DECLARE_INTERFACE(GammaRay::ToolFactory, "com.kdab.GammaRay.ToolFactory/1.0")
132 Q_DECLARE_METATYPE(GammaRay::ToolFactory *)
133 
134 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
135 #define Q_PLUGIN_METADATA(x)
136 #endif
137 
138 #endif
Declares the ProbeInterface abstract base class.
virtual void init(ProbeInterface *probe)
Definition: toolfactory.h:118
An abstract interface for accessing the core GammaRay probe.
Definition: probeinterface.h:57
An abstract interface for probe tools.
Definition: toolfactory.h:57
bool isHidden() const
Definition: toolfactory.h:123
virtual QStringList supportedTypes() const
Definition: toolfactory.h:108
Definition: endpoint.h:41
virtual QString id() const
Definition: toolfactory.h:113
virtual QObject * probe() const =0
virtual void init(ProbeInterface *probe)=0
virtual QString name() const =0
virtual bool isHidden() const =0
virtual QString id() const =0
virtual QStringList supportedTypes() const =0
A templated generic ToolFactory for some data type and tool.
Definition: toolfactory.h:105

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/