schrodinger.application.msv.gui.menu module

class schrodinger.application.msv.gui.menu.MenuAction(label, tooltip=None, shortcut=None, checkable=False, icon_path=None, data=None)[source]

Bases: PyQt5.QtWidgets.QAction

__init__(label, tooltip=None, shortcut=None, checkable=False, icon_path=None, data=None)[source]
setImplemented(has_been_implemented)[source]

Sets whether a feature has been implemented yet

Parameters

has_been_implemented (bool) – Whether action has been implemented

AboutQtRole = 3
AboutRole = 4
class ActionEvent

Bases: int

ApplicationSpecificRole = 2
HighPriority = 256
Hover = 1
LowPriority = 0
class MenuRole

Bases: int

NoRole = 0
NormalPriority = 128
PreferencesRole = 5
class Priority

Bases: int

QuitRole = 6
TextHeuristicRole = 1
Trigger = 0
actionGroup(self) → QActionGroup
activate(self, QAction.ActionEvent)
associatedGraphicsWidgets(self) → List[QGraphicsWidget]
associatedWidgets(self) → List[QWidget]
autoRepeat(self) → bool
blockSignals(self, bool) → bool
changed

changed(self) [signal]

childEvent(self, QChildEvent)
children(self) → List[QObject]
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
data(self) → Any
deleteLater(self)
destroyed

destroyed(self, object: QObject = None) [signal]

disconnect(QMetaObject.Connection) → bool
disconnect(self) → None
disconnectNotify(self, QMetaMethod)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) → List[QByteArray]
event(self, QEvent) → bool
eventFilter(self, QObject, QEvent) → bool
findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject
findChild(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject
findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
font(self) → QFont
hover(self)
hovered

hovered(self) [signal]

icon(self) → QIcon
iconText(self) → str
inherits(self, str) → bool
installEventFilter(self, QObject)
isCheckable(self) → bool
isChecked(self) → bool
isEnabled(self) → bool
isIconVisibleInMenu(self) → bool
isSeparator(self) → bool
isShortcutVisibleInContextMenu(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isVisible(self) → bool
isWidgetType(self) → bool
isWindowType(self) → bool
killTimer(self, int)
menu(self) → QMenu
menuRole(self) → QAction.MenuRole
metaObject(self) → QMetaObject
moveToThread(self, QThread)
objectName(self) → str
objectNameChanged

objectNameChanged(self, str) [signal]

parent(self) → QObject
parentWidget(self) → QWidget
priority(self) → QAction.Priority
property(self, str) → Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

receivers(self, PYQT_SIGNAL) → int
removeEventFilter(self, QObject)
sender(self) → QObject
senderSignalIndex(self) → int
setActionGroup(self, QActionGroup)
setAutoRepeat(self, bool)
setCheckable(self, bool)
setChecked(self, bool)
setData(self, Any)
setDisabled(self, bool)
setEnabled(self, bool)
setFont(self, QFont)
setIcon(self, QIcon)
setIconText(self, str)
setIconVisibleInMenu(self, bool)
setMenu(self, QMenu)
setMenuRole(self, QAction.MenuRole)
setObjectName(self, str)
setParent(self, QObject)
setPriority(self, QAction.Priority)
setProperty(self, str, Any) → bool
setSeparator(self, bool)
setShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int])
setShortcutContext(self, Qt.ShortcutContext)
setShortcutVisibleInContextMenu(self, bool)
setShortcuts(self, Iterable[Union[QKeySequence, QKeySequence.StandardKey, str, int]])
setShortcuts(self, QKeySequence.StandardKey) → None
setStatusTip(self, str)
setText(self, str)
setToolTip(self, str)
setVisible(self, bool)
setWhatsThis(self, str)
shortcut(self) → QKeySequence
shortcutContext(self) → Qt.ShortcutContext
shortcuts(self) → List[QKeySequence]
showStatusText(self, widget: QWidget = None) → bool
signalsBlocked(self) → bool
startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
staticMetaObject = <PyQt5.QtCore.QMetaObject object>
statusTip(self) → str
text(self) → str
thread(self) → QThread
timerEvent(self, QTimerEvent)
toggle(self)
toggled

