summaryrefslogtreecommitdiffstats
path: root/htmlhelpdatainterface_p.h
diff options
context:
space:
mode:
authorTor Arne Vestbø <tor.arne.vestbo@nokia.com>2010-05-03 12:34:27 +0200
committerTor Arne Vestbø <tor.arne.vestbo@nokia.com>2010-05-03 12:34:27 +0200
commit415b44ffb6ffcdeb4ad5b7cdd6d9d9e17ab3e47f (patch)
treed9417f99ef9665167668fe3047416a0d11e1518f /htmlhelpdatainterface_p.h
Initial checkinHEADmaster
Diffstat (limited to 'htmlhelpdatainterface_p.h')
-rw-r--r--htmlhelpdatainterface_p.h86
1 files changed, 86 insertions, 0 deletions
diff --git a/htmlhelpdatainterface_p.h b/htmlhelpdatainterface_p.h
new file mode 100644
index 0000000..1efd2e1
--- /dev/null
+++ b/htmlhelpdatainterface_p.h
@@ -0,0 +1,86 @@
+/****************************************************************************
+ **
+ ** 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 HTMLHELPDATAINTERFACE_P_H
+#define HTMLHELPDATAINTERFACE_P_H
+
+#include "qhelpdatainterface_p.h"
+#include <QString>
+#include <QStringList>
+
+QT_BEGIN_NAMESPACE
+
+class HtmlHelpParser;
+
+class HtmlHelpDataInterface : public QHelpDataInterface
+{
+private:
+ QString m_projectTitle;
+ QString m_filterIdent;
+ QString m_entryPageHref;
+ QList<QHelpDataIndexItem> m_index;
+ QList<QHelpDataContentItem *> m_toc;
+
+ QString m_rootPath;
+ QString m_nameSpace;
+ QString m_virtualFolder;
+ QStringList m_files;
+ QList<QHelpDataCustomFilter> m_custumFilters;
+ QList<QHelpDataFilterSection> m_filterSections;
+
+public:
+ HtmlHelpDataInterface(const QString &projectFileName,
+ const QString &namespaceName, const QString &virtualFolder);
+
+private:
+ void initFromDoxygenHtmlHelpProject(const QString &projectFileName);
+
+ const QStringList applyPrefix(const QStringList &list, const QString &prefix) const;
+ QStringList findSubDirs(const QString &dir) const;
+ QStringList findDoxygenFiles(const QString &dir) const;
+ QStringList findDoxygenFilesRecursively(const QString &dir,
+ const QString &prefix = QString()) const;
+ void scanRootPath();
+ void parseToc(const QString &fileName);
+ void parseIndex(const QString &fileName);
+
+ QString replaceFileExtension(const QString &fileName,
+ const QString &extension);
+ QString getTocFileName(const QString &projectFileName);
+ QString getIndexFileName(const QString &projectFileName);
+ QString getRootPath(const QString &projectFileName);
+
+private:
+ QString namespaceName() const;
+ QString virtualFolder() const;
+ QList<QHelpDataCustomFilter> customFilters() const;
+ QList<QHelpDataFilterSection> filterSections() const;
+ QMap<QString, QVariant> metaData() const;
+ QString rootPath() const;
+
+};
+
+QT_END_NAMESPACE
+
+#endif // HTMLHELPDATAINTERFACE_P_H
+