Create and manage output console for commands run by GUI. More...

Public Member Functions
def	__init__
def	MakeSearchPaneContent
	Create search pane.
def	OnSearchPaneChanged
	Collapse search module box.
def	GetPanel
	Get panel.
def	Redirect
	Redirect stdout/stderr.
def	WriteLog
	Generic method for writing log message in given style.
def	WriteCmdLog
	Write message in selected style.
def	WriteWarning
	Write message in warning style.
def	WriteError
	Write message in error style.
def	RunCmd
	Run command typed into console command prompt (GPrompt).
def	ClearHistory
	Clear history of commands.
def	GetProgressBar
	Return progress bar widget.
def	GetLog
	Get widget used for logging.
def	SaveHistory
	Save history of commands.
def	GetCmd
	Get running command or None.
def	SetCopyingOfSelectedText
	Enable or disable copying of selected text in to clipboard.
def	OnUpdateStatusBar
	Update statusbar text.
def	OnCmdOutput
	Print command output.
def	OnCmdProgress
	Update progress message info.
def	OnCmdAbort
	Abort running command.
def	OnCmdRun
	Run command.
def	OnCmdPrepare
	Prepare for running command.
def	OnCmdDone
	Command done (or aborted)
def	OnProcessPendingOutputWindowEvents
def	ResetFocus
	Reset focus.
Data Fields
	panelOutput
	panelPrompt
	parent
	lineWidth
	linePos
	requestQ
	resultQ
	progressbar
	cmdOutput
	cmdOutputTimer
	cmdPrompt
	search
	infoCollapseLabelExp
	infoCollapseLabelCol
	searchPane
	cmdStdOut
	cmdStdErr
	cmdThread
	outputBox
	cmdBox
	btnOutputClear
	btnCmdClear
	btnOutputSave
	btnCmdAbort
	history
	linepos

Detailed Description

Create and manage output console for commands run by GUI.

Definition at line 183 of file goutput.py.

Constructor & Destructor Documentation

def goutput.GMConsole.__init__	(	self,
		parent,
		id = `wx.ID_ANY`,
		margin = `False`,
		notebook = `None`,
		style = `wx.TAB_TRAVERSAL \| wx.FULL_REPAINT_ON_RESIZE`,
		kwargs
	)

Definition at line 189 of file goutput.py.

References render.Layer.SetName(), and model.ModelRelation.SetName().

Member Function Documentation

def goutput.GMConsole.ClearHistory	(	self,
		event
	)

Clear history of commands.

Definition at line 608 of file goutput.py.

def goutput.GMConsole.GetCmd ( self )

Get running command or None.

Definition at line 655 of file goutput.py.

Referenced by wxnviz.ImageTexture.Corresponds().

def goutput.GMConsole.GetLog	(	self,
		err = `False`
	)

Get widget used for logging.

Parameters:

err	True to get stderr widget

Definition at line 619 of file goutput.py.

References goutput.GMConsole.cmdStdErr, and goutput.GMConsole.cmdStdOut.

def goutput.GMConsole.GetPanel	(	self,
		prompt = `True`
	)

Get panel.

Parameters:

prompt get prompt / output panel

Returns:: wx.Panel reference

Definition at line 360 of file goutput.py.

References goutput.GMConsole.panelOutput, and goutput.GMConsole.panelPrompt.

def goutput.GMConsole.GetProgressBar ( self )

Return progress bar widget.

Definition at line 615 of file goutput.py.

References goutput.GMConsole.progressbar.

Referenced by mapdisplay.MapFrame.OnUpdateProgress(), and frame.MapFrame.OnUpdateProgress().

def goutput.GMConsole.MakeSearchPaneContent	(	self,
		pane
	)

Create search pane.

Definition at line 338 of file goutput.py.

References ghelp.SearchModuleWindow.cmdPrompt, goutput.GMConsole.cmdPrompt, ghelp.SearchModuleWindow.search, dialogs.ModelSearchDialog.search, ghelp.MenuTreeWindow.search, and goutput.GMConsole.search.

def goutput.GMConsole.OnCmdAbort	(	self,
		event
	)

Abort running command.

Definition at line 749 of file goutput.py.

def goutput.GMConsole.OnCmdDone	(	self,
		event
	)

Command done (or aborted)

Definition at line 768 of file goutput.py.

References utils.GetLayerNameFromCmd(), goutput.GMConsole.Redirect(), goutput.GMConsole.WriteCmdLog(), and goutput.GMConsole.WriteLog().

def goutput.GMConsole.OnCmdOutput	(	self,
		event
	)

Print command output.

Definition at line 682 of file goutput.py.

References goutput.GMConsole.linepos.

def goutput.GMConsole.OnCmdPrepare	(	self,
		event
	)

Prepare for running command.

Definition at line 761 of file goutput.py.

def goutput.GMConsole.OnCmdProgress	(	self,
		event
	)

Update progress message info.

Definition at line 745 of file goutput.py.

def goutput.GMConsole.OnCmdRun	(	self,
		event
	)

Run command.

Definition at line 753 of file goutput.py.

References goutput.GMConsole.WriteCmdLog().

def goutput.GMConsole.OnProcessPendingOutputWindowEvents	(	self,
		event
	)

Definition at line 904 of file goutput.py.

def goutput.GMConsole.OnSearchPaneChanged	(	self,
		event
	)

Collapse search module box.

Definition at line 350 of file goutput.py.

References goutput.GMConsole.infoCollapseLabelCol, and goutput.GMConsole.infoCollapseLabelExp.

def goutput.GMConsole.OnUpdateStatusBar	(	self,
		event
	)

Update statusbar text.

Definition at line 672 of file goutput.py.

Referenced by prompt.GPromptPopUp.__init__(), and prompt.GPrompt.OnRunCmd().

def goutput.GMConsole.Redirect ( self )

Redirect stdout/stderr.

Definition at line 372 of file goutput.py.

References goutput.GMConsole.cmdStdErr, goutput.GMConsole.cmdStdOut, and goutput.GMConsole.WriteLog().

Referenced by goutput.GMConsole.OnCmdDone().

def goutput.GMConsole.ResetFocus ( self )

Reset focus.

Definition at line 907 of file goutput.py.

def goutput.GMConsole.RunCmd	(	self,
		command,
		compReg = `True`,
		switchPage = `False`,
		skipInterface = `False`,
		onDone = `None`,
		onPrepare = `None`,
		userData = `None`
	)

Run command typed into console command prompt (GPrompt).

Todo:: Display commands (*.d) are captured and processed separately by mapdisp.py. Display commands are rendered in map display widget that currently has the focus (as indicted by mdidx).

Parameters:

command	command given as a list (produced e.g. by utils.split())
compReg	True use computation region
switchPage	switch to output page
skipInterface	True to do not launch GRASS interface parser when command has no arguments given
onDone	function to be called when command is finished
onPrepare	function to be called before command is launched
userData	data defined for the command