gui_modules.menuform.mainFrame Class Reference

This is the Frame containing the dialog for options input. More...

Public Member Functions
def	__init__
def	updateValuesHook
	Update status bar data.
def	OnKeyUp
	Key released (check hot-keys)
def	OnDone
	This function is launched from OnRun() when command is finished.
def	OnOK
	OK button pressed.
def	OnApply
	Apply the command.
def	OnRun
	Run the command.
def	OnAbort
	Abort running command.
def	OnCopy
	Copy the command.
def	OnCancel
	Cancel button pressed.
def	OnHelp
	Show manual page (switch to the 'Manual' notebook page)
def	createCmd
	Create command string (python list)

Data Fields
	get_dcmd
	layer
	task
	parent
	modeler
	locale
	panel
	standalone
	logo
	description
	notebookpanel
	goutput
	btn_cancel
	btn_run
	btn_clipboard
	btn_help
	addbox
	closebox
	requestQ
	resultQ
	updateThread

---

Detailed Description

This is the Frame containing the dialog for options input.

The dialog is organized in a notebook according to the guisections defined by each GRASS command.

If run with a parent, it may Apply, Ok or Cancel; the latter two close the dialog. The former two trigger a callback.

If run standalone, it will allow execution of the command.

The command is checked and sent to the clipboard when clicking 'Copy'.

Definition at line 340 of file menuform.py.

---

Constructor & Destructor Documentation

def gui_modules.menuform.mainFrame.__init__	(		self,
			parent,
			ID,
			task_description,
			get_dcmd = None,
			layer = None
	)

Definition at line 355 of file menuform.py.

---

Member Function Documentation

def gui_modules.menuform.mainFrame.createCmd	(		self,
			ignoreErrors = False,
			ignoreRequired = False
	)

Create command string (python list)

Definition at line 719 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnApply(), gui_modules.menuform.mainFrame.OnCopy(), and gui_modules.menuform.mainFrame.OnRun().

def gui_modules.menuform.mainFrame.OnAbort	(		self,
			event
	)

Abort running command.

Definition at line 671 of file menuform.py.

References gui_modules.menuform.mainFrame.goutput, and gui_modules.gmodeler.ModelFrame.goutput.

Referenced by gui_modules.menuform.mainFrame.OnKeyUp().

def gui_modules.menuform.mainFrame.OnApply	(		self,
			event
	)

Apply the command.

Definition at line 626 of file menuform.py.

References gui_modules.menuform.mainFrame.createCmd(), gui_modules.menuform.mainFrame.get_dcmd, gui_modules.dbm.VirtualAttributeList.layer, gui_modules.colorrules.ColorTable.layer, gui_modules.histogram.HistFrame.layer, gui_modules.menuform.mainFrame.layer, gui_modules.dbm.AttributeManager.layer, and gui_modules.menuform.mainFrame.modeler.

Referenced by gui_modules.menuform.mainFrame.OnOK(), gui_modules.vdigit.VDigitCategoryDialog.OnOK(), gui_modules.nviz_preferences.NvizPreferencesDialog.OnSave(), and gui_modules.nviz_tools.NvizPreferencesDialog.OnSave().

def gui_modules.menuform.mainFrame.OnCancel	(		self,
			event
	)

Cancel button pressed.

Definition at line 689 of file menuform.py.

