Package gui :: Package input_elements :: Module sequence :: Class Sequence
[hide private]
[frames] | no frames]

Class Sequence

source code


Wizard GUI element for the input of all types of Python sequence objects.

The supported Python types include:

Instance Methods [hide private]
 
__init__(self, name=None, default=None, parent=None, element_type='default', seq_type=None, value_type=None, dim=None, min=0, max=1000, sizer=None, titles=None, desc=None, combo_choices=None, combo_data=None, combo_list_min=None, tooltip=None, divider=None, padding=0, spacer=None, height_element=27, single_value=False, read_only=False, can_be_none=False)
Set up the element.
source code
 
Clear(self)
Special method for clearing or resetting the GUI element.
source code
sequence type
GetValue(self)
Special method for returning the sequence values of the GUI element.
source code
 
SetValue(self, value=None, index=None)
Special method for setting the value of the GUI element.
source code
 
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.
source code
 
open_dialog(self, event)
Open a special dialog for inputting a list of text values.
source code
 
selection_win_data(self)
Extract the data from the selection window.
source code
 
selection_win_show(self)
Show the selection window.
source code
Method Details [hide private]

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

source code 

Set up the element.

Parameters:
  • name (str) - The name of the element to use in titles, etc.
  • default (sequence object) - The default value of the element.
  • parent (wx.Panel instance) - The wizard GUI element.
  • element_type (str) - The type of GUI element to create. If set to 'default', the wx.TextCtrl element with a button to bring up a dialog with ListCtrl will be used. If set to 'combo_list', the special gui.components.combo_list.Combo_list element will be used.
  • seq_type (str) - The type of Python sequence. This should be one of 'list' or 'tuple'.
  • value_type (str) - The type of Python object that the value should be. This can be one of 'float', 'int', or 'str'.
  • dim (int, tuple of int or None) - The dimensions that a list or tuple must conform to. For a 1D sequence, this can be a single value or a tuple of possible sizes. For a 2D sequence (a numpy matrix or list of lists), this must be a tuple of the fixed dimension sizes, e.g. a 3x5 matrix should be specified as (3, 5).
  • min (int) - For a SpinCtrl, the minimum value allowed.
  • max (int) - For a SpinCtrl, the maximum value allowed.
  • sizer (wx.Sizer instance) - The sizer to put the input field widget into.
  • titles (list of str) - The titles of each of the elements of the fixed dimension elements.
  • 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_list_min (int or None) - The minimum length for the Combo_list object.
  • 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.
  • single_value (bool) - A flag which if True will cause single input values to be treated as single values rather than a list or tuple.
  • 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)

source code 

Special method for returning the sequence values of the GUI element.

Returns: sequence type
The sequence of values.

SetValue(self, value=None, index=None)

source code 

Special method for setting the value of the GUI element.

Parameters:
  • value (value or list of values) - The value to set.
  • index (int or None) - The index of the value to set, if the full list is not given.

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

source code 

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_list'.
  • combo_data (list) - The data returned by a call to GetValue(). This is only used if the element_type is set to 'combo_list'. 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_list'.

open_dialog(self, event)

source code 

Open a special dialog for inputting a list of text values.

Parameters:
  • event (wx event) - The wx event.