Class Base_list

Known Subclasses:

• scripts.Scripts
• , relax_data.Relax_data_list
• , citations.Citations
• , molecule.Molecule
• , relax_data_meta.Relax_data_meta_list
• , software.Software
• , spectrum.Spectra_list

The GUI element for listing the software used in the analysis.

Instance Methods

__init__(self, gui=None, parent=None, box=None, id=None, proportion=0, button_placement='default')
Build the base list GUI element.

Enable(self, enable=True)
Enable or disable the element.

add_buttons(self, sizer)
Add the buttons for manipulating the data.

build_element(self)
Build the grid.

build_element_safe(self)
Build the spectra listing GUI element in a thread safe wx.CallAfter call.

delete(self)
Unregister the class.

list of dict of wxID, str, str, method generate_popup_menu(self, id=None)
Create and return the popup menu.

init_element(self, sizer)
Initialise the GUI element.

bool is_complete(self)
Base method which always returns True.

observer_register(self, remove=False)
Register and unregister methods with the observer objects.

on_right_click(self, event)
Pop up menu for the right click.

resize(self, event)
Catch the resize to allow the element to be resized.

set_box_label(self)
Set the label of the StaticBox.

size_cols(self)
Set the column sizes.

Method Details

__init__(self, gui=None, parent=None, box=None, id=None, proportion=0, button_placement='default')
(Constructor)

Build the base list GUI element.

Parameters:

• gui (wx.Frame instance) - The main GUI object.
• parent (wx object) - The parent GUI element that this is to be attached to.
• box (wx.BoxSizer instance) - The box sizer to pack this GUI component into.
• id (str) - A unique identification string. This is used to register the update method with the GUI user function observer object.
• proportion (bool) - The window proportion parameter.
• button_placement (str or None) - Override the button visibility and placement. The value of 'default' will leave the buttons at the default setting. The value of 'top' will place the buttons at the top, 'bottom' will place them at the bottom, and None will turn off the buttons.

Overrides: object.__init__

Enable(self, enable=True)

Enable or disable the element.

Parameters:

• enable (bool) - The flag specifying if the element should be enabled or disabled.

add_buttons(self, sizer)

Add the buttons for manipulating the data.

Parameters:

• sizer (wx.BoxSizer instance) - The sizer element to pack the buttons into.

generate_popup_menu(self, id=None)

Create and return the popup menu.

Parameters:

• id (str) - The ID string for the row that was clicked on.

Returns: list of dict of wxID, str, str, method

The popup menu.

init_element(self, sizer)

Initialise the GUI element.

Parameters:

• sizer (wx.BoxSizer instance) - The sizer element to pack the element into.

is_complete(self)

Base method which always returns True.

Returns: bool

The answer to the question.

observer_register(self, remove=False)

Register and unregister methods with the observer objects.

Parameters:

• remove (False) - If set to True, then the methods will be unregistered.

on_right_click(self, event)

Pop up menu for the right click.

Parameters:

• event (wx event) - The wx event.

resize(self, event)

Catch the resize to allow the element to be resized.

Parameters:

• event (wx event) - The wx event.