QGIS/python/core/qgscontexthelp.sip
Nyall Dawson c49b5b777f Change a lot of arguments to const references in core/gui
Rationale:
- there was a lot of large objects passed by value, so potentially
there's a speed bump from this
- even for implicitly shared classes like QString/QList there's still
a (small) cost for copying the objects when there's no reason to
- it's the right thing to do!
2015-10-07 12:02:04 +11:00

24 lines
611 B
Plaintext

/** \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
QgsContextHelp();
//! Destructor
~QgsContextHelp();
};