blob: ffadb2b4398d3165fdc41b5966de839f8a2f5a64 (
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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QHPWRITER_H
#define QHPWRITER_H
#include <QtCore/QXmlStreamWriter>
#include "filterpage.h"
QT_BEGIN_NAMESPACE
class AdpReader;
class QhpWriter : public QXmlStreamWriter
{
public:
enum IdentifierPrefix {SkipAll, FilePrefix, GlobalPrefix};
QhpWriter(const QString &namespaceName,
const QString &virtualFolder);
void setAdpReader(AdpReader *reader);
void setFilterAttributes(const QStringList &attributes);
void setCustomFilters(const QList<CustomFilter> filters);
void setFiles(const QStringList &files);
void generateIdentifiers(IdentifierPrefix prefix,
const QString prefixString = QString());
bool writeFile(const QString &fileName);
private:
void writeCustomFilters();
void writeFilterSection();
void writeToc();
void writeKeywords();
void writeFiles();
QString m_namespaceName;
QString m_virtualFolder;
AdpReader *m_adpReader;
QStringList m_filterAttributes;
QList<CustomFilter> m_customFilters;
QStringList m_files;
IdentifierPrefix m_prefix;
QString m_prefixString;
};
QT_END_NAMESPACE
#endif
|
