diff options
Diffstat (limited to 'parts/documentation/plugins/tdevtoc/doctdevtocplugin.h')
-rw-r--r-- | parts/documentation/plugins/tdevtoc/doctdevtocplugin.h | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/parts/documentation/plugins/tdevtoc/doctdevtocplugin.h b/parts/documentation/plugins/tdevtoc/doctdevtocplugin.h new file mode 100644 index 00000000..266efb94 --- /dev/null +++ b/parts/documentation/plugins/tdevtoc/doctdevtocplugin.h @@ -0,0 +1,55 @@ +/*************************************************************************** + * Copyright (C) 2004 by Alexander Dymo * + * [email protected] * + * * + * 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., * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * + ***************************************************************************/ +#ifndef DOCTDEVTOCPLUGIN_H +#define DOCTDEVTOCPLUGIN_H + +#include <tqdom.h> + +#include <tdevdocumentationplugin.h> + +class DocTDevTOCPlugin : public DocumentationPlugin +{ + Q_OBJECT + +public: + DocTDevTOCPlugin(TQObject* parent, const char* name, const TQStringList args = TQStringList()); + ~DocTDevTOCPlugin(); + + virtual TQString pluginName() const; + + virtual TQString catalogTitle(const TQString& url); + virtual DocumentationCatalogItem* createCatalog(TDEListView* contents, const TQString& title, const TQString& url); + virtual void createTOC(DocumentationCatalogItem* item); + virtual void setCatalogURL(DocumentationCatalogItem* item); + + virtual bool needRefreshIndex(DocumentationCatalogItem* item); + virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item); + + virtual TQStringList fullTextSearchLocations(); + + virtual TQPair<KFile::Mode, TQString > catalogLocatorProps(); + virtual void autoSetupPlugin(); + +protected: + void addTocSect(DocumentationItem *parent, TQDomElement childEl, const TQString &base, uint level); + static TQString constructURL(const TQString &base, const TQString &url) ; +}; + +#endif |