Package schrodinger :: Package application :: Package jaguar :: Package gui :: Module base_panel :: Class SubTabMixin

Class SubTabMixin

object --+
         |
        SubTabMixin

A mixin for panels that contain an InputTab with sub-tabs. This mixin controls markers and atom picking activation/deactivation. Requires InputTabMixin and must appear before InputTabMixin on the inheritance list.

Instance Methods

[hide private]

setup(self)

deactivateTabs(self)
Deactivate workspace atom picking in all tabs

showEvent(self, event)
When the panel is shown, activate workspace atom picking if necessary

tabChanged(self, new_index)
When the tab is changed, activate the newly selected tab

showAllJaguarMarkers(self)
Display only markers for the current sub-tab and apply the sub-tab- specific settings

addSubTabMarker(self, atoms, settings, sub_tab_name)
Add a workspace marker for the specified sub-tab.

removeSubTabMarker(self, atoms, sub_tab_name)
Delete a workspace marker for the specified sub-tab.

setSubTabMarkerHighlighting(self, atoms, highlight, sub_tab_name)
Change the workspace marker highlighting for the specified marker.

projectUpdated(self)
Make sure that marker visibility is updated *after* the Input table has updated the included structures so that we can remove markers for structures that have been removed from the panel.

theoryToInput(self)
When the level of theory changes, pass the new theory level to the Input tab so it can enable or disable the Charge Constraints sub-tab as necessary.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

deactivateTabs(self)

Deactivate workspace atom picking in all tabs

Decorators:

@af2.appmethods.close()

showEvent(self, event)

When the panel is shown, activate workspace atom picking if necessary

See Qt documentation for an explanation of the argument

tabChanged(self, new_index)

When the tab is changed, activate the newly selected tab

Parameters:

new_index (int) - The index of the newly selected tab

showAllJaguarMarkers(self)

Display only markers for the current sub-tab and apply the sub-tab- specific settings

Note: This function is named showAllJaguarMarkers() so it will override the AF2 showAllJaguarMarkers() function. Note that it doesn't always show all markers.

addSubTabMarker(self, atoms, settings, sub_tab_name)

Add a workspace marker for the specified sub-tab. If a marker already exists for the given atoms, sub-tab-specific settings will be added to the marker.

Parameters:

atoms (list) - A list of atoms to add the marker for
settings (dict) - The marker settings
sub_tab_name (str) - The name of the sub-tab that the marker is for

removeSubTabMarker(self, atoms, sub_tab_name)

Delete a workspace marker for the specified sub-tab. If the marker applies to other sub-tabs, then only the sub-tab-specific settings for the given sub-tab will be deleted.

Parameters:

atoms (list) - A list of atoms to remove the marker for
sub_tab_name (str) - The name of the sub-tab that the marker is for

setSubTabMarkerHighlighting(self, atoms, highlight, sub_tab_name)

Change the workspace marker highlighting for the specified marker.

Parameters:

atoms (list) - A list of atoms to change the highlighting for
highlight (bool) - Whether to highlight (True) or unhighlight (False) the specified marker
sub_tab_name (str) - The name of the sub-tab that the marker is for

Note: This function assumes that the specified sub-tab is currently active.

projectUpdated(self)

Make sure that marker visibility is updated *after* the Input table has updated the included structures so that we can remove markers for structures that have been removed from the panel.

Decorators:

@af2.maestro_callback.project_updated