From 114a878c64ce6f8223cfd22d76a20eb16d177e5e Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- .../plugins/devhelp/docdevhelpplugin.h | 60 ++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 parts/documentation/plugins/devhelp/docdevhelpplugin.h (limited to 'parts/documentation/plugins/devhelp/docdevhelpplugin.h') diff --git a/parts/documentation/plugins/devhelp/docdevhelpplugin.h b/parts/documentation/plugins/devhelp/docdevhelpplugin.h new file mode 100644 index 00000000..ab0b0ece --- /dev/null +++ b/parts/documentation/plugins/devhelp/docdevhelpplugin.h @@ -0,0 +1,60 @@ +/*************************************************************************** + * 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., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ +#ifndef DOCDEVHELPPLUGIN_H +#define DOCDEVHELPPLUGIN_H + +#include +#include + +#include + +class DocDevHelpPlugin: public DocumentationPlugin +{ + Q_OBJECT +public: + DocDevHelpPlugin(QObject* parent, const char* name, const QStringList args = QStringList()); + ~DocDevHelpPlugin(); + + virtual QString pluginName() const; + + virtual QString catalogTitle(const QString& url); + virtual void setCatalogURL(DocumentationCatalogItem* item); + + virtual void createTOC(DocumentationCatalogItem* item); + + virtual DocumentationCatalogItem* createCatalog(KListView* contents, const QString& title, const QString& url); + + virtual bool needRefreshIndex(DocumentationCatalogItem* item); + virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item); + + virtual QStringList fullTextSearchLocations(); + virtual void autoSetupPlugin(); + + virtual QPair catalogLocatorProps(); + + virtual ProjectDocumentationPlugin *projectDocumentationPlugin(ProjectDocType type); + +protected: + void pushToScanStack(QValueStack &stack, const QString &value); + void scanDevHelpDir(const QString &path); + void addTocSect(DocumentationItem *parent, QDomElement childEl, QString baseUrl, bool book=false); +}; + +#endif -- cgit v1.2.3