← Back to branch summary

~ubuntu-branches/ubuntu/wily/qgis/wily

« back to all changes in this revision

Viewing changes to python/core/qgscontexthelp.sip

  • Committer: Bazaar Package Importer
  • Author(s): Johan Van de Wauw
  • Date: 2010-07-11 20:23:24 UTC
  • mfrom: (3.1.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100711202324-5ktghxa7hracohmr
Tags: 1.4.0+12730-3ubuntu1
https://launchpad.net/bugs/540941
* Merge from Debian unstable (LP: #540941).
* Fix compilation issues with QT 4.7
* Add build-depends on libqt4-webkit-dev 

Show diffs side-by-side

added added

removed removed

Lines of Context:
python/core/qgscontexthelp.sip
 
1
/*!
 
2
 * \class QgsContextHelp
 
3
 * \brief Provides a context based help browser for a dialog.
 
4
 *
 
5
 * The help text is stored in SQLite and accessed by a context identifier
 
6
 * unique to each dialog. This is a singleton class which invokes the help
 
7
 * viewer using QProcess and ensures that only one viewer is open.
 
8
 * The viewer will be terminated if open when the main application quits.
 
9
 *
 
10
 * If the compile-time flag QGSCONTEXTHELP_REUSE is defined, the help viewer
 
11
 * will be reused if it is still open. If this flag is not set, the viewer
 
12
 * process will be terminated if open and restarted; this makes it the top
 
13
 * window for window managers such as Linux/GNOME which will make a window
 
14
 * active but not bring it to the top if raised programatically.
 
15
 */
 
16
class QgsContextHelp : QObject
 
17
{
 
18
%TypeHeaderCode
 
19
#include <qgscontexthelp.h>
 
20
%End
 
21
 
 
22
public:
 
23
  static void run(QString context);
 
24
 
 
25
private:
 
26
  //! Constructor
 
27
  QgsContextHelp(QString context);
 
28
 
 
29
  //! Destructor
 
30
  ~QgsContextHelp();
 
31
};