ProjectDocumentationPlugin Class Reference
Project documentation plugin. More...
#include <kdevdocumentationplugin.h>
Inheritance diagram for ProjectDocumentationPlugin:


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 | |
DocumentationPlugin * | m_docPlugin |
DocumentationCatalogItem * | m_catalog |
Private Attributes | |
DocumentationPlugin::ProjectDocType | m_type |
KDirWatch * | m_watch |
KListView * | m_contents |
IndexBox * | m_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
|
Definition at line 652 of file kdevdocumentationplugin.cpp. References kdDebug(), m_watch, reinit(), and KDirWatch::startScan(). |
|
Definition at line 662 of file kdevdocumentationplugin.cpp. References deinit(). |
Member Function Documentation
|
Definition at line 704 of file kdevdocumentationplugin.cpp. Referenced by DocumentationPart::saveProjectDocumentationInfo(). |
|
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(). |
|
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(). |
|
Definition at line 699 of file kdevdocumentationplugin.cpp. References m_docPlugin, and DocumentationPlugin::pluginName(). Referenced by DocumentationPart::saveProjectDocumentationInfo(). |
|
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
|
Definition at line 382 of file kdevdocumentationplugin.h. |
|
Definition at line 388 of file kdevdocumentationplugin.h. |
|
Definition at line 381 of file kdevdocumentationplugin.h. Referenced by init(), and pluginName(). |
|
Definition at line 389 of file kdevdocumentationplugin.h. |
|
Definition at line 385 of file kdevdocumentationplugin.h. Referenced by init(). |
|
Definition at line 390 of file kdevdocumentationplugin.h. |
|
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:
- lib/interfaces/kdevdocumentationplugin.h
- lib/interfaces/kdevdocumentationplugin.cpp