QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Static Public Member Functions | Private Slots | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
QgsContextHelp Class Reference

Provides a context based help browser for a dialog. More...

#include <qgscontexthelp.h>

Inheritance diagram for QgsContextHelp:
Inheritance graph
[legend]
Collaboration diagram for QgsContextHelp:
Collaboration graph
[legend]

Static Public Member Functions

static void run (QString context)
 

Private Slots

void processExited ()
 
void error (QProcess::ProcessError error)
 

Private Member Functions

 QgsContextHelp ()
 Constructor. More...
 
 ~QgsContextHelp ()
 Destructor. More...
 
QProcess * start ()
 
void showContext (QString context)
 
void init ()
 

Private Attributes

QProcess * mProcess
 

Static Private Attributes

static QgsContextHelpgContextHelp = 0
 
static QHash< QString, QString > gContextHelpTexts
 

Detailed Description

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.

Definition at line 35 of file qgscontexthelp.h.

Constructor & Destructor Documentation

QgsContextHelp::QgsContextHelp ( )
private

Constructor.

Definition at line 43 of file qgscontexthelp.cpp.

References mProcess, and start().

Referenced by run().

QgsContextHelp::~QgsContextHelp ( )
private

Destructor.

Definition at line 48 of file qgscontexthelp.cpp.

References mProcess.

Member Function Documentation

void QgsContextHelp::error ( QProcess::ProcessError  error)
privateslot

Definition at line 81 of file qgscontexthelp.cpp.

References QgsMessageLog::logMessage(), and tr.

Referenced by start().

void QgsContextHelp::init ( )
private

Definition at line 6 of file qgscontexthelp_texts.cpp.

References gContextHelpTexts.

Referenced by showContext().

void QgsContextHelp::processExited ( )
privateslot

Definition at line 102 of file qgscontexthelp.cpp.

References gContextHelp.

Referenced by start().

void QgsContextHelp::run ( QString  context)
static
void QgsContextHelp::showContext ( QString  context)
private

Definition at line 86 of file qgscontexthelp.cpp.

References gContextHelpTexts, init(), mProcess, QgsApplication::reportStyleSheet(), and tr.

Referenced by run().

QProcess * QgsContextHelp::start ( )
private

Member Data Documentation

QgsContextHelp * QgsContextHelp::gContextHelp = 0
staticprivate

Definition at line 54 of file qgscontexthelp.h.

Referenced by processExited(), and run().

QHash< QString, QString > QgsContextHelp::gContextHelpTexts
staticprivate

Definition at line 57 of file qgscontexthelp.h.

Referenced by init(), and showContext().

QProcess* QgsContextHelp::mProcess
private

Definition at line 55 of file qgscontexthelp.h.

Referenced by QgsContextHelp(), showContext(), and ~QgsContextHelp().


The documentation for this class was generated from the following files: