QgsHelp Class Reference

Helper class for showing help topic URI for the given key. More...

#include <qgshelp.h>

Static Public Member Functions
static QUrl	helpUrl (const QString &key)
	Returns URI of the help topic for the given key. More...
static void	openHelp (const QString &key)
	Opens help topic for the given help key using default system web browser. More...

Detailed Description

Helper class for showing help topic URI for the given key.

Help can be stored online, on the local directory or on the intranet server. Location of the QGIS help can be configured in QGIS options. Multiple locations are supported, they will be used in order of preference, from top to bottom.

URI construction takes in account following information:

• QGIS version
• language of the QGIS UI

If no help found, default error page with information how to setup help system will be shown.

Since

QGIS 3.0

Definition at line 44 of file qgshelp.h.

Member Function Documentation

helpUrl()

QUrl QgsHelp::helpUrl ( const QString &  key )

static

Returns URI of the help topic for the given key.

If help topic not found, URI of the builtin error page returned.

Parameters

key	key which identified help topic

Since

QGIS 3.0

Definition at line 41 of file qgshelp.cpp.

openHelp()

void QgsHelp::openHelp ( const QString &  key )

static

Opens help topic for the given help key using default system web browser.

If help topic not found, builtin error page shown.

Parameters

key	key which identified help topic

Since

QGIS 3.0

Definition at line 36 of file qgshelp.cpp.

---

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

• /build/qgis-3.20.0+99unstable/src/gui/qgshelp.h
• /build/qgis-3.20.0+99unstable/src/gui/qgshelp.cpp