Clean and order documentation in source files. Source ready to beta 2 release
[mdictionary] / src / mdictionary / backbone / ConfigGenerator.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 /*!
23     \file ConfigGenerator.h
24     \brief Generating default config files, css stylesheet etc
25
26     \author Bartosz Szatkowski <bulislaw@linux.com>
27 */
28
29 #ifndef CONFIGGENERATOR_H
30 #define CONFIGGENERATOR_H
31
32 #include <QFile>
33 #include <QString>
34 #include <QDebug>
35
36 /*!
37     ConfigGenerator generates configuration files (with default values),
38     if a given file doesn't exist.
39 */
40 class ConfigGenerator {
41
42 public:
43     /*!
44         Generates default css stylesheet for xslt transformations
45         \param file file to be generated
46         \return if file was generated - returns true; if file alredy exists
47         returns true; if file doesn't exist but cannot be generated returns false
48     */
49     bool generateCss(QString file);
50
51     /*! Generates default configuration files
52         \param file file to be generated
53         \return if file was generated - returns true; if file already exists
54         returns true; if file doesn't exist but cannot be generated returns false
55     */
56     bool generateDefaultConfig(QString file);
57
58 private:
59     bool generateFile(QString source, QString file);
60 };
61
62 #endif // CONFIGGENERATOR_H