QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Member Functions | List of all members
QgsLayoutItemPropertiesDialog Class Reference

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

#include <qgslayoutnewitempropertiesdialog.h>

Inheritance diagram for QgsLayoutItemPropertiesDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutItemPropertiesDialog (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 Constructor for QgsLayoutNewItemPropertiesDialog. More...
 
QgsLayoutPoint itemPosition () const
 Returns the current item position defined by the dialog. More...
 
QgsLayoutSize itemSize () const
 Returns the item size defined by the dialog. More...
 
int page () const
 Returns the page number for the new item. More...
 
QgsLayoutItem::ReferencePoint referencePoint () const
 Returns the item reference point defined by the dialog. More...
 
void setItemPosition (QgsLayoutPoint position)
 Sets the item position to show in the dialog. More...
 
void setItemSize (QgsLayoutSize size)
 Sets the item size to show in the dialog. More...
 
void setLayout (QgsLayout *layout)
 Sets the layout associated with the dialog. More...
 
void setReferencePoint (QgsLayoutItem::ReferencePoint point)
 Sets the item reference point defined to show in the dialog. More...
 

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.

Since
QGIS 3.0

Definition at line 36 of file qgslayoutnewitempropertiesdialog.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemPropertiesDialog()

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

Constructor for QgsLayoutNewItemPropertiesDialog.

Definition at line 25 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 77 of file qgslayoutnewitempropertiesdialog.cpp.

◆ itemSize()

QgsLayoutSize QgsLayoutItemPropertiesDialog::itemSize ( ) const

Returns the item size defined by the dialog.

See also
setItemSize()

Definition at line 94 of file qgslayoutnewitempropertiesdialog.cpp.

◆ page()

int QgsLayoutItemPropertiesDialog::page ( ) const

Returns the page number for the new item.

Definition at line 82 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 99 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 62 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 87 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 182 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 140 of file qgslayoutnewitempropertiesdialog.cpp.


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