diff options
Diffstat (limited to 'parts/documentation/plugins/custom')
4 files changed, 210 insertions, 0 deletions
diff --git a/parts/documentation/plugins/custom/Makefile.am b/parts/documentation/plugins/custom/Makefile.am new file mode 100644 index 00000000..999dc853 --- /dev/null +++ b/parts/documentation/plugins/custom/Makefile.am @@ -0,0 +1,10 @@ +INCLUDES = -I$(top_srcdir)/lib/interfaces \ + -I$(top_srcdir)/parts/documentation/interfaces $(all_includes) +METASOURCES = AUTO +kde_module_LTLIBRARIES = libdoccustomplugin.la +libdoccustomplugin_la_LDFLAGS = -module -avoid-version -no-undefined $(all_libraries) +libdoccustomplugin_la_LIBADD = $(top_builddir)/lib/libkdevelop.la \ + $(top_builddir)/parts/documentation/interfaces/libdocumentation_interfaces.la +noinst_HEADERS = doccustomplugin.h +libdoccustomplugin_la_SOURCES = doccustomplugin.cpp +kde_services_DATA = doccustomplugin.desktop diff --git a/parts/documentation/plugins/custom/doccustomplugin.cpp b/parts/documentation/plugins/custom/doccustomplugin.cpp new file mode 100644 index 00000000..b3cc7685 --- /dev/null +++ b/parts/documentation/plugins/custom/doccustomplugin.cpp @@ -0,0 +1,106 @@ +/*************************************************************************** + * Copyright (C) 2004 by Alexander Dymo * + * adymo@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. * + ***************************************************************************/ +#include "doccustomplugin.h" + +#include <kurl.h> +#include <kaboutdata.h> +#include <kconfig.h> +#include <klocale.h> +#include <klistview.h> + +#include <kdevgenericfactory.h> +#include <kdevplugininfo.h> + +static const KDevPluginInfo data("doccustomplugin"); +typedef KDevGenericFactory<DocCustomPlugin> DocCustomPluginFactory; +K_EXPORT_COMPONENT_FACTORY( libdoccustomplugin, DocCustomPluginFactory(data) ) + +DocCustomPlugin::DocCustomPlugin(QObject* parent, const char* name, const QStringList // args + ) + :DocumentationPlugin(DocCustomPluginFactory::instance()->config(), parent, name) +{ + setCapabilities(CustomDocumentationTitles | ProjectUserManual); + autoSetup(); +} + +DocCustomPlugin::~DocCustomPlugin() +{ +} + +bool DocCustomPlugin::needRefreshIndex(DocumentationCatalogItem* // item + ) +{ + return false; +} + +QString DocCustomPlugin::pluginName() const +{ + return i18n("Custom Documentation Collection"); +} + +DocumentationCatalogItem* DocCustomPlugin::createCatalog(KListView* contents, const QString& title, const QString& url) +{ + DocumentationCatalogItem *item = new DocumentationCatalogItem(this, contents, title); + item->setURL(KURL(url)); + return item; +} + +QPair<KFile::Mode, QString> DocCustomPlugin::catalogLocatorProps() +{ + return QPair<KFile::Mode, QString>(KFile::File, "all/allfiles"); +} + +QString DocCustomPlugin::catalogTitle(const QString& /*url*/) +{ + return QString::null; +} + +QStringList DocCustomPlugin::fullTextSearchLocations() +{ + return QStringList(); +} + + +void DocCustomPlugin::autoSetupPlugin() +{ + return; +} + +void DocCustomPlugin::createIndex(IndexBox* /*index*/, DocumentationCatalogItem* /*item*/) +{ + return; +} + +void DocCustomPlugin::createTOC(DocumentationCatalogItem* /*item*/) +{ + return; +} + +void DocCustomPlugin::setCatalogURL(DocumentationCatalogItem* /*item*/) +{ + return; +} + +ProjectDocumentationPlugin *DocCustomPlugin::projectDocumentationPlugin(ProjectDocType type) +{ + if (type == UserManual) + return new ProjectDocumentationPlugin(this, type); + return DocumentationPlugin::projectDocumentationPlugin(type); +} diff --git a/parts/documentation/plugins/custom/doccustomplugin.desktop b/parts/documentation/plugins/custom/doccustomplugin.desktop new file mode 100644 index 00000000..09b018e7 --- /dev/null +++ b/parts/documentation/plugins/custom/doccustomplugin.desktop @@ -0,0 +1,44 @@ +[Desktop Entry] +Type=Service +Name=DocCustomPlugin +Name[da]=Brugerdefineret doc-plugin +Name[sk]=Doc vlastný modul +Name[sv]=Egen dokumentationsinsticksmodul +Name[ta]=ஆவண தனிப்பயன் சொருகுப்பொருள் +Name[zh_TW]=Doc 自訂外掛程式 +Exec=blubb +Comment=Documentation plugin for all types of documentation +Comment[ca]=Connector de documentació per a tot tipus de documentació +Comment[da]=Dokumentations-plugin for alle typer dokumentation +Comment[de]=Komponente für alle Arten von Dokumentation +Comment[el]=Πρόσθετο τεκμηρίωσης για όλους τους τύπους τεκμηρίωσης +Comment[es]=Complemento de documentación para todos los tipos de documentación +Comment[et]=Igat tüüpi dokumentatsiooni plugin +Comment[eu]=Dokumentu mota guztientzako dokumentazio plugin-a +Comment[fa]=وصلۀ مستندسازی برای همۀ انواع مستندات +Comment[fr]=Module externe de documentation pour tous les types de documentation +Comment[gl]=Extensión de documentación para tódolos tipos de documentación +Comment[hu]=Dokumentációmodul mindenféle dokumentációhoz +Comment[it]=Plugin di documentazione per tutti i tipi di documentazione +Comment[ja]=全種類のドキュメンテーションのためのドキュメンテーションプラグイン +Comment[ms]=Plugin dokumentasi untuk semua jenis dokumentasi +Comment[nds]=Dokmentatschoon-Moduul för all Oorden vun Dokmentatschoon +Comment[ne]=सबै प्रकारको मिसिलीकरणका लागि मिसिलीकरण प्लगइन +Comment[nl]=Documentatie plugin voor alle typen documentatie +Comment[pl]=Wtyczka dokumentacji dla wszystkich typów dokumentacji +Comment[pt]='Plugin' para documentação de todos os tipos +Comment[pt_BR]=Plug-in de documentação para todos os tipos de documentação +Comment[ru]=Модуль для работы с документацией +Comment[sk]=Dokumentačný modul pre všetky typy dokumentácie +Comment[sl]=Dokumentacijski vstavek za vse vrste dokumentacije +Comment[sr]=Документациони прикључак за све типове документације +Comment[sr@Latn]=Dokumentacioni priključak za sve tipove dokumentacije +Comment[sv]=Dokumentationsinsticksmodul för alla typer av dokumentation +Comment[ta]=எல்லா வகை ஆவணமயமாக்கலுக்கான ஆவணமயமாக்கல் சொருகுப்பொருள் +Comment[tg]=Модул барои кор кардан бо ҳуҷҷатҳо +Comment[tr]=Her tür belgelendirme için belgelendirme eklentisi +Comment[zh_CN]=全部类型文档的文档插件 +Comment[zh_TW]=所有型態的文件外掛程式 +ServiceTypes=KDevelop/DocumentationPlugins +X-KDevelop-Version=5 +X-KDE-Library=libdoccustomplugin diff --git a/parts/documentation/plugins/custom/doccustomplugin.h b/parts/documentation/plugins/custom/doccustomplugin.h new file mode 100644 index 00000000..2888af81 --- /dev/null +++ b/parts/documentation/plugins/custom/doccustomplugin.h @@ -0,0 +1,50 @@ +/*************************************************************************** + * Copyright (C) 2004 by Alexander Dymo * + * adymo@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 DOCCUSTOMPLUGIN_H +#define DOCCUSTOMPLUGIN_H + +#include <kdevdocumentationplugin.h> + +class DocCustomPlugin : public DocumentationPlugin { +public: + DocCustomPlugin(QObject* parent, const char* name, const QStringList args = QStringList()); + ~DocCustomPlugin(); + + 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 |