/usr/include/gofigure2/QGoPlugin.h is in libgofigure-dev 0.9.0-3+b1.
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 | /*=========================================================================
Authors: The GoFigure Dev. Team.
at Megason Lab, Systems biology, Harvard Medical school, 2009-11
Copyright (c) 2009-11, President and Fellows of Harvard College.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
Neither the name of the President and Fellows of Harvard College
nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/
#ifndef __QGoPlugin_h
#define __QGoPlugin_h
#include <vector>
#include <list>
#include <QString>
#include <QAction>
#include <QMenu>
#include <QToolBar>
#include <QDockWidget>
#include <QWidget>
#include "PluginInformationBase.h"
#include "GoFigureGlobalDefinition.h"
/**
\class QGoPlugin
\brief Abstract class for any kind of plugins used by GoFigure2.
*/
class QGoPlugin:public QObject
{
Q_OBJECT
public:
/** \brief Default Constructor.*/
explicit QGoPlugin(QObject *iParent = 0x0);
/** \brief Destructor.*/
virtual ~QGoPlugin(){}
/** \brief return Plugin Name of the plugin.*/
QString Name() const;
/** \brief return Plugin Version of the plugin.*/
QString Version() const;
/** \brief return GoFigure version for compatibility with the plugin.*/
QString GoFigureCompatibilityVersion() const;
/** \brief return Distributor of the plugin.*/
QString Distributor() const;
/** \brief return Copyright of the plugin.*/
QString Copyright() const;
/** \brief return License of the plugin.*/
QString License() const;
/** \brief return Short description of the plugin.*/
QString Description() const;
/** \brief Write Settings for the plugin.*/
virtual void WriteSettings() = 0;
/** \brief Read Settings for the plugin.*/
virtual void ReadSettings() = 0;
virtual std::list< GoFigure::TabDimensionType > TabElementCompatibility() const = 0;
/** \brief */
virtual std::vector< QAction * > Actions() = 0;
/** \brief */
virtual QMenu * Menu() = 0;
/** \brief */
virtual QToolBar * ToolBar() = 0;
/** \brief */
virtual QDockWidget * DockWidget() = 0;
/** \brief */
virtual QWidget * AdditionalWidget() = 0;
/** \brief */
virtual void OnTabActivated(const int &) = 0;
/** \brief */
virtual void OnTabMoved(const int &, const int &) = 0;
/** \brief */
virtual void OnTabClosed(const int &) = 0;
protected:
/** \brief contains all information related to the plugin.
\todo it would not be a bad idea to use a xml file instead.
*/
PluginInformationBase m_Information;
/** \brief Set all required information (name, version, license...).
\note This method MUST be called in the constructor of any plugin which
inherits from QGoPlugin.
*/
virtual void SetAllRequiredInformation() = 0;
private:
Q_DISABLE_COPY(QGoPlugin);
};
Q_DECLARE_INTERFACE(QGoPlugin, "GoFigure2.QGoPlugin/1.0")
#endif
|