GRASS Programmer's Manual  6.4.2(2012)
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
gui_modules.ghelp.HelpWindow Class Reference

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

Public Member Functions

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

Data Fields

 parent
 loaded
 FIXME: calling LoadPage() is strangely time-consuming (only first call) self.LoadPage(self.fspath + grass_command + ".html")
 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 1266 of file ghelp.py.

Constructor & Destructor Documentation

def gui_modules.ghelp.HelpWindow.__init__ (   self,
  parent,
  grass_command,
  text,
  skip_description,
  kwargs 
)

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

If 'skip_description' 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 1274 of file ghelp.py.

Member Function Documentation

def gui_modules.ghelp.HelpWindow.fillContentsFromFile (   self,
  htmlFile,
  skip_description = True 
)
def gui_modules.ghelp.HelpWindow.OnLinkClicked (   self,
  linkinfo 
)

Field Documentation

gui_modules.ghelp.HelpWindow.fspath
gui_modules.ghelp.HelpWindow.history

Definition at line 1292 of file ghelp.py.

gui_modules.ghelp.HelpWindow.historyIdx

Definition at line 1293 of file ghelp.py.

Referenced by gui_modules.ghelp.HelpWindow.OnLinkClicked().

gui_modules.ghelp.HelpWindow.loaded

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

Definition at line 1291 of file ghelp.py.

Referenced by gui_modules.ghelp.HelpWindow.fillContentsFromFile().


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