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 #ifndef FILESCRIPTPLUGIN_HH
45 #define FILESCRIPTPLUGIN_HH
46 
47 #include <QObject>
48 
56 
58 {
59  Q_OBJECT
60  Q_INTERFACES(FileInterface)
61  Q_INTERFACES(LoadSaveInterface)
62  Q_INTERFACES(LoggingInterface)
63  Q_INTERFACES(BaseInterface)
64  Q_INTERFACES(ScriptInterface)
65  Q_INTERFACES(RPCInterface)
66 
67  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-FileScript")
68 
69  signals:
70  // log Interface
71  void log(Logtype _type, QString _message);
72  void log(QString _message);
73 
74  // RPC Interface
75  void pluginExists (QString _pluginName, bool& _exists) ;
76  void functionExists (QString _pluginName, QString _functionName, bool& _exists);
77 
78  private slots:
79 
80  void noguiSupported( ) {} ;
81 
82  public :
83 
84  ~FileScriptPlugin() {};
85 
86  QString name() { return (QString("FileScript")); };
87  QString description( ) { return (QString(tr("Load Scripts"))); };
88 
90 
91  QString getSaveFilters();
92  QString getLoadFilters();
93 
94 
95 
96  QWidget* saveOptionsWidget(QString /*_currentFilter*/) { return 0; };
97  QWidget* loadOptionsWidget(QString /*_currentFilter*/) { return 0; };
98 
99  public slots:
100 
101  int loadObject(QString _filename);
102 
104  bool saveObject(int /*_id*/, QString /*_filename*/) { return false;}
105 
106  QString version() { return QString("1.0"); };
107 
108 };
109 
110 #endif //FILESCRIPTPLUGIN_HH
Interface to call functions across plugins.
Definition: RPCInterface.hh:61
Logtype
Log types for Message Window.
Interface for all plugins which want to Load or Save files and create Objects.
Interface for all Plugins which provide scriptable Functions.
QWidget * loadOptionsWidget(QString)
Definition: FileScript.hh:97
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: FileScript.cc:57
Interface for all Plugins which do logging to the logging window of the framework.
QString getSaveFilters()
Definition: FileScript.cc:53
Interface class from which all plugins have to be created.
bool saveObject(int, QString)
No objects are saved by this Plugin so ignore the saveObject call.
Definition: FileScript.hh:104
QString name()
Return a name for the plugin.
Definition: FileScript.hh:86
Predefined datatypes.
Definition: DataTypes.hh:83
Interface class for file handling.
QWidget * saveOptionsWidget(QString)
Definition: FileScript.hh:96
QString getLoadFilters()
Definition: FileScript.cc:49
QString description()
Return a description of what the plugin is doing.
Definition: FileScript.hh:87