Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 75 insertions, 0 deletions

diff --git a/parts/documentation/plugins/doxygen/docdoxygenplugin.h b/parts/documentation/plugins/doxygen/docdoxygenplugin.h
new file mode 100644
index 00000000..fbd7e56f
--- /dev/null
+++ b/parts/documentation/plugins/doxygen/docdoxygenplugin.h
@@ -0,0 +1,75 @@
+/***************************************************************************
+ *   Copyright (C) 2004 by Alexander Dymo                                  *
+ *   cloudtemple@mksat.net                                                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program 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 General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#ifndef DOCDOXYGENPLUGIN_H
+#define DOCDOXYGENPLUGIN_H
+
+#include <kdevdocumentationplugin.h>
+
+class QDomDocument;
+class QDomElement;
+
+class DocDoxygenPlugin: public DocumentationPlugin
+{
+    Q_OBJECT
+public:
+    DocDoxygenPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
+    ~DocDoxygenPlugin();
+
+    virtual QString pluginName() const;
+
+    virtual DocumentationCatalogItem *createCatalog(KListView *contents, const QString &title, const QString &url);
+    
+    virtual void createTOC(DocumentationCatalogItem* item);
+    virtual void setCatalogURL(DocumentationCatalogItem* item);
+
+    virtual bool needRefreshIndex(DocumentationCatalogItem* item);
+    virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item);
+
+    virtual QStringList fullTextSearchLocations();
+                    
+    virtual QPair<KFile::Mode, QString> catalogLocatorProps();
+    virtual QString catalogTitle(const QString& url);
+    
+    virtual void autoSetupPlugin();
+
+    virtual ProjectDocumentationPlugin *projectDocumentationPlugin(ProjectDocType type);
+        
+protected:
+    void createBookTOC(DocumentationItem* item, const QString &tagUrl = QString::null, 
+        const QString &baseHtmlUrl = QString::null);
+    void createBookIndex(const QString &tagfile, IndexBox* index, DocumentationCatalogItem* item, const QString &baseHtmlUrl = QString::null);
+    
+    void createIndexFromTag(QDomDocument &dom, IndexBox* index, DocumentationCatalogItem* item,
+        QDomElement &parentEl, const QString &prefix);
+    
+    void autoSetupDocs(const QString &defaultDir, const QString &searchDir, 
+        const QString &name);
+
+    /**
+     * Returns all the tag files from a directory and its subdirectories.
+     * @param startDir the directory to start with
+     * @param level the depth of the current search
+     * @return a list with the absolute path to the ".tag" files in startDir
+     */
+    QStringList tagFiles(const QString &startDir, int level = 0);    
+};
+
+
+#endif