QGIS/python/gui/auto_generated/qgshelp.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgshelp.h                                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/




class QgsHelp
{
%Docstring
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.

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgshelp.h"
%End
  public:

    static void openHelp( const QString &key );
%Docstring
Opens help topic for the given help key using default system
web browser. If help topic not found, builtin error page shown.

:param key: key which identified help topic

.. versionadded:: 3.0
%End

    static QUrl helpUrl( const QString &key );
%Docstring
Returns URI of the help topic for the given key. If help topic
not found, URI of the builtin error page returned.

:param key: key which identified help topic

.. versionadded:: 3.0
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgshelp.h                                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/