docchmplugin.h
Go to the documentation of this file.00001 /*************************************************************************** 00002 * Copyright (C) 2004 by Alexander Dymo * 00003 * cloudtemple@mksat.net * 00004 * * 00005 * This program is free software; you can redistribute it and/or modify * 00006 * it under the terms of the GNU General Public License as published by * 00007 * the Free Software Foundation; either version 2 of the License, or * 00008 * (at your option) any later version. * 00009 * * 00010 * This program is distributed in the hope that it will be useful, * 00011 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 00012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 00013 * GNU General Public License for more details. * 00014 * * 00015 * You should have received a copy of the GNU General Public License * 00016 * along with this program; if not, write to the * 00017 * Free Software Foundation, Inc., * 00018 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * 00019 ***************************************************************************/ 00020 #ifndef DOCCHMPLUGIN_H 00021 #define DOCCHMPLUGIN_H 00022 00023 #include <kdevdocumentationplugin.h> 00024 00025 class DocCHMPlugin :public DocumentationPlugin 00026 { 00027 Q_OBJECT 00028 public: 00029 DocCHMPlugin(QObject* parent, const char* name, QStringList args = QStringList()); 00030 ~DocCHMPlugin(); 00031 00032 virtual QString pluginName() const; 00033 00034 virtual void setCatalogURL(DocumentationCatalogItem* item); 00035 virtual QString catalogTitle(const QString& url); 00036 virtual QPair<KFile::Mode, QString> catalogLocatorProps(); 00037 virtual DocumentationCatalogItem* createCatalog(KListView* contents, const QString& title, const QString& url); 00038 virtual void createTOC(DocumentationCatalogItem* item); 00039 00040 virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item); 00041 virtual bool needRefreshIndex(DocumentationCatalogItem* item); 00042 00043 virtual QStringList fullTextSearchLocations(); 00044 00045 virtual void autoSetupPlugin(); 00046 }; 00047 00048 #endif