PyPO User Manual
GUI.ParameterForms.formGenerator.FormGenerator Class Reference

FormGenerator. More...

Inheritance diagram for GUI.ParameterForms.formGenerator.FormGenerator:

Public Member Functions

def __init__ (self, ElementData, readAction=None, addButtons=True, test=False, okText=None)
 Constructor. More...
 
def setupInputs (self)
 Calls constructor of inputWidget for each InputDescription depending on its inType.
 
def setupButtons (self)
 Creates close, clear and read buttons in the bottom of the form.
 
def closeAction (self)
 Close the form.
 
def clear (self)
 Clears all inputs of the form.
 
def read (self)
 Reads the form. More...
 

Public Attributes

 formData
 
 readme
 
 okText
 
 layout
 
 inputs
 

Static Public Attributes

 closed = Signal()
 

Detailed Description

FormGenerator.

Generate an input form for interacting with PyPO.

Constructor & Destructor Documentation

◆ __init__()

def GUI.ParameterForms.formGenerator.FormGenerator.__init__ (   self,
  ElementData,
  readAction = None,
  addButtons = True,
  test = False,
  okText = None 
)

Constructor.

Creates a form widget given a list of InputDescription.

Parameters
ElementDataList of InputDescription objects.
readActionFunction to be called upon clicking OK button.
addButtonsBoolean. Determines weather there will be buttons in the bottom of the form.
testBoolean. If true, buttons can be added without the need to provide a readAction.
okTextString. Text used as label for the OK button. Defaults to "add"

Member Function Documentation

◆ read()

def GUI.ParameterForms.formGenerator.FormGenerator.read (   self)

Reads the form.

Returns
A dictionary containing the values read form the form.

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