KDevelop API Documentation

ProjectDocumentationPlugin Class Reference

Project documentation plugin. More...

#include <kdevdocumentationplugin.h>

Inheritance diagram for ProjectDocumentationPlugin:

Inheritance graph
[legend]
Collaboration diagram for ProjectDocumentationPlugin:

Collaboration graph
[legend]
List of all members.

Public Slots

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

Public Member Functions

 ProjectDocumentationPlugin (DocumentationPlugin *docPlugin, DocumentationPlugin::ProjectDocType type)
virtual ~ProjectDocumentationPlugin ()
virtual void init (KListView *contents, IndexBox *index, const QString &url)
 Initializes project documentation plugin - creates documentation catalog.
virtual void deinit ()
 Deinitializes project documentation plugin - removes documentation catalog.
QString pluginName () const
QString catalogURL () const

Protected Attributes

DocumentationPluginm_docPlugin
DocumentationCatalogItemm_catalog

Private Attributes

DocumentationPlugin::ProjectDocType m_type
KDirWatchm_watch
KListViewm_contents
IndexBoxm_index
QString m_url

Detailed Description

Project documentation plugin.

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

Definition at line 362 of file kdevdocumentationplugin.h.


Constructor & Destructor Documentation

ProjectDocumentationPlugin::ProjectDocumentationPlugin DocumentationPlugin docPlugin,
DocumentationPlugin::ProjectDocType  type
 

Definition at line 652 of file kdevdocumentationplugin.cpp.

References kdDebug(), m_watch, reinit(), and KDirWatch::startScan().

ProjectDocumentationPlugin::~ProjectDocumentationPlugin  )  [virtual]
 

Definition at line 662 of file kdevdocumentationplugin.cpp.

References deinit().


Member Function Documentation

QString ProjectDocumentationPlugin::catalogURL  )  const
 

Definition at line 704 of file kdevdocumentationplugin.cpp.

Referenced by DocumentationPart::saveProjectDocumentationInfo().

void ProjectDocumentationPlugin::deinit  )  [virtual]
 

Deinitializes project documentation plugin - removes documentation catalog.

Definition at line 692 of file kdevdocumentationplugin.cpp.

References m_catalog, m_url, m_watch, and KDirWatch::removeFile().

Referenced by init(), reinit(), and ~ProjectDocumentationPlugin().

void ProjectDocumentationPlugin::init KListView contents,
IndexBox index,
const QString url
[virtual]
 

Initializes project documentation plugin - creates documentation catalog.

Definition at line 667 of file kdevdocumentationplugin.cpp.

References KDirWatch::addFile(), DocumentationPlugin::createCatalog(), deinit(), m_catalog, m_contents, m_docPlugin, m_index, m_type, m_url, m_watch, and DocumentationCatalogItem::setProjectDocumentationItem().

Referenced by DocProjectConfigWidget::accept(), DocumentationPart::projectOpened(), and reinit().

QString ProjectDocumentationPlugin::pluginName  )  const
 

Definition at line 699 of file kdevdocumentationplugin.cpp.

References m_docPlugin, and DocumentationPlugin::pluginName().

Referenced by DocumentationPart::saveProjectDocumentationInfo().

void ProjectDocumentationPlugin::reinit  )  [virtual, slot]
 

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

Definition at line 685 of file kdevdocumentationplugin.cpp.

References deinit(), init(), m_contents, m_index, and m_url.

Referenced by ProjectDocumentationPlugin().


Member Data Documentation

DocumentationCatalogItem* ProjectDocumentationPlugin::m_catalog [protected]
 

Definition at line 382 of file kdevdocumentationplugin.h.

Referenced by deinit(), and init().

class KListView* ProjectDocumentationPlugin::m_contents [private]
 

Definition at line 388 of file kdevdocumentationplugin.h.

Referenced by init(), and reinit().

DocumentationPlugin* ProjectDocumentationPlugin::m_docPlugin [protected]
 

Definition at line 381 of file kdevdocumentationplugin.h.

Referenced by init(), and pluginName().

class IndexBox* ProjectDocumentationPlugin::m_index [private]
 

Definition at line 389 of file kdevdocumentationplugin.h.

Referenced by init(), and reinit().

DocumentationPlugin::ProjectDocType ProjectDocumentationPlugin::m_type [private]
 

Definition at line 385 of file kdevdocumentationplugin.h.

Referenced by init().

QString ProjectDocumentationPlugin::m_url [private]
 

Definition at line 390 of file kdevdocumentationplugin.h.

Referenced by deinit(), init(), and reinit().

class KDirWatch* ProjectDocumentationPlugin::m_watch [private]
 

Definition at line 387 of file kdevdocumentationplugin.h.

Referenced by deinit(), init(), and ProjectDocumentationPlugin().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 22 09:46:04 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003