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
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Assistant 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 COLLECTIONCONFIGURATION_H
#define COLLECTIONCONFIGURATION_H
#include <QtCore/QByteArray>
#include <QtCore/QCoreApplication>
#include <QtCore/QDateTime>
#include <QtCore/QString>
#include <QtCore/QStringList>
QT_BEGIN_NAMESPACE
class QHelpEngineCore;
class CollectionConfiguration
{
public:
static const QString windowTitle(const QHelpEngineCore &helpEngine);
static void setWindowTitle(QHelpEngineCore &helpEngine,
const QString &windowTitle);
static const QString cacheDir(const QHelpEngineCore &helpEngine);
static bool cacheDirIsRelativeToCollection(const QHelpEngineCore &helpEngine);
static void setCacheDir(QHelpEngineCore &helpEngine,
const QString &cacheDir, bool relativeToCollection);
static uint creationTime(const QHelpEngineCore &helpEngine);
static void setCreationTime(QHelpEngineCore &helpEngine, uint time);
static bool filterFunctionalityEnabled(const QHelpEngineCore &helpEngine);
static void setFilterFunctionalityEnabled(QHelpEngineCore &helpEngine,
bool enabled);
static bool filterToolbarVisible(const QHelpEngineCore &helpEngine);
static void setFilterToolbarVisible(QHelpEngineCore &helpEngine,
bool visible);
static bool addressBarEnabled(const QHelpEngineCore &helpEngine);
static void setAddressBarEnabled(QHelpEngineCore &helpEngine, bool enabled);
static bool addressBarVisible(const QHelpEngineCore &helpEngine);
static void setAddressBarVisible(QHelpEngineCore &helpEngine, bool visible);
static bool documentationManagerEnabled(const QHelpEngineCore &helpEngine);
static void setDocumentationManagerEnabled(QHelpEngineCore &helpEngine,
bool enabled);
static const QByteArray applicationIcon(const QHelpEngineCore &helpEngine);
static void setApplicationIcon(QHelpEngineCore &helpEngine,
const QByteArray &icon);
// TODO: Encapsulate encoding from/to QByteArray here
static const QByteArray aboutMenuTexts(const QHelpEngineCore &helpEngine);
static void setAboutMenuTexts(QHelpEngineCore &helpEngine,
const QByteArray &texts);
static const QByteArray aboutIcon(const QHelpEngineCore &helpEngine);
static void setAboutIcon(QHelpEngineCore &helpEngine,
const QByteArray &icon);
// TODO: Encapsulate encoding from/to QByteArray here
static const QByteArray aboutTexts(const QHelpEngineCore &helpEngine);
static void setAboutTexts(QHelpEngineCore &helpEngine,
const QByteArray &texts);
static const QByteArray aboutImages(const QHelpEngineCore &helpEngine);
static void setAboutImages(QHelpEngineCore &helpEngine,
const QByteArray &images);
static const QString defaultHomePage(const QHelpEngineCore &helpEngine);
static void setDefaultHomePage(QHelpEngineCore &helpEngine,
const QString &page);
// TODO: Don't allow last pages and zoom factors to be set in isolation
// Perhaps also fill up missing elements automatically or assert.
static const QStringList lastShownPages(const QHelpEngineCore &helpEngine);
static void setLastShownPages(QHelpEngineCore &helpEngine,
const QStringList &lastShownPages);
static const QStringList lastZoomFactors(const QHelpEngineCore &helpEngine);
static void setLastZoomFactors(QHelpEngineCore &helPEngine,
const QStringList &lastZoomFactors);
static int lastTabPage(const QHelpEngineCore &helpEngine);
static void setLastTabPage(QHelpEngineCore &helpEngine, int lastPage);
static bool isNewer(const QHelpEngineCore &newer,
const QHelpEngineCore &older);
static void copyConfiguration(const QHelpEngineCore &source,
QHelpEngineCore &target);
/*
* Note that this only reflects register actions caused by the
* "-register" command line switch, not GUI or remote control actions.
*/
static const QDateTime lastRegisterTime(const QHelpEngineCore &helpEngine);
static void updateLastRegisterTime(QHelpEngineCore &helpEngine);
static bool fullTextSearchFallbackEnabled(const QHelpEngineCore &helpEngine);
static void setFullTextSearchFallbackEnabled(QHelpEngineCore &helpEngine,
bool on);
static const QString DefaultZoomFactor;
static const QString ListSeparator;
};
QT_END_NAMESPACE
#endif // COLLECTIONCONFIGURATION_H
|
