QgsLayoutAddPagesDialog Class Reference

A dialog for configuring properties of new pages to be added to a layout. More...

#include <qgslayoutaddpagesdialog.h>

Inheritance diagram for QgsLayoutAddPagesDialog:

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.
int	beforePage () const
	Returns the page number for which new pages should be inserted before/after.
int	numberPages () const
	Returns the number of pages to insert.
PagePosition	pagePosition () const
	Returns the position at which to insert the new pages.
QgsLayoutSize	pageSize () const
	Returns the desired page size.
void	setLayout (QgsLayout *layout)
	Sets the layout associated with the dialog.

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

enum QgsLayoutAddPagesDialog::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 25 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 80 of file qgslayoutaddpagesdialog.cpp.

numberPages()

int QgsLayoutAddPagesDialog::numberPages

(

)

const

Returns the number of pages to insert.

Definition at line 70 of file qgslayoutaddpagesdialog.cpp.

pagePosition()

QgsLayoutAddPagesDialog::PagePosition QgsLayoutAddPagesDialog::pagePosition

(

)

const

Returns the position at which to insert the new pages.

Definition at line 75 of file qgslayoutaddpagesdialog.cpp.

pageSize()

QgsLayoutSize QgsLayoutAddPagesDialog::pageSize

(

)

const

Returns the desired page size.

Definition at line 85 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 62 of file qgslayoutaddpagesdialog.cpp.

---

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

• /build/qgis-3.40.0+99sid/src/gui/layout/qgslayoutaddpagesdialog.h
• /build/qgis-3.40.0+99sid/src/gui/layout/qgslayoutaddpagesdialog.cpp