Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
collectionconfigreader.h
Go to the documentation of this file.
1// Copyright (C) 2018 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3// Qt-Security score:insignificant reason:build-tool
4
5#ifndef COLLECTIONCONFIGREADER_H
6#define COLLECTIONCONFIGREADER_H
7
8#include <QtCore/QMap>
9#include <QtCore/QObject>
10#include <QtCore/QXmlStreamReader>
11
12QT_USE_NAMESPACE
13
14class CollectionConfigReader : public QXmlStreamReader
15{
16public:
17 void readData(const QByteArray &contents);
18
19 QString title() const { return m_title; }
20 QString homePage() const { return m_homePage; }
21 QString startPage() const { return m_startPage; }
22 QString applicationIcon() const { return m_applicationIcon; }
23 QString currentFilter() const { return m_currentFilter; }
24 bool enableFilterFunctionality() const
25 { return m_enableFilterFunctionality; }
26 bool hideFilterFunctionality() const
27 { return m_hideFilterFunctionality; }
28 bool enableAddressBar() const { return m_enableAddressBar; }
29 bool hideAddressBar() const { return m_hideAddressBar; }
30 bool enableDocumentationManager() const
31 { return m_enableDocumentationManager; }
32
33 QMap<QString, QString> aboutMenuTexts() const
34 { return m_aboutMenuTexts; }
35 QString aboutIcon() const { return m_aboutIcon; }
36 QMap<QString, QString> aboutTextFiles() const
37 { return m_aboutTextFiles; }
38
39 QMap<QString, QString> filesToGenerate() const
40 { return m_filesToGenerate; }
41
42 QStringList filesToRegister() const { return m_filesToRegister; }
43
44 QString cacheDirectory() const { return m_cacheDirectory; }
45 bool cacheDirRelativeToCollection() const { return m_cacheDirRelativeToCollection; }
46
47 bool fullTextSearchFallbackEnabled() const {
48 return m_enableFullTextSearchFallback;
49 }
50
51private:
52 void raiseErrorWithLine();
53 void readConfig();
54 void readAssistantSettings();
55 void readMenuTexts();
56 void readAboutDialog();
57 void readDocFiles();
58 void readGenerate();
59 void readFiles();
60 void readRegister();
61
62 QMap<QString, QString> m_aboutMenuTexts;
63 QMap<QString, QString> m_aboutTextFiles;
64 QMap<QString, QString> m_filesToGenerate;
65 QStringList m_filesToRegister;
66 QString m_title;
67 QString m_homePage;
68 QString m_startPage;
69 QString m_applicationIcon;
70 QString m_currentFilter;
71 QString m_aboutIcon;
72 QString m_cacheDirectory;
73 bool m_enableFilterFunctionality;
74 bool m_hideFilterFunctionality;
75 bool m_enableAddressBar;
76 bool m_hideAddressBar;
77 bool m_enableDocumentationManager;
78 bool m_cacheDirRelativeToCollection;
79 bool m_enableFullTextSearchFallback;
80};
81
82#endif
static void setFullTextSearchFallbackEnabled(QHelpEngineCore &helpEngine, bool on)
static void setAddressBarVisible(QHelpEngineCore &helpEngine, bool visible)
static void setDocumentationManagerEnabled(QHelpEngineCore &helpEngine, bool enabled)
static void setAddressBarEnabled(QHelpEngineCore &helpEngine, bool enabled)
static void updateLastRegisterTime(QHelpEngineCore &helpEngine)
static void setFilterToolbarVisible(QHelpEngineCore &helpEngine, bool visible)
static void setFilterFunctionalityEnabled(QHelpEngineCore &helpEngine, bool enabled)
QString error() const
bool checkLinks(const QHelpProjectData &helpData)
bool generate(QHelpProjectData *helpData, const QString &outputFileName)
Definition main.cpp:25
The QHelpProjectData class stores all information found in a Qt help project file.
QHelpProjectData()
Constructs a Qt help project data structure.
Combined button and popup list for selecting options.
static const char QHP[]
Definition main.cpp:29
static const char QHC[]
Definition main.cpp:33
int generateCollectionFile(const QByteArray &data, const QString &basePath, const QString outputFile)
Definition main.cpp:42
static const char QCH[]
Definition main.cpp:30
static const char QHCP[]
Definition main.cpp:32
int main(int argc, char *argv[])
[ctor_close]