Package gui :: Package user_functions :: Module base :: Class UF_base
[hide private]
[frames] | no frames]

Class UF_base

source code


User function GUI element base class.

Instance Methods [hide private]
 
__init__(self, parent)
Set up the window.
source code
gui.wizard.Wiz_window instance, wizard page instance
create_wizard(self, size_x=600, size_y=400, name=None, uf_page=None, apply_button=True, return_page=False)
Create and return the wizard window.
source code
GUI str
get_title(self, base=None, fn=None)
Get the title for the wizard window from the user function documentation.
source code
Method Details [hide private]

__init__(self, parent)
(Constructor)

source code 

Set up the window.

Parameters:
  • parent (wx.Window instance) - The parent window.

create_wizard(self, size_x=600, size_y=400, name=None, uf_page=None, apply_button=True, return_page=False)

source code 

Create and return the wizard window.

Parameters:
  • size_x (int) - The width of the wizard.
  • size_y (int) - The height of the wizard.
  • name (str) - The name of the user function, such as 'deselect.all'.
  • uf_page (class) - The user function page class.
  • apply_button (bool) - A flag which if true will show the apply button for that page. This will be passed to the wizard's add_page() method.
  • return_page (bool) - A flag which if True will cause the user function page to be returned.
Returns: gui.wizard.Wiz_window instance, wizard page instance
The wizard dialog (and wizard page if the return flag is given).

get_title(self, base=None, fn=None)

source code 

Get the title for the wizard window from the user function documentation.

Parameters:
  • base (str) - The name of the user function base class, if it exists.
  • fn (str) - The name of the function of the base class, or the user function itself if there is no base class.
Returns: GUI str
The title for the window.