ProjectDocumentationPlugin Class Reference

#include <kdevdocumentationplugin.h>

Public Slots
virtual void	reinit ()

Public Member Functions
	ProjectDocumentationPlugin (DocumentationPlugin *docPlugin, DocumentationPlugin::ProjectDocType type)
virtual void	init (TDEListView *contents, IndexBox *index, const TQString &url)
virtual void	deinit ()
TQString	pluginName () const
TQString	catalogURL () const

Protected Member Functions
TDEListViewItem *	findCatalogPosition (const TQString &key, const TDEListView *contents) const

Protected Attributes
DocumentationPlugin *	m_docPlugin
DocumentationCatalogItem *	m_catalog

Detailed Description

Project documentation plugin.

Represents functionality to display project documentation catalog and index in documentation browser.

Definition at line 392 of file kdevdocumentationplugin.h.

Constructor & Destructor Documentation

ProjectDocumentationPlugin()

ProjectDocumentationPlugin::ProjectDocumentationPlugin	(	DocumentationPlugin *	docPlugin,
		DocumentationPlugin::ProjectDocType	type )

Definition at line 682 of file kdevdocumentationplugin.cpp.

~ProjectDocumentationPlugin()

ProjectDocumentationPlugin::~ProjectDocumentationPlugin ( )

virtual

Definition at line 692 of file kdevdocumentationplugin.cpp.

Member Function Documentation

catalogURL()

TQString ProjectDocumentationPlugin::catalogURL

(

)

const

Definition at line 753 of file kdevdocumentationplugin.cpp.

deinit()

void ProjectDocumentationPlugin::deinit ( )

virtual

Deinitializes project documentation plugin - removes documentation catalog.

Definition at line 738 of file kdevdocumentationplugin.cpp.

findCatalogPosition()

TDEListViewItem * ProjectDocumentationPlugin::findCatalogPosition ( const TQString & key, const TDEListView * contents ) const

protected

Find catalog insert position to maintain a sorted order.

Definition at line 697 of file kdevdocumentationplugin.cpp.

init()

void ProjectDocumentationPlugin::init ( TDEListView * contents, IndexBox * index, const TQString & url )

virtual

Initializes project documentation plugin - creates documentation catalog.

Definition at line 712 of file kdevdocumentationplugin.cpp.

pluginName()

TQString ProjectDocumentationPlugin::pluginName

(

)

const

Definition at line 748 of file kdevdocumentationplugin.cpp.

reinit

void ProjectDocumentationPlugin::reinit ( )

virtualslot

Performs reinitialization if project documentation has changed (after building api documentation).

Definition at line 731 of file kdevdocumentationplugin.cpp.

Member Data Documentation

m_catalog

DocumentationCatalogItem* ProjectDocumentationPlugin::m_catalog

protected

Definition at line 416 of file kdevdocumentationplugin.h.

m_docPlugin

DocumentationPlugin* ProjectDocumentationPlugin::m_docPlugin

protected

Definition at line 415 of file kdevdocumentationplugin.h.

---

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

• kdevdocumentationplugin.h
• kdevdocumentationplugin.cpp