forms.TaskFrame 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 333 of file forms.py.

---

Constructor & Destructor Documentation

def forms.TaskFrame.__init__	(		self,
			parent,
			ID,
			task_description,
			get_dcmd = None,
			layer = None
	)

Definition at line 348 of file forms.py.

---

Member Function Documentation

def forms.TaskFrame.createCmd	(		self,
			ignoreErrors = False,
			ignoreRequired = False
	)

Create command string (python list)

Definition at line 715 of file forms.py.

Referenced by forms.TaskFrame.OnApply(), forms.TaskFrame.OnCopy(), and forms.TaskFrame.OnRun().

def forms.TaskFrame.OnAbort	(		self,
			event
	)

Abort running command.

Definition at line 667 of file forms.py.

References frame.ModelFrame.goutput, and forms.TaskFrame.goutput.

Referenced by forms.TaskFrame.OnKeyUp().

def forms.TaskFrame.OnApply	(		self,
			event
	)

Apply the command.

Definition at line 622 of file forms.py.

References forms.TaskFrame.createCmd(), forms.TaskFrame.get_dcmd, sqlbuilder.SQLFrame.layer, manager.VirtualAttributeList.layer, forms.TaskFrame.layer, manager.AttributeManager.layer, and forms.TaskFrame.modeler.

Referenced by dialogs.VDigitCategoryDialog.OnOK(), colorrules.ColorTable.OnOK(), forms.TaskFrame.OnOK(), and preferences.NvizPreferencesDialog.OnSave().

def forms.TaskFrame.OnCancel	(		self,
			event
	)

Cancel button pressed.

Definition at line 685 of file forms.py.

References forms.TaskFrame.get_dcmd, statusbar.SbItem.Hide(), statusbar.SbTextItem.Hide(), sqlbuilder.SQLFrame.layer, manager.VirtualAttributeList.layer, forms.TaskFrame.layer, manager.AttributeManager.layer, sqlbuilder.SQLFrame.parent, dialogs.ModelDataDialog.parent, dialogs.DisplayAttributesDialog.parent, manager.Log.parent, frame.ModelFrame.parent, manager.VirtualAttributeList.parent, manager.GCPWizard.parent, dialogs.ModelSearchDialog.parent, forms.UpdateThread.parent, dialogs.ModelRelationDialog.parent, manager.LocationPage.parent, forms.UpdateQThread.parent, forms.TaskFrame.parent, dialogs.ModelItemDialog.parent, manager.GroupPage.parent, dialogs.DecorationDialog.parent, manager.AttributeManager.parent, dialogs.ModelListCtrl.parent, manager.DispMapPage.parent, dialogs.TextLayerDialog.parent, manager.GCP.parent, model.ModelAction.parent, dialogs.GroupDialog.parent, dialogs.ItemCheckListCtrl.parent, frame.ModelCanvas.parent, model.ModelData.parent, dialogs.MapLayersDialog.parent, model.ModelRelation.parent, frame.VariablePanel.parent, model.ModelItem.parent, frame.ItemPanel.parent, frame.PythonPanel.parent, dialogs.ImportDialog.parent, dialogs.LayersList.parent, dialogs.SetOpacityDialog.parent, dialogs.ImageSizeDialog.parent, model.ModelParamDialog.parent, manager.TableListCtrl.parent, manager.LayerListCtrl.parent, manager.GrSettingsDialog.parent, and manager.LayerBook.parent.

Referenced by colorrules.ColorTable.OnCloseWindow(), forms.TaskFrame.OnKeyUp(), dialogs.VDigitCategoryDialog.OnOK(), colorrules.ColorTable.OnOK(), and forms.TaskFrame.OnOK().

def forms.TaskFrame.OnCopy	(		self,
			event
	)

Copy the command.

Definition at line 672 of file forms.py.

References forms.TaskFrame.createCmd().

Referenced by toolbars.VDigitToolbar.OnAdditionalToolMenu(), and forms.TaskFrame.OnKeyUp().

def forms.TaskFrame.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 582 of file forms.py.

