Added generated documentation
[mdictionary] / trunk / src / includes / settings.h
1 /*******************************************************************************
2
3     This file is part of mDictionary.
4
5     mDictionary is free software: you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation, either version 3 of the License, or
8     (at your option) any later version.
9
10     mDictionary is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with mDictionary.  If not, see <http://www.gnu.org/licenses/>.
17
18     Copyright 2010 Comarch S.A.
19
20 *******************************************************************************/
21
22 //Created by Bartosz Szatkowski
23
24 #ifndef SETTINGS_H
25 #define SETTINGS_H
26
27 #include <QString>
28 #include "CommonDictInterface.h"
29
30 //! Plugin specific configuration 
31 class Settings {
32   public:
33     //! \retrun value fo given key
34     //! \param key
35     virtual QString value(const QString key) const = 0;
36
37     //! sets key to value
38     virtual void setValue(const QString key, const QString value) = 0;
39
40     //! \return dict CommonDictInterface
41     virtual CommonDictInterface* type() const = 0;
42
43     //! sets settings type to given dictionary
44     virtual void setType(const CommonDictInterface*) = 0;
45 };
46
47 #endif