Class Wiz_page

Known Subclasses:

• analyses.wizard.Data_pipe_page
• , uf_objects.Uf_page
• , spin_viewer.frame.Finish_page
• , analyses.wizard.New_analysis_page
• , spin_viewer.frame.Load_method_page
• , peak_intensity.Spectral_error_type_page
• , components.free_file_format.Free_file_format_window

The wizard pages to be placed inside the wizard.

To inherit from this class, you must minimally supply the add_contents() method. This method should build the specific GUI elements. The following methods are also designed to be overwritten:

• add_artwork(), this builds the left hand artwork section of the page.
• add_contents(), this builds the right hand section of the page.
• on_display(), this is executed when the page is displayed.
• on_display_post(), this is executed when the page is displayed, directly after the on_display method.
• on_execute(), this is executed when the wizard is terminated or the apply button is hit.
• on_next(), this is executed when moving to the next wizard page.

The following methods can be used by add_contents() to create standard GUI elements:

• chooser()
• combo_box()
• file_selection()
• input_field()
• text()

These are described in full detail in their docstrings.

Instance Methods

__init__(self, parent, height_desc=220)
Set up the window.

_add_title(self, sizer)
Add the title to the dialog.

_apply(self, event=None)
Apply the operation.

wx.Sizer instance _build_main_section(self, sizer)
Add the main part of the dialog.

add_artwork(self, sizer)
Add the artwork to the dialog.

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

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

on_apply(self)
To be over-ridden if an action is to be performed on hitting the apply button.

on_back(self)
To be over-ridden if an action is to be performed just before moving back to the previous page.

on_completion(self)
To be over-ridden if an action is to be performed just after executing self.on_execute().

on_display(self)
To be over-ridden if an action is to be performed prior to displaying the page.

on_display_post(self)
To be over-ridden if an action is to be performed after the execution of the on_display() method.

on_execute(self)
To be over-ridden if an action is to be performed just before exiting the page.

on_init(self)
To be over-ridden if an action is to be performed when a page is newly displayed.

on_next(self)
To be over-ridden if an action is to be performed just before moving to the next page.

Class Variables

art_spacing = 20

divider = None

height_element = 27

image_path = IMAGE_PATH+ "relax.gif"

main_text = ''

setup_fail = False

size_button = 100, 33

size_square_button = 33, 33

title = ''

Method Details

__init__(self, parent, height_desc=220)
(Constructor)

Set up the window.

Parameters:

• parent (wx.object instance) - The parent GUI element.
• height_desc (int or None) - The height in pixels of the description part of the wizard.

_add_title(self, sizer)

Add the title to the dialog.

Parameters:

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

_apply(self, event=None)

Apply the operation.

Parameters:

• event (wx event) - The wx event.

_build_main_section(self, sizer)

Add the main part of the dialog.

Parameters:

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

Returns: wx.Sizer instance

The sizer object for the main part of the dialog.

add_artwork(self, sizer)

Add the artwork to the dialog.

Parameters:

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

add_contents(self, sizer)

Add the specific GUI elements (dummy method).

Parameters:

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

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.

on_apply(self)

To be over-ridden if an action is to be performed on hitting the apply button.

This method will be called when clicking on the apply button.

on_back(self)

To be over-ridden if an action is to be performed just before moving back to the previous page.

This method is called when moving back to the previous page of the wizard.

on_completion(self)

To be over-ridden if an action is to be performed just after executing self.on_execute().

This method is called just after self.on_execute() has been called

on_display(self)

To be over-ridden if an action is to be performed prior to displaying the page.

This method will be called by the wizard class method _display_page() just after hiding all other pages but prior to displaying this page.

on_display_post(self)

To be over-ridden if an action is to be performed after the execution of the on_display() method.

This method will be called by the wizard class method _display_page() just after hiding all other pages but prior to displaying this page.

on_execute(self)

To be over-ridden if an action is to be performed just before exiting the page.

This method is called when terminating the wizard or hitting the apply button.

on_init(self)

To be over-ridden if an action is to be performed when a page is newly displayed.

This method will be called by the wizard class method _display_page() at the very end.

on_next(self)

To be over-ridden if an action is to be performed just before moving to the next page.

This method is called when moving to the next page of the wizard.