ghelp.HelpWindow Class Reference

This panel holds the text from GRASS docs. More...

Inheritance diagram for ghelp.HelpWindow:

Collaboration diagram for ghelp.HelpWindow:

Public Member Functions
def	__init__
	If command is given, the corresponding HTML help file will be presented, with all links pointing to absolute paths of local files. More...
def	OnLinkClicked
def	fillContentsFromFile
	Load content from file. More...

Data Fields
	parent
	loaded
	FIXME: calling LoadPage() is strangely time-consuming (only first call) self.LoadPage(self.fspath + command + ".html") More...
	history
	historyIdx
	fspath

Detailed Description

This panel holds the text from GRASS docs.

GISBASE must be set in the environment to find the html docs dir. The SYNOPSIS section is skipped, since this Panel is supposed to be integrated into the cmdPanel and options are obvious there.

Definition at line 578 of file ghelp.py.

Constructor & Destructor Documentation

def ghelp.HelpWindow.__init__	(		self,
			parent,
			command,
			text,
			skipDescription,
			kwargs
	)

If command is given, the corresponding HTML help file will be presented, with all links pointing to absolute paths of local files.

If 'skipDescription' is True, the HTML corresponding to SYNOPSIS will be skipped, thus only presenting the help file from the DESCRIPTION section onwards.

If 'text' is given, it must be the HTML text to be presented in the Panel.

Definition at line 586 of file ghelp.py.

Member Function Documentation

def ghelp.HelpWindow.fillContentsFromFile	(		self,
			htmlFile,
			skipDescription = True
	)

Load content from file.

Definition at line 636 of file ghelp.py.

References ghelp.HelpWindow.fspath, ghelp.HelpWindow.loaded, and frame.PsMapBufferedWindow.SetPage().

def ghelp.HelpWindow.OnLinkClicked	(		self,
			linkinfo
	)

Definition at line 626 of file ghelp.py.

References ghelp.HelpWindow.fspath, and ghelp.HelpWindow.historyIdx.

Field Documentation

ghelp.HelpWindow.fspath

Definition at line 606 of file ghelp.py.

Referenced by ghelp.HelpWindow.fillContentsFromFile(), and ghelp.HelpWindow.OnLinkClicked().

ghelp.HelpWindow.history

Definition at line 604 of file ghelp.py.

ghelp.HelpWindow.historyIdx

Definition at line 605 of file ghelp.py.

Referenced by ghelp.HelpWindow.OnLinkClicked().

ghelp.HelpWindow.loaded

FIXME: calling LoadPage() is strangely time-consuming (only first call) self.LoadPage(self.fspath + command + ".html")

Definition at line 603 of file ghelp.py.

Referenced by ghelp.HelpWindow.fillContentsFromFile().

ghelp.HelpWindow.parent

Definition at line 598 of file ghelp.py.

Referenced by wxdigit.VDigitError.Database(), wxdigit.VDigitError.DbExecute(), wxdigit.VDigitError.DbLink(), wxdigit.VDigitError.DeadLine(), wxdigit.VDigitError.Driver(), wxdigit.VDigitError.FeatureType(), colorrules.RulesPanel.LoadRules(), wxdigit.VDigitError.NoMap(), mapwindow.GLWindow.OnLeftUp(), mapwindow.BufferedWindow.OnLeftUp(), frame.PsMapBufferedWindow.OnLeftUp(), goutput.GMConsole.OnOutputSave(), toolbars.VDigitToolbar.OnSelectMap(), gselect.GdalSelect.OnSetDsn(), toolbars.LMNvizToolbar.OnSettings(), toolbars.VDigitToolbar.OnSettings(), toolbars.BaseToolbar.OnTool(), toolbars.VDigitToolbar.OnZBulk(), wxdigit.VDigitError.ReadLine(), goutput.CmdThread.run(), goutput.GMConsole.RunCmd(), toolbars.VDigitToolbar.StopEditing(), colorrules.VectorColorTable.UpdateColorColumn(), mapwindow.BufferedWindow.UpdateMap(), and wxdigit.VDigitError.WriteLine().

---

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

• ghelp.py