Class: QgsLayoutUnitsComboBox¶
- class qgis.gui.QgsLayoutUnitsComboBox¶
Bases:
PyQt5.QtWidgets.QComboBox
A custom combo box for selecting units for layout settings.
New in version 3.0.
QgsLayoutUnitsComboBox(parent: QWidget = None) Constructor for QgsLayoutUnitsComboBox.
Methods
Returns the converter used when automatically converting units for linked widgets.
Registers a spin box
widget
as linked with the combo box.Sets a
converter
to use when automatically converting units for linked widgets.Sets the
unit
currently selected in the combo box.Returns the unit currently selected in the combo box.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- actionEvent(self, QActionEvent)¶
- changeEvent(self, QEvent)¶
- changed¶
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.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- converter(self) QgsLayoutMeasurementConverter ¶
Returns the converter used when automatically converting units for linked widgets.
See also
- Return type:
- create(self, window: PyQt5.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)¶
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- initPainter(self, QPainter)¶
- initStyleOption(self, QStyleOptionComboBox)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
- linkToWidget(self, widget: QDoubleSpinBox)¶
Registers a spin box
widget
as linked with the combo box.Registered spin boxes will automatically be upodated whenever the unit is changed. I.e. a spin box with a value of 100 will be set to 1 when the unit is changed from centimeters to meters.
A measurement
converter()
must be set in order for the automatic unit conversion to occur.See also
- Parameters:
widget (QDoubleSpinBox) –
- 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], PyQt5.sip.voidptr) Tuple[bool, int] ¶
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) int ¶
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setConverter(self, converter: QgsLayoutMeasurementConverter)¶
Sets a
converter
to use when automatically converting units for linked widgets. The ownership ofconverter
is not transferred, and converter must exist for the life of the combo box.See also
- Parameters:
converter (QgsLayoutMeasurementConverter) –
- setUnit(self, unit: QgsUnitTypes.LayoutUnit)¶
Sets the
unit
currently selected in the combo box.See also
- Parameters:
unit (QgsUnitTypes.LayoutUnit) –
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- unit(self) QgsUnitTypes.LayoutUnit ¶
Returns the unit currently selected in the combo box.
See also
- Return type:
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