summaryrefslogtreecommitdiffstats
path: root/qthelpprojectwriter_p.h
blob: 0d86f01516a62d0a29e65c89cdf3d349d7275151 (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
/****************************************************************************
 **
 ** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).
 ** Contact: Nokia Corporation (qt-info@nokia.com)
 **
 ** This file is part of the doxygen2qthelp project on Trolltech Labs.
 **
 ** This file may be used under the terms of the GNU General Public
 ** License version 2.0 or 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 GNU
 ** General Public Licensing requirements will be met:
 ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
 ** http://www.gnu.org/copyleft/gpl.html.
 **
 ** If you are unsure which license is appropriate for your use, please
 ** contact the sales department at qt-sales@nokia.com.
 **
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 **
 ****************************************************************************/

#ifndef QTHELPPROJECTWRITER_H
#define QTHELPPROJECTWRITER_H

#include <QtXml/QXmlStreamWriter>

QT_BEGIN_NAMESPACE

class QHelpDataInterface;
class QHelpDataContentItem;

template <class T>
class QList;

class QtHelpProjectWriter : public QXmlStreamWriter
{
private:
    const QHelpDataInterface *m_helpData;

public:
    QtHelpProjectWriter();
    bool writeFile(const QHelpDataInterface *helpData,
            const QString &fileName);

private:
    void writeHead();
    void writeCustomFilters();
    void writeTocItems(const QList<QHelpDataContentItem*> &items);
    void writeFilterSections();
    void writeBody();
    void writeFoot();
};

QT_END_NAMESPACE

#endif // QTHELPPROJECTWRITER_H