QgsLayoutItemPropertiesDialog class

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.

Constructors, destructors, conversion operators

QgsLayoutItemPropertiesDialog(QWidget* parent = nullptr, Qt::WindowFlags flags = nullptr)
Constructor for QgsLayoutNewItemPropertiesDialog.

Public functions

auto itemPosition() const -> QgsLayoutPoint
Returns the current item position defined by the dialog.
auto itemSize() const -> QgsLayoutSize
Returns the item size defined by the dialog.
auto page() const -> int
Returns the page number for the new item.
auto referencePoint() const -> QgsLayoutItem::ReferencePoint
Returns the item reference point defined by the dialog.
void setItemPosition(QgsLayoutPoint position)
Sets the item position to show in the dialog.
void setItemSize(QgsLayoutSize size)
Sets the item size to show in the dialog.
void setLayout(QgsLayout* layout)
Sets the layout associated with the dialog.
void setReferencePoint(QgsLayoutItem::ReferencePoint point)
Sets the item reference point defined to show in the dialog.

Function documentation

QgsLayoutPoint QgsLayoutItemPropertiesDialog::itemPosition() const

Returns the current item position defined by the dialog.

QgsLayoutSize QgsLayoutItemPropertiesDialog::itemSize() const

Returns the item size defined by the dialog.

QgsLayoutItem::ReferencePoint QgsLayoutItemPropertiesDialog::referencePoint() const

Returns the item reference point defined by the dialog.

void QgsLayoutItemPropertiesDialog::setItemPosition(QgsLayoutPoint position)

Sets the item position to show in the dialog.

void QgsLayoutItemPropertiesDialog::setItemSize(QgsLayoutSize size)

Sets the item size to show in the dialog.

void QgsLayoutItemPropertiesDialog::setLayout(QgsLayout* layout)

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.

void QgsLayoutItemPropertiesDialog::setReferencePoint(QgsLayoutItem::ReferencePoint point)

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