diff options
Diffstat (limited to 'parts/documentation/plugins/qt/docqtplugin.h')
-rw-r--r-- | parts/documentation/plugins/qt/docqtplugin.h | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/parts/documentation/plugins/qt/docqtplugin.h b/parts/documentation/plugins/qt/docqtplugin.h new file mode 100644 index 00000000..802dd98a --- /dev/null +++ b/parts/documentation/plugins/qt/docqtplugin.h @@ -0,0 +1,56 @@ +/*************************************************************************** + * Copyright (C) 2004 by Alexander Dymo * + * [email protected] * + * * + * 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 DOCQTPLUGIN_H +#define DOCQTPLUGIN_H + +#include <kdevdocumentationplugin.h> +#include <qdom.h> + +class KConfig; + +class DocQtPlugin : public DocumentationPlugin +{ + Q_OBJECT +public: + DocQtPlugin(QObject* parent, const char* name, const QStringList args = QStringList()); + ~DocQtPlugin(); + + 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 void createSectionIndex(QFileInfo &fi, IndexBox *index, DocumentationCatalogItem *item, + QDomElement section); + + virtual QStringList fullTextSearchLocations(); + + virtual QPair<KFile::Mode, QString> catalogLocatorProps(); + virtual QString catalogTitle(const QString &url); + + virtual void autoSetupPlugin(); + +}; + +#endif |