|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Assistant of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #ifndef QHELPGENERATOR_H |
|
43 #define QHELPGENERATOR_H |
|
44 |
|
45 // |
|
46 // W A R N I N G |
|
47 // ------------- |
|
48 // |
|
49 // This file is not part of the Qt API. It exists for the convenience |
|
50 // of the help generator tools. This header file may change from version |
|
51 // to version without notice, or even be removed. |
|
52 // |
|
53 // We mean it. |
|
54 // |
|
55 |
|
56 #include "qhelp_global.h" |
|
57 #include "qhelpdatainterface_p.h" |
|
58 |
|
59 #include <QtCore/QObject> |
|
60 |
|
61 QT_BEGIN_HEADER |
|
62 |
|
63 QT_BEGIN_NAMESPACE |
|
64 |
|
65 class QHelpGeneratorPrivate; |
|
66 |
|
67 class QHELP_EXPORT QHelpGenerator : public QObject |
|
68 { |
|
69 Q_OBJECT |
|
70 |
|
71 public: |
|
72 QHelpGenerator(QObject *parent = 0); |
|
73 ~QHelpGenerator(); |
|
74 |
|
75 bool generate(QHelpDataInterface *helpData, |
|
76 const QString &outputFileName); |
|
77 QString error() const; |
|
78 |
|
79 Q_SIGNALS: |
|
80 void statusChanged(const QString &msg); |
|
81 void progressChanged(double progress); |
|
82 void warning(const QString &msg); |
|
83 |
|
84 private: |
|
85 struct FileNameTableData |
|
86 { |
|
87 QString name; |
|
88 int fileId; |
|
89 QString title; |
|
90 }; |
|
91 |
|
92 void writeTree(QDataStream &s, QHelpDataContentItem *item, int depth); |
|
93 bool createTables(); |
|
94 bool insertFileNotFoundFile(); |
|
95 bool registerCustomFilter(const QString &filterName, |
|
96 const QStringList &filterAttribs, bool forceUpdate = false); |
|
97 bool registerVirtualFolder(const QString &folderName, const QString &ns); |
|
98 bool insertFilterAttributes(const QStringList &attributes); |
|
99 bool insertKeywords(const QList<QHelpDataIndexItem> keywords, |
|
100 const QStringList &filterAttributes); |
|
101 bool insertFiles(const QStringList &files, const QString &rootPath, |
|
102 const QStringList &filterAttributes); |
|
103 bool insertContents(const QByteArray &ba, |
|
104 const QStringList &filterAttributes); |
|
105 bool insertMetaData(const QMap<QString, QVariant> &metaData); |
|
106 void cleanupDB(); |
|
107 void setupProgress(QHelpDataInterface *helpData); |
|
108 void addProgress(double step); |
|
109 |
|
110 QHelpGeneratorPrivate *d; |
|
111 }; |
|
112 |
|
113 QT_END_NAMESPACE |
|
114 |
|
115 QT_END_HEADER |
|
116 |
|
117 #endif |