toggled(self, bool) [signal]

toolTip(self) → str
tr(self, str, disambiguation: str = None, n: int = - 1) → str
trigger(self)
triggered

triggered(self, checked: bool = False) [signal]

whatsThis(self) → str
class schrodinger.application.msv.gui.menu.ToggleTextAction(true_text, false_text)[source]

Bases: schrodinger.models.mappers.TargetMixin, schrodinger.application.msv.gui.menu.MenuAction

Menu action that toggles a bool every time it’s triggered and updates the text based on the value of the bool

__init__(true_text, false_text)[source]
targetGetValue()[source]
targetSetValue(value: bool)[source]
AboutQtRole = 3
AboutRole = 4
class ActionEvent

Bases: int

ApplicationSpecificRole = 2
HighPriority = 256
Hover = 1
LowPriority = 0
class MenuRole

Bases: int

NoRole = 0
NormalPriority = 128
PreferencesRole = 5
class Priority

Bases: int

QuitRole = 6
TextHeuristicRole = 1
Trigger = 0
actionGroup(self) → QActionGroup
activate(self, QAction.ActionEvent)
associatedGraphicsWidgets(self) → List[QGraphicsWidget]
associatedWidgets(self) → List[QWidget]
autoRepeat(self) → bool
auto_update_model = True
auto_update_target = True
blockSignals(self, bool) → bool
changed

changed(self) [signal]

childEvent(self, QChildEvent)
children(self) → List[QObject]
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
data(self) → Any
deleteLater(self)
destroyed

destroyed(self, object: QObject = None) [signal]

disconnect(QMetaObject.Connection) → bool
disconnect(self) → None
disconnectNotify(self, QMetaMethod)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) → List[QByteArray]
event(self, QEvent) → bool
eventFilter(self, QObject, QEvent) → bool
findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject
findChild(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject
findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
font(self) → QFont
hover(self)
hovered

hovered(self) [signal]

icon(self) → QIcon
iconText(self) → str
inherits(self, str) → bool
installEventFilter(self, QObject)
isCheckable(self) → bool
isChecked(self) → bool
isEnabled(self) → bool
isIconVisibleInMenu(self) → bool
isSeparator(self) → bool
isShortcutVisibleInContextMenu(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isVisible(self) → bool
isWidgetType(self) → bool
isWindowType(self) → bool
killTimer(self, int)
menu(self) → QMenu
menuRole(self) → QAction.MenuRole
metaObject(self) → QMetaObject
moveToThread(self, QThread)
objectName(self) → str
objectNameChanged

objectNameChanged(self, str) [signal]

parent(self) → QObject
parentWidget(self) → QWidget
priority(self) → QAction.Priority
property(self, str) → Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

receivers(self, PYQT_SIGNAL) → int
removeEventFilter(self, QObject)
sender(self) → QObject
senderSignalIndex(self) → int
setActionGroup(self, QActionGroup)
setAutoRepeat(self, bool)
setCheckable(self, bool)
setChecked(self, bool)
setData(self, Any)
setDisabled(self, bool)
setEnabled(self, bool)
setFont(self, QFont)
setIcon(self, QIcon)
setIconText(self, str)
setIconVisibleInMenu(self, bool)
setImplemented(has_been_implemented)

Sets whether a feature has been implemented yet

Parameters

has_been_implemented (bool) – Whether action has been implemented

setMenu(self, QMenu)
setMenuRole(self, QAction.MenuRole)
setObjectName(self, str)
setParent(self, QObject)
setPriority(self, QAction.Priority)
setProperty(self, str, Any) → bool
setSeparator(self, bool)
setShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int])
setShortcutContext(self, Qt.ShortcutContext)
setShortcutVisibleInContextMenu(self, bool)
setShortcuts(self, Iterable[Union[QKeySequence, QKeySequence.StandardKey, str, int]])
setShortcuts(self, QKeySequence.StandardKey) → None
setStatusTip(self, str)
setText(self, str)
setToolTip(self, str)
setVisible(self, bool)
setWhatsThis(self, str)
shortcut(self) → QKeySequence
shortcutContext(self) → Qt.ShortcutContext
shortcuts(self) → List[QKeySequence]
showStatusText(self, widget: QWidget = None) → bool
signalsBlocked(self) → bool
startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
staticMetaObject = <PyQt5.QtCore.QMetaObject object>
statusTip(self) → str
targetValueChanged
text(self) → str
thread(self) → QThread
timerEvent(self, QTimerEvent)
toggle(self)
toggled

