DocGenerator.h

Go to the documentation of this file.

/*  Copyright (C) 2009 Jens-Malte Gottfried

    This file is part of Tuchulcha.

    Tuchulcha is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Tuchulcha is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Tuchulcha.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef DOCGENERATOR_H_
#define DOCGENERATOR_H_

#include <QObject>
#include <vector>

class QTextBrowser;
class QUrl;
class MetaData ;

class DocGenerator : public QObject {
    Q_OBJECT

public:

    DocGenerator(QTextBrowser* viewer, QObject* parent = 0);

    virtual ~DocGenerator();

public slots:
    void showHelp();

    void showIntro();


    void showDocPage(const QString& fileName);


    void showClassDoc(const QString& className);


    void showDocString(const QString& doc);

    void updateMetaData() ;

protected:

    QString _docList(
            QStringList parList, QString className,
            QString slotType = "") const;

    QTextBrowser* _viewer;

    QString _stylesheet;

    QString _footer;

    QString _helpDoc;

private:

    MetaData* _meta ;
};

#endif /*DOCGENERATOR_H_*/