GRASS Programmer's Manual  6.4.4(2014)-r
forms.TaskFrame Class Reference

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

Inheritance diagram for forms.TaskFrame:
Collaboration diagram for forms.TaskFrame:

Public Member Functions

def __init__
 
def updateValuesHook
 Update status bar data. More...
 
def OnKeyUp (self, event)
 Key released (check hot-keys) More...
 
def OnDone (self, cmd, returncode)
 This function is launched from OnRun() when command is finished. More...
 
def OnOK (self, event)
 OK button pressed. More...
 
def OnApply (self, event)
 Apply the command. More...
 
def OnRun (self, event)
 Run the command. More...
 
def OnAbort (self, event)
 Abort running command. More...
 
def OnCopy (self, event)
 Copy the command. More...
 
def OnCancel (self, event)
 Cancel button pressed. More...
 
def OnHelp (self, event)
 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
 

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

Constructor & Destructor Documentation

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

Definition at line 347 of file forms.py.

Member Function Documentation

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.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.

Parameters
returncodecommand'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.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 
)

Update status bar data.

Definition at line 550 of file forms.py.

Field Documentation

forms.TaskFrame.addbox

Definition at line 496 of file forms.py.

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.closebox

Definition at line 511 of file forms.py.

forms.TaskFrame.description

Definition at line 406 of file forms.py.

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

forms.TaskFrame.get_dcmd
forms.TaskFrame.locale

Definition at line 372 of file forms.py.

forms.TaskFrame.logo

Definition at line 394 of file forms.py.

forms.TaskFrame.modeler

Definition at line 353 of file forms.py.

Referenced by forms.TaskFrame.OnApply().

forms.TaskFrame.notebookpanel

Definition at line 417 of file forms.py.

forms.TaskFrame.panel
forms.TaskFrame.requestQ

Definition at line 535 of file forms.py.

forms.TaskFrame.resultQ

Definition at line 536 of file forms.py.

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().

forms.TaskFrame.updateThread

Definition at line 537 of file forms.py.


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