You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdevelop/parts/documentation/plugins/kdevtoc/dockdevtocplugin.h

55 lines
2.6 KiB

/***************************************************************************
* 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., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02111-1307, USA. *
***************************************************************************/
#ifndef DOCKDEVTOCPLUGIN_H
#define DOCKDEVTOCPLUGIN_H
#include <qdom.h>
#include <kdevdocumentationplugin.h>
class DocKDevTOCPlugin : public DocumentationPlugin
{
Q_OBJECT
public:
DocKDevTOCPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
~DocKDevTOCPlugin();
virtual QString pluginName() const;
virtual QString catalogTitle(const QString& url);
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 void autoSetupPlugin();
protected:
void addTocSect(DocumentationItem *parent, QDomElement childEl, const QString &base, uint level);
static QString constructURL(const QString &base, const QString &url) ;
};
#endif