Developer Documentation

INIInterface.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 #pragma once
43
44 #include <OpenFlipper/INIFile/INIFile.hh>
45
60 class INIInterface {
61 public :
62
64 virtual ~INIInterface() {};
65
66 private slots:
67
68 //=======================================
71 //=======================================
82 virtual void loadIniFile( INIFile& _ini ,int _id ) {};
83
93 virtual void saveIniFile( INIFile& _ini ,int _id) {};
94
98 //=======================================
101 //=======================================
102
103 private slots:
104
115 virtual void loadIniFileOptions( INIFile& _ini ) {};
116
126 virtual void loadIniFileOptionsLast( INIFile& _ini ) {};
127
136 virtual void saveIniFileOptions( INIFile& _ini ) {};
137
145 virtual void saveOnExit( INIFile& _ini ) {};
146
147
151 };
152
153 Q_DECLARE_INTERFACE(INIInterface,"OpenFlipper.INIInterface/1.2")
154
INIInterface
Interface class for Plugins which have to store information in ini files.
Definition: INIInterface.hh:60
INIInterface::loadIniFileOptions
virtual void loadIniFileOptions(INIFile &_ini)
Load per Plugin settings.
Definition: INIInterface.hh:115
INIInterface::loadIniFileOptionsLast
virtual void loadIniFileOptionsLast(INIFile &_ini)
Load per Plugin settings after objects are loaded.
Definition: INIInterface.hh:126
INIInterface::~INIInterface
virtual ~INIInterface()
Destructor.
Definition: INIInterface.hh:64
INIInterface::loadIniFile
virtual void loadIniFile(INIFile &_ini, int _id)
Load per object settings.
Definition: INIInterface.hh:82
INIInterface::saveIniFileOptions
virtual void saveIniFileOptions(INIFile &_ini)
Save Plugin Options When the core is about to save an ini file this slot will be called once per Plug...
Definition: INIInterface.hh:136
INIInterface::saveOnExit
virtual void saveOnExit(INIFile &_ini)
Save per Plugin settings when application is about to quit.
Definition: INIInterface.hh:145
INIInterface::saveIniFile
virtual void saveIniFile(INIFile &_ini, int _id)
Save per object settings.
Definition: INIInterface.hh:93
INIFile
Class for the handling of simple configuration files.
Definition: INIFile.hh:99