-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/** \ingroup core | ||
* \class QgsHelp | ||
* @brief 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. | ||
* | ||
* This class can be created directly, or accessed via | ||
* QgsApplication::helpViewer(). | ||
* | ||
* @note added in QGIS 3.0 | ||
*/ | ||
class QgsHelp : QObject | ||
{ | ||
%TypeHeaderCode | ||
#include <qgshelp.h> | ||
%End | ||
|
||
public: | ||
|
||
/** Constructor for QgsHelp. | ||
* @param parent parent QObject | ||
*/ | ||
QgsHelp( QObject* parent = nullptr ); | ||
|
||
virtual ~QgsHelp(); | ||
|
||
/** 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 | ||
* @note added in QGIS 3.0 | ||
*/ | ||
void openHelp( const QString& key ) const; | ||
|
||
/** 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 | ||
* @note added in QGIS 3.0 | ||
*/ | ||
QUrl helpUrl( const QString& key ) const; | ||
}; |