DocDoxygenPlugin Class Reference

#include <docdoxygenplugin.h>

Inheritance diagram for DocDoxygenPlugin:

[legend]Collaboration diagram for DocDoxygenPlugin:


Public Member Functions
	DocDoxygenPlugin (QObject parent, const char name, const QStringList args=QStringList())
	~DocDoxygenPlugin ()
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.
Protected Member Functions
void	createBookTOC (DocumentationItem *item, const QString &tagUrl=QString::null, const QString &baseHtmlUrl=QString::null)
void	createBookIndex (const QString &tagfile, IndexBox index, DocumentationCatalogItem item, const QString &baseHtmlUrl=QString::null)
void	createIndexFromTag (QDomDocument &dom, IndexBox index, DocumentationCatalogItem item, QDomElement &parentEl, const QString &prefix)

Constructor & Destructor Documentation

DocDoxygenPlugin::DocDoxygenPlugin ( QObject * parent,

const char * name,

const QStringList args = QStringList()

)

DocDoxygenPlugin::~DocDoxygenPlugin ( )

Definition at line 72 of file docdoxygenplugin.cpp.

Member Function Documentation

void DocDoxygenPlugin::autoSetupPlugin ( ) [virtual]

Plugin specific automatic setup code.
This method is called by autoSetup.
Implements DocumentationPlugin.
Definition at line 186 of file docdoxygenplugin.cpp.
References URLUtil::envExpand(), KConfigBase::setGroup(), KConfigBase::writeEntry(), and KConfigBase::writePathEntry().

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

Returns a mode and a filter for catalog locator dialogs.

Implements DocumentationPlugin.
Definition at line 76 of file docdoxygenplugin.cpp.

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

Returns a title of catalog defined by an url parameter.

Implements DocumentationPlugin.
Definition at line 81 of file docdoxygenplugin.cpp.

void DocDoxygenPlugin::createBookIndex ( const QString & tagfile,

IndexBox * index,

DocumentationCatalogItem * item,

const QString & baseHtmlUrl = QString::null

) [protected]

Definition at line 353 of file docdoxygenplugin.cpp.
References createIndexFromTag(), and kdDebug().
Referenced by createIndex().

void DocDoxygenPlugin::createBookTOC ( DocumentationItem * item,

const QString & tagUrl = QString::null,

const QString & baseHtmlUrl = QString::null

) [protected]

Definition at line 299 of file docdoxygenplugin.cpp.
References KURL::directory(), kdDebug(), DocumentationItem::setURL(), KURL::upURL(), and DocumentationItem::url().
Referenced by createTOC().

DocumentationCatalogItem * DocDoxygenPlugin::createCatalog ( KListView * contents,

const QString & title,

const QString & url

) [virtual]

Creates documentation catalog with given title and url.

Implements DocumentationPlugin.
Definition at line 291 of file docdoxygenplugin.cpp.
References kdDebug(), and DocumentationItem::setURL().

void DocDoxygenPlugin::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 207 of file docdoxygenplugin.cpp.
References createBookIndex(), KURL::directory(), DoxyDocumentationCatalogItem::origUrl(), KURL::path(), and DocumentationItem::url().

void DocDoxygenPlugin::createIndexFromTag ( QDomDocument & dom,

IndexBox * index,

DocumentationCatalogItem * item,

QDomElement & parentEl,

const QString & prefix

) [protected]

Definition at line 380 of file docdoxygenplugin.cpp.
References IndexItemProto::addURL(), and DocumentationPlugin::IndexItemProto.
Referenced by createBookIndex().

void DocDoxygenPlugin::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 248 of file docdoxygenplugin.cpp.
References createBookTOC(), KURL::directory(), DoxyDocumentationCatalogItem::origUrl(), KURL::path(), DocumentationItem::setURL(), and DocumentationItem::url().

QStringList DocDoxygenPlugin::fullTextSearchLocations ( ) [virtual]

Implements DocumentationPlugin.
Definition at line 127 of file docdoxygenplugin.cpp.
References KConfig::entryMap(), KConfigBase::readBoolEntry(), KConfigBase::readPathEntry(), and KConfigBase::setGroup().

bool DocDoxygenPlugin::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 168 of file docdoxygenplugin.cpp.
References kdDebug(), DoxyDocumentationCatalogItem::origUrl(), KConfigBase::readDateTimeEntry(), KConfigBase::setGroup(), and KConfigBase::writeEntry().

QString DocDoxygenPlugin::pluginName ( ) const [virtual]

Returns the i18n name of the plugin.

Implements DocumentationPlugin.
Definition at line 122 of file docdoxygenplugin.cpp.

ProjectDocumentationPlugin * DocDoxygenPlugin::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 422 of file docdoxygenplugin.cpp.
References DocumentationPlugin::projectDocumentationPlugin().

void DocDoxygenPlugin::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 148 of file docdoxygenplugin.cpp.
References KURL::directory(), DocumentationItem::setURL(), KURL::url(), and DocumentationItem::url().

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

parts/documentation/plugins/doxygen/docdoxygenplugin.h
parts/documentation/plugins/doxygen/docdoxygenplugin.cpp

KDevelop API Documentation

DocDoxygenPlugin Class Reference

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation