Developer Documentation
FileScript.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef FILESCRIPTPLUGIN_HH
51 #define FILESCRIPTPLUGIN_HH
52 
53 #include <QObject>
54 
62 
64 {
65  Q_OBJECT
66  Q_INTERFACES(FileInterface)
67  Q_INTERFACES(LoadSaveInterface)
68  Q_INTERFACES(LoggingInterface)
69  Q_INTERFACES(BaseInterface)
70  Q_INTERFACES(ScriptInterface)
71  Q_INTERFACES(RPCInterface)
72 
73 #if QT_VERSION >= 0x050000
74  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-FileScript")
75 #endif
76 
77  signals:
78  // log Interface
79  void log(Logtype _type, QString _message);
80  void log(QString _message);
81 
82  // RPC Interface
83  void pluginExists (QString _pluginName, bool& _exists) ;
84  void functionExists (QString _pluginName, QString _functionName, bool& _exists);
85 
86  private slots:
87 
88  void noguiSupported( ) {} ;
89 
90  public :
91 
92  ~FileScriptPlugin() {};
93 
94  QString name() { return (QString("FileScript")); };
95  QString description( ) { return (QString(tr("Load Scripts"))); };
96 
98 
99  QString getSaveFilters();
100  QString getLoadFilters();
101 
102 
103 
104  QWidget* saveOptionsWidget(QString /*_currentFilter*/) { return 0; };
105  QWidget* loadOptionsWidget(QString /*_currentFilter*/) { return 0; };
106 
107  public slots:
108 
109  int loadObject(QString _filename);
110 
112  bool saveObject(int /*_id*/, QString /*_filename*/) { return false;}
113 
114  QString version() { return QString("1.0"); };
115 
116 };
117 
118 #endif //FILESCRIPTPLUGIN_HH
bool saveObject(int, QString)
No objects are saved by this Plugin so ignore the saveObject call.
Definition: FileScript.hh:112
Predefined datatypes.
Definition: DataTypes.hh:96
Logtype
Log types for Message Window.
QString getSaveFilters()
Definition: FileScript.cc:63
QString description()
Return a description of what the plugin is doing.
Definition: FileScript.hh:95
Interface for all Plugins which provide scriptable Functions.
Interface class from which all plugins have to be created.
QString getLoadFilters()
Definition: FileScript.cc:59
Interface for all Plugins which do logging to the logging window of the framework.
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: FileScript.cc:67
Interface class for file handling.
QString name()
Return a name for the plugin.
Definition: FileScript.hh:94
Interface for all plugins which want to Load or Save files and create Objects.
QWidget * saveOptionsWidget(QString)
Definition: FileScript.hh:104
Interface to call functions across plugins.
Definition: RPCInterface.hh:71
QWidget * loadOptionsWidget(QString)
Definition: FileScript.hh:105