toggled(self, bool) [signal]

toolTip(self) → str
tr(self, str, disambiguation: str = None, n: int = - 1) → str
trigger(self)
triggered

triggered(self, checked: bool = False) [signal]

whatsThis(self) → str
schrodinger.application.msv.gui.menu.submenu_action(title: str) → PyQt5.QtWidgets.QAction[source]

Create a QAction with an associated QMenu. QAction.menu() and QAction.setMenu() were removed from PyQt 6, so we have to create the menu first and then get an action from the menu. We store the menu as action.menu so we can access it later.

Parameters

title – The title of the submenu

Returns

The newly created action

class schrodinger.application.msv.gui.menu.MenuBarActions[source]

Bases: object

MenuBarActions provides a namespace for all the actions on the menu bar

__init__()[source]
class schrodinger.application.msv.gui.menu.EnabledTargetSpec(widget)[source]

Bases: schrodinger.models.mappers.TargetSpec

A TargetSpec for mapping a BoolParam to the enabled state of a widget

__init__(widget)[source]
Parameters

obj – this object, if specified, will be used to determine default access for this target.

For example, passing in a QCheckBox, my_chk, will make the default getter my_chk.isChecked, the default setter my_chk.setChecked, and the default signal my_chk.stateChanged.

Passing in None will disable default access. In this case only explicitly specified getters, setters, signals, and slots will be used.

Parameters

  • getter (callable) – a function to get a value from the target. Overrides the default getter in obj, if specified. Passing in None will result in the target value always returning None.

  • setter (callable) – a function that sets the value on the target. Overrides the default setter in obj, if specified. Passing in None will result in the target value never being changed.

  • signal (QtCore.pyqtSignal) – the signal that indicates a change in target value. This will override the default signal in obj, if specified. The target signal is forwarded to targetChanged, to provide a common interface. Pass in None to disable monitoring of target changes.

  • datatype (type) – the type of data expected by the target object. If set, this will be used to cast values being passed to the target object via the setter. Ex. setting the datatype to str for a QLineEdit allows the line edit to display IntParam data. Note: this does not work the other way - mapping a QLineEdit to an IntParam will cause the param to take on a string value.

  • slot (callable) – a function that will get called whenever the corresponding model param is changed. Will get called regardless of whether a setter or obj is specified. By default there is no slot set.

  • auto_update_target (bool) – whether the target should be automatically (and immediately) updated when the param is changed. Default behavior: if the obj has an attribute named auto_update_target, use that, otherwise True.

  • auto_update_model (bool) – whether the model should be automatically (and immediately) updated when the target is changed. Default behavior: if the obj has an attribute named auto_update_model, use that, otherwise True.

property auto_update_model

This property controls live updating of the model in response to target value changes. This may be modified at any time. Set it to DEFAULT to revert back to the original behavior.

property auto_update_target

This property controls live updating of the target in response to model value changes. This may be modified at any time. Set it to DEFAULT to revert back to the original behavior.

