QGIS/python/core/qgscontexthelp.sip

24 lines
611 B
Plaintext
Raw Normal View History

2014-05-27 23:22:50 +02:00
/** \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 QgsContextHelp : QObject
{
%TypeHeaderCode
#include <qgscontexthelp.h>
%End
public:
static void run( const QString& context );
private:
//! Constructor
2014-05-27 23:22:50 +02:00
QgsContextHelp();
//! Destructor
~QgsContextHelp();
};