QGIS API Documentation  3.23.0-Master (22c16f2067)
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 "qgis_gui.h"
20 
21 #include <QString>
22 #include <QUrl>
23 
44 class GUI_EXPORT QgsHelp
45 {
46  public:
47 
54  static void openHelp( const QString &key );
55 
62  static QUrl helpUrl( const QString &key );
63 
64  private:
65 
72  static bool urlExists( const QString &url );
73 };
74 
75 #endif // QGSHELP_H
Helper class for showing help topic URI for the given key.
Definition: qgshelp.h:45