DocCHMPlugin Class Reference
#include <docchmplugin.h>
Inheritance diagram for DocCHMPlugin:


Public Member Functions | |
DocCHMPlugin (QObject *parent, const char *name, QStringList args=QStringList()) | |
~DocCHMPlugin () | |
virtual QString | pluginName () const |
Returns the i18n name of the plugin. | |
virtual void | setCatalogURL (DocumentationCatalogItem *item) |
Sets the URL to the catalog. | |
virtual QString | catalogTitle (const QString &url) |
Returns a title of catalog defined by an url parameter. | |
virtual QPair< KFile::Mode, QString > | catalogLocatorProps () |
Returns a mode and a filter for catalog locator dialogs. | |
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 | createIndex (IndexBox *index, DocumentationCatalogItem *item) |
Builds index for given catalog. | |
virtual bool | needRefreshIndex (DocumentationCatalogItem *item) |
Indicates if an index of given catalog should be rebuilt. | |
virtual QStringList | fullTextSearchLocations () |
virtual void | autoSetupPlugin () |
Plugin specific automatic setup code. |
Constructor & Destructor Documentation
|
|
|
Definition at line 43 of file docchmplugin.cpp. |
Member Function Documentation
|
Plugin specific automatic setup code. This method is called by autoSetup. Implements DocumentationPlugin. Definition at line 79 of file docchmplugin.cpp. |
|
Returns a mode and a filter for catalog locator dialogs.
Implements DocumentationPlugin. Definition at line 54 of file docchmplugin.cpp. |
|
Returns a title of catalog defined by an url parameter.
Implements DocumentationPlugin. Definition at line 59 of file docchmplugin.cpp. |
|
Creates documentation catalog with given title and url.
Implements DocumentationPlugin. Definition at line 47 of file docchmplugin.cpp. References DocumentationPlugin::DocumentationCatalogItem, and DocumentationItem::setURL(). |
|
Builds index for given catalog. This method should fill index with IndexItem objects.
Implements DocumentationPlugin. Definition at line 84 of file docchmplugin.cpp. |
|
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 89 of file docchmplugin.cpp. |
|
Implements DocumentationPlugin. Definition at line 69 of file docchmplugin.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 74 of file docchmplugin.cpp. |
|
Returns the i18n name of the plugin.
Implements DocumentationPlugin. Definition at line 64 of file docchmplugin.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 94 of file docchmplugin.cpp. References KURL::addPath(), KURL::setProtocol(), DocumentationItem::setURL(), and DocumentationItem::url(). |
The documentation for this class was generated from the following files:
- parts/documentation/plugins/chm/docchmplugin.h
- parts/documentation/plugins/chm/docchmplugin.cpp