blockSignals(self, bool) → bool
childEvent(self, QChildEvent)
children(self) → List[QObject]
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
deleteLater(self)
destroyed

destroyed(self, object: QObject = None) [signal]

disconnect(QMetaObject.Connection) → bool
disconnect(self) → None
disconnectNotify(self, QMetaMethod)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) → List[QByteArray]
event(self, QEvent) → bool
eventFilter(self, QObject, QEvent) → bool
findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject
findChild(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject
findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
getValue()

The standard method for getting a target’s value, regardless of whether this is using a default getter or a custom one.

inherits(self, str) → bool
installEventFilter(self, QObject)
isSignalConnected(self, QMetaMethod) → bool
isWidgetType(self) → bool
isWindowType(self) → bool
killTimer(self, int)
metaObject(self) → QMetaObject
moveToThread(self, QThread)
objectName(self) → str
objectNameChanged

objectNameChanged(self, str) [signal]

onModelParamChanged(value)
onTargetSignal()

We connect this slot to the target’s specific signal and emit the generic targetChanged signal with the new value. This provides a uniform interface for the mapper to connect to.

parent(self) → QObject
property(self, str) → Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

receivers(self, PYQT_SIGNAL) → int
removeEventFilter(self, QObject)
sender(self) → QObject
senderSignalIndex(self) → int
setObjectName(self, str)
setParent(self, QObject)
setProperty(self, str, Any) → bool
setValue(value)

The standard method for setting a target’s value, regardless of whether this is using a default setter or a custom one.

signalsBlocked(self) → bool
slot()
startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
staticMetaObject = <PyQt5.QtCore.QMetaObject object>
targetChanged
thread(self) → QThread
timerEvent(self, QTimerEvent)
tr(self, str, disambiguation: str = None, n: int = - 1) → str
class schrodinger.application.msv.gui.menu.MsvMenuBar(*args, **kwargs)[source]

Bases: schrodinger.models.mappers.MapperMixin, PyQt5.QtWidgets.QMenuBar

model_class

alias of schrodinger.application.msv.gui.gui_models.MenuEnabledModel

__init__(*args, **kwargs)[source]
defineMappings()[source]

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)]
canRedoChanged(can_redo)[source]

Update the menu state depending on whether redo is available

canUndoChanged(can_undo)[source]

Update the menu state depending on whether undo is available

onRedoTextChanged(redo_text)[source]

Update the Red menu action text to reflect the current redo action.

Parameters

redo_text (str) – Text of the current redo action

onUndoTextChanged(undo_text)[source]

Update the Undo menu action text to reflect the current undo action.

Parameters

undo_text (str) – Text of the current undo action

DrawChildren = 2
DrawWindowBackground = 1
IgnoreMask = 4
class PaintDeviceMetric

Bases: int

PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
class RenderFlag

Bases: int

class RenderFlags
class RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) → None
class RenderFlags(QWidget.RenderFlags) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)
acceptDrops(self) → bool
accessibleDescription(self) → str
accessibleName(self) → str
actionAt(self, QPoint) → QAction
actionEvent(self, QActionEvent)
actionGeometry(self, QAction) → QRect
actions(self) → List[QAction]
activateWindow(self)
activeAction(self) → QAction
addAction(self, QAction)
addAction(self, str) → QAction
addAction(self, str, PYQT_SLOT) → QAction
addActions(self, Iterable[QAction])
addMenu(self, QMenu) → QAction
addMenu(self, str) → QMenu
addMenu(self, QIcon, str) → QMenu
addSeparator(self) → QAction
adjustSize(self)
autoFillBackground(self) → bool
backgroundRole(self) → QPalette.ColorRole
baseSize(self) → QSize
blockSignals(self, bool) → bool
changeEvent(self, QEvent)
childAt(self, QPoint) → QWidget
MsvMenuBar.childAt(self, int, int) -> QWidget
childEvent(self, QChildEvent)
children(self) → List[QObject]
childrenRect(self) → QRect
childrenRegion(self) → QRegion
clear(self)
clearFocus(self)
clearMask(self)
close(self) → bool
closeEvent(self, QCloseEvent)
colorCount(self) → int
connectNotify(self, QMetaMethod)
contentsMargins(self) → QMargins
contentsRect(self) → QRect
contextMenuEvent(self, QContextMenuEvent)
contextMenuPolicy(self) → Qt.ContextMenuPolicy
cornerWidget(self, corner: Qt.Corner = Qt.TopRightCorner) → QWidget
create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(QWindow, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) → QWidget
cursor(self) → QCursor
customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)
deleteLater(self)
depth(self) → int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

