GRASS Programmer's Manual
6.4.3(2013)-r
|
This is the Frame containing the dialog for options input. More...
Public Member Functions | |
def | __init__ |
def | updateValuesHook |
Update status bar data. More... | |
def | OnKeyUp |
Key released (check hot-keys) More... | |
def | OnDone |
This function is launched from OnRun() when command is finished. More... | |
def | OnOK |
OK button pressed. More... | |
def | OnApply |
Apply the command. More... | |
def | OnRun |
Run the command. More... | |
def | OnAbort |
Abort running command. More... | |
def | OnCopy |
Copy the command. More... | |
def | OnCancel |
Cancel button pressed. More... | |
def | OnHelp |
Show manual page (switch to the 'Manual' notebook page) More... | |
def | createCmd |
Create command string (python list) More... | |
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 | |
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'.
def forms.TaskFrame.__init__ | ( | self, | |
parent, | |||
ID, | |||
task_description, | |||
get_dcmd = None , |
|||
layer = None |
|||
) |
def forms.TaskFrame.createCmd | ( | self, | |
ignoreErrors = False , |
|||
ignoreRequired = False |
|||
) |
Create command string (python list)
Definition at line 718 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 669 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 624 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(), dialogs.TextDialog.OnOk(), colorrules.ColorTable.OnOK(), forms.TaskFrame.OnOK(), dialogs.OptDialog.OnOk(), dialogs.TextDialog.OnSave(), preferences.NvizPreferencesDialog.OnSave(), and dialogs.OptDialog.OnSave().
def forms.TaskFrame.OnCancel | ( | self, | |
event | |||
) |
Cancel button pressed.
Definition at line 688 of file forms.py.
References forms.TaskFrame.get_dcmd, overlays.OverlayController.Hide(), 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, dialogs.GroupDialog.parent, model.ModelAction.parent, dialogs.ItemCheckListCtrl.parent, frame.ModelCanvas.parent, model.ModelData.parent, dialogs.MapLayersDialog.parent, model.ModelRelation.parent, frame.VariablePanel.parent, model.ModelItem.parent, dialogs.ImportDialog.parent, frame.ItemPanel.parent, frame.PythonPanel.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(), forms.TaskFrame.OnOK(), and dialogs.DxfImportDialog.OnRun().
def forms.TaskFrame.OnCopy | ( | self, | |
event | |||
) |
Copy the command.
Definition at line 675 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.
returncode | command's return code (0 for success) |
Definition at line 581 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, dialogs.GroupDialog.parent, model.ModelAction.parent, dialogs.ItemCheckListCtrl.parent, frame.ModelCanvas.parent, model.ModelData.parent, dialogs.MapLayersDialog.parent, model.ModelRelation.parent, frame.VariablePanel.parent, model.ModelItem.parent, dialogs.ImportDialog.parent, frame.ItemPanel.parent, frame.PythonPanel.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 709 of file forms.py.
Referenced by forms.TaskFrame.OnKeyUp().
def forms.TaskFrame.OnKeyUp | ( | self, | |
event | |||
) |
Key released (check hot-keys)
Definition at line 556 of file forms.py.
References forms.TaskFrame.OnAbort(), dialogs.ImportDialog.OnAbort(), dialogs.ModelDataDialog.OnCancel(), dialogs.DisplayAttributesDialog.OnCancel(), forms.TaskFrame.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 618 of file forms.py.
References forms.TaskFrame.get_dcmd, sqlbuilder.SQLFrame.OnApply(), preferences.PreferencesDialog.OnApply(), forms.TaskFrame.OnApply(), dialogs.GroupDialog.OnApply(), dialogs.SetOpacityDialog.OnApply(), manager.GrSettingsDialog.OnApply(), dialogs.ModelDataDialog.OnCancel(), dialogs.DisplayAttributesDialog.OnCancel(), and forms.TaskFrame.OnCancel().
def forms.TaskFrame.OnRun | ( | self, | |
event | |||
) |
Run the command.
Definition at line 641 of file forms.py.
References forms.TaskFrame.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, dialogs.GroupDialog.parent, model.ModelAction.parent, dialogs.ItemCheckListCtrl.parent, frame.ModelCanvas.parent, model.ModelData.parent, dialogs.MapLayersDialog.parent, model.ModelRelation.parent, frame.VariablePanel.parent, model.ModelItem.parent, dialogs.ImportDialog.parent, frame.ItemPanel.parent, frame.PythonPanel.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 |
|||
) |
forms.TaskFrame.btn_cancel |
Definition at line 434 of file forms.py.
Referenced by forms.TaskFrame.OnRun().
forms.TaskFrame.btn_clipboard |
Definition at line 461 of file forms.py.
Referenced by forms.TaskFrame.OnRun().
forms.TaskFrame.btn_help |
Definition at line 475 of file forms.py.
Referenced by forms.TaskFrame.OnRun().
forms.TaskFrame.btn_run |
Definition at line 455 of file forms.py.
Referenced by forms.TaskFrame.OnRun().
forms.TaskFrame.description |
Definition at line 406 of file forms.py.
Referenced by python.task.grassTask.get_description().
forms.TaskFrame.get_dcmd |
Definition at line 348 of file forms.py.
Referenced by forms.TaskFrame.OnApply(), forms.TaskFrame.OnCancel(), and forms.TaskFrame.OnOK().
forms.TaskFrame.goutput |
Definition at line 419 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 349 of file forms.py.
Referenced by colorrules.ColorTable.DoPreview(), forms.TaskFrame.OnApply(), forms.TaskFrame.OnCancel(), and histogram.HistogramFrame.SetHistLayer().
forms.TaskFrame.modeler |
Definition at line 353 of file forms.py.
Referenced by forms.TaskFrame.OnApply().
forms.TaskFrame.panel |
Definition at line 374 of file forms.py.
Referenced by prompt.GPromptPopUp.__init__(), prompt.GPromptSTC.__init__(), and prompt.GPrompt.GetPanel().
forms.TaskFrame.parent |
Definition at line 351 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(), mapwindow.GLWindow.OnLeftUp(), mapwindow.BufferedWindow.OnLeftUp(), frame.PsMapBufferedWindow.OnLeftUp(), goutput.GMConsole.OnOutputSave(), 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.standalone |
Definition at line 386 of file forms.py.
Referenced by forms.TaskFrame.OnRun().
forms.TaskFrame.task |
Definition at line 350 of file forms.py.
Referenced by python.task.processTask.get_task(), and forms.CmdPanel.OnUpdateSelection().