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

#include <qgslayoutnewitempropertiesdialog.h>

Inheritance diagram for QgsLayoutItemPropertiesDialog:

[legend]

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

QgsLayoutPoint	itemPosition () const
	Returns the current item position defined by the dialog.

QgsLayoutSize	itemSize () const
	Returns the item size defined by the dialog.

int	page () const
	Returns the page number for the new item.

QgsLayoutItem::ReferencePoint	referencePoint () const
	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.

Detailed Description

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.

Definition at line 35 of file qgslayoutnewitempropertiesdialog.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemPropertiesDialog()

QgsLayoutItemPropertiesDialog::QgsLayoutItemPropertiesDialog	(	QWidget *	parent = `nullptr`,
		Qt::WindowFlags	flags = `Qt::WindowFlags()`
	)

Constructor for QgsLayoutNewItemPropertiesDialog.

Definition at line 27 of file qgslayoutnewitempropertiesdialog.cpp.

Member Function Documentation

◆ itemPosition()

QgsLayoutPoint QgsLayoutItemPropertiesDialog::itemPosition ( ) const

Returns the current item position defined by the dialog.

See also: setItemPosition()

Definition at line 79 of file qgslayoutnewitempropertiesdialog.cpp.

◆ itemSize()

QgsLayoutSize QgsLayoutItemPropertiesDialog::itemSize ( ) const

Returns the item size defined by the dialog.

See also: setItemSize()

Definition at line 96 of file qgslayoutnewitempropertiesdialog.cpp.

◆ page()

int QgsLayoutItemPropertiesDialog::page ( ) const

Returns the page number for the new item.

Definition at line 84 of file qgslayoutnewitempropertiesdialog.cpp.

◆ referencePoint()

QgsLayoutItem::ReferencePoint QgsLayoutItemPropertiesDialog::referencePoint ( ) const

Returns the item reference point defined by the dialog.

See also: setReferencePoint()

Definition at line 101 of file qgslayoutnewitempropertiesdialog.cpp.

◆ setItemPosition()

void QgsLayoutItemPropertiesDialog::setItemPosition ( QgsLayoutPoint position )

Sets the item position to show in the dialog.

See also: itemPosition()

Definition at line 64 of file qgslayoutnewitempropertiesdialog.cpp.

◆ setItemSize()

void QgsLayoutItemPropertiesDialog::setItemSize ( QgsLayoutSize size )

Sets the item size to show in the dialog.

See also: itemSize()

Definition at line 89 of file qgslayoutnewitempropertiesdialog.cpp.

◆ setLayout()

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.

Definition at line 184 of file qgslayoutnewitempropertiesdialog.cpp.

◆ setReferencePoint()

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

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

See also: referencePoint()

Definition at line 142 of file qgslayoutnewitempropertiesdialog.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/layout/qgslayoutnewitempropertiesdialog.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/layout/qgslayoutnewitempropertiesdialog.cpp

Public Member Functions