Class Selector_bool

Wizard GUI element for boolean selection.

Instance Methods

__init__(self, name=None, parent=None, element_type='default', sizer=None, desc=None, tooltip=None, divider=None, padding=0, spacer=None, height_element=27, default=True)
Build the boolean selector widget for selecting between True and False.

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.

Method Details

__init__(self, name=None, parent=None, element_type='default', sizer=None, desc=None, tooltip=None, divider=None, padding=0, spacer=None, height_element=27, default=True)
(Constructor)

Build the boolean selector widget for selecting between True and False.

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. This is currently unused, but can in the future specify alternative selector widgets.
• sizer (wx.Sizer instance) - The sizer to put the combo box widget into.
• desc (str) - The text description.
• 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.
• default (bool) - The default boolean 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) - The value to set.