Class: QgsRatioLockButton

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

Class Hierarchy

Base classes

QToolButton
QAbstractButton
QWidget
QObject
QPaintDevice

class qgis.gui.QgsRatioLockButton

Bases: QToolButton

__init__(parent: QWidget | None = None)

Construct a new ratio lock button. Use parent to attach a parent QWidget to the button.

Parameters:

parent (Optional[QWidget] = None)

signal lockChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

locked(self) → bool

Returns whether the button state is locked.

Return type:

bool

Returns:

True if the button state is locked.

See also

setLocked()

resetRatio(self)

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

setHeightSpinBox(self, widget: QDoubleSpinBox | None)

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.

See also

setWidthSpinBox()

Parameters:

widget (Optional[QDoubleSpinBox])

setLocked(self, locked: bool)

Sets whether the button state is locked.

Parameters:

locked (bool) – locked state

See also

locked()

setWidthSpinBox(self, widget: QDoubleSpinBox | None)

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.

See also

setHeightSpinBox()

Parameters:

widget (Optional[QDoubleSpinBox])