Package gui :: Module wizard_elements :: Class Base_value
[hide private]
[frames] | no frames]

Class Base_value

source code


Base wizard GUI element for the input of all types of lists.

Instance Methods [hide private]
 
__init__(self, name=None, parent=None, element_type='text', sizer=None, desc=None, combo_choices=None, combo_data=None, combo_default=None, tooltip=None, divider=None, padding=0, spacer=None, read_only=False)
Set up the base value element.
source code
 
Clear(self)
Special method for clearing or resetting the GUI element.
source code
list of str
GetValue(self)
Special method for returning the value of the GUI element.
source code
 
ResetChoices(self, combo_choices=None, combo_data=None, combo_default=None)
Special wizard method for resetting the list of choices in a ComboBox type element.
source code
 
SetValue(self, value)
Special method for setting the value of the GUI element.
source code
 
conversion_fns(self)
Dummy method for setting up the conversion functions.
source code
Method Details [hide private]

__init__(self, name=None, parent=None, element_type='text', sizer=None, desc=None, combo_choices=None, combo_data=None, combo_default=None, tooltip=None, divider=None, padding=0, spacer=None, read_only=False)
(Constructor)

source code 

Set up the base value element.

Parameters:
  • name (str) - The name of the element to use in titles, etc.
  • parent (wx.Panel instance) - The wizard GUI element.
  • element_type (str) - The type of GUI element to create. If set to 'text', a wx.TextCtrl element will be used. If set to 'combo', a wx.ComboBox element will be used.
  • 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.
  • combo_default (str or None) - The default value of the ComboBox. This is only used if the element_type is set to 'combo'.
  • tooltip (str) - The tooltip which appears on hovering over the text or input field.
  • divider (None or int) - The optional position of the divider. If None, the class variable _div_left will be used.
  • 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.
  • read_only (bool) - A flag which if True means that the text of the element cannot be edited.

GetValue(self)

source code 

Special method for returning the value of the GUI element.

Returns: list of str
The string list value.

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

source code 

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

Parameters:
  • key (str) - The key corresponding to the desired GUI element.
  • 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'.

SetValue(self, value)

source code 

Special method for setting the value of the GUI element.

Parameters:
  • value (list of str) - The value to set.

conversion_fns(self)

source code 

Dummy method for setting up the conversion functions.

This should define the self.convert_to_gui() and self.convert_from_gui() function aliases.