-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgscontexthelp.h
64 lines (52 loc) · 2.13 KB
/
qgscontexthelp.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/***************************************************************************
qgscontexthelp.h
Display context help for a dialog by invoking the
QgsHelpViewer
-------------------
begin : 2005-06-19
copyright : (C) 2005 by Gary E.Sherman
email : sherman at mrcc.com
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSCONTEXTHELP_H
#define QGSCONTEXTHELP_H
#include <QObject>
#include <QHash>
#include <QProcess>
#include "qgis_core.h"
/** \ingroup core
* Provides a context based help browser for a dialog.
*
* The help text is stored in SQLite and accessed by a context identifier
* unique to each dialog. This is a singleton class which invokes the help
* viewer using QProcess and ensures that only one viewer is open.
* The viewer will be terminated if open when the main application quits.
*
*/
class CORE_EXPORT QgsContextHelp : public QObject
{
Q_OBJECT
public:
static void run( const QString& context );
private slots:
void processExited();
void error( QProcess::ProcessError error );
private:
//! Constructor
QgsContextHelp();
~QgsContextHelp();
QProcess *start();
void showContext( const QString& context );
static QgsContextHelp *gContextHelp; // Singleton instance
QProcess *mProcess;
static QHash<QString, QString> gContextHelpTexts;
void init();
};
#endif //QGSCONTEXTHELP_H