/usr/include/avogadro/tool.h is in libavogadro-dev 1.0.3-10.1+b2.
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 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | /**********************************************************************
Tool - Avogadro Tool Interface
Copyright (C) 2007 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 TOOL_H
#define TOOL_H
#include <avogadro/global.h>
#include "plugin.h"
#include <QSettings>
#include <QtPlugin>
#include <QWheelEvent>
#define AVOGADRO_TOOL(i, t, d, s) \
public: \
static QString staticIdentifier() { return i; } \
QString identifier() const { return i; } \
static QString staticName() { return t; } \
QString name() const { return t; } \
static QString staticDescription() { return d; } \
QString description() const { return d; } \
QString settingsTitle() const { return s; }
#define AVOGADRO_TOOL_FACTORY(c) \
public: \
Avogadro::Plugin *createInstance(QObject *parent = 0) { return new c(parent); } \
Avogadro::Plugin::Type type() const { return Avogadro::Plugin::ToolType; } \
QString identifier() const { return c::staticIdentifier(); } \
QString name() const { return c::staticName(); } \
QString description() const { return c::staticDescription(); }
class QAction;
class QUndoCommand;
class QWidget;
namespace Avogadro {
class GLWidget;
class Molecule;
/**
* @class Tool tool.h <avogadro/tool.h>
* @brief Interface for tool plugins
* @author Donald Ephraim Curtis
*
* This is a template class for tools which manipulate the GLWidget
* area. The functions they implement are in response to actions
* performed by the user on the GLWidget.
*/
class ToolPrivate;
class A_EXPORT Tool : public Plugin
{
Q_OBJECT
public:
/**
* Constructor
*/
Tool(QObject *parent = 0);
/**
* Destructor
*/
virtual ~Tool();
/**
* Plugin Type.
*/
Plugin::Type type() const;
/**
* Plugin Type Name (Tools).
*/
QString typeName() const;
/**
* @return The QAction of the tool.
*/
virtual QAction* activateAction() const;
/**
* @return The settings widget for the tool.
*/
virtual QWidget* settingsWidget();
/**
* @return The translated name of the settings widget
*/
virtual QString settingsTitle() const = 0;
/**
* Response to mouse press
* @param widget the %GLWidget where the even occurred
* @param event the mouse event information
*/
virtual QUndoCommand* mousePressEvent(GLWidget *widget, QMouseEvent *event) = 0;
/**
* Response to mouse release
* @param widget the %GLWidget where the even occurred
* @param event the mouse event information
*/
virtual QUndoCommand* mouseReleaseEvent(GLWidget *widget, QMouseEvent *event) = 0;
/**
* Response to mouse movement
* @param widget the %GLWidget where the event occurred
* @param event the mouse event information
*/
virtual QUndoCommand* mouseMoveEvent(GLWidget *widget, QMouseEvent *event) = 0;
/**
* Response to mouse wheel movement
* @param widget the %GLWidget where the event occurred
* @param event the mouse wheel event information
*/
virtual QUndoCommand* wheelEvent(GLWidget *widget, QWheelEvent *event);
/**
* Response to key press events.
* @param widget the %GLWidget where the event occurred
* @param event the key event information
*/
virtual QUndoCommand* keyPressEvent(GLWidget *widget, QKeyEvent *event);
/**
* Response to key release events.
* @param widget the %GLWidget where the event occurred
* @param event the key event information
*/
virtual QUndoCommand* keyReleaseEvent(GLWidget *widget, QKeyEvent *event);
/**
* Called by the GLWidget allowing overlay painting by the
* tool. Tools get painted last in the overall scheme.
* @param widget the %GLWidget to paint to
*/
virtual bool paint(GLWidget *widget);
/**
* Determines the ordering of the tools. More useful
* tools are placed first. It is up to the tool designer
* to be humble about their usefulness value.
* @return usefulness value
*/
virtual int usefulness() const;
bool operator<(const Tool &other) const;
/**
* Write the tool 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 tool instance.
*/
virtual void readSettings(QSettings &settings);
Q_SIGNALS:
/**
* Can be used to add messages to the message pane.
* @param m the message to add to the message pane.
*/
void message(const QString &m);
public Q_SLOTS:
/**
* Called by the parent (normally toolGroup) to tell the tool the underlying
* model (molecule) has changed
*/
virtual void setMolecule(Molecule *molecule);
protected:
QAction *m_activateAction;
ToolPrivate *const d;
};
} // end namespace Avogadro
#endif
|