Package gui :: Package spin_viewer :: Module containers :: Class Spin
[hide private]
[frames] | no frames]

Class Spin

source code


The spin container.

Instance Methods [hide private]
 
__init__(self, box, parent, mol_name=None, res_num=None, res_name=None, spin_num=None, spin_name=None, spin_id=None, select=True)
Set up the spin container.
source code
wx.Sizer instance
header_spin(self)
Create the header for the spin container.
source code
wx.Sizer instance
spin_vars(self, blacklist=[])
Create the variable table for the spin container.
source code

Inherited from Container_base: create_head_text, create_subtitle, create_title

Class Variables [hide private]

Inherited from Container_base: border

Method Details [hide private]

__init__(self, box, parent, mol_name=None, res_num=None, res_name=None, spin_num=None, spin_name=None, spin_id=None, select=True)
(Constructor)

source code 

Set up the spin container.

Parameters:
  • box (wx object) - The box sizer element to pack the contents into.
  • parent (wx object) - The parent GUI element.
  • mol_name (str) - The molecule name.
  • res_num (str) - The residue number.
  • res_name (str) - The residue name.
  • spin_num (str) - The spin number.
  • spin_name (str) - The spin name.
  • spin_id (str) - The spin ID string.
  • select (bool) - The selection state.

header_spin(self)

source code 

Create the header for the spin container.

Returns: wx.Sizer instance
The sizer containing the header.

spin_vars(self, blacklist=[])

source code 

Create the variable table for the spin container.

Parameters:
  • blacklist (list of str) - A list of spin container objects to blacklist from the variable display table.
Returns: wx.Sizer instance
The sizer containing the table.