destroyed(self, object: QObject = None) [signal]

devType(self) → int
devicePixelRatio(self) → int
devicePixelRatioF(self) → float
devicePixelRatioFScale() → float
disconnect(QMetaObject.Connection) → bool
disconnect(self) → None
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) → List[QByteArray]
effectiveWinId(self) → PyQt5.sip.voidptr
ensurePolished(self)
enterEvent(self, QEvent)
event(self, QEvent) → bool
eventFilter(self, QObject, QEvent) → bool
find(PyQt5.sip.voidptr) → QWidget
findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject
findChild(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject
findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]
focusInEvent(self, QFocusEvent)
focusNextChild(self) → bool
focusNextPrevChild(self, bool) → bool
focusOutEvent(self, QFocusEvent)
focusPolicy(self) → Qt.FocusPolicy
focusPreviousChild(self) → bool
focusProxy(self) → QWidget
focusWidget(self) → QWidget
font(self) → QFont
fontInfo(self) → QFontInfo
fontMetrics(self) → QFontMetrics
foregroundRole(self) → QPalette.ColorRole
frameGeometry(self) → QRect
frameSize(self) → QSize
geometry(self) → QRect
getContentsMargins(self) → Tuple[int, int, int, int]
getModel()
getSignalsAndSlots(model)

Override this method to specify signal and slot pairs that need to be connected/disconnected whenever the model instance is switched using setModel. The model instance is provided as an argument so that instance-specific signals can be used, but any pairs of signals and slots may be returned from this method.

Returns

a list of 2-tuples where each tuple is a signal, slot pair

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) → QPixmap
grabGesture(self, Qt.GestureType, flags: Union[Qt.GestureFlags, Qt.GestureFlag] = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, Union[QCursor, Qt.CursorShape]) → None
grabShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) → int
graphicsEffect(self) → QGraphicsEffect
graphicsProxyWidget(self) → QGraphicsProxyWidget
hasFocus(self) → bool
hasHeightForWidth(self) → bool
hasMouseTracking(self) → bool
hasTabletTracking(self) → bool
height(self) → int
heightForWidth(self, int) → int
heightMM(self) → int
hide(self)
hideEvent(self, QHideEvent)
hovered

hovered(self, QAction) [signal]

inherits(self, str) → bool
initLayOut()

@overrides: widgetmixins.InitMixin

initPainter(self, QPainter)
initSetDefaults()

@overrides: widgetmixins.InitMixin

