mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-23 00:02:38 -05:00
bbd36b107f
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@6415 c8812cc2-4d05-0410-92ff-de0c093fc19c
33 lines
987 B
Plaintext
33 lines
987 B
Plaintext
/*!
|
|
* \class QgsContextHelp
|
|
* \brief 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.
|
|
*
|
|
* If the compile-time flag QGSCONTEXTHELP_REUSE is defined, the help viewer
|
|
* will be reused if it is still open. If this flag is not set, the viewer
|
|
* process will be terminated if open and restarted; this makes it the top
|
|
* window for window managers such as Linux/GNOME which will make a window
|
|
* active but not bring it to the top if raised programatically.
|
|
*/
|
|
class QgsContextHelp : QObject
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgscontexthelp.h>
|
|
%End
|
|
|
|
public:
|
|
static void run(int contextId);
|
|
|
|
private:
|
|
//! Constructor
|
|
QgsContextHelp(int contextId);
|
|
//! Destructor
|
|
~QgsContextHelp();
|
|
|
|
};
|
|
|