KDevelop API Documentation

docqtplugin.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 DOCQTPLUGIN_H
00021 #define DOCQTPLUGIN_H
00022 
00023 #include <kdevdocumentationplugin.h>
00024 
00025 class KConfig;
00026 
00027 class DocQtPlugin : public DocumentationPlugin
00028 {
00029     Q_OBJECT
00030 public:
00031     DocQtPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
00032     ~DocQtPlugin();
00033 
00034     virtual QString pluginName() const;
00035     
00036     virtual DocumentationCatalogItem *createCatalog(KListView *contents, const QString &title, const QString &url);
00037     
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 QString catalogTitle(const QString &url);
00048         
00049     virtual void autoSetupPlugin();
00050 
00051 };
00052 
00053 #endif
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 22 09:22:40 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003