References sqlbuilder.SQLFrame.parent, dialogs.ModelDataDialog.parent, dialogs.DisplayAttributesDialog.parent, manager.Log.parent, frame.ModelFrame.parent, manager.VirtualAttributeList.parent, manager.GCPWizard.parent, dialogs.ModelSearchDialog.parent, forms.UpdateThread.parent, dialogs.ModelRelationDialog.parent, manager.LocationPage.parent, forms.UpdateQThread.parent, forms.TaskFrame.parent, dialogs.ModelItemDialog.parent, manager.GroupPage.parent, dialogs.DecorationDialog.parent, manager.AttributeManager.parent, dialogs.ModelListCtrl.parent, manager.DispMapPage.parent, dialogs.TextLayerDialog.parent, manager.GCP.parent, model.ModelAction.parent, dialogs.GroupDialog.parent, dialogs.ItemCheckListCtrl.parent, frame.ModelCanvas.parent, model.ModelData.parent, dialogs.MapLayersDialog.parent, model.ModelRelation.parent, frame.VariablePanel.parent, model.ModelItem.parent, frame.ItemPanel.parent, frame.PythonPanel.parent, dialogs.ImportDialog.parent, dialogs.LayersList.parent, dialogs.SetOpacityDialog.parent, dialogs.ImageSizeDialog.parent, model.ModelParamDialog.parent, manager.TableListCtrl.parent, manager.LayerListCtrl.parent, manager.GrSettingsDialog.parent, and manager.LayerBook.parent.

Referenced by vclean.VectorCleaningFrame.OnCleaningRun(), extensions.InstallExtensionWindow.OnInstall(), mcalc_builder.MapCalcFrame.OnMCalcRun(), and forms.TaskFrame.OnRun().

def forms.TaskFrame.OnHelp	(		self,
			event
	)

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

Definition at line 706 of file forms.py.

Referenced by forms.TaskFrame.OnKeyUp().

def forms.TaskFrame.OnKeyUp	(		self,
			event
	)

Key released (check hot-keys)

Definition at line 557 of file forms.py.

References forms.TaskFrame.OnAbort(), dialogs.ImportDialog.OnAbort(), dialogs.ModelDataDialog.OnCancel(), dialogs.DisplayAttributesDialog.OnCancel(), dialogs.DecorationDialog.OnCancel(), forms.TaskFrame.OnCancel(), dialogs.ImportDialog.OnCancel(), forms.TaskFrame.OnCopy(), frame.ModelFrame.OnHelp(), forms.TaskFrame.OnHelp(), gis_set.GRASSStartup.OnHelp(), manager.GCP.OnHelp(), forms.TaskFrame.OnRun(), frame.PythonPanel.OnRun(), dialogs.ImportDialog.OnRun(), dialogs.GdalImportDialog.OnRun(), and dialogs.DxfImportDialog.OnRun().

def forms.TaskFrame.OnOK	(		self,
			event
	)

OK button pressed.

Definition at line 616 of file forms.py.

References forms.TaskFrame.get_dcmd, preferences.PreferencesDialog.OnApply(), sqlbuilder.SQLFrame.OnApply(), forms.TaskFrame.OnApply(), dialogs.GroupDialog.OnApply(), manager.GrSettingsDialog.OnApply(), dialogs.ModelDataDialog.OnCancel(), dialogs.DisplayAttributesDialog.OnCancel(), dialogs.DecorationDialog.OnCancel(), forms.TaskFrame.OnCancel(), and dialogs.ImportDialog.OnCancel().

def forms.TaskFrame.OnRun	(		self,
			event
	)

Run the command.

Definition at line 639 of file forms.py.

References forms.TaskFrame.btn_cancel, dialogs.ImportDialog.btn_cancel, forms.TaskFrame.btn_clipboard, forms.TaskFrame.btn_help, forms.TaskFrame.btn_run, dialogs.ImportDialog.btn_run, forms.TaskFrame.createCmd(), frame.ModelFrame.OnDone(), forms.TaskFrame.OnDone(), frame.PythonPanel.OnDone(), sqlbuilder.SQLFrame.parent, dialogs.ModelDataDialog.parent, dialogs.DisplayAttributesDialog.parent, manager.Log.parent, frame.ModelFrame.parent, manager.VirtualAttributeList.parent, manager.GCPWizard.parent, dialogs.ModelSearchDialog.parent, forms.UpdateThread.parent, dialogs.ModelRelationDialog.parent, manager.LocationPage.parent, forms.UpdateQThread.parent, forms.TaskFrame.parent, dialogs.ModelItemDialog.parent, manager.GroupPage.parent, dialogs.DecorationDialog.parent, manager.AttributeManager.parent, dialogs.ModelListCtrl.parent, manager.DispMapPage.parent, dialogs.TextLayerDialog.parent, manager.GCP.parent, model.ModelAction.parent, dialogs.GroupDialog.parent, dialogs.ItemCheckListCtrl.parent, frame.ModelCanvas.parent, model.ModelData.parent, dialogs.MapLayersDialog.parent, model.ModelRelation.parent, frame.VariablePanel.parent, model.ModelItem.parent, frame.ItemPanel.parent, frame.PythonPanel.parent, dialogs.ImportDialog.parent, dialogs.LayersList.parent, dialogs.SetOpacityDialog.parent, dialogs.ImageSizeDialog.parent, model.ModelParamDialog.parent, manager.TableListCtrl.parent, manager.LayerListCtrl.parent, manager.GrSettingsDialog.parent, manager.LayerBook.parent, and forms.TaskFrame.standalone.

