GRASS Programmer's Manual  6.4.3(2013)-r
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
forms.CmdPanel Class Reference

A panel containing a notebook dividing in tabs the different guisections of the GRASS cmd. More...

Inheritance diagram for forms.CmdPanel:
Collaboration diagram for forms.CmdPanel:

Public Member Functions

def __init__
 
def OnFileLoad
 Load file to interactive input. More...
 
def OnFileSave
 Save interactive input to the file. More...
 
def OnFileText
 
def OnUpdateDialog
 
def OnVerbosity
 Verbosity level changed. More...
 
def OnPageChange
 
def OnColorChange
 
def OnUpdateValues
 If we were part of a richer interface, report back the current command being built. More...
 
def OnCheckBoxMulti
 Fill the values as a ','-separated string according to current status of the checkboxes. More...
 
def OnSetValue
 Retrieve the widget value and set the task value field accordingly. More...
 
def OnSetSymbol
 Shows dialog for symbol selection. More...
 
def OnUpdateSelection
 Update dialog (layers, tables, columns, etc.) More...
 
def createCmd
 Produce a command line string (list) or feeding into GRASS. More...
 
def OnSize
 

Data Fields

 parent
 
 task
 
 label_id
 
 notebook
 
 goutput
 add 'command output' tab regardless standalone dialog More...
 
 outpage
 
 manual_tab
 
 panelMinHeight
 
 constrained_size
 

Detailed Description

A panel containing a notebook dividing in tabs the different guisections of the GRASS cmd.

Definition at line 723 of file forms.py.

Constructor & Destructor Documentation

def forms.CmdPanel.__init__ (   self,
  parent,
  task,
  id = wx.ID_ANY,
  frame = None,
  args,
  kwargs 
)

Definition at line 727 of file forms.py.

Member Function Documentation

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

Produce a command line string (list) or feeding into GRASS.

Parameters
ignoreErrorsTrue then it will return whatever has been built so far, even though it would not be a correct command for GRASS

Definition at line 1785 of file forms.py.

def forms.CmdPanel.OnCheckBoxMulti (   self,
  event 
)

Fill the values as a ','-separated string according to current status of the checkboxes.

Definition at line 1671 of file forms.py.

def forms.CmdPanel.OnColorChange (   self,
  event 
)

Definition at line 1628 of file forms.py.

References widgets.GetValue(), and forms.CmdPanel.OnUpdateValues().

def forms.CmdPanel.OnFileLoad (   self,
  event 
)

Load file to interactive input.

Definition at line 1502 of file forms.py.

References widgets.GetValue(), and widgets.SetValue().

def forms.CmdPanel.OnFileSave (   self,
  event 
)

Save interactive input to the file.

Definition at line 1530 of file forms.py.

References widgets.GetValue(), and widgets.SetValue().

def forms.CmdPanel.OnFileText (   self,
  event 
)
File input interactively entered

Definition at line 1566 of file forms.py.

def forms.CmdPanel.OnPageChange (   self,
  event 
)

Definition at line 1612 of file forms.py.

def forms.CmdPanel.OnSetSymbol (   self,
  event 
)

Shows dialog for symbol selection.

Definition at line 1742 of file forms.py.

References forms.CmdPanel.OnUpdateValues().

def forms.CmdPanel.OnSetValue (   self,
  event 
)

Retrieve the widget value and set the task value field accordingly.

Use for widgets that have a proper GetValue() method, i.e. not for selectors.

Definition at line 1704 of file forms.py.

References forms.CmdPanel.OnUpdateValues().

def forms.CmdPanel.OnSize (   self,
  event 
)

Definition at line 1806 of file forms.py.

References forms.CmdPanel.label_id, and max.

def forms.CmdPanel.OnUpdateDialog (   self,
  event 
)

Definition at line 1590 of file forms.py.

References frame.fn.

def forms.CmdPanel.OnUpdateValues (   self,
  event = None 
)

If we were part of a richer interface, report back the current command being built.

This method should be set by the parent of this panel if needed. It's a hook, actually. Beware of what is 'self' in the method def, though. It will be called with no arguments.

Definition at line 1661 of file forms.py.

Referenced by forms.CmdPanel.OnColorChange(), forms.CmdPanel.OnSetSymbol(), and forms.CmdPanel.OnSetValue().

def forms.CmdPanel.OnVerbosity (   self,
  event 
)

Verbosity level changed.

Definition at line 1596 of file forms.py.

Field Documentation

forms.CmdPanel.constrained_size

Definition at line 1481 of file forms.py.

forms.CmdPanel.goutput

add 'command output' tab regardless standalone dialog

Definition at line 786 of file forms.py.

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

forms.CmdPanel.label_id

Definition at line 741 of file forms.py.

Referenced by forms.CmdPanel.OnSize().

forms.CmdPanel.manual_tab

Definition at line 791 of file forms.py.

forms.CmdPanel.notebook

Definition at line 770 of file forms.py.

Referenced by preferences.PreferencesDialog.__init__(), and frame.GMFrame.IsPaneShown().

forms.CmdPanel.outpage

Definition at line 787 of file forms.py.

forms.CmdPanel.panelMinHeight

Definition at line 1480 of file forms.py.

forms.CmdPanel.task

Definition at line 732 of file forms.py.

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


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