schrodinger.ui.qt.forcefield.ffglobalpreferencewidget module

class schrodinger.ui.qt.forcefield.ffglobalpreferencewidget.FFGlobalPreferenceWidget

Bases: PyQt6.QtWidgets.QWidget

Singleton class for Force Field Global Preference UI.

Variables
  • _instance ('FFGlobalPreferenceWidget') – Holds instance of this class.

  • customOPLSPathChanged (pyqtSignal) – Signal emitted when forcefield opls path is changed.

  • useCustomForceFieldToggled (pyqtSignal) – Signal emitted with new state when ‘use custom forcefield’ is toggled.

customOPLSPathChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

useCustomForceFieldToggled

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

__init__()
static getInstance()

To support singleton pattern for the class :return: instance of this FFGlobalPreferenceWidget. :rtype: ‘FFGlobalPreferenceWidget’

updateCustomOplsDir(path)

Updates custom opls directory preference with new path. :param path: new custom opls dir :vartype path: str

schrodinger.ui.qt.forcefield.ffglobalpreferencewidget.request_ff_preference_widget()

This function is called from Maestro. Creates an instance of the ‘FFGlobalPreferenceWidget’ widget and passes on the QWidget to Maestro via MaestroHub::setForceFieldPreferenceWidget SIGNAL.