Class: QgsRatioLockButton

class qgis.gui.QgsRatioLockButton

Bases: PyQt5.QtWidgets.QToolButton

A cross platform button subclass used to represent a locked / unlocked ratio state.

New in version 3.0.

QgsRatioLockButton(parent: QWidget = None) Construct a new ratio lock button. Use parent to attach a parent QWidget to the button.

Methods

actionEvent

changeEvent

param e

checkStateSet

childEvent

closeEvent

connectNotify

contextMenuEvent

create

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

hitButton

initPainter

initStyleOption

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

locked

Returns whether the button state is locked.

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

nextCheckState

paintEvent

receivers

resetRatio

Resets the current width/height ratio, taking the width and height from the current values of the width and height spin boxes.

resizeEvent

param event

sender

senderSignalIndex

setHeightSpinBox

Registers a spin box widget as the linked “height” spin box.

setLocked

Sets whether the button state is locked.

setWidthSpinBox

Registers a spin box widget as the linked “width” spin box.

sharedPainter

showEvent

param e

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

lockChanged

Emitted whenever the lock state changes.

actionEvent(self, QActionEvent)
changeEvent(self, e: QEvent)
Parameters

e (QEvent) –

checkStateSet(self)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent)bool
focusInEvent(self, QFocusEvent)
focusNextChild(self)bool
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self)bool
hideEvent(self, QHideEvent)
hitButton(self, QPoint)bool
initPainter(self, QPainter)
initStyleOption(self, QStyleOptionToolButton)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
lockChanged

Emitted whenever the lock state changes. [signal]

Parameters

locked (bool) –

locked(self)bool

Returns whether the button state is locked.

Return type

bool

Returns

True if the button state is locked.

See also

setLocked()

metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
nextCheckState(self)
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL)int
resetRatio(self)

Resets the current width/height ratio, taking the width and height from the current values of the width and height spin boxes.

resizeEvent(self, event: QResizeEvent)
Parameters

event (QResizeEvent) –

sender(self)QObject
senderSignalIndex(self)int
setHeightSpinBox(self, widget: QDoubleSpinBox)

Registers a spin box widget as the linked “height” spin box.

If both a width and height spin box are linked to the button, they will automatically have their values updates when if the other spin box value is changed. I.e. changing the width spin box will automatically update the height spin box to a value which keeps the same locked ratio.

Parameters

widget (QDoubleSpinBox) –

setLocked(self, locked: bool)

Sets whether the button state is locked.

Parameters

locked (bool) – locked state

See also

locked()

setWidthSpinBox(self, widget: QDoubleSpinBox)

Registers a spin box widget as the linked “width” spin box.

If both a width and height spin box are linked to the button, they will automatically have their values updates when if the other spin box value is changed. I.e. changing the width spin box will automatically update the height spin box to a value which keeps the same locked ratio.

Parameters

widget (QDoubleSpinBox) –

sharedPainter(self)QPainter
showEvent(self, e: QShowEvent)
Parameters

e (QShowEvent) –

tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)