Developer Documentation

iniPlugin.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 INIPLUGIN_HH
45 #define INIPLUGIN_HH
46
47 #include <QObject>
48 #include <QMenuBar>
49
50 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
51 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
52 #include <OpenFlipper/BasePlugin/ScriptInterface.hh>
53 #include <OpenFlipper/BasePlugin/INIInterface.hh>
54
55 class INIPlugin : public QObject, BaseInterface, LoggingInterface, ScriptInterface, INIInterface
56 {
57 Q_OBJECT
58 Q_INTERFACES(LoggingInterface)
59 Q_INTERFACES(BaseInterface)
60 Q_INTERFACES(ScriptInterface)
61 Q_INTERFACES(INIInterface)
62
63 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-INI")
64
65 signals:
66 void log(Logtype _type, QString _message);
67 void log(QString _message);
68
69 private slots:
70 void loadIniFile( INIFile& _ini ,int _id);
71 void saveIniFile( INIFile& _ini ,int _id);
72
73 void noguiSupported( ) {} ;
74
75 public :
76
77 INIPlugin();
78 ~INIPlugin() {};
79
80 public slots:
81
82 QString name() { return (QString("INIPlugin")); };
83 QString description( ) { return (QString(tr("Handle INI-files."))); };
84
85 QString version() { return QString("1.0"); };
86
87 private:
88 // Template function to parse ini file entries
89 template <class Object>
90 void parseIniFileT(INIFile& _ini, Object* _object);
91
92 // Template function to save ini file entries
93 template <class Object>
94 void saveIniFileT(INIFile& _ini, Object* _object);
95
96
97 // Parse data from baseObjectData derived objects
98 void parseIniFile(INIFile& _ini, BaseObjectData* _object);
99
100 // Save data from baseObjectData derived objects
101 void saveIniFile(INIFile& _ini, BaseObjectData* _object);
102 };
103
104 //=============================================================================
105 #if defined(INCLUDE_TEMPLATES) && !defined(INIPLUGINT_C)
106 #define INIPLUGINT_TEMPLATES
107 #include "iniPluginT_impl.hh"
108 #endif
109 //=============================================================================
110
111 #endif //INIPLUGIN_HH
ScriptInterface.hh
INIPlugin
Definition: iniPlugin.hh:55
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
INIPlugin::version
QString version()
Return a version string for your plugin.
Definition: iniPlugin.hh:85
LoggingInterface
Interface for all Plugins which do logging to the logging window of the framework.
Definition: LoggingInterface.hh:112
LoggingInterface.hh
BaseObjectData
Definition: BaseObjectData.hh:102
INIInterface
Interface class for Plugins which have to store information in ini files.
Definition: INIInterface.hh:60
INIPlugin::INIPlugin
INIPlugin()
Constructor.
Definition: iniPlugin.cc:52
INIFile
Class for the handling of simple configuration files.
Definition: INIFile.hh:99
ScriptInterface
Interface for all Plugins which provide scriptable Functions.
Definition: ScriptInterface.hh:58
INIPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: iniPlugin.hh:83
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
BaseInterface.hh