Clean and order documentation in source files. Source ready to beta 2 release
[mdictionary] / src / include / DictDialog.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 /*! \file DictDialog.h
23     \brief Interface for plugin dialog provider
24
25     \author Mateusz Półrola <mateusz.polrola@comarch.com>
26 */
27
28
29 //Created by Mateusz Półrola
30
31 #ifndef DICTDIALOG_H
32 #define DICTDIALOG_H
33
34 #include <QObject>
35 #include "Notify.h"
36
37 class Settings;
38
39 //! Interface for plugin dialog provider
40 class DictDialog : public QObject {
41     Q_OBJECT
42
43 public:
44     DictDialog(QObject *parent = 0) : QObject(parent) {}
45
46     /*!
47       Shows "add a new dictionary" dialog and returns settings of a new dict
48       \param parent parent widget on which the dialog will be displayed
49       */
50     virtual Settings* addNewDictionary(QWidget*parent=0)=0;
51
52     /*!
53       Shows "settings" dialog and saves new settings in plugin
54       \param parent parent widget on which the dialog will be displayed
55       */
56     virtual void changeSettings(QWidget *parent = 0) = 0;
57
58 Q_SIGNALS:
59     void notify(Notify::NotifyType, QString);
60 };
61
62 #endif // DICTDIALOG_H