aboutsummaryrefslogtreecommitdiffstats
path: root/src/winextras/qwintaskbarbutton.h
blob: 08c3085c7c81a788550ce69f377330251e5549c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/****************************************************************************
 **
 ** Copyright (C) 2013 Ivan Vizir <define-true-false@yandex.com>
 ** Contact: http://www.qt-project.org/legal
 **
 ** This file is part of the QtWinExtras module of the Qt Toolkit.
 **
 ** $QT_BEGIN_LICENSE:LGPL$
 ** Commercial License Usage
 ** Licensees holding valid commercial Qt licenses may use this file in
 ** accordance with the commercial license agreement provided with the
 ** Software or, alternatively, in accordance with the terms contained in
 ** a written agreement between you and Digia.  For licensing terms and
 ** conditions see http://qt.digia.com/licensing.  For further information
 ** use the contact form at http://qt.digia.com/contact-us.
 **
 ** GNU Lesser General Public License Usage
 ** Alternatively, this file may be used under the terms of the GNU Lesser
 ** General Public License version 2.1 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.LGPL included in the
 ** packaging of this file.  Please review the following information to
 ** ensure the GNU Lesser General Public License version 2.1 requirements
 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 **
 ** In addition, as a special exception, Digia gives you certain additional
 ** rights.  These rights are described in the Digia Qt LGPL Exception
 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 **
 ** GNU General Public License Usage
 ** Alternatively, this file may be used under the terms of the GNU
 ** General Public License version 3.0 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.GPL included in the
 ** packaging of this file.  Please review the following information to
 ** ensure the GNU General Public License version 3.0 requirements will be
 ** met: http://www.gnu.org/copyleft/gpl.html.
 **
 **
 ** $QT_END_LICENSE$
 **
 ****************************************************************************/

#ifndef QWINTASKBARBUTTON_H
#define QWINTASKBARBUTTON_H

#include <QtCore/qobject.h>
#include <QtWinExtras/qwinextrasglobal.h>

QT_BEGIN_NAMESPACE

class QWindow;
class QWinTaskbarButtonPrivate;

class Q_WINEXTRAS_EXPORT QWinTaskbarButton : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QIcon overlayIcon READ overlayIcon WRITE setOverlayIcon)
    Q_PROPERTY(QString overlayIconAccessibilityDescription READ overlayIconAccessibilityDescription WRITE setOverlayIconAccessibilityDescription)
    Q_PROPERTY(int progressValue READ progressValue WRITE setProgressValue)
    Q_PROPERTY(int progressMaximum READ progressMaximum WRITE setProgressMaximum)
    Q_PROPERTY(int progressMinimum READ progressMinimum WRITE setProgressMinimum)
    Q_PROPERTY(ProgressState progressState READ progressState WRITE setProgressState)
    Q_PROPERTY(QWindow *window READ window WRITE setWindow)

public:
    enum ProgressState {
        NoProgressState,
        IndeterminateState,
        NormalState,
        PausedState,
        ErrorState
    };

    Q_ENUMS(ProgressState)

    explicit QWinTaskbarButton(QObject *parent = 0);
    ~QWinTaskbarButton();

    void setWindow(QWindow *window);
    QWindow *window() const;

    QIcon overlayIcon() const;
    QString overlayIconAccessibilityDescription() const;

    ProgressState progressState() const;
    int progressValue() const;
    int progressMinimum() const;
    int progressMaximum() const;

    bool eventFilter(QObject *, QEvent *);

public Q_SLOTS:
    void setOverlayIcon(const QIcon &icon);
    void setOverlayIconAccessibilityDescription(const QString &description);

    void clearOverlayIcon();

    void setProgressState(ProgressState state);
    void setProgressValue(int progress);
    void setProgressMinimum(int min);
    void setProgressMaximum(int max);
    void setProgressRange(int mininum, int progressMaximum);
    void resetProgress();

Q_SIGNALS:
    void progressStateChanged(const ProgressState state);
    void progressValueChanged(int value);

private:
    QScopedPointer<QWinTaskbarButtonPrivate> d_ptr;

    friend class QQuickWinTaskbarButton;

    Q_DECLARE_PRIVATE(QWinTaskbarButton)
};

QT_END_NAMESPACE

#endif // QWINTASKBARBUTTON_H