aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/winextras/qquickjumplist.cpp
blob: b49be6d0dd266daf787707dcb8df374f91d9aaf6 (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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/****************************************************************************
 **
 ** Copyright (C) 2013 Ivan Vizir <define-true-false@yandex.com>
 ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
 ** 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$
 **
 ****************************************************************************/

#include "qquickjumplist_p.h"
#include <QIcon>

QT_BEGIN_NAMESPACE

/*!
    \qmltype JumpList
    \instantiates QQuickJumpList
    \inqmlmodule QtWinExtras

    \brief Enables you to modify the application Jump List.

    \since QtWinExtras 1.0

    The JumpList type enables you to modify Windows Jump Lists.

    An application can use Jump Lists to provide users with faster access to
    files or to display shortcuts to tasks or commands.
 */

/*!
    \class QQuickJumpList
    \internal
 */

QQuickJumpList::QQuickJumpList(QQuickItem *parent) :
    QQuickItem(parent), frequentCategoryShown(false), recentCategoryShown(false)
{
}

/*!
    \qmlproperty object JumpList::tasks

    Application tasks.
 */
QQmlListProperty<QQuickJumpListItem> QQuickJumpList::tasks()
{
    return QQmlListProperty<QQuickJumpListItem>(this, this, &QQuickJumpList::appendTaskItem, 0, 0, 0);
}

/*!
    \qmlproperty object JumpList::destinations

    Categories of custom destinations.
 */
QQmlListProperty<QQuickJumpListCategory> QQuickJumpList::destinations()
{
    return QQmlListProperty<QQuickJumpListCategory>(this, this, &QQuickJumpList::appendGroup, 0, 0, 0);
}

/*!
    \qmlproperty bool JumpList::showFrequentCategory

    Contains true if the \e Frequent category is shown; otherwise false.
 */
bool QQuickJumpList::showFrequentCategory() const
{
    return frequentCategoryShown;
}

void QQuickJumpList::setShowFrequentCategory(bool show)
{
    frequentCategoryShown = show;
}

/*!
    \qmlproperty bool JumpList::showRecentCategory

    Contains true if the \e Recent category is shown; otherwise false.
 */
bool QQuickJumpList::showRecentCategory() const
{
    return recentCategoryShown;
}

void QQuickJumpList::setShowRecentCategory(bool show)
{
    recentCategoryShown = show;
}

void QQuickJumpList::componentComplete()
{
    QQuickItem::componentComplete();
    QWinJumpList jumplist;
    jumplist.frequent()->setVisible(frequentCategoryShown);
    jumplist.recent()->setVisible(recentCategoryShown);
    if (!taskList.isEmpty()) {
        Q_FOREACH (QQuickJumpListItem *item, taskList)
            jumplist.tasks()->addItem(item->toJumpListItem());
        taskList.clear();
    }
    if (!categoryList.isEmpty()) {
        Q_FOREACH (QQuickJumpListCategory *category, categoryList) {
            QList<QWinJumpListItem *> items = category->toItemList();
            jumplist.addCategory(category->title(), items);
        }
    }
}

void QQuickJumpList::appendTaskItem(QQmlListProperty<QQuickJumpListItem> *property, QQuickJumpListItem *value)
{
    static_cast<QQuickJumpList *>(property->data)->taskList.append(value);
}

void QQuickJumpList::appendGroup(QQmlListProperty<QQuickJumpListCategory> *property, QQuickJumpListCategory *value)
{
    static_cast<QQuickJumpList *>(property->data)->categoryList.append(value);
}


/*!
    \qmltype JumpCategory
    \instantiates QQuickJumpListCategory
    \inqmlmodule QtWinExtras

    \brief Represents a category of custom destinations.

    \since QtWinExtras 1.0

    The JumpCategory type represents a category that consists of several
    Jump List destinations and has a title.
 */

/*!
    \class QQuickJumpListCategory
    \internal
 */

QQuickJumpListCategory::QQuickJumpListCategory(QObject *parent) :
    QObject(parent)
{
}

QQuickJumpListCategory::~QQuickJumpListCategory()
{
}

/*!
    \qmlproperty object JumpCategory::destinations

    The destinations in this category.
 */
QQmlListProperty<QQuickJumpListItem> QQuickJumpListCategory::destinations()
{
    return QQmlListProperty<QQuickJumpListItem>(this, this, &QQuickJumpListCategory::addItem, 0, 0, 0);
}

void QQuickJumpListCategory::setTitle(const QString &title)
{
    m_groupTitle = title;
}

/*!
    \qmlproperty string JumpCategory::title

    The title of the category.
 */
QString QQuickJumpListCategory::title() const
{
    return m_groupTitle;
}

QList<QWinJumpListItem *> QQuickJumpListCategory::toItemList() const
{
    QList<QWinJumpListItem *> destinations;
    foreach (QQuickJumpListItem *item, m_destinations)
        destinations.append(item->toJumpListItem());
    return destinations;
}

void QQuickJumpListCategory::addItem(QQmlListProperty<QQuickJumpListItem> *property, QQuickJumpListItem *value)
{
    static_cast<QQuickJumpListCategory *>(property->data)->m_destinations.append(value);
}


QQuickJumpListItem::QQuickJumpListItem(QObject *p) :
    QObject(p)
{
}

QQuickJumpListItem::~QQuickJumpListItem()
{
}

void QQuickJumpListItem::setType(int type)
{
    m_type = type;
}

int QQuickJumpListItem::type() const
{
    return m_type;
}

QWinJumpListItem *QQuickJumpListItem::toJumpListItem() const
{
    QWinJumpListItem *item = new QWinJumpListItem(QWinJumpListItem::Separator);
    switch (m_type) {
    case ItemTypeDestination :
        item->setType(QWinJumpListItem::Destination);
        item->setFilePath(property("filePath").toString());
        break;
    case ItemTypeLink :
        item->setType(QWinJumpListItem::Link);
        item->setFilePath(property("executablePath").toString());
        item->setArguments(QStringList(property("arguments").toStringList()));
        item->setDescription(property("description").toString());
        item->setTitle(property("title").toString());
        item->setIcon(QIcon(property("iconPath").toString()));
        break;
    }

    return item;
}

QT_END_NAMESPACE