Class Value

GUI element for the input of all types of simple Python objects.

The supported Python types include:

• floats
• integers
• strings

Instance Methods

__init__(self, name=None, default=None, parent=None, element_type='default', value_type=None, sizer=None, desc=None, combo_choices=None, combo_data=None, min=0, max=1000, tooltip=None, divider=None, padding=0, spacer=None, height_element=27, read_only=False, can_be_none=False)
Set up the base value element.

Clear(self)
Special method for clearing or resetting the GUI element.

list of str GetValue(self)
Special method for returning the value of the GUI element.

SetValue(self, value)
Special method for setting the value of the GUI element.

UpdateChoices(self, combo_choices=None, combo_data=None, combo_default=None)
Special wizard method for updating the list of choices in a ComboBox type element.

Method Details

__init__(self, name=None, default=None, parent=None, element_type='default', value_type=None, sizer=None, desc=None, combo_choices=None, combo_data=None, min=0, max=1000, tooltip=None, divider=None, padding=0, spacer=None, height_element=27, read_only=False, can_be_none=False)
(Constructor)

Set up the base value element.

Parameters:

• name (str) - The name of the element to use in titles, etc.
• default (float or int or str) - The default value of the element.
• parent (wx.Panel instance) - The parent GUI element.
• element_type (str) - The type of GUI element to create. This can be set to:
  • 'text', a wx.TextCtrl element will be used.
  • 'combo', a wx.ComboBox element will be used.
  • 'spin', a wx.SpinCtrl element will be used. This is only valid for integer types!
• value_type (str) - The type of Python object that the value should be. This can be one of 'float', 'int', or 'str'.
• sizer (wx.Sizer instance) - The sizer to put the input field widget into.
• desc (str) - The text description.
• combo_choices (list of str) - The list of choices to present to the user. This is only used if the element_type is set to 'combo'.
• combo_data (list) - The data returned by a call to GetValue(). This is only used if the element_type is set to 'combo'. If supplied, it should be the same length at the combo_choices list. If not supplied, the combo_choices list will be used for the returned data.
• min (int) - For a SpinCtrl, the minimum value allowed.
• max (int) - For a SpinCtrl, the maximum value allowed.
• tooltip (str) - The tooltip which appears on hovering over the text or input field.
• divider (int) - The position of the divider.
• padding (int) - Spacing to the left and right of the widgets.
• spacer (None or int) - The amount of spacing to add below the field in pixels. If None, a stretchable spacer will be used.
• height_element (int) - The height in pixels of the GUI element.
• read_only (bool) - A flag which if True means that the text of the element cannot be edited.
• can_be_none (bool) - A flag which specifies if the element is allowed to have the None value.

GetValue(self)

Special method for returning the value of the GUI element.

Returns: list of str

The string list value.

SetValue(self, value)

Special method for setting the value of the GUI element.

Parameters:

• value (list of str or None) - The value to set.

UpdateChoices(self, combo_choices=None, combo_data=None, combo_default=None)

Special wizard method for updating the list of choices in a ComboBox type element.

Parameters:

• combo_choices (list of str) - The list of choices to present to the user. This is only used if the element_type is set to 'combo'.
• combo_data (list) - The data returned by a call to GetValue(). This is only used if the element_type is set to 'combo'. If supplied, it should be the same length at the combo_choices list. If not supplied, the combo_choices list will be used for the returned data.
• combo_default (str or None) - The default value of the ComboBox. This is only used if the element_type is set to 'combo'.