schrodinger.application.livedesign.ld_settings module¶

class schrodinger.application.livedesign.ld_settings.LDSettingsMixin(*args, **kwargs)¶

Bases: object

Mixin class for any LD panel that contains lr_widget of type live_report_widget.LiveReportWidget as a member, whose settings need to be saved/restored. The panel should specify a PREF_GROUP so that saveLDSettings() and restoreLDSettings() can be called to save/restore the settings in preferences under a subgroup for the current host under PREF_GROUP. Preferences will be saved/restored per host.

This mixin can be subclassed to save/restore any additional panel settings by implementing saveAdditionalSettings() and restoreAdditionalSettings() methods.

Variables

PREF_GROUP (str | None) – Preference group name under which the settings will be saved to/restored from
restoreCompleted (QtCore.pyqtSignal) – Signal emitted when restore completes

PREF_GROUP = None¶

restoreCompleted¶

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__(*args, **kwargs)¶

setPrefGroup(reset_host_group: bool = False)¶

Set the preference group to use to PREF_GROUP/hostname

Parameters: reset_host_group – If True, clear the complete host group

restoreLDSettings()¶: Restore LiveReportWidget settings and any additional settings as implemented in restoreAdditionalSettings()

restoreAdditionalSettings()¶: Derived classes can reimplement this method to restore additional settings.

saveLDSettings()¶: Save LiveReportWidget settings and any additional settings as implemented in saveAdditionalSettings()`

saveAdditionalSettings()¶: Derived classes can reimplement this method to save additional settings.

class schrodinger.application.livedesign.ld_settings.LDExportSettingsMixin(*args, **kwargs)¶

Bases: schrodinger.application.livedesign.ld_settings.LDSettingsMixin

Mixin for LD Export GUI panels inherited from AbstractExportPanel to save/restore panel settings

restoreAdditionalSettings()¶: Restore Mappings

saveAdditionalSettings()¶: Save mappings