1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtWidgets module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QPROGRESSBAR_H
41 #define QPROGRESSBAR_H
42 
43 #include <QtWidgets/qtwidgetsglobal.h>
44 #include <QtWidgets/qframe.h>
45 
46 QT_REQUIRE_CONFIG(progressbar);
47 
48 QT_BEGIN_NAMESPACE
49 
50 class QProgressBarPrivate;
51 class QStyleOptionProgressBar;
52 
53 class Q_WIDGETS_EXPORT QProgressBar : public QWidget
54 {
55     Q_OBJECT
56     Q_PROPERTY(int minimum READ minimum WRITE setMinimum)
57     Q_PROPERTY(int maximum READ maximum WRITE setMaximum)
58     Q_PROPERTY(QString text READ text)
59     Q_PROPERTY(int value READ value WRITE setValue NOTIFY valueChanged)
60     Q_PROPERTY(Qt::Alignment alignment READ alignment WRITE setAlignment)
61     Q_PROPERTY(bool textVisible READ isTextVisible WRITE setTextVisible)
62     Q_PROPERTY(Qt::Orientation orientation READ orientation WRITE setOrientation)
63     Q_PROPERTY(bool invertedAppearance READ invertedAppearance WRITE setInvertedAppearance)
64     Q_PROPERTY(Direction textDirection READ textDirection WRITE setTextDirection)
65     Q_PROPERTY(QString format READ format WRITE setFormat RESET resetFormat)
66 
67 public:
68     enum Direction { TopToBottom, BottomToTop };
69     Q_ENUM(Direction)
70 
71     explicit QProgressBar(QWidget *parent = nullptr);
72     ~QProgressBar();
73 
74     int minimum() const;
75     int maximum() const;
76 
77     int value() const;
78 
79     virtual QString text() const;
80     void setTextVisible(bool visible);
81     bool isTextVisible() const;
82 
83     Qt::Alignment alignment() const;
84     void setAlignment(Qt::Alignment alignment);
85 
86     QSize sizeHint() const override;
87     QSize minimumSizeHint() const override;
88 
89     Qt::Orientation orientation() const;
90 
91     void setInvertedAppearance(bool invert);
92     bool invertedAppearance() const;
93     void setTextDirection(QProgressBar::Direction textDirection);
94     QProgressBar::Direction textDirection() const;
95 
96     void setFormat(const QString &format);
97     void resetFormat();
98     QString format() const;
99 
100 public Q_SLOTS:
101     void reset();
102     void setRange(int minimum, int maximum);
103     void setMinimum(int minimum);
104     void setMaximum(int maximum);
105     void setValue(int value);
106     void setOrientation(Qt::Orientation);
107 
108 Q_SIGNALS:
109     void valueChanged(int value);
110 
111 protected:
112     bool event(QEvent *e) override;
113     void paintEvent(QPaintEvent *) override;
114     void initStyleOption(QStyleOptionProgressBar *option) const;
115 
116 private:
117     Q_DECLARE_PRIVATE(QProgressBar)
118     Q_DISABLE_COPY(QProgressBar)
119 };
120 
121 QT_END_NAMESPACE
122 
123 #endif // QPROGRESSBAR_H
124