Class Uf_page

User function specific pages for the wizards.

Instance Methods

__init__(self, name, parent=None, height_desc=220, sync=False, execute=True)
Set up the window.

str _format_text(self, text)
Format the text by stripping whitespace.

str _intro_text(self, keys, values, prompt=True)
Build and return the user function intro text.

Clear(self, key)
Special wizard method for clearing the value of the GUI element corresponding to the key.

unknown GetValue(self, key)
Special wizard method for getting the value of the GUI element corresponding to the key.

SetValue(self, key, value)
Special wizard method for setting the value of the GUI element corresponding to the key.

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

add_contents(self, sizer)
Add the specific GUI elements.

add_desc(self, sizer, max_y=220)
Add the description to the dialog.

execute(self, uf, *args, **kwds)
Execute the user function, either asynchronously or synchronously.

on_back(self)
Remove this page from the observers.

on_display(self)
Clear and update the data if needed.

on_execute(self, force_exec=False)
Execute the user function.

on_next(self)
Remove this page from the observers.

bool update_args(self)
Update all the argument ComboBox choices.

Inherited from wizards.wiz_objects.Wiz_page: add_artwork, on_apply, on_completion, on_display_post, on_init

Inherited from wizards.wiz_objects.Wiz_page (private): _add_title, _apply, _build_main_section

Class Variables

Inherited from wizards.wiz_objects.Wiz_page: art_spacing, divider, height_element, image_path, main_text, setup_fail, size_button, size_square_button, title

Method Details

__init__(self, name, parent=None, height_desc=220, sync=False, execute=True)
(Constructor)

Set up the window.

Parameters:

• name (str) - The name of the user function.
• parent (class instance) - The parent class containing the GUI.
• height_desc (int or None) - The height in pixels of the description part of the wizard.
• sync (bool) - A flag which if True will call user functions via interpreter.apply and if False via interpreter.queue.
• execute (bool) - A flag which if True will prevent the user function from being executed when clicking on 'Next', 'Ok', or 'Apply'. This can be useful for delaying the execution of the user function.

Overrides: wizards.wiz_objects.Wiz_page.__init__

_format_text(self, text)

Format the text by stripping whitespace.

Parameters:

• text (str) - The text to strip.

Returns: str

The stripped text.

_intro_text(self, keys, values, prompt=True)

Build and return the user function intro text.

Parameters:

• keys (list of str) - The user function keys.
• values (list) - The values corresponding to the keys.
• prompt (bool) - A flag which if True will cause the prompt text to be included.

Returns: str

The user function intro text.

Clear(self, key)

Special wizard method for clearing the value of the GUI element corresponding to the key.

Parameters:

• key (str) - The key corresponding to the desired GUI element.

GetValue(self, key)

Special wizard method for getting the value of the GUI element corresponding to the key.

Parameters:

• key (str) - The key corresponding to the desired GUI element.

Returns: unknown

The value that the specific GUI element's GetValue() method returns.

SetValue(self, key, value)

Special wizard method for setting the value of the GUI element corresponding to the key.

Parameters:

• key (str) - The key corresponding to the desired GUI element.
• value (unknown) - The value that the specific GUI element's SetValue() method expects.

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

Special user function page method for updating 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'.

add_contents(self, sizer)

Add the specific GUI elements.

Parameters:

• sizer (wx.Sizer instance) - A sizer object.

Overrides: wizards.wiz_objects.Wiz_page.add_contents

add_desc(self, sizer, max_y=220)

Add the description to the dialog.

Parameters:

• sizer (wx.Sizer instance) - A sizer object.
• max_y (int) - The maximum height, in number of pixels, for the description.

Overrides: wizards.wiz_objects.Wiz_page.add_desc

execute(self, uf, *args, **kwds)

Execute the user function, either asynchronously or synchronously.

Parameters:

• uf (str) - The user function as a string.
• args (any arguments) - The user function arguments.
• kwds (any keyword arguments) - The user function keyword arguments.

on_back(self)

Remove this page from the observers.

Overrides: wizards.wiz_objects.Wiz_page.on_back

on_display(self)

Clear and update the data if needed.

Overrides: wizards.wiz_objects.Wiz_page.on_display

on_execute(self, force_exec=False)

Execute the user function.

Parameters:

• force_exec (bool) - A flag which if True will cause the execution flag to be ignored and the user function to be executed.

Overrides: wizards.wiz_objects.Wiz_page.on_execute

on_next(self)

Remove this page from the observers.

Overrides: wizards.wiz_objects.Wiz_page.on_next

update_args(self)

Update all the argument ComboBox choices.

Returns: bool

The status of the update - False if a RelaxError occurs, True otherwise.