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.

Class Hierarchy¶

Base classes¶

QDialog
QWidget
QObject
QPaintDevice

Methods

`itemPosition`	Returns the current item position defined by the dialog.
`itemSize`	Returns the item size defined by the dialog.
`page`	Returns the page number for the new item.
`referencePoint`	Returns the item reference point defined by the dialog.
`setItemPosition`	Sets the item position to show in the dialog.
`setItemSize`	Sets the item size to show in the dialog.
`setLayout`	Sets the layout associated with the dialog.
`setReferencePoint`	Sets the item reference point defined to show in the dialog.

class qgis.gui.QgsLayoutItemPropertiesDialog[source]¶

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[source]¶

Returns the current item position defined by the dialog.

See also

setItemPosition()

Return type:: QgsLayoutPoint

itemSize(self) → QgsLayoutSize[source]¶

Returns the item size defined by the dialog.

See also

setItemSize()

Return type:: QgsLayoutSize

page(self) → int[source]¶

Returns the page number for the new item.

Return type:: int

referencePoint(self) → QgsLayoutItem.ReferencePoint[source]¶

Returns the item reference point defined by the dialog.

See also

setReferencePoint()

Return type:: QgsLayoutItem.ReferencePoint

setItemPosition(self, position: QgsLayoutPoint)[source]¶

Sets the item position to show in the dialog.

See also

itemPosition()

Parameters:: position (QgsLayoutPoint)

setItemSize(self, size: QgsLayoutSize)[source]¶

Sets the item size to show in the dialog.

See also

itemSize()

Parameters:: size (QgsLayoutSize)

setLayout(self, layout: QgsLayout | None)[source]¶

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)[source]¶

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

See also

referencePoint()

Parameters:: point (QgsLayoutItem.ReferencePoint)