Referenced by ghelp.MenuTreeWindow.OnItemActivated(), and forms.TaskFrame.OnKeyUp().

def forms.TaskFrame.updateValuesHook	(		self,
			event = None
	)

Update status bar data.

Definition at line 551 of file forms.py.

---

Field Documentation

forms.TaskFrame.addbox

Definition at line 497 of file forms.py.

forms.TaskFrame.btn_cancel

Definition at line 435 of file forms.py.

Referenced by forms.TaskFrame.OnRun().

forms.TaskFrame.btn_clipboard

Definition at line 462 of file forms.py.

Referenced by forms.TaskFrame.OnRun().

forms.TaskFrame.btn_help

Definition at line 476 of file forms.py.

Referenced by forms.TaskFrame.OnRun().

forms.TaskFrame.btn_run

Definition at line 456 of file forms.py.

Referenced by forms.TaskFrame.OnRun().

forms.TaskFrame.closebox

Definition at line 512 of file forms.py.

forms.TaskFrame.description

Definition at line 407 of file forms.py.

Referenced by python.task.grassTask.get_description().

forms.TaskFrame.get_dcmd

Definition at line 349 of file forms.py.

Referenced by forms.TaskFrame.OnApply(), forms.TaskFrame.OnCancel(), and forms.TaskFrame.OnOK().

forms.TaskFrame.goutput

Definition at line 420 of file forms.py.

Referenced by frame.GMFrame.GetLogWindow(), forms.TaskFrame.OnAbort(), frame.GMFrame.OnDone(), frame.GMFrame.OnNewVector(), and frame.GMFrame.OnShowAttributeTable().

forms.TaskFrame.layer

Definition at line 350 of file forms.py.

Referenced by colorrules.ColorTable.DoPreview(), forms.TaskFrame.OnApply(), forms.TaskFrame.OnCancel(), and histogram.HistogramFrame.SetHistLayer().

forms.TaskFrame.locale

Definition at line 373 of file forms.py.

forms.TaskFrame.logo

Definition at line 395 of file forms.py.

forms.TaskFrame.modeler

Definition at line 354 of file forms.py.

Referenced by forms.TaskFrame.OnApply().

forms.TaskFrame.notebookpanel

Definition at line 418 of file forms.py.

forms.TaskFrame.panel

Definition at line 375 of file forms.py.

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

forms.TaskFrame.parent

Definition at line 352 of file forms.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(), forms.TaskFrame.OnCancel(), forms.TaskFrame.OnDone(), frame.PsMapBufferedWindow.OnLeftUp(), forms.TaskFrame.OnRun(), toolbars.VDigitToolbar.OnSelectMap(), gselect.GdalSelect.OnSetDsn(), toolbars.LMNvizToolbar.OnSettings(), toolbars.VDigitToolbar.OnSettings(), toolbars.BaseToolbar.OnTool(), forms.CmdPanel.OnUpdateSelection(), 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().

forms.TaskFrame.requestQ

Definition at line 536 of file forms.py.

forms.TaskFrame.resultQ

Definition at line 537 of file forms.py.

forms.TaskFrame.standalone

Definition at line 387 of file forms.py.

Referenced by forms.TaskFrame.OnRun().

forms.TaskFrame.task

Definition at line 351 of file forms.py.

Referenced by python.task.processTask.get_task(), and forms.CmdPanel.OnUpdateSelection().

forms.TaskFrame.updateThread

Definition at line 538 of file forms.py.

---

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

• forms.py