KDevelop API Documentation

docdoxygenplugin.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  *   Copyright (C) 2004 by Alexander Dymo                                  *
00003  *   cloudtemple@mksat.net                                                 *
00004  *                                                                         *
00005  *   This program is free software; you can redistribute it and/or modify  *
00006  *   it under the terms of the GNU General Public License as published by  *
00007  *   the Free Software Foundation; either version 2 of the License, or     *
00008  *   (at your option) any later version.                                   *
00009  *                                                                         *
00010  *   This program is distributed in the hope that it will be useful,       *
00011  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00012  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
00013  *   GNU General Public License for more details.                          *
00014  *                                                                         *
00015  *   You should have received a copy of the GNU General Public License     *
00016  *   along with this program; if not, write to the                         *
00017  *   Free Software Foundation, Inc.,                                       *
00018  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
00019  ***************************************************************************/
00020 #ifndef DOCDOXYGENPLUGIN_H
00021 #define DOCDOXYGENPLUGIN_H
00022 
00023 #include <kdevdocumentationplugin.h>
00024 
00025 class QDomDocument;
00026 class QDomElement;
00027 
00028 class DocDoxygenPlugin: public DocumentationPlugin
00029 {
00030     Q_OBJECT
00031 public:
00032     DocDoxygenPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
00033     ~DocDoxygenPlugin();
00034 
00035     virtual QString pluginName() const;
00036 
00037     virtual DocumentationCatalogItem *createCatalog(KListView *contents, const QString &title, const QString &url);
00038     
00039     virtual void createTOC(DocumentationCatalogItem* item);
00040     virtual void setCatalogURL(DocumentationCatalogItem* item);
00041 
00042     virtual bool needRefreshIndex(DocumentationCatalogItem* item);
00043     virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item);
00044 
00045     virtual QStringList fullTextSearchLocations();
00046                     
00047     virtual QPair<KFile::Mode, QString> catalogLocatorProps();
00048     virtual QString catalogTitle(const QString& url);
00049     
00050     virtual void autoSetupPlugin();
00051 
00052     virtual ProjectDocumentationPlugin *projectDocumentationPlugin(ProjectDocType type);
00053         
00054 protected:
00055     void createBookTOC(DocumentationItem* item, const QString &tagUrl = QString::null, 
00056         const QString &baseHtmlUrl = QString::null);
00057     void createBookIndex(const QString &tagfile, IndexBox* index, DocumentationCatalogItem* item, const QString &baseHtmlUrl = QString::null);
00058     
00059     void createIndexFromTag(QDomDocument &dom, IndexBox* index, DocumentationCatalogItem* item,
00060         QDomElement &parentEl, const QString &prefix);
00061 };
00062 
00063 
00064 #endif
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 00:03:56 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003