QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
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
43
class
GUI_EXPORT
QgsHelp
44
{
45
public
:
51
static
void
openHelp
(
const
QString &key );
52
58
static
QUrl
helpUrl
(
const
QString &key );
59
60
private
:
66
static
bool
urlExists(
const
QString &url );
67
};
68
69
#endif
// QGSHELP_H
QgsHelp
Helper class for showing help topic URI for the given key.
Definition
qgshelp.h:44
QgsHelp::helpUrl
static QUrl helpUrl(const QString &key)
Returns URI of the help topic for the given key.
Definition
qgshelp.cpp:46
QgsHelp::openHelp
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Definition
qgshelp.cpp:41
Generated on
for QGIS API Documentation by
1.17.0