Added comments to interfaces
[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 //! Plugin specific configuration 
25 class Settings {
26   public:
27     //! \retrun value fo given key
28     //! \param key
29     QString value(const QString key) const = 0;
30
31     //! sets key to value
32     void setValue(const QString key, const Qstring value) = 0;
33
34     //! \return dict CommonDictInterface
35     CommonDictInterface type() const = 0;
36
37     //! sets settings type to given dictionary
38     void setType(const CommonDictInterface) = 0;
39 }