Class: QgsLayoutItemPropertiesWidget

class qgis.gui.QgsLayoutItemPropertiesWidget(parent: QWidget, item: QgsLayoutItem)

Bases: PyQt5.QtWidgets.QWidget

Constructs a QgsLayoutItemPropertiesWidget with a parent and for the given layout item.

A widget for controlling the common properties of layout items (e.g. position and size, background, stroke, frame). This widget can be embedded into other layout item widgets.

New in version 3.0.

  • parent (QWidget) –

  • item

actionEvent(self, QActionEvent)
changeEvent(self, QEvent)
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)
initPainter(self, QPainter)

Initializes data defined buttons to current atlas coverage layer

inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) → bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
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]
paintEvent(self, QPaintEvent)

Sets data defined button state to match item

positionMode(self) → QgsLayoutItem.ReferencePoint

Returns the position mode

Return type


receivers(self, PYQT_SIGNAL) → int
resizeEvent(self, QResizeEvent)
sender(self) → QObject
senderSignalIndex(self) → int
setItem(self, item: QgsLayoutItem)

Sets the layout item


item (QgsLayoutItem) –

setMasterLayout(self, masterLayout: QgsMasterLayoutInterface)

Sets the master layout associated with the item.

New in version 3.10.


masterLayout (QgsMasterLayoutInterface) –

sharedPainter(self) → QPainter
showBackgroundGroup(self, showGroup: bool)

Determines if the background of the group box shall be shown


showGroup (bool) –

showEvent(self, QShowEvent)
showFrameGroup(self, showGroup: bool)

Determines if the frame of the group box shall be shown


showGroup (bool) –

tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)

Updates the variables widget, refreshing the values of variables shown.

New in version 3.10.

wheelEvent(self, QWheelEvent)