schrodinger.application.models.gui.library_selector module

class schrodinger.application.models.gui.library_selector.ClientType

Bases: Enum

LOCAL_DIRECTORY = 1
LIVEDESIGN = 2
class schrodinger.application.models.gui.library_selector.FileSystemClientSource

Bases: Enum

NONE = 1
BROWSE = 2
BUILTIN_LIBRARY = 3
EXAMPLE_LIBRARY = 4
class schrodinger.application.models.gui.library_selector.FileSystemClientModel(*args, _param_type=<object object>, **kwargs)

Bases: CompoundParam

source: FileSystemClientSource

A parameter of the class.

path: str

A parameter of the class.

getClient() → schrodinger.application.models.library._file_system_client.FileSystemLibraryClient | None
pathChanged

A pyqtSignal emitted by instances of the class.

pathReplaced

A pyqtSignal emitted by instances of the class.

sourceChanged

A pyqtSignal emitted by instances of the class.

sourceReplaced

A pyqtSignal emitted by instances of the class.

class schrodinger.application.models.gui.library_selector.FileSystemClientSelector(*args, **kwargs)

Bases: MapperMixin, BaseWidget

model_class

alias of FileSystemClientModel

initSetUp()

Creates widget from ui and stores it ui_widget.

Suggested subclass use: create and initialize subwidgets, and connect signals.

initLayOut()

@overrides: widgetmixins.InitMixin

defineMappings()

Override this in the subclass to define mappings. Should return a list of tuples [(<target>, <param>)]. Targets can be:

  1. a basic widget, like QLineEdit or QComboBox

  2. a custom object that inherits MapperMixin or TargetMixin

  3. a TargetSpec instance

  4. a slot

For common widgets, standard signals and getter/setter methods will be used, as defined in mappers._get_default_access_names().

For more fine-grained custom control, instantiate a TargetSpec object, which allows custom setters, getters, and signals to be specified.

Supplying a slot as the first element of the tuple is equivalent to providing TargetSpec(slot=my_slot).

Note that all target slots are triggered on setModel() as well as in response to the specified signal.

The param is an abstract param reference, e.g. MyModel.my_param.

Example:

def defineMappings(self):
    combo = self.style_combo
    return [(self.name_le, MyModel.name),
            (TargetSpec(combo,
                    getter=combo.currentText,
                    setter=combo.setCurrentText), MyModel.style),
            (self.coord_widget, MyModel.coord),
            (self._onASLTextChanged, MyModel.asl_text)]
class schrodinger.application.models.gui.library_selector.LibrarySelectorModel(*args, _param_type=<object object>, **kwargs)

Bases: CompoundParam

client_type: ClientType

A parameter of the class.

fsc_model: FileSystemClientModel

A parameter of the class.

client: AbstractLibraryClient

A parameter of the class.

clientChanged

A pyqtSignal emitted by instances of the class.

clientReplaced

A pyqtSignal emitted by instances of the class.

client_typeChanged

A pyqtSignal emitted by instances of the class.

client_typeReplaced

A pyqtSignal emitted by instances of the class.

fsc_modelChanged

A pyqtSignal emitted by instances of the class.

fsc_modelReplaced

A pyqtSignal emitted by instances of the class.

class schrodinger.application.models.gui.library_selector.LibrarySelector(*args, **kwargs)

Bases: MapperMixin, BaseDialog

model_class

alias of LibrarySelectorModel

initSetUp()

Creates widget from ui and stores it ui_widget.

Suggested subclass use: create and initialize subwidgets, and connect signals.

initLayOut()

@overrides: widgetmixins.InitMixin

defineMappings()

Override this in the subclass to define mappings. Should return a list of tuples [(<target>, <param>)]. Targets can be:

  1. a basic widget, like QLineEdit or QComboBox

  2. a custom object that inherits MapperMixin or TargetMixin

  3. a TargetSpec instance

  4. a slot

For common widgets, standard signals and getter/setter methods will be used, as defined in mappers._get_default_access_names().

For more fine-grained custom control, instantiate a TargetSpec object, which allows custom setters, getters, and signals to be specified.

Supplying a slot as the first element of the tuple is equivalent to providing TargetSpec(slot=my_slot).

Note that all target slots are triggered on setModel() as well as in response to the specified signal.

The param is an abstract param reference, e.g. MyModel.my_param.

Example:

def defineMappings(self):
    combo = self.style_combo
    return [(self.name_le, MyModel.name),
            (TargetSpec(combo,
                    getter=combo.currentText,
                    setter=combo.setCurrentText), MyModel.style),
            (self.coord_widget, MyModel.coord),
            (self._onASLTextChanged, MyModel.asl_text)]
getLibrary() → Library | None
accept(self)