DocKDevTOCPlugin Class Reference
#include <dockdevtocplugin.h>
Inheritance diagram for DocKDevTOCPlugin:


Public Member Functions | |
DocKDevTOCPlugin (QObject *parent, const char *name, const QStringList args=QStringList()) | |
~DocKDevTOCPlugin () | |
virtual QString | pluginName () const |
Returns the i18n name of the plugin. | |
virtual QString | catalogTitle (const QString &url) |
Returns a title of catalog defined by an url parameter. | |
virtual DocumentationCatalogItem * | createCatalog (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 void | autoSetupPlugin () |
Plugin specific automatic setup code. | |
Protected Member Functions | |
void | addTocSect (DocumentationItem *parent, QDomElement childEl, const QString &base, uint level) |
Static Protected Member Functions | |
QString | constructURL (const QString &base, const QString &url) |
Constructor & Destructor Documentation
|
|
|
Definition at line 73 of file dockdevtocplugin.cpp. |
Member Function Documentation
|
Definition at line 212 of file dockdevtocplugin.cpp. References constructURL(), and DocumentationItem::setURL(). Referenced by createTOC(). |
|
Plugin specific automatic setup code. This method is called by autoSetup. Implements DocumentationPlugin. Definition at line 123 of file dockdevtocplugin.cpp. References catalogTitle(), KConfigBase::setGroup(), and KConfigBase::writePathEntry(). |
|
Returns a mode and a filter for catalog locator dialogs.
Implements DocumentationPlugin. Definition at line 87 of file dockdevtocplugin.cpp. |
|
Returns a title of catalog defined by an url parameter.
Implements DocumentationPlugin. Definition at line 92 of file dockdevtocplugin.cpp. Referenced by autoSetupPlugin(). |
|
Definition at line 266 of file dockdevtocplugin.cpp. Referenced by addTocSect(), createIndex(), and setCatalogURL(). |
|
Creates documentation catalog with given title and url.
Implements DocumentationPlugin. Definition at line 82 of file dockdevtocplugin.cpp. |
|
Builds index for given catalog. This method should fill index with IndexItem objects.
Implements DocumentationPlugin. Definition at line 134 of file dockdevtocplugin.cpp. References IndexItemProto::addURL(), constructURL(), DocumentationPlugin::IndexItemProto, kdDebug(), and TOCDocumentationCatalogItem::tocFile(). |
|
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 179 of file dockdevtocplugin.cpp. References addTocSect(), kdDebug(), and TOCDocumentationCatalogItem::tocFile(). |
|
Implements DocumentationPlugin. Definition at line 113 of file dockdevtocplugin.cpp. |
|
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 118 of file dockdevtocplugin.cpp. |
|
Returns the i18n name of the plugin.
Implements DocumentationPlugin. Definition at line 77 of file dockdevtocplugin.cpp. |
|
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 231 of file dockdevtocplugin.cpp. References constructURL(), KURL::isEmpty(), kdDebug(), DocumentationItem::setURL(), TOCDocumentationCatalogItem::tocFile(), and DocumentationItem::url(). |
The documentation for this class was generated from the following files:
- parts/documentation/plugins/kdevtoc/dockdevtocplugin.h
- parts/documentation/plugins/kdevtoc/dockdevtocplugin.cpp