Clean and order documentation in source files. Source ready to beta 2 release
[mdictionary] / src / plugins / xdxf / XdxfDictDownloadProgressDialog.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 XdxfDictDownloadProgressDialog.h
23     \brief Shows downloading progress bar.
24
25     \author Mateusz Półrola <mateusz.polrola@comarch.com>
26 */
27
28 #ifndef XDXFDICTDOWNLOADPROGRESSDIALOG_H
29 #define XDXFDICTDOWNLOADPROGRESSDIALOG_H
30
31 #include <QDialog>
32 #include <QtGui>
33
34 /*!
35     Shows downloading progress bar. Currently it displays "busy bar".
36     User can cancel current download by pressing cancel button
37 */
38 class XdxfDictDownloadProgressDialog : public QDialog {
39     Q_OBJECT
40 public:
41     XdxfDictDownloadProgressDialog(QWidget *parent = 0);
42
43 public Q_SLOTS:
44     //! Reimplemented to block rejecting on maemo. User must cancel.
45     void reject();
46
47     //! Set text which will be displayed to user as info about current download
48     void setText(QString);
49
50     /*!
51         set parameters of prograsBar(wher "prograss"*100 is value,
52         and maxValue=100
53     */
54     void updateProgress(float progress);
55
56     void show();
57
58 Q_SIGNALS:
59     //! signal emitted when user cancels downloading of a dictionary
60     void cancelDownloading();
61
62 private:
63     QLabel* downloadLabel;
64     QProgressBar* downloadProgressBar;
65     QPushButton* cancelButton;
66     QVBoxLayout* verticalLayout;
67 };
68
69 #endif // XDXFDICTDOWNLOADPROGRESSDIALOG_H