schrodinger.ui.qt.standard.components.footer module

A standard application footer composed from PanelX widgets.

class schrodinger.ui.qt.standard.components.footer.Footer(parent: PyQt6.QtWidgets.QWidget | None = None)

Bases: Container

A standard composite footer built from PanelX components.

Use setVariant to control the footer surface appearance. Configure the exposed standard controls directly, and use contentLayout to add custom content when needed.

__init__(parent: PyQt6.QtWidgets.QWidget | None = None)

contentLayout() → QHBoxLayout

Return the customizable footer layout.

Insert widgets relative to standard components instead of relying on fixed indexes. For example, to insert a widget before Help:

layout = footer.contentLayout()
index = layout.indexOf(footer.helpButton())
layout.insertWidget(index, widget)

resetButton() → ResetButton

Return the standard Reset button.

messageLabel() → FooterText

Return the standard footer message label.

cancelButton() → Button

Return the standard Cancel button.

primaryButton() → Button

Return the standard primary button.

helpButton() → HelpButton

Return the standard Help button.

showStatus(text: str, *, variant: FooterTextVariant) → None

Show status text with the specified variant.

clearStatus() → None

Clear and hide the status text.

setVariant(variant: ContainerVariant) → None

Set the runtime variant and refresh the widget style.