GOFIGURE2  0.9.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
QGoPlugin.h
Go to the documentation of this file.
1 /*=========================================================================
2  Authors: The GoFigure Dev. Team.
3  at Megason Lab, Systems biology, Harvard Medical school, 2009-11
4 
5  Copyright (c) 2009-11, President and Fellows of Harvard College.
6  All rights reserved.
7 
8  Redistribution and use in source and binary forms, with or without
9  modification, are permitted provided that the following conditions are met:
10 
11  Redistributions of source code must retain the above copyright notice,
12  this list of conditions and the following disclaimer.
13  Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16  Neither the name of the President and Fellows of Harvard College
17  nor the names of its contributors may be used to endorse or promote
18  products derived from this software without specific prior written
19  permission.
20 
21  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
25  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
26  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
28  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
30  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 
33 =========================================================================*/
34 #ifndef __QGoPlugin_h
35 #define __QGoPlugin_h
36 
37 #include <vector>
38 #include <list>
39 
40 #include <QString>
41 #include <QAction>
42 #include <QMenu>
43 #include <QToolBar>
44 #include <QDockWidget>
45 #include <QWidget>
46 
47 #include "PluginInformationBase.h"
49 
54 class QGoPlugin:public QObject
55 {
56  Q_OBJECT
57 public:
59  explicit QGoPlugin(QObject *iParent = 0x0);
60 
62  virtual ~QGoPlugin(){}
63 
65  QString Name() const;
66 
68  QString Version() const;
69 
72 
74  QString Distributor() const;
75 
77  QString Copyright() const;
78 
80  QString License() const;
81 
83  QString Description() const;
84 
86  virtual void WriteSettings() = 0;
87 
89  virtual void ReadSettings() = 0;
90 
91  virtual std::list< GoFigure::TabDimensionType > TabElementCompatibility() const = 0;
92 
94  virtual std::vector< QAction * > Actions() = 0;
95 
97  virtual QMenu * Menu() = 0;
98 
100  virtual QToolBar * ToolBar() = 0;
101 
103  virtual QDockWidget * DockWidget() = 0;
104 
106  virtual QWidget * AdditionalWidget() = 0;
107 
109  virtual void OnTabActivated(const int &) = 0;
110 
112  virtual void OnTabMoved(const int &, const int &) = 0;
113 
115  virtual void OnTabClosed(const int &) = 0;
116 
117 protected:
122 
127  virtual void SetAllRequiredInformation() = 0;
128 
129 private:
131 };
132 
133 Q_DECLARE_INTERFACE(QGoPlugin, "GoFigure2.QGoPlugin/1.0")
134 
135 #endif
QGoPlugin(QObject *iParent=0x0)
Default Constructor.
Definition: QGoPlugin.cxx:36
virtual QMenu * Menu()=0
virtual QWidget * AdditionalWidget()=0
virtual void OnTabMoved(const int &, const int &)=0
Q_DISABLE_COPY(QGoPlugin)
virtual std::vector< QAction * > Actions()=0
PluginInformationBase m_Information
contains all information related to the plugin.
Definition: QGoPlugin.h:121
Abstract class for any kind of plugins used by GoFigure2.
Definition: QGoPlugin.h:54
QString Version() const
return Plugin Version of the plugin.
Definition: QGoPlugin.cxx:44
virtual void ReadSettings()=0
Read Settings for the plugin.
QString Distributor() const
return Distributor of the plugin.
Definition: QGoPlugin.cxx:54
virtual void WriteSettings()=0
Write Settings for the plugin.
QString License() const
return License of the plugin.
Definition: QGoPlugin.cxx:64
virtual QDockWidget * DockWidget()=0
QString GoFigureCompatibilityVersion() const
return GoFigure version for compatibility with the plugin.
Definition: QGoPlugin.cxx:49
virtual ~QGoPlugin()
Destructor.
Definition: QGoPlugin.h:62
QString Copyright() const
return Copyright of the plugin.
Definition: QGoPlugin.cxx:59
virtual QToolBar * ToolBar()=0
QString Name() const
return Plugin Name of the plugin.
Definition: QGoPlugin.cxx:39
virtual void OnTabClosed(const int &)=0
QString Description() const
return Short description of the plugin.
Definition: QGoPlugin.cxx:69
virtual std::list< GoFigure::TabDimensionType > TabElementCompatibility() const =0
virtual void SetAllRequiredInformation()=0
Set all required information (name, version, license...).
virtual void OnTabActivated(const int &)=0