Clean and order documentation in source files. Source ready to beta 2 release
[mdictionary] / src / plugins / xdxf / XdxfCachingDialog.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 XdxfCachingDialog.h
23     \brief Shows dialog with progress of dictionary caching
24
25     \author Mateusz Półrola <mateusz.polrola@gmail.com>
26 */
27
28
29 #ifndef XDXFCACHINGDIALOG_H
30 #define XDXFCACHINGDIALOG_H
31
32 #include <QDialog>
33 #include <QtGui>
34
35
36 class XdxfPlugin;
37
38 /*!
39     Displays progress bar and estimated time left of caching
40 */
41 class XdxfCachingDialog : public QDialog
42 {
43     Q_OBJECT
44 public:
45     explicit XdxfCachingDialog(QWidget *parent = 0);
46
47 public Q_SLOTS:
48     //! Overload function from QDialog, this function does nothing
49     void reject() { return;}
50
51     //! update progresBar and print text with time to end caching
52     void updateCachingProgress(int, int);
53
54 Q_SIGNALS:
55     //! signal emitted when user cancels caching of a dictionary
56     void cancelCaching();
57
58
59 private:
60     QLabel* cachingLabel;
61     QLabel* cachingTimeLabel;
62     QProgressBar* cachingProgressBar;
63     QPushButton* cancelButton;
64     QVBoxLayout* verticalLayout;
65     //! used to check the progress of dictionary caching
66     QTime time;
67 };
68
69 #endif // XDXFCACHINGDIALOG_H