DocDevHelpPlugin Class Reference

#include <docdevhelpplugin.h>

Inheritance diagram for DocDevHelpPlugin:

[legend]Collaboration diagram for DocDevHelpPlugin:


Public Member Functions
	DocDevHelpPlugin (QObject parent, const char name, const QStringList args=QStringList())
	~DocDevHelpPlugin ()
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 void	setCatalogURL (DocumentationCatalogItem *item)
	Sets the URL to the catalog.
virtual void	createTOC (DocumentationCatalogItem *item)
	Creates a table of contents for given catalog.
virtual DocumentationCatalogItem *	createCatalog (KListView *contents, const QString &title, const QString &url)
	Creates documentation catalog with given title and url.
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 void	autoSetupPlugin ()
	Plugin specific automatic setup code.
virtual QPair< KFile::Mode, QString >	catalogLocatorProps ()
	Returns a mode and a filter for catalog locator dialogs.
virtual ProjectDocumentationPlugin *	projectDocumentationPlugin (ProjectDocType type)
	Returns associated project documentation plugin.
Protected Member Functions
void	pushToScanStack (QValueStack< QString > &stack, const QString &value)
void	scanDevHelpDir (const QString &path)
void	addTocSect (DocumentationItem *parent, QDomElement childEl, QString baseUrl, bool book=false)

Constructor & Destructor Documentation

DocDevHelpPlugin::DocDevHelpPlugin ( QObject * parent,

const char * name,

const QStringList args = QStringList()

)

DocDevHelpPlugin::~DocDevHelpPlugin ( )

Definition at line 71 of file docdevhelpplugin.cpp.

void DocDevHelpPlugin::addTocSect ( DocumentationItem * parent,

QDomElement childEl,

QString baseUrl,

bool book = false

) [protected]

Definition at line 309 of file docdevhelpplugin.cpp.
References DocumentationItem::setURL().
Referenced by createTOC().

void DocDevHelpPlugin::autoSetupPlugin ( ) [virtual]

Plugin specific automatic setup code.
This method is called by autoSetup.
Implements DocumentationPlugin.
Definition at line 149 of file docdevhelpplugin.cpp.
References pushToScanStack(), and scanDevHelpDir().

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

Returns a mode and a filter for catalog locator dialogs.

Implements DocumentationPlugin.
Definition at line 80 of file docdevhelpplugin.cpp.

QString DocDevHelpPlugin::catalogTitle ( const QString & url ) [virtual]

Returns a title of catalog defined by an url parameter.

Implements DocumentationPlugin.
Definition at line 85 of file docdevhelpplugin.cpp.
Referenced by scanDevHelpDir().

DocumentationCatalogItem * DocDevHelpPlugin::createCatalog ( KListView * contents,

const QString & title,

const QString & url

) [virtual]

Creates documentation catalog with given title and url.

Implements DocumentationPlugin.
Definition at line 75 of file docdevhelpplugin.cpp.

void DocDevHelpPlugin::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 236 of file docdevhelpplugin.cpp.
References IndexItemProto::addURL(), DevHelpDocumentationCatalogItem::devHelpFile(), DocumentationPlugin::IndexItemProto, and kdDebug().

void DocDevHelpPlugin::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 278 of file docdevhelpplugin.cpp.
References addTocSect(), DevHelpDocumentationCatalogItem::devHelpFile(), and kdDebug().

bool DocDevHelpPlugin::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 131 of file docdevhelpplugin.cpp.
References DevHelpDocumentationCatalogItem::devHelpFile(), kdDebug(), KConfigBase::readDateTimeEntry(), KConfigBase::setGroup(), and KConfigBase::writeEntry().

QString DocDevHelpPlugin::pluginName ( ) const [virtual]

Returns the i18n name of the plugin.

Implements DocumentationPlugin.
Definition at line 105 of file docdevhelpplugin.cpp.

ProjectDocumentationPlugin * DocDevHelpPlugin::projectDocumentationPlugin ( ProjectDocType type ) [virtual]

Returns associated project documentation plugin.
Default implementation returns zero. Reimplement this if the documentation plugin can also handle project documentation.
Reimplemented from DocumentationPlugin.
Definition at line 365 of file docdevhelpplugin.cpp.
References DocumentationPlugin::projectDocumentationPlugin().

void DocDevHelpPlugin::pushToScanStack ( QValueStack< QString > & stack,

const QString & value

) [protected]

Definition at line 227 of file docdevhelpplugin.cpp.
References kdDebug().
Referenced by autoSetupPlugin().

void DocDevHelpPlugin::scanDevHelpDir ( const QString & path ) [protected]

Definition at line 205 of file docdevhelpplugin.cpp.
References catalogTitle(), KConfigBase::setGroup(), and KConfigBase::writePathEntry().
Referenced by autoSetupPlugin().

void DocDevHelpPlugin::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 333 of file docdevhelpplugin.cpp.
References DevHelpDocumentationCatalogItem::devHelpFile(), KURL::isEmpty(), kdDebug(), DocumentationItem::setURL(), and DocumentationItem::url().

The documentation for this class was generated from the following files: