A dialog for configuring properties of new pages to be added to a layout. More...
#include <qgslayoutaddpagesdialog.h>
Public Types | |
| enum | PagePosition { BeforePage , AfterPage , AtEnd } |
| Page insertion positions. More... | |
Public Member Functions | |
| QgsLayoutAddPagesDialog (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags()) | |
| Constructor for QgsLayoutAddPagesDialog. More... | |
| int | beforePage () const |
| Returns the page number for which new pages should be inserted before/after. More... | |
| int | numberPages () const |
| Returns the number of pages to insert. More... | |
| PagePosition | pagePosition () const |
| Returns the position at which to insert the new pages. More... | |
| QgsLayoutSize | pageSize () const |
| Returns the desired page size. More... | |
| void | setLayout (QgsLayout *layout) |
| Sets the layout associated with the dialog. More... | |
Detailed Description
A dialog for configuring properties of new pages to be added to a layout.
- Note
- This class is not a part of public API
- Since
- QGIS 3.12
Definition at line 38 of file qgslayoutaddpagesdialog.h.
Member Enumeration Documentation
◆ PagePosition
Page insertion positions.
| Enumerator | |
|---|---|
| BeforePage | |
| AfterPage | |
| AtEnd | |
Definition at line 45 of file qgslayoutaddpagesdialog.h.
Constructor & Destructor Documentation
◆ QgsLayoutAddPagesDialog()
| QgsLayoutAddPagesDialog::QgsLayoutAddPagesDialog | ( | QWidget * | parent = nullptr, |
| Qt::WindowFlags | flags = Qt::WindowFlags() |
||
| ) |
Constructor for QgsLayoutAddPagesDialog.
Definition at line 24 of file qgslayoutaddpagesdialog.cpp.
Member Function Documentation
◆ beforePage()
| int QgsLayoutAddPagesDialog::beforePage | ( | ) | const |
Returns the page number for which new pages should be inserted before/after.
Definition at line 79 of file qgslayoutaddpagesdialog.cpp.
◆ numberPages()
| int QgsLayoutAddPagesDialog::numberPages | ( | ) | const |
Returns the number of pages to insert.
Definition at line 69 of file qgslayoutaddpagesdialog.cpp.
◆ pagePosition()
| QgsLayoutAddPagesDialog::PagePosition QgsLayoutAddPagesDialog::pagePosition | ( | ) | const |
Returns the position at which to insert the new pages.
Definition at line 74 of file qgslayoutaddpagesdialog.cpp.
◆ pageSize()
| QgsLayoutSize QgsLayoutAddPagesDialog::pageSize | ( | ) | const |
Returns the desired page size.
Definition at line 84 of file qgslayoutaddpagesdialog.cpp.
◆ setLayout()
| void QgsLayoutAddPagesDialog::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 61 of file qgslayoutaddpagesdialog.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.24.2+99sid/src/gui/layout/qgslayoutaddpagesdialog.h
- /build/qgis-3.24.2+99sid/src/gui/layout/qgslayoutaddpagesdialog.cpp
