Class: QgsLayoutItemPropertiesDialog

A dialog for configuring properties like the size and position of layout items.

This is usually used only when constructing new layout items, allowing users to precisely enter their sizes and positions.

QgsLayoutItemPropertiesDialog

Class Hierarchy

Base classes

QDialog
QWidget
QObject
QPaintDevice

class qgis.gui.QgsLayoutItemPropertiesDialog

Bases: QDialog

__init__(parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = Qt.WindowFlags())

Constructor for QgsLayoutNewItemPropertiesDialog.

Parameters:

• parent (Optional[QWidget] = None)

• flags (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())

itemPosition(self) → QgsLayoutPoint

Returns the current item position defined by the dialog.

See also

setItemPosition()

Return type:

QgsLayoutPoint

itemSize(self) → QgsLayoutSize

Returns the item size defined by the dialog.

See also

setItemSize()

Return type:

QgsLayoutSize

page(self) → int

Returns the page number for the new item.

Return type:

int

referencePoint(self) → QgsLayoutItem.ReferencePoint

Returns the item reference point defined by the dialog.

See also

setReferencePoint()

Return type:

QgsLayoutItem.ReferencePoint

setItemPosition(self, position: QgsLayoutPoint)

Sets the item position to show in the dialog.

See also

itemPosition()

Parameters:

position (QgsLayoutPoint)

setItemSize(self, size: QgsLayoutSize)

Sets the item size to show in the dialog.

See also

itemSize()

Parameters:

size (QgsLayoutSize)

setLayout(self, layout: QgsLayout | None)

Sets the layout associated with the dialog. This allows the dialog to retrieve properties from the layout and perform tasks like automatic conversion of units.

Parameters:

layout (Optional[QgsLayout])

setReferencePoint(self, point: QgsLayoutItem.ReferencePoint)

Sets the item reference point defined to show in the dialog.

See also

referencePoint()

Parameters:

point (QgsLayoutItem.ReferencePoint)