QgsHelp class

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

Contents

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.

Public static functions

static auto helpUrl(const QString& key) -> QUrl
Returns URI of the help topic for the given key.
static void openHelp(const QString& key)
Opens help topic for the given help key using default system web browser.

Function documentation

static QUrl QgsHelp::helpUrl(const QString& key)

Returns URI of the help topic for the given key.

Parameters
key key which identified help topic

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

static void QgsHelp::openHelp(const QString& key)

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

Parameters
key key which identified help topic

If help topic not found, builtin error page shown.