|
|
|
|
/***************************************************************************
|
|
|
|
|
* Copyright (C) 2004 by Mathieu Chouinard *
|
|
|
|
|
* mathieu.chouinard@kdemail.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 02110-1301, USA. *
|
|
|
|
|
***************************************************************************/
|
|
|
|
|
#ifndef DOCPDFPLUGIN_H
|
|
|
|
|
#define DOCPDFPLUGIN_H
|
|
|
|
|
|
|
|
|
|
#include <kdevdocumentationplugin.h>
|
|
|
|
|
|
|
|
|
|
class DocPDFPlugin : public DocumentationPlugin {
|
|
|
|
|
public:
|
|
|
|
|
DocPDFPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
|
|
|
|
|
~DocPDFPlugin();
|
|
|
|
|
|
|
|
|
|
virtual QString pluginName() const;
|
|
|
|
|
|
|
|
|
|
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 QString catalogTitle(const QString& url);
|
|
|
|
|
|
|
|
|
|
virtual void autoSetupPlugin();
|
|
|
|
|
|
|
|
|
|
virtual ProjectDocumentationPlugin *projectDocumentationPlugin(ProjectDocType type);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
#endif
|
