KHelpClient

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
anchorThis has to be a defined anchor in your docbook sources or website. If empty the main index is loaded.
appnameThis 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.

This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Jan 30 2023 03:55:06 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.