GRASS Programmer's Manual
6.4.2(2012)
|
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 |
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.
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.
def gui_modules.ghelp.HelpWindow.fillContentsFromFile | ( | self, | |
htmlFile, | |||
skip_description = True |
|||
) |
Load content from file.
Definition at line 1324 of file ghelp.py.
References gui_modules.ghelp.HelpWindow.fspath, gui_modules.ghelp.HelpWindow.loaded, gui_modules.psmap.PsMapBufferedWindow.SetPage(), and gui_modules.nviz_tools.NvizToolWindow.SetPage().
def gui_modules.ghelp.HelpWindow.OnLinkClicked | ( | self, | |
linkinfo | |||
) |
Definition at line 1314 of file ghelp.py.
References gui_modules.ghelp.HelpWindow.fspath, and gui_modules.ghelp.HelpWindow.historyIdx.
gui_modules.ghelp.HelpWindow.fspath |
Definition at line 1294 of file ghelp.py.
Referenced by gui_modules.ghelp.HelpWindow.fillContentsFromFile(), and gui_modules.ghelp.HelpWindow.OnLinkClicked().
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().
gui_modules.ghelp.HelpWindow.parent |
Definition at line 1286 of file ghelp.py.
Referenced by gui_modules.gmodeler.ModelLoop.__init__(), gui_modules.wxvdigit.VDigitError.Database(), gui_modules.wxvdigit.VDigitError.DbExecute(), gui_modules.wxvdigit.VDigitError.DbLink(), gui_modules.wxvdigit.VDigitError.DeadLine(), gui_modules.wxvdigit.VDigitError.Driver(), gui_modules.wxvdigit.VDigitError.FeatureType(), gui_modules.wxvdigit.VDigitError.NoMap(), gui_modules.menuform.mainFrame.OnCancel(), gui_modules.menuform.mainFrame.OnDone(), gui_modules.gmodeler.ModelFrame.OnHelp(), wxgui.GMFrame.OnPsMap(), gui_modules.menuform.mainFrame.OnRun(), gui_modules.toolbars.VDigitToolbar.OnSelectMap(), gui_modules.gselect.GdalSelect.OnSetDsn(), gui_modules.toolbars.VDigitToolbar.OnSettings(), gui_modules.toolbars.NvizToolbar.OnSettings(), gui_modules.toolbars.AbstractToolbar.OnTool(), gui_modules.menuform.cmdPanel.OnUpdateSelection(), gui_modules.toolbars.VDigitToolbar.OnZBulk(), gui_modules.wxvdigit.VDigitError.ReadLine(), gui_modules.goutput.CmdThread.run(), gui_modules.menuform.UpdateQThread.run(), gui_modules.goutput.GMConsole.RunCmd(), gui_modules.toolbars.VDigitToolbar.StopEditing(), gui_modules.mapdisp_window.BufferedWindow.UpdateMap(), and gui_modules.wxvdigit.VDigitError.WriteLine().