• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • KDevelop Documentation Part Interfaces Library
 

KDevelop Documentation Part Interfaces Library

Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ProjectDocumentationPlugin Class Reference

#include <kdevdocumentationplugin.h>

Inherits TQObject.

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.

Member Function Documentation

◆ 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.

◆ reinit

void ProjectDocumentationPlugin::reinit ( )
virtualslot

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

Definition at line 731 of file kdevdocumentationplugin.cpp.


The documentation for this class was generated from the following files:
  • kdevdocumentationplugin.h
  • kdevdocumentationplugin.cpp

KDevelop Documentation Part Interfaces Library

Skip menu "KDevelop Documentation Part Interfaces Library"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members

KDevelop Documentation Part Interfaces Library

Skip menu "KDevelop Documentation Part Interfaces Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for KDevelop Documentation Part Interfaces Library by doxygen 1.8.13
This website is maintained by Timothy Pearson.