aboutsummaryrefslogtreecommitdiffstats
path: root/src/winextras/qjumplist.h
blob: aadada1c8ec4cfd07045de930456547eddc331ea (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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/****************************************************************************
 **
 ** Copyright (C) 2013 Ivan Vizir <define-true-false@yandex.com>
 ** Contact: http://www.qt-project.org/legal
 **
 ** This file is part of QtWinExtras in 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 QJUMPLIST2_H
#define QJUMPLIST2_H

#include <QtWinExtras/qwinextrasglobal.h>
#include <QObject>
#include <QStringList>

QT_BEGIN_NAMESPACE

class QJumpListItemPrivate;

class Q_WINEXTRAS_EXPORT QJumpListItem
{
public:
    enum Type {
        Unknown,
        Destination,
        Link,
        Separator
    };

    explicit QJumpListItem(Type type = Unknown);
    ~QJumpListItem();

    void setType(Type type);
    Type type() const;
    void setFilePath(const QString &filePath);
    QString filePath() const;
    void setWorkingDirectory(const QString &workingDirectory);
    QString workingDirectory() const;
    void setIcon(const QIcon &icon);
    QIcon icon() const;
    void setTitle(const QString &title);
    QString title() const;
    void setDescription(const QString &description);
    QString description() const;
    void setArguments(const QStringList &arguments);
    QStringList arguments() const;

private:
    QScopedPointer<QJumpListItemPrivate> d_ptr;

    Q_DECLARE_PRIVATE(QJumpListItem)
};

class QJumpListPrivate;

class Q_WINEXTRAS_EXPORT QJumpList : public QObject
{
    Q_OBJECT
    Q_PROPERTY(int recentCategoryShown READ isRecentCategoryShown WRITE setRecentCategoryShown)
    Q_PROPERTY(int frequentCategoryShown READ isFrequentCategoryShown WRITE setFrequentCategoryShown)

public:
    explicit QJumpList(QObject *parent = 0);
    ~QJumpList();

public Q_SLOTS:
    bool begin();
    bool commit();
    bool abort();
    bool clear();

public:
    bool setApplicationId(const QString &);
    QList<QJumpListItem *> removedDestinations() const;
    int capacity() const;

    void setRecentCategoryShown(bool);
    bool isRecentCategoryShown() const;
    void setFrequentCategoryShown(bool);
    bool isFrequentCategoryShown() const;

    void beginCategory(const QString &title);
    void beginTasks();

    bool addItem(QJumpListItem *item);
    void addDestination(const QString &filePath);
    void addLink(const QString &title, const QString &executablePath, const QStringList &arguments = QStringList());
    void addLink(const QString &title, const QString &description, const QString &executablePath, const QStringList &arguments = QStringList());
    void addLink(const QIcon &icon, const QString &title, const QString &executablePath, const QStringList &arguments = QStringList());
    void addLink(const QIcon &icon, const QString &title, const QString &description, const QString &executablePath, const QStringList &arguments = QStringList());
    void addLink(const QIcon &icon, const QString &title, const QString &description, const QString &workingDirectory, const QString &executablePath, const QStringList &arguments);
    void addSeparator();

private:
    QScopedPointer<QJumpListPrivate> d_ptr;

    Q_DECLARE_PRIVATE(QJumpList)
};

QT_END_NAMESPACE

#endif // QJUMPLIST2_H