Package schrodinger :: Package application :: Package matsci :: Module chargegui :: Class ChargePropertySelector
[hide private]
[frames] | no frames]

Class ChargePropertySelector

ui.qt.propertyselector.PropertySelectorMenu --+
                                              |
                                             ChargePropertySelector

A widget that allows the user to pick from a list of properties from a combobox and shows the user the "User" version of the property name (Property Name rather than x_prog_Property_Name)

Instance Methods [hide private]
 
__init__(self, label, layout=None, tip=None)
Create a Charge PropertySelector instance
 
setVisible(self, state)
Set the combobox and label visible or hidden
bool
isVisible(self)
Check if the combobox is visible
 
reset(self)
Reset the combobox
 
updateProperties(self, structs)
Fill the combobox with all allowed atom properties available in structs
str or None
getSelectedProp(self)
Return the x_prog_property_name form of the selected property

Inherited from ui.qt.propertyselector.PropertySelectorMenu: clear, getSelected, select, setProperties

Static Methods [hide private]
list
getAllPotentialAtomChargeProperties(structs)
Accumulate a list of all numeric atomic properties in all structures, removing any on the NON_CHARGE_PROPS list
Method Details [hide private]

__init__(self, label, layout=None, tip=None)
(Constructor)

 

Create a Charge PropertySelector instance

Parameters:
  • label (str) - The label for the combobox
  • layout (QBoxLayout) - The layout to place the SLabeledComboBox into
  • tip (str) - The tooltip for the combobox
Overrides: ui.qt.propertyselector.PropertySelectorMenu.__init__

setVisible(self, state)

 

Set the combobox and label visible or hidden

Parameters:
  • state (bool) - Whether to show (True) or hide (False) the widgets

isVisible(self)

 

Check if the combobox is visible

Returns: bool
True if visible, False if not

updateProperties(self, structs)

 

Fill the combobox with all allowed atom properties available in structs

Parameters:

getSelectedProp(self)

 

Return the x_prog_property_name form of the selected property

Returns: str or None
The x_prog_property_name value of the selected property or None if no property is selected

getAllPotentialAtomChargeProperties(structs)
Static Method

 

Accumulate a list of all numeric atomic properties in all structures, removing any on the NON_CHARGE_PROPS list

Parameters:
Returns: list
A list of all numeric (r_, i_) atom properties found in structs. The list is sorted alphabetically.