initStyleOption(self, QStyleOptionMenuItem, QAction)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) → Qt.InputMethodHints
inputMethodQuery(self, Qt.InputMethodQuery) → Any
MsvMenuBar.insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
insertMenu(self, QAction, QMenu) → QAction
insertSeparator(self, QAction) → QAction
installEventFilter(self, QObject)
isActiveWindow(self) → bool
isAncestorOf(self, QWidget) → bool
isDefaultUp(self) → bool
isEnabled(self) → bool
isEnabledTo(self, QWidget) → bool
isFullScreen(self) → bool
isHidden(self) → bool
isLeftToRight(self) → bool
isMaximized(self) → bool
isMinimized(self) → bool
isModal(self) → bool
isNativeMenuBar(self) → bool
isRightToLeft(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isVisible(self) → bool
isVisibleTo(self, QWidget) → bool
isWidgetType(self) → bool
isWindow(self) → bool
isWindowModified(self) → bool
isWindowType(self) → bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
keyboardGrabber() → QWidget
killTimer(self, int)
layout(self) → QLayout
layoutDirection(self) → Qt.LayoutDirection
leaveEvent(self, QEvent)
locale(self) → QLocale
logicalDpiX(self) → int
logicalDpiY(self) → int
lower(self)
makeInitialModel()
mapFrom(self, QWidget, QPoint) → QPoint
mapFromGlobal(self, QPoint) → QPoint
mapFromParent(self, QPoint) → QPoint
mapTo(self, QWidget, QPoint) → QPoint
mapToGlobal(self, QPoint) → QPoint
mapToParent(self, QPoint) → QPoint
mappedParams()

Return a list of the abstract params that are mapped to.

mask(self) → QRegion
maximumHeight(self) → int
maximumSize(self) → QSize
maximumWidth(self) → int
metaObject(self) → QMetaObject
metric(self, QPaintDevice.PaintDeviceMetric) → int
minimumHeight(self) → int
minimumSize(self) → QSize
minimumSizeHint(self) → QSize
minimumWidth(self) → int
property model
mouseDoubleClickEvent(self, QMouseEvent)
mouseGrabber() → QWidget
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
move(self, QPoint)
MsvMenuBar.move(self, int, int) -> None
moveEvent(self, QMoveEvent)
moveToThread(self, QThread)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]
nativeParentWidget(self) → QWidget
nextInFocusChain(self) → QWidget
normalGeometry(self) → QRect
objectName(self) → str
objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])
overrideWindowState(self, Union[Qt.WindowStates, Qt.WindowState])
paintEngine(self) → QPaintEngine
paintEvent(self, QPaintEvent)
paintingActive(self) → bool
palette(self) → QPalette
parent(self) → QObject
parentWidget(self) → QWidget
physicalDpiX(self) → int
physicalDpiY(self) → int
pos(self) → QPoint
previousInFocusChain(self) → QWidget
property(self, str) → Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)
receivers(self, PYQT_SIGNAL) → int
rect(self) → QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, int)
removeAction(self, QAction)
removeEventFilter(self, QObject)
render(self, QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))
render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) → None
repaint(self)
MsvMenuBar.repaint(self, int, int, int, int) -> None
repaint(self, QRect) → None
repaint(self, QRegion) → None
resetMappedParams()
resize(self, QSize)
MsvMenuBar.resize(self, int, int) -> None
resizeEvent(self, QResizeEvent)
restoreGeometry(self, Union[QByteArray, bytes, bytearray]) → bool
runAllSlots()
saveGeometry(self) → QByteArray
MsvMenuBar.scroll(self, int, int)
MsvMenuBar.scroll(self, int, int, QRect) -> None
sender(self) → QObject
senderSignalIndex(self) → int
setAcceptDrops(self, bool)
setAccessibleDescription(self, str)
setAccessibleName(self, str)
setActiveAction(self, QAction)
setAttribute(self, Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, bool)
setBackgroundRole(self, QPalette.ColorRole)
MsvMenuBar.setBaseSize(self, int, int)
setBaseSize(self, QSize) → None
MsvMenuBar.setContentsMargins(self, int, int, int, int)
setContentsMargins(self, QMargins) → None
setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCornerWidget(self, QWidget, corner: Qt.Corner = Qt.TopRightCorner)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDefaultUp(self, bool)
setDefaults()

@overrides: af2.App

