Package gui :: Package components :: Module free_file_format :: Class Free_file_format
[hide private]
[frames] | no frames]

Class Free_file_format

source code

GUI element for the free file format.

This is used for specifying the columns used for the molecule name, residue name and number, spin name and number and data and error columns.

Instance Methods [hide private]
 
__init__(self, sizer, parent, padding=10, spacer=3, data_cols=False, save=True, reset=True)
Build the free format file settings widget.
source code
dict
GetValue(self)
Return the free file format settings as a keyword dictionary.
source code
 
SetValue(self, key, value)
Special method for setting the value of the GUI element corresponding to the key.
source code
 
reset(self, event)
Reset the free file format widget contents to the original values.
source code
 
save(self, event)
Save the free file format widget contents into the relax data store.
source code
 
set_vals(self)
Set the free file format widget contents to the values from the relax data store.
source code
Class Variables [hide private]
  size_square_button = 33, 33
Method Details [hide private]

__init__(self, sizer, parent, padding=10, spacer=3, data_cols=False, save=True, reset=True)
(Constructor)

source code 

Build the free format file settings widget.

Parameters:
  • sizer (wx.Sizer instance) - The sizer to put the GUI element into.
  • parent (wx object) - The parent wx GUI element.
  • padding (int) - The size of the padding between the wx.StaticBoxSizer border and the internal elements, in pixels.
  • spacer (int) - The horizontal spacing between the elements, in pixels.
  • data_cols (bool) - A flag which if True causes the data and error column elements to be displayed.
  • save (bool) - A flag which if True will cause the save button to be displayed.
  • reset (bool) - A flag which if True will cause the reset button to be displayed.

GetValue(self)

source code 

Return the free file format settings as a keyword dictionary.

Returns: dict
The dictionary of free file format settings.

SetValue(self, key, value)

source code 

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

Parameters:
  • key (str) - The key corresponding to the desired GUI element. This can be one of ['spin_id_col', 'mol_name_col', 'res_num_col', 'res_name_col', 'spin_num_col', 'spin_name_col', 'data_col', 'error_col', 'sep'].
  • value (unknown) - The value that the specific GUI element's SetValue() method expects.

reset(self, event)

source code 

Reset the free file format widget contents to the original values.

Parameters:
  • event (wx event) - The wx event.

save(self, event)

source code 

Save the free file format widget contents into the relax data store.

Parameters:
  • event (wx event) - The wx event.