schrodinger.ui.qt.basewidgets module

class schrodinger.ui.qt.basewidgets.BaseWidget(*args, **kwargs)

Bases: schrodinger.ui.qt.widgetmixins.basicmixins.BaseMixinCollection, PyQt6.QtWidgets.QWidget

QWidget with several mixins. See QWidget and widgetmixins.BaseMixinCollection for full documentation.

class schrodinger.ui.qt.basewidgets.BaseDialog(*args, **kwargs)

Bases: schrodinger.ui.qt.widgetmixins.basicmixins.BaseMixinCollection, PyQt6.QtWidgets.QDialog

QDialog with several mixins. See QDialog and widgetmixins.BaseMixinCollection for full documentation.

initSetOptions()

Suggested subclass use: set instance variables, excluding layouts and subwidgets. Also use here to (optionally) apply the legacy stylesheet spacing settings (PANEL-19101).

initSetUp()

Creates widget from ui and stores it ui_widget.

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

run(blocking: bool = False, modal: bool = False, finished_callback: Callable = None) PyQt6.QtWidgets.QDialog.DialogCode

See ExecutionMixin for documentation.

Returns

Dialog code indicating the dialog acceptance / rejection.

class schrodinger.ui.qt.basewidgets.Panel(*args, **kwargs)

Bases: schrodinger.ui.qt.widgetmixins.panelmixins.PanelMixin, schrodinger.ui.qt.basewidgets.BaseWidget

A BaseWidget with MapperMixin, is a window by default, and has the panel method to run the singleton panel.

class schrodinger.ui.qt.basewidgets.TaskPanel(*args, **kwargs)

Bases: schrodinger.ui.qt.widgetmixins.panelmixins.TaskPanelMixin, schrodinger.ui.qt.basewidgets.BaseWidget

initSetUp()

Creates widget from ui and stores it ui_widget.

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

class schrodinger.ui.qt.basewidgets.BaseOptionsDialog(*args, **kwargs)

Bases: schrodinger.ui.qt.widgetmixins.panelmixins.CleanStateMixin, schrodinger.models.mappers.MapperMixin, schrodinger.ui.qt.basewidgets.BaseDialog

Base class for options dialogs. Includes:

  • An “OK” button that closes the dialog (hotkeyed to “Enter”)

  • A cancel button that resets the model to the state it was in when

    the dialog was run (hotkeyed to “Esc”)

  • A reset button that resets the dialog to default state specified in

    initSetDefaults

Subclasses can define self.help_topic = 'HELP_TOPIC_KEY' to define a help button.

Subclasses must have models that are deepcopyable. Subclasses can define custom actions for the standard buttons after initSetOptions of base class gets called.

initSetOptions()

Suggested subclass use: set instance variables, excluding layouts and subwidgets. Also use here to (optionally) apply the legacy stylesheet spacing settings (PANEL-19101).

reject(self)
class schrodinger.ui.qt.basewidgets.MaestroDockPanel(*args, **kwargs)

Bases: schrodinger.ui.qt.widgetmixins.panelmixins.PanelMixin, schrodinger.ui.qt.basewidgets._DockablePanel

class schrodinger.ui.qt.basewidgets.MaestroDockTaskPanel(*args, **kwargs)

Bases: schrodinger.ui.qt.widgetmixins.panelmixins.TaskPanelMixin, schrodinger.ui.qt.basewidgets._DockablePanel