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
|
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qcompressedhelpinfo.h"
#include "qhelpdbreader_p.h"
#include <QtCore/qversionnumber.h>
QT_BEGIN_NAMESPACE
using namespace Qt::StringLiterals;
class QCompressedHelpInfoPrivate : public QSharedData
{
public:
QCompressedHelpInfoPrivate() = default;
QCompressedHelpInfoPrivate(const QCompressedHelpInfoPrivate &other)
: QSharedData(other)
, m_namespaceName(other.m_namespaceName)
, m_component(other.m_component)
, m_version(other.m_version)
, m_isNull(other.m_isNull)
{ }
QString m_namespaceName;
QString m_component;
QVersionNumber m_version;
bool m_isNull = true;
};
/*!
\class QCompressedHelpInfo
\since 5.13
\inmodule QtHelp
\brief The QCompressedHelpInfo class provides access to
the details about a compressed help file.
The detailed information about the compressed
help file can be fetched by calling the fromCompressedHelpFile()
static method, providing the path to the compressed
help file.
The class provides access to various information about a compressed help file.
The namespace associated with the given compressed help file is
namespaceName(), the associated component name is component()
and version() provides version information.
\sa QHelpFilterEngine
*/
/*!
Constructs empty information about a compressed help file.
*/
QCompressedHelpInfo::QCompressedHelpInfo()
: d(new QCompressedHelpInfoPrivate)
{}
/*!
Constructs a copy of \a other.
*/
QCompressedHelpInfo::QCompressedHelpInfo(const QCompressedHelpInfo &) = default;
/*!
Move-constructs a QCompressedHelpInfo instance,
making it point to the same object that \a other was pointing to,
so that it contains the information the \a other used to contain.
*/
QCompressedHelpInfo::QCompressedHelpInfo(QCompressedHelpInfo &&) = default;
/*!
Destroys the QCompressedHelpInfo.
*/
QCompressedHelpInfo::~QCompressedHelpInfo() = default;
/*!
Makes this QHelpCollectionDetails into a copy of \a other, so the two
are identical, and returns a reference to this QHelpCollectionDetails.
*/
QCompressedHelpInfo &QCompressedHelpInfo::operator=(const QCompressedHelpInfo &) = default;
/*!
Move-assigns \a other to this QCompressedHelpInfo instance.
*/
QCompressedHelpInfo &QCompressedHelpInfo::operator=(QCompressedHelpInfo &&) = default;
/*!
\fn void QCompressedHelpInfo::swap(QCompressedHelpInfo &other)
Swaps the compressed help file \a other with this compressed help file. This
operation is very fast and never fails.
*/
/*!
Returns the namespace name of the compressed help file.
*/
QString QCompressedHelpInfo::namespaceName() const
{
return d->m_namespaceName;
}
/*!
Returns the component of the compressed help file.
*/
QString QCompressedHelpInfo::component() const
{
return d->m_component;
}
/*!
Returns the version of the compressed help file.
*/
QVersionNumber QCompressedHelpInfo::version() const
{
return d->m_version;
}
/*!
Returns \c true if the info is invalid, otherwise returns
\c false.
*/
bool QCompressedHelpInfo::isNull() const
{
return d->m_isNull;
}
/*!
Returns the QCompressedHelpInfo instance for the
\a documentationFileName of the existing qch file.
*/
QCompressedHelpInfo QCompressedHelpInfo::fromCompressedHelpFile(const QString &documentationFileName)
{
void *pointer = const_cast<QString *>(&documentationFileName);
QHelpDBReader reader(documentationFileName, QHelpGlobal::uniquifyConnectionName(
"GetCompressedHelpInfo"_L1, pointer), nullptr);
if (reader.init()) {
QCompressedHelpInfo info;
info.d->m_namespaceName = reader.namespaceName();
info.d->m_component = reader.virtualFolder();
info.d->m_version = QVersionNumber::fromString(reader.version());
info.d->m_isNull = false;
return info;
}
return {};
}
QT_END_NAMESPACE
|
