QGIS API Documentation  3.17.0-Master (a035f434f4)
qgshelp.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgshelp.h
3  --------------------------------------
4  Date : December 2016
5  Copyright : (C) 2016 by Alexander Bruy
6  Email : alexander dot bruy at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSHELP_H
17 #define QGSHELP_H
18 
19 #include <QtCore>
20 
21 #include "qgis_gui.h"
22 
43 class GUI_EXPORT QgsHelp
44 {
45  public:
46 
53  static void openHelp( const QString &key );
54 
61  static QUrl helpUrl( const QString &key );
62 
63  private:
64 
71  static bool urlExists( const QString &url );
72 };
73 
74 #endif // QGSHELP_H
Helper class for showing help topic URI for the given key.
Definition: qgshelp.h:43