/usr/include/avogadro/plugin.h is in libavogadro-dev 1.1.1-0ubuntu2.
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 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | /**********************************************************************
Plugin - Avogadro Plugin Interface Base Class
Copyright (C) 2008 Tim Vandermeersch
Copyright (C) 2008 Donald Ephraim Curtis
This file is part of the Avogadro molecular editor project.
For more information, see <http://avogadro.openmolecules.net/>
Avogadro 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.
Avogadro 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, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
**********************************************************************/
#ifndef PLUGIN_H
#define PLUGIN_H
#include <avogadro/global.h>
#include <QObject>
#include <QSettings> // do not remove!!
namespace Avogadro {
/**
* @class Plugin plugin.h <avogadro/plugin.h>
* @brief Interface for plugins
* @author Tim Vandermeersch
*
* This is a template class for plugins like tools, engines,
* extensions, colors, ...
*/
/*class A_EXPORT PluginMeta*/
/*{*/
/*public:*/
/*QString className();*/
/*QString type();*/
/*}*/
//class PluginPrivate;
class A_EXPORT Plugin : public QObject
{
Q_OBJECT
public:
enum Type
{
EngineType = 0,
ToolType,
ExtensionType,
ColorType,
OtherType,
TypeCount // this needs to be last always
};
public:
/**
* Constructor
*/
Plugin(QObject *parent = NULL);
/**
* Destructor
*/
virtual ~Plugin();
/**
* @return The type of the plugin.
*/
virtual Plugin::Type type() const = 0;
/**
* @return The unique, untranslated identifier for the plugin.
*/
virtual QString identifier() const = 0;
/**
* @return The translated name of the plugin.
*/
virtual QString name() const = 0;
/**
* @return A description of the plugin.
*/
virtual QString description() const;
/**
* @return The license applied to the plugin.
* @note This defaults to GPL2+, and must be a license compatible with a
* GPL2 only library, as all plugins link to Avogadro and OpenBabel.
*/
virtual QString license() const;
/**
* @return a QWidget containing the engine settings or 0
* if no settings widget is available.
*/
virtual QWidget *settingsWidget();
/**
* Write the plugin settings so that they can be saved between sessions.
*/
virtual void writeSettings(QSettings &settings) const;
/**
* Read in the settings that have been saved for the plugin instance.
*/
virtual void readSettings(QSettings &settings);
protected:
//PluginPrivate *const d;
};
/**
* @class PluginFactory plugin.h <avogadro/plugin.h>
* @brief Generates new instances of the Plugin class for which it is defined.
*
* Generates new instances of the Plugin class for which it is defined.
*/
class A_EXPORT PluginFactory
{
public:
/**
* Destructor.
*/
virtual ~PluginFactory() {}
/**
* @return pointer to a new instance of an Engine subclass object.
*/
virtual Plugin *createInstance(QObject *parent=0) = 0;
/**
* @return The type of the plugin.
*/
virtual Plugin::Type type() const = 0;
/**
* @return The untranslated identifier of the plugin.
*/
virtual QString identifier() const = 0;
/**
* @return The translated name of the plugin.
*/
virtual QString name() const = 0;
/**
* @return A description of the plugin.
*/
virtual QString description() const = 0;
};
} // end namespace Avogadro
Q_DECLARE_METATYPE(Avogadro::Plugin*)
Q_DECLARE_INTERFACE(Avogadro::PluginFactory,
"net.sourceforge.avogadro.pluginfactory/1.5")
#endif
|