Class: QgsLayoutItemPropertiesWidget

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.

QgsLayoutItemPropertiesWidget

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Methods

initializeDataDefinedButtons	Initializes data defined buttons to current atlas coverage layer
populateDataDefinedButtons	Sets data defined button state to match item
positionMode	Returns the position mode
setItem	Sets the layout item
setMasterLayout	Sets the master layout associated with the item.
showBackgroundGroup	Determines if the background of the group box shall be shown
showFrameGroup	Determines if the frame of the group box shall be shown
updateVariables	Updates the variables widget, refreshing the values of variables shown.

class qgis.gui.QgsLayoutItemPropertiesWidget

Bases: QWidget

__init__(parent: QWidget | None, item: QgsLayoutItem | None)

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

Parameters:

• parent (Optional[QWidget])

• item (Optional[QgsLayoutItem])

initializeDataDefinedButtons(self)

Initializes data defined buttons to current atlas coverage layer

populateDataDefinedButtons(self)

Sets data defined button state to match item

positionMode(self) → QgsLayoutItem.ReferencePoint

Returns the position mode

Return type:

QgsLayoutItem.ReferencePoint

setItem(self, item: QgsLayoutItem | None)

Sets the layout item

Parameters:

item (Optional[QgsLayoutItem])

setMasterLayout(self, masterLayout: QgsMasterLayoutInterface | None)

Sets the master layout associated with the item.

Added in version 3.10.

Parameters:

masterLayout (Optional[QgsMasterLayoutInterface])

showBackgroundGroup(self, showGroup: bool)

Determines if the background of the group box shall be shown

Parameters:

showGroup (bool)

showFrameGroup(self, showGroup: bool)

Determines if the frame of the group box shall be shown

Parameters:

showGroup (bool)

updateVariables(self)

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

Added in version 3.10.