dockdevtocplugin.h
Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020 #ifndef DOCKDEVTOCPLUGIN_H
00021 #define DOCKDEVTOCPLUGIN_H
00022
00023 #include <qdom.h>
00024
00025 #include <kdevdocumentationplugin.h>
00026
00027 class DocKDevTOCPlugin : public DocumentationPlugin
00028 {
00029 Q_OBJECT
00030 public:
00031 DocKDevTOCPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
00032 ~DocKDevTOCPlugin();
00033
00034 virtual QString pluginName() const;
00035
00036 virtual QString catalogTitle(const QString& url);
00037 virtual DocumentationCatalogItem* createCatalog(KListView* contents, const QString& title, const QString& url);
00038 virtual void createTOC(DocumentationCatalogItem* item);
00039 virtual void setCatalogURL(DocumentationCatalogItem* item);
00040
00041 virtual bool needRefreshIndex(DocumentationCatalogItem* item);
00042 virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item);
00043
00044 virtual QStringList fullTextSearchLocations();
00045
00046 virtual QPair<KFile::Mode, QString > catalogLocatorProps();
00047 virtual void autoSetupPlugin();
00048
00049 protected:
00050 void addTocSect(DocumentationItem *parent, QDomElement childEl, const QString &base, uint level);
00051 static QString constructURL(const QString &base, const QString &url) ;
00052 };
00053
00054 #endif
This file is part of the documentation for KDevelop Version 3.1.2.