setDisabled(self, bool)
setEnabled(self, bool)
setFixedHeight(self, int)
setFixedSize(self, QSize)
MsvMenuBar.setFixedSize(self, int, int) -> None
setFixedWidth(self, int)
setFocus(self)
setFocus(self, Qt.FocusReason) → None
setFocusPolicy(self, Qt.FocusPolicy)
setFocusProxy(self, QWidget)
setFont(self, QFont)
setForegroundRole(self, QPalette.ColorRole)
setGeometry(self, QRect)
MsvMenuBar.setGeometry(self, int, int, int, int) -> None
setGraphicsEffect(self, QGraphicsEffect)
setHidden(self, bool)
setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLocale(self, QLocale)
setMask(self, QBitmap)
setMask(self, QRegion) → None
setMaximumHeight(self, int)
MsvMenuBar.setMaximumSize(self, int, int)
setMaximumSize(self, QSize) → None
setMaximumWidth(self, int)
setMinimumHeight(self, int)
MsvMenuBar.setMinimumSize(self, int, int)
setMinimumSize(self, QSize) → None
setMinimumWidth(self, int)
setModel(model)

Sets the model object for the mapper. Disconnects the old model, if one is set, and connects the new model. Pass in None to have no model set.

Parameters

model – the model instance or None

setModelWithoutSlots(model)

This is called when this MapperMixin is a sub-widget of a parent MapperMixin. Since the slots will all be called at the end of the parent setModel, they shouldn’t be called during the sub-widget’s setModel.

setMouseTracking(self, bool)
setNativeMenuBar(self, bool)
setObjectName(self, str)
setPalette(self, QPalette)
setParent(self, QWidget)
setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType]) → None
setProperty(self, str, Any) → bool
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
MsvMenuBar.setSizeIncrement(self, int, int)
setSizeIncrement(self, QSize) → None
setSizePolicy(self, QSizePolicy)
setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy) → None
setStatusTip(self, str)
setStyle(self, QStyle)
setStyleSheet(self, str)
MsvMenuBar.setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setVisible(self, bool)
setWhatsThis(self, str)
setWindowFilePath(self, str)
setWindowFlag(self, Qt.WindowType, on: bool = True)
setWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])
setWindowIcon(self, QIcon)
setWindowIconText(self, str)
setWindowModality(self, Qt.WindowModality)
setWindowModified(self, bool)
setWindowOpacity(self, float)
setWindowRole(self, str)
setWindowState(self, Union[Qt.WindowStates, Qt.WindowState])
setWindowTitle(self, str)
setting_model()
sharedPainter(self) → QPainter
show(self)
showEvent(self, QShowEvent)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
signalsBlocked(self) → bool
size(self) → QSize
sizeHint(self) → QSize
sizeIncrement(self) → QSize
sizePolicy(self) → QSizePolicy
stackUnder(self, QWidget)
startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
staticMetaObject = <PyQt5.QtCore.QMetaObject object>
statusTip(self) → str
style(self) → QStyle
styleSheet(self) → str
tabletEvent(self, QTabletEvent)
testAttribute(self, Qt.WidgetAttribute) → bool
thread(self) → QThread
timerEvent(self, QTimerEvent)
toolTip(self) → str
toolTipDuration(self) → int
tr(self, str, disambiguation: str = None, n: int = - 1) → str
triggered

triggered(self, QAction) [signal]

underMouse(self) → bool
ungrabGesture(self, Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, QRect) → None
update(self, QRegion) → None
MsvMenuBar.update(self, int, int, int, int) -> None
updateGeometry(self)
updateMicroFocus(self)
updatesEnabled(self) → bool
visibleRegion(self) → QRegion
whatsThis(self) → str
wheelEvent(self, QWheelEvent)
width(self) → int
widthMM(self) → int
winId(self) → PyQt5.sip.voidptr
window(self) → QWidget
windowFilePath(self) → str
windowFlags(self) → Qt.WindowFlags
windowHandle(self) → QWindow
windowIcon(self) → QIcon
windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str
windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality
windowOpacity(self) → float
windowRole(self) → str
windowState(self) → Qt.WindowStates
windowTitle(self) → str
windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType
x(self) → int
y(self) → int