DocCustomPlugin Class Reference

#include <doccustomplugin.h>

Inheritance diagram for DocCustomPlugin:

[legend]Collaboration diagram for DocCustomPlugin:


Public Member Functions
	DocCustomPlugin (QObject parent, const char name, const QStringList args=QStringList())
	~DocCustomPlugin ()
virtual QString	pluginName () const
	Returns the i18n name of the plugin.
virtual DocumentationCatalogItem *	createCatalog (KListView *contents, const QString &title, const QString &url)
	Creates documentation catalog with given title and url.
virtual void	createTOC (DocumentationCatalogItem *item)
	Creates a table of contents for given catalog.
virtual void	setCatalogURL (DocumentationCatalogItem *item)
	Sets the URL to the catalog.
virtual bool	needRefreshIndex (DocumentationCatalogItem *item)
	Indicates if an index of given catalog should be rebuilt.
virtual void	createIndex (IndexBox index, DocumentationCatalogItem item)
	Builds index for given catalog.
virtual QStringList	fullTextSearchLocations ()
virtual QPair< KFile::Mode, QString >	catalogLocatorProps ()
	Returns a mode and a filter for catalog locator dialogs.
virtual QString	catalogTitle (const QString &url)
	Returns a title of catalog defined by an url parameter.
virtual void	autoSetupPlugin ()
	Plugin specific automatic setup code.
virtual ProjectDocumentationPlugin *	projectDocumentationPlugin (ProjectDocType type)
	Returns associated project documentation plugin.

Constructor & Destructor Documentation

DocCustomPlugin::DocCustomPlugin ( QObject * parent,

const char * name,

const QStringList args = QStringList()

)

DocCustomPlugin::~DocCustomPlugin ( )

Definition at line 41 of file doccustomplugin.cpp.

Member Function Documentation

void DocCustomPlugin::autoSetupPlugin ( ) [virtual]

Plugin specific automatic setup code.
This method is called by autoSetup.
Implements DocumentationPlugin.
Definition at line 78 of file doccustomplugin.cpp.

QPair< KFile::Mode, QString > DocCustomPlugin::catalogLocatorProps ( ) [virtual]

Returns a mode and a filter for catalog locator dialogs.

Implements DocumentationPlugin.
Definition at line 62 of file doccustomplugin.cpp.

QString DocCustomPlugin::catalogTitle ( const QString & url ) [virtual]

Returns a title of catalog defined by an url parameter.

Implements DocumentationPlugin.
Definition at line 67 of file doccustomplugin.cpp.

DocumentationCatalogItem * DocCustomPlugin::createCatalog ( KListView * contents,

const QString & title,

const QString & url

) [virtual]

Creates documentation catalog with given title and url.

Implements DocumentationPlugin.
Definition at line 55 of file doccustomplugin.cpp.
References DocumentationPlugin::DocumentationCatalogItem, and DocumentationItem::setURL().

void DocCustomPlugin::createIndex ( IndexBox * index,

DocumentationCatalogItem * item

) [virtual]

Builds index for given catalog.
This method should fill index with IndexItem objects.
Parameters:

index the listbox which contains index items

Implements DocumentationPlugin.
Definition at line 83 of file doccustomplugin.cpp.

void DocCustomPlugin::createTOC ( DocumentationCatalogItem * item ) [virtual]

Creates a table of contents for given catalog.
Documentation part uses lazy loading of toc's to reduce startup time. This means that createTOC will be called on expand event of catalog item.
Implements DocumentationPlugin.
Definition at line 88 of file doccustomplugin.cpp.

QStringList DocCustomPlugin::fullTextSearchLocations ( ) [virtual]

Implements DocumentationPlugin.
Definition at line 72 of file doccustomplugin.cpp.

bool DocCustomPlugin::needRefreshIndex ( DocumentationCatalogItem * item ) [virtual]

Indicates if an index of given catalog should be rebuilt.
This method is used by index caching algorythm to make a descision to rebuild index or to load it from cache.
Implements DocumentationPlugin.
Definition at line 45 of file doccustomplugin.cpp.

QString DocCustomPlugin::pluginName ( ) const [virtual]

Returns the i18n name of the plugin.

Implements DocumentationPlugin.
Definition at line 50 of file doccustomplugin.cpp.

ProjectDocumentationPlugin * DocCustomPlugin::projectDocumentationPlugin ( ProjectDocType type ) [virtual]

Returns associated project documentation plugin.
Default implementation returns zero. Reimplement this if the documentation plugin can also handle project documentation.
Reimplemented from DocumentationPlugin.
Definition at line 98 of file doccustomplugin.cpp.
References DocumentationPlugin::projectDocumentationPlugin().

void DocCustomPlugin::setCatalogURL ( DocumentationCatalogItem * item ) [virtual]

Sets the URL to the catalog.
This method will be called each time user clicks the documentation item. If it is too much overhead to determine the documentation catalog url in createCatalog method then you can set it here.
Implements DocumentationPlugin.
Definition at line 93 of file doccustomplugin.cpp.

The documentation for this class was generated from the following files:

parts/documentation/plugins/custom/doccustomplugin.h
parts/documentation/plugins/custom/doccustomplugin.cpp

KDevelop API Documentation

DocCustomPlugin Class Reference

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation