docdevhelpplugin.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 DOCDEVHELPPLUGIN_H
00021 #define DOCDEVHELPPLUGIN_H
00022
00023 #include <qvaluestack.h>
00024 #include <qdom.h>
00025
00026 #include <kdevdocumentationplugin.h>
00027
00028 class DocDevHelpPlugin: public DocumentationPlugin
00029 {
00030 Q_OBJECT
00031 public:
00032 DocDevHelpPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
00033 ~DocDevHelpPlugin();
00034
00035 virtual QString pluginName() const;
00036
00037 virtual QString catalogTitle(const QString& url);
00038 virtual void setCatalogURL(DocumentationCatalogItem* item);
00039
00040 virtual void createTOC(DocumentationCatalogItem* item);
00041
00042 virtual DocumentationCatalogItem* createCatalog(KListView* contents, const QString& title, const QString& url);
00043
00044 virtual bool needRefreshIndex(DocumentationCatalogItem* item);
00045 virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item);
00046
00047 virtual QStringList fullTextSearchLocations();
00048 virtual void autoSetupPlugin();
00049
00050 virtual QPair<KFile::Mode, QString> catalogLocatorProps();
00051
00052 virtual ProjectDocumentationPlugin *projectDocumentationPlugin(ProjectDocType type);
00053
00054 protected:
00055 void pushToScanStack(QValueStack<QString> &stack, const QString &value);
00056 void scanDevHelpDir(const QString &path);
00057 void addTocSect(DocumentationItem *parent, QDomElement childEl, QString baseUrl, bool book=false);
00058 };
00059
00060 #endif
This file is part of the documentation for KDevelop Version 3.1.2.