KHelpClient Namespace Reference

Functions
void	invokeHelp (const QString &anchor=QString(), const QString &appname=QString())

Detailed Description

Provides utility functions for access to help manuals.

Function Documentation

invokeHelp()

void KHelpClient::invokeHelp	(	const QString &	anchor = QString(),
		const QString &	appname = QString() )

Invokes the KHelpCenter HTML help viewer from docbook sources.

The HTML file will be found using the X-DocPath entry in the application's desktop file. It can be either a relative path, or a website URL.

Parameters

anchor	This has to be a defined anchor in your docbook sources or website. If empty the main index is loaded.
appname	This allows you to specify the .desktop file to get the help path from. If empty the QCoreApplication::applicationName() is used.

Since

5.0

Definition at line 17 of file khelpclient.cpp.