KDevelop API Documentation

DocQtPlugin Class Reference

#include <docqtplugin.h>

Inheritance diagram for DocQtPlugin:

Inheritance graph
[legend]
Collaboration diagram for DocQtPlugin:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DocQtPlugin (QObject *parent, const char *name, const QStringList args=QStringList())
 ~DocQtPlugin ()
virtual QString pluginName () const
 Returns the i18n name of the plugin.
virtual DocumentationCatalogItemcreateCatalog (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.

Constructor & Destructor Documentation

DocQtPlugin::DocQtPlugin QObject parent,
const char *  name,
const QStringList  args = QStringList()
 

DocQtPlugin::~DocQtPlugin  ) 
 

Definition at line 70 of file docqtplugin.cpp.


Member Function Documentation

void DocQtPlugin::autoSetupPlugin  )  [virtual]
 

Plugin specific automatic setup code.

This method is called by autoSetup.

Implements DocumentationPlugin.

Definition at line 138 of file docqtplugin.cpp.

References URLUtil::envExpand(), KConfigBase::setGroup(), KConfigBase::writeEntry(), and KConfigBase::writePathEntry().

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

Returns a mode and a filter for catalog locator dialogs.

Implements DocumentationPlugin.

Definition at line 299 of file docqtplugin.cpp.

QString DocQtPlugin::catalogTitle const QString url  )  [virtual]
 

Returns a title of catalog defined by an url parameter.

Implements DocumentationPlugin.

Definition at line 304 of file docqtplugin.cpp.

DocumentationCatalogItem * DocQtPlugin::createCatalog KListView contents,
const QString title,
const QString url
[virtual]
 

Creates documentation catalog with given title and url.

Implements DocumentationPlugin.

Definition at line 324 of file docqtplugin.cpp.

void DocQtPlugin::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 216 of file docqtplugin.cpp.

References IndexItemProto::addURL(), QtDocumentationCatalogItem::dcfFile(), DocumentationPlugin::IndexItemProto, and kdDebug().

void DocQtPlugin::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 74 of file docqtplugin.cpp.

References QtDocumentationCatalogItem::dcfFile(), kdDebug(), and DocumentationItem::setURL().

QStringList DocQtPlugin::fullTextSearchLocations  )  [virtual]
 

Implements DocumentationPlugin.

Definition at line 278 of file docqtplugin.cpp.

References KConfig::entryMap(), KConfigBase::readBoolEntry(), KConfigBase::readPathEntry(), and KConfigBase::setGroup().

bool DocQtPlugin::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 198 of file docqtplugin.cpp.

References QtDocumentationCatalogItem::dcfFile(), kdDebug(), KConfigBase::readDateTimeEntry(), KConfigBase::setGroup(), and KConfigBase::writeEntry().

QString DocQtPlugin::pluginName  )  const [virtual]
 

Returns the i18n name of the plugin.

Implements DocumentationPlugin.

Definition at line 193 of file docqtplugin.cpp.

void DocQtPlugin::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 161 of file docqtplugin.cpp.

References QtDocumentationCatalogItem::dcfFile(), KURL::isEmpty(), kdDebug(), DocumentationItem::setURL(), and DocumentationItem::url().


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 Wed Mar 23 00:23:37 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003