References gui_modules.menuform.mainFrame.get_dcmd, gui_modules.dbm.VirtualAttributeList.layer, gui_modules.colorrules.ColorTable.layer, gui_modules.histogram.HistFrame.layer, gui_modules.menuform.mainFrame.layer, gui_modules.dbm.AttributeManager.layer, gui_modules.menu.Menu.parent, gui_modules.mapdisp_command.Command.parent, gui_modules.gpyshell.PyShellWindow.parent, gui_modules.mcalc_builder.MapCalcFrame.parent, gui_modules.colorrules.ColorTable.parent, gui_modules.histogram.BufferedWindow.parent, gui_modules.dbm_dialogs.DisplayAttributesDialog.parent, gui_modules.mapdisp_window.MapWindow.parent, gui_modules.dbm.Log.parent, gui_modules.goutput.CmdThread.parent, gui_modules.dbm.VirtualAttributeList.parent, gui_modules.gcpmapdisp.MapFrame.parent, gui_modules.gcpmanager.GCPWizard.parent, gui_modules.mapdisp.MapFrame.parent, gui_modules.menuform.UpdateThread.parent, gui_modules.goutput.GMConsole.parent, gui_modules.ghelp.MenuTreeWindow.parent, gui_modules.location_wizard.CoordinateSystemPage.parent, gui_modules.menuform.UpdateQThread.parent, gui_modules.gcpmanager.LocationPage.parent, gui_modules.menuform.mainFrame.parent, gui_modules.location_wizard.ProjectionsPage.parent, gui_modules.gcpmanager.GroupPage.parent, gui_modules.ghelp.MenuTree.parent, gui_modules.gdialogs.DecorationDialog.parent, gui_modules.dbm.AttributeManager.parent, gui_modules.gcpmanager.DispMapPage.parent, gui_modules.gmodeler.ModelFrame.parent, gui_modules.gselect.LayerSelect.parent, gui_modules.location_wizard.ProjParamsPage.parent, gui_modules.gdialogs.TextLayerDialog.parent, gui_modules.colorrules.BufferedWindow.parent, gui_modules.gcpmanager.GCP.parent, gui_modules.ghelp.InstallExtensionWindow.parent, gui_modules.gdialogs.AddMapLayersDialog.parent, gui_modules.location_wizard.DatumPage.parent, gui_modules.goutput.GMStdout.parent, gui_modules.goutput.GMStderr.parent, gui_modules.goutput.GMStc.parent, gui_modules.location_wizard.EllipsePage.parent, gui_modules.ghelp.ExtensionTree.parent, gui_modules.gdialogs.ImportDialog.parent, gui_modules.gselect.GdalSelect.parent, gui_modules.ghelp.UninstallExtensionWindow.parent, gui_modules.ghelp.CheckListExtension.parent, gui_modules.location_wizard.EPSGPage.parent, gui_modules.ghelp.HelpWindow.parent, gui_modules.gdialogs.LayersList.parent, gui_modules.location_wizard.CustomPage.parent, gui_modules.gdialogs.SetOpacityDialog.parent, gui_modules.location_wizard.SummaryPage.parent, gui_modules.gmodeler.ModelCanvas.parent, gui_modules.gdialogs.StaticWrapText.parent, gui_modules.gmodeler.ModelAction.parent, gui_modules.gdialogs.ImageSizeDialog.parent, gui_modules.location_wizard.LocationWizard.parent, gui_modules.gmodeler.ModelData.parent, gui_modules.gmodeler.ModelDataDialog.parent, gui_modules.location_wizard.RegionDef.parent, gui_modules.dbm.TableListCtrl.parent, gui_modules.dbm.LayerListCtrl.parent, gui_modules.dbm.LayerBook.parent, gui_modules.gcpmanager.GrSettingsDialog.parent, gui_modules.gmodeler.ModelSearchDialog.parent, gui_modules.gmodeler.ModelRelation.parent, gui_modules.gmodeler.ModelRelationDialog.parent, gui_modules.gmodeler.ModelParamDialog.parent, gui_modules.gmodeler.ModelListCtrl.parent, gui_modules.gmodeler.VariablePanel.parent, gui_modules.gmodeler.ModelItem.parent, gui_modules.gmodeler.ModelItemDialog.parent, gui_modules.gmodeler.ItemPanel.parent, and gui_modules.gmodeler.ItemCheckListCtrl.parent.

Referenced by gui_modules.menuform.mainFrame.OnKeyUp(), gui_modules.menuform.mainFrame.OnOK(), and gui_modules.vdigit.VDigitCategoryDialog.OnOK().

def gui_modules.menuform.mainFrame.OnCopy	(		self,
			event
	)

Copy the command.

Definition at line 676 of file menuform.py.

References gui_modules.menuform.mainFrame.createCmd().

Referenced by gui_modules.toolbars.VDigitToolbar.OnAdditionalToolMenu(), and gui_modules.menuform.mainFrame.OnKeyUp().

def gui_modules.menuform.mainFrame.OnDone	(		self,
			cmd,
			returncode
	)

This function is launched from OnRun() when command is finished.

Parameters:

returncode

command's return code (0 for success)

Definition at line 586 of file menuform.py.

References gui_modules.render.map, gui_modules.menu.Menu.parent, gui_modules.gpyshell.PyShellWindow.parent, gui_modules.mapdisp_command.Command.parent, gui_modules.mcalc_builder.MapCalcFrame.parent, gui_modules.colorrules.ColorTable.parent, gui_modules.histogram.BufferedWindow.parent, gui_modules.dbm_dialogs.DisplayAttributesDialog.parent, gui_modules.mapdisp_window.MapWindow.parent, gui_modules.dbm.Log.parent, gui_modules.goutput.CmdThread.parent, gui_modules.dbm.VirtualAttributeList.parent, gui_modules.gcpmapdisp.MapFrame.parent, gui_modules.gcpmanager.GCPWizard.parent, gui_modules.mapdisp.MapFrame.parent, gui_modules.menuform.UpdateThread.parent, gui_modules.goutput.GMConsole.parent, gui_modules.ghelp.MenuTreeWindow.parent, gui_modules.location_wizard.CoordinateSystemPage.parent, gui_modules.menuform.UpdateQThread.parent, gui_modules.gcpmanager.LocationPage.parent, gui_modules.menuform.mainFrame.parent, gui_modules.location_wizard.ProjectionsPage.parent, gui_modules.gcpmanager.GroupPage.parent, gui_modules.ghelp.MenuTree.parent, gui_modules.gdialogs.DecorationDialog.parent, gui_modules.dbm.AttributeManager.parent, gui_modules.gcpmanager.DispMapPage.parent, gui_modules.gmodeler.ModelFrame.parent, gui_modules.gselect.LayerSelect.parent, gui_modules.location_wizard.ProjParamsPage.parent, gui_modules.gdialogs.TextLayerDialog.parent, gui_modules.colorrules.BufferedWindow.parent, gui_modules.gcpmanager.GCP.parent, gui_modules.ghelp.InstallExtensionWindow.parent, gui_modules.gdialogs.AddMapLayersDialog.parent, gui_modules.location_wizard.DatumPage.parent, gui_modules.goutput.GMStdout.parent, gui_modules.goutput.GMStderr.parent, gui_modules.goutput.GMStc.parent, gui_modules.location_wizard.EllipsePage.parent, gui_modules.ghelp.ExtensionTree.parent, gui_modules.gdialogs.ImportDialog.parent, gui_modules.gselect.GdalSelect.parent, gui_modules.ghelp.UninstallExtensionWindow.parent, gui_modules.ghelp.CheckListExtension.parent, gui_modules.location_wizard.EPSGPage.parent, gui_modules.ghelp.HelpWindow.parent, gui_modules.gdialogs.LayersList.parent, gui_modules.location_wizard.CustomPage.parent, gui_modules.gdialogs.SetOpacityDialog.parent, gui_modules.location_wizard.SummaryPage.parent, gui_modules.gmodeler.ModelCanvas.parent, gui_modules.gdialogs.StaticWrapText.parent, gui_modules.gmodeler.ModelAction.parent, gui_modules.gdialogs.ImageSizeDialog.parent, gui_modules.location_wizard.LocationWizard.parent, gui_modules.gmodeler.ModelData.parent, gui_modules.gmodeler.ModelDataDialog.parent, gui_modules.location_wizard.RegionDef.parent, gui_modules.dbm.TableListCtrl.parent, gui_modules.dbm.LayerListCtrl.parent, gui_modules.dbm.LayerBook.parent, gui_modules.gcpmanager.GrSettingsDialog.parent, gui_modules.gmodeler.ModelSearchDialog.parent, gui_modules.gmodeler.ModelRelation.parent, gui_modules.gmodeler.ModelRelationDialog.parent, gui_modules.gmodeler.ModelParamDialog.parent, gui_modules.gmodeler.ModelListCtrl.parent, gui_modules.gmodeler.VariablePanel.parent, gui_modules.gmodeler.ModelItem.parent, gui_modules.gmodeler.ModelItemDialog.parent, gui_modules.gmodeler.ItemPanel.parent, and gui_modules.gmodeler.ItemCheckListCtrl.parent.

Referenced by gui_modules.menuform.mainFrame.OnRun().

def gui_modules.menuform.mainFrame.OnHelp	(		self,
			event
	)

Show manual page (switch to the 'Manual' notebook page)

Definition at line 710 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnKeyUp().

def gui_modules.menuform.mainFrame.OnKeyUp	(		self,
			event
	)

Key released (check hot-keys)

Definition at line 561 of file menuform.py.

References gui_modules.menuform.mainFrame.OnAbort(), gui_modules.gdialogs.ImportDialog.OnAbort(), gui_modules.dbm_dialogs.DisplayAttributesDialog.OnCancel(), gui_modules.colorrules.ColorTable.OnCancel(), gui_modules.gdialogs.DecorationDialog.OnCancel(), gui_modules.menuform.mainFrame.OnCancel(), gui_modules.gdialogs.ImportDialog.OnCancel(), gui_modules.gmodeler.ModelDataDialog.OnCancel(), gui_modules.location_wizard.RegionDef.OnCancel(), gui_modules.menuform.mainFrame.OnCopy(), gui_modules.mcalc_builder.MapCalcFrame.OnHelp(), gui_modules.colorrules.ColorTable.OnHelp(), gui_modules.menuform.mainFrame.OnHelp(), gis_set.GRASSStartup.OnHelp(), gui_modules.gmodeler.ModelFrame.OnHelp(), gui_modules.gcpmanager.GCP.OnHelp(), gui_modules.ghelp.MenuTreeWindow.OnRun(), gui_modules.menuform.mainFrame.OnRun(), gui_modules.gdialogs.ImportDialog.OnRun(), gui_modules.gdialogs.GdalImportDialog.OnRun(), and gui_modules.gdialogs.DxfImportDialog.OnRun().

def gui_modules.menuform.mainFrame.OnOK	(		self,
			event
	)

OK button pressed.

Definition at line 620 of file menuform.py.

References gui_modules.menuform.mainFrame.get_dcmd, gui_modules.colorrules.ColorTable.OnApply(), gui_modules.menuform.mainFrame.OnApply(), gui_modules.gcpmanager.GrSettingsDialog.OnApply(), gui_modules.gmodeler.PreferencesDialog.OnApply(), gui_modules.dbm_dialogs.DisplayAttributesDialog.OnCancel(), gui_modules.colorrules.ColorTable.OnCancel(), gui_modules.gdialogs.DecorationDialog.OnCancel(), gui_modules.menuform.mainFrame.OnCancel(), gui_modules.gdialogs.ImportDialog.OnCancel(), gui_modules.gmodeler.ModelDataDialog.OnCancel(), and gui_modules.location_wizard.RegionDef.OnCancel().

def gui_modules.menuform.mainFrame.OnRun	(		self,
			event
	)

Run the command.

Definition at line 643 of file menuform.py.

References gui_modules.menuform.mainFrame.btn_cancel, gui_modules.gdialogs.ImportDialog.btn_cancel, gui_modules.menuform.mainFrame.btn_clipboard, gui_modules.mcalc_builder.MapCalcFrame.btn_help, gui_modules.menuform.mainFrame.btn_help, gui_modules.mcalc_builder.MapCalcFrame.btn_run, gui_modules.menuform.mainFrame.btn_run, gui_modules.gdialogs.ImportDialog.btn_run, gui_modules.menuform.mainFrame.createCmd(), gui_modules.mcalc_builder.MapCalcFrame.OnDone(), gui_modules.menuform.mainFrame.OnDone(), gui_modules.ghelp.InstallExtensionWindow.OnDone(), gui_modules.gmodeler.ModelFrame.OnDone(), gui_modules.menu.Menu.parent, gui_modules.mapdisp_command.Command.parent, gui_modules.gpyshell.PyShellWindow.parent, gui_modules.mcalc_builder.MapCalcFrame.parent, gui_modules.colorrules.ColorTable.parent, gui_modules.histogram.BufferedWindow.parent, gui_modules.dbm_dialogs.DisplayAttributesDialog.parent, gui_modules.mapdisp_window.MapWindow.parent, gui_modules.dbm.Log.parent, gui_modules.goutput.CmdThread.parent, gui_modules.dbm.VirtualAttributeList.parent, gui_modules.gcpmapdisp.MapFrame.parent, gui_modules.gcpmanager.GCPWizard.parent, gui_modules.mapdisp.MapFrame.parent, gui_modules.menuform.UpdateThread.parent, gui_modules.goutput.GMConsole.parent, gui_modules.ghelp.MenuTreeWindow.parent, gui_modules.location_wizard.CoordinateSystemPage.parent, gui_modules.menuform.UpdateQThread.parent, gui_modules.gcpmanager.LocationPage.parent, gui_modules.menuform.mainFrame.parent, gui_modules.location_wizard.ProjectionsPage.parent, gui_modules.gcpmanager.GroupPage.parent, gui_modules.ghelp.MenuTree.parent, gui_modules.gdialogs.DecorationDialog.parent, gui_modules.dbm.AttributeManager.parent, gui_modules.gcpmanager.DispMapPage.parent, gui_modules.gmodeler.ModelFrame.parent, gui_modules.gselect.LayerSelect.parent, gui_modules.location_wizard.ProjParamsPage.parent, gui_modules.gdialogs.TextLayerDialog.parent, gui_modules.colorrules.BufferedWindow.parent, gui_modules.gcpmanager.GCP.parent, gui_modules.ghelp.InstallExtensionWindow.parent, gui_modules.gdialogs.AddMapLayersDialog.parent, gui_modules.location_wizard.DatumPage.parent, gui_modules.goutput.GMStdout.parent, gui_modules.goutput.GMStderr.parent, gui_modules.goutput.GMStc.parent, gui_modules.location_wizard.EllipsePage.parent, gui_modules.ghelp.ExtensionTree.parent, gui_modules.gdialogs.ImportDialog.parent, gui_modules.gselect.GdalSelect.parent, gui_modules.ghelp.UninstallExtensionWindow.parent, gui_modules.ghelp.CheckListExtension.parent, gui_modules.location_wizard.EPSGPage.parent, gui_modules.ghelp.HelpWindow.parent, gui_modules.gdialogs.LayersList.parent, gui_modules.location_wizard.CustomPage.parent, gui_modules.gdialogs.SetOpacityDialog.parent, gui_modules.location_wizard.SummaryPage.parent, gui_modules.gmodeler.ModelCanvas.parent, gui_modules.gdialogs.StaticWrapText.parent, gui_modules.gmodeler.ModelAction.parent, gui_modules.gdialogs.ImageSizeDialog.parent, gui_modules.location_wizard.LocationWizard.parent, gui_modules.gmodeler.ModelData.parent, gui_modules.gmodeler.ModelDataDialog.parent, gui_modules.location_wizard.RegionDef.parent, gui_modules.dbm.TableListCtrl.parent, gui_modules.dbm.LayerListCtrl.parent, gui_modules.dbm.LayerBook.parent, gui_modules.gcpmanager.GrSettingsDialog.parent, gui_modules.gmodeler.ModelSearchDialog.parent, gui_modules.gmodeler.ModelRelation.parent, gui_modules.gmodeler.ModelRelationDialog.parent, gui_modules.gmodeler.ModelParamDialog.parent, gui_modules.gmodeler.ModelListCtrl.parent, gui_modules.gmodeler.VariablePanel.parent, gui_modules.gmodeler.ModelItem.parent, gui_modules.gmodeler.ModelItemDialog.parent, gui_modules.gmodeler.ItemPanel.parent, gui_modules.gmodeler.ItemCheckListCtrl.parent, and gui_modules.menuform.mainFrame.standalone.

Referenced by gui_modules.menuform.mainFrame.OnKeyUp().

def gui_modules.menuform.mainFrame.updateValuesHook	(		self,
			event = None
	)

Update status bar data.

Definition at line 555 of file menuform.py.

---

Field Documentation

gui_modules.menuform.mainFrame.addbox

Definition at line 501 of file menuform.py.

gui_modules.menuform.mainFrame.btn_cancel

Definition at line 442 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnRun().

gui_modules.menuform.mainFrame.btn_clipboard

Definition at line 466 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnRun().

gui_modules.menuform.mainFrame.btn_help

Definition at line 480 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnRun().

gui_modules.menuform.mainFrame.btn_run

Definition at line 462 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnRun().

gui_modules.menuform.mainFrame.closebox

Definition at line 516 of file menuform.py.

gui_modules.menuform.mainFrame.description

Definition at line 414 of file menuform.py.

Referenced by python.task.grassTask.get_description(), and icons.icon.MetaIcon.GetDesc().

gui_modules.menuform.mainFrame.get_dcmd

Definition at line 356 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnApply(), gui_modules.menuform.mainFrame.OnCancel(), and gui_modules.menuform.mainFrame.OnOK().

gui_modules.menuform.mainFrame.goutput

Definition at line 427 of file menuform.py.

Referenced by wxgui.GMFrame.GetLogWindow(), gui_modules.menuform.mainFrame.OnAbort(), wxgui.GMFrame.OnDone(), wxgui.GMFrame.OnNewVector(), and wxgui.GMFrame.OnShowAttributeTable().

gui_modules.menuform.mainFrame.layer

Definition at line 357 of file menuform.py.

Referenced by gui_modules.sqlbuilder.SQLFrame.OnAddValue(), gui_modules.menuform.mainFrame.OnApply(), gui_modules.menuform.mainFrame.OnCancel(), and gui_modules.sqlbuilder.SQLFrame.OnUniqueValues().

gui_modules.menuform.mainFrame.locale

Definition at line 380 of file menuform.py.

gui_modules.menuform.mainFrame.logo

Definition at line 402 of file menuform.py.

gui_modules.menuform.mainFrame.modeler

Definition at line 361 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnApply().

gui_modules.menuform.mainFrame.notebookpanel

Definition at line 425 of file menuform.py.

gui_modules.menuform.mainFrame.panel

Definition at line 382 of file menuform.py.

Referenced by gui_modules.prompt.GPromptPopUp.__init__(), gui_modules.prompt.GPromptSTC.__init__(), and gui_modules.prompt.GPrompt.GetPanel().

gui_modules.menuform.mainFrame.parent

Definition at line 359 of file menuform.py.

Referenced by 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(), wxgui.GMFrame.OnPsMap(), gui_modules.menuform.mainFrame.OnRun(), gui_modules.toolbars.VDigitToolbar.OnSelectMap(), 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.toolbars.VDigitToolbar.StopEditing(), and gui_modules.wxvdigit.VDigitError.WriteLine().

gui_modules.menuform.mainFrame.requestQ

Definition at line 540 of file menuform.py.

gui_modules.menuform.mainFrame.resultQ

Definition at line 541 of file menuform.py.

gui_modules.menuform.mainFrame.standalone

Definition at line 394 of file menuform.py.

Referenced by gui_modules.menuform.mainFrame.OnRun().

gui_modules.menuform.mainFrame.task

Definition at line 358 of file menuform.py.

Referenced by python.task.processTask.get_task(), and gui_modules.menuform.cmdPanel.OnUpdateSelection().

gui_modules.menuform.mainFrame.updateThread

Definition at line 542 of file menuform.py.

---

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

• menuform.py