diff options
Diffstat (limited to 'tools/qdoc3/pagegenerator.h')
-rw-r--r-- | tools/qdoc3/pagegenerator.h | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/tools/qdoc3/pagegenerator.h b/tools/qdoc3/pagegenerator.h new file mode 100644 index 0000000..002d390 --- /dev/null +++ b/tools/qdoc3/pagegenerator.h @@ -0,0 +1,85 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 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 the GNU General Public License version 3.0 requirements will be +** met: 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. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/* + pagegenerator.h +*/ + +#ifndef PAGEGENERATOR_H +#define PAGEGENERATOR_H + +#include <QStack> +#include <qtextstream.h> + +#include "generator.h" +#include "location.h" + +QT_BEGIN_NAMESPACE + +class ClassNode; +class InnerNode; +class NamespaceNode; + +class PageGenerator : public Generator +{ + public: + PageGenerator(); + ~PageGenerator(); + + virtual void generateTree(const Tree *tree, CodeMarker *marker); + + protected: + virtual QString fileBase(const Node *node); + virtual QString fileExtension(const Node *node) = 0; + QString fileName(const Node *node); + QString outFileName(); + void beginSubPage(const Location& location, const QString& fileName); + void endSubPage(); + virtual void generateInnerNode(const InnerNode *node, CodeMarker *marker); + QTextStream& out(); + + private: + QStack<QTextStream *> outStreamStack; +}; + +QT_END_NAMESPACE + +#endif |