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