git.iko.soy/unity8
on 1ca89ff help sign in
unity8/plugins/Wizard/PageList.cpp
129 lines 3.9 kB history raw
1/*
2 * Copyright (C) 2014-2016 Canonical Ltd.
3 *
4 * This program is free software: you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 3, as published
6 * by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranties of
10 * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
11 * PURPOSE. See the GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
17/**
18 * This class lets the list of wizard pages be dynamic.
19 * - To add new ones, drop them into
20 * $XDG_DATA_DIRS/Wizard/Pages with a numbered prefix,
21 * like "21-custom-page.qml". The number determines the order in the page
22 * sequence that your page will appear.
23 * - To disable an existing page, add a file like "21-custom-page.qml.disabled"
24 * - To go to the next page, use pageStack.next()
25 * - To go back to the previous page, use pageStack.prev()
26 * - To load a page outside of the normal flow (so that it doesn't affect the
27 * back button), use pageStack.push(Qt.resolvedUrl("custom-page.qml")) in
28 * your page.
29 * - See default pages for plenty of examples.
30 */
32#include "PageList.h"
33#include <paths.h>
34#include <QDir>
35#include <QSet>
36#include <QStandardPaths>
37#include <QSettings>
39PageList::PageList(QObject *parent)
40 : QObject(parent),
41 m_index(-1),
42 m_pages()
44 const QString qmlSuffix = QStringLiteral(".qml");
45 const QString disabledSuffix = QStringLiteral(".disabled");
46 QSet<QString> disabledPages;
47 QStringList dataDirs;
49 if (getenv("WIZARD_TESTING") != nullptr) {
50 dataDirs = QStandardPaths::standardLocations(QStandardPaths::GenericDataLocation);
51 } else if (!isRunningInstalled()) {
52 dataDirs << qmlDirectory();
53 } else {
54 dataDirs = shellDataDirs();
55 }
57 Q_FOREACH(const QString &dataDir, dataDirs) {
58 QDir dir(dataDir + "/Wizard/Pages");
59 const QStringList entries = dir.entryList(QStringList(QStringLiteral("[0-9]*")), QDir::Files | QDir::Readable);
60 Q_FOREACH(const QString &entry, entries) {
61 if (!m_pages.contains(entry) && entry.endsWith(qmlSuffix))
62 m_pages.insert(entry, dir.absoluteFilePath(entry));
63 else if (entry.endsWith(qmlSuffix + disabledSuffix))
64 disabledPages.insert(entry.left(entry.size() - disabledSuffix.size()));
65 }
66 }
68 // Now remove any explicitly disabled entries
69 Q_FOREACH(const QString &page, disabledPages) {
70 m_pages.remove(page);
71 }
73 // If there was a system update installed, skip until the last page to just greet the user
74 QSettings settings;
75 if (settings.value(QStringLiteral("Wizard/SkipUntilFinishedPage")).toBool()) {
76 const QString lastPage = m_pages.lastKey();
77 Q_FOREACH(const QString &page, m_pages.keys()) {
78 if (Q_UNLIKELY(page != lastPage)) {
79 m_pages.remove(page);
80 }
81 }
83 // ... and reset it again for the next run
84 settings.remove(QStringLiteral("Wizard/SkipUntilFinishedPage"));
85 }
88QStringList PageList::entries() const
90 return m_pages.keys();
93QStringList PageList::paths() const
95 return m_pages.values();
98int PageList::index() const
100 return m_index;
103int PageList::numPages() const
105 return m_pages.size();
108QString PageList::prev()
110 if (m_index > 0)
111 return m_pages.values()[setIndex(m_index - 1)];
112 else
113 return QString();
116QString PageList::next()
118 if (m_index < m_pages.count() - 1)
119 return m_pages.values()[setIndex(m_index + 1)];
120 else
121 return QString();
124int PageList::setIndex(int index)
126 m_index = index;
127 Q_EMIT indexChanged();
128 return m_index;