/usr/include/gammaray/ui/tooluifactory.h is in gammaray-dev 2.7.0-1ubuntu8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | /*
This file is part of GammaRay, the Qt application inspection and
manipulation tool.
Copyright (C) 2010-2017 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
Author: Volker Krause <volker.krause@kdab.com>
Licensees holding valid commercial KDAB GammaRay licenses may use this file in
accordance with GammaRay Commercial License Agreement provided with the Software.
Contact info@kdab.com if any conditions of this licensing are not clear to you.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GAMMARAY_TOOLUIFACTORY_H
#define GAMMARAY_TOOLUIFACTORY_H
#include "gammaray_ui_export.h"
#include <QMetaType>
#include <QStringList>
#include <QtPlugin>
namespace GammaRay {
/**
* @brief An abstract interface for creating the UI parts of probe tools.
*
* The ToolUiFactory class is an abstract base class for creating UIs for probe tools
* for GammaRay. The unique identifier used for the UI must match the one of the corresponding
* probe tool.
*/
class GAMMARAY_UI_EXPORT ToolUiFactory
{
public:
ToolUiFactory();
virtual ~ToolUiFactory();
/**
* Unique id of this tool, must match the id of a the corresponding probe tool.
* @return a QString containing the tool id.
*/
virtual QString id() const = 0;
/*!
* Human readable name of this tool.
* You do not need to override this usually, the plugin loader will fill this in.
* @return a QString containing the tool name.
*/
virtual QString name() const;
/**
* Return @c true if this tool supports remoting, @c false otherwise.
* The default implementation returns @c true.
*/
virtual bool remotingSupported() const;
/**
* Create the UI part of this tool.
* @param parentWidget The parent widget for the visual elements of this tool.
* @return a pointer to the created QwWidget.
*/
virtual QWidget *createWidget(QWidget *parentWidget) = 0;
/**
* Initialize UI related stuff for this tool. This function is called on loading
* the plugin, before the widget itself is needed. Use createWidget to create
* the actual widget.
*/
virtual void initUi();
private:
Q_DISABLE_COPY(ToolUiFactory)
};
/**
* @brief A templated convenience ToolUiFactory applicable for most use-cases.
*/
template<typename ToolUi>
class StandardToolUiFactory : public ToolUiFactory
{
public:
QString id() const override
{
return QString(); // TODO is this a problem??
}
QWidget *createWidget(QWidget *parentWidget) override
{
return new ToolUi(parentWidget);
}
};
}
QT_BEGIN_NAMESPACE
Q_DECLARE_INTERFACE(GammaRay::ToolUiFactory, "com.kdab.GammaRay.ToolUiFactory/1.0")
QT_END_NAMESPACE
Q_DECLARE_METATYPE(GammaRay::ToolUiFactory *)
#if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
#define Q_PLUGIN_METADATA(x)
#endif
#endif
|