QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgslayoutaddpagesdialog.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutaddpagesdialog.h
3  -------------------------
4  Date : July 2017
5  Copyright : (C) 2017 Nyall Dawson
6  Email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSLAYOUTADDPAGESDIALOG_H
17 #define QGSLAYOUTADDPAGESDIALOG_H
18 
19 // We don't want to expose this in the public API
20 #define SIP_NO_FILE
21 
22 #include "qgis_sip.h"
23 #include "qgis_gui.h"
24 #include "ui_qgslayoutnewpagedialog.h"
25 
26 #include "qgslayoutsize.h"
27 #include "qgslayoutpoint.h"
28 #include "qgslayoutitem.h"
30 
38 class GUI_EXPORT QgsLayoutAddPagesDialog : public QDialog, private Ui::QgsLayoutNewPageDialog
39 {
40  Q_OBJECT
41 
42  public:
43 
46  {
49  AtEnd
50  };
51 
55  QgsLayoutAddPagesDialog( QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags() );
56 
62  void setLayout( QgsLayout *layout );
63 
67  int numberPages() const;
68 
72  PagePosition pagePosition() const;
73 
77  int beforePage() const;
78 
82  QgsLayoutSize pageSize() const;
83 
84  private slots:
85 
86  void positionChanged( int index );
87  void pageSizeChanged( int index );
88  void orientationChanged( int index );
89  void setToCustomSize();
90  void showHelp();
91 
92  private:
93 
94  bool mSettingPresetSize = false;
95 
97 
98 };
99 
100 #endif // QGSLAYOUTADDPAGESDIALOG_H
QgsLayoutAddPagesDialog::BeforePage
@ BeforePage
Definition: qgslayoutaddpagesdialog.h:47
QgsLayoutAddPagesDialog::AfterPage
@ AfterPage
Definition: qgslayoutaddpagesdialog.h:48
QgsLayoutAddPagesDialog::PagePosition
PagePosition
Page insertion positions.
Definition: qgslayoutaddpagesdialog.h:46
qgslayoutsize.h
qgslayoutpoint.h
qgslayoutmeasurementconverter.h
qgslayoutitem.h
qgis_sip.h
QgsLayoutAddPagesDialog
A dialog for configuring properties of new pages to be added to a layout.
Definition: qgslayoutaddpagesdialog.h:39
QgsLayoutMeasurementConverter
This class provides a method of converting QgsLayoutMeasurements from one unit to another.
Definition: qgslayoutmeasurementconverter.h:41
QgsLayout
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:50
QgsLayoutSize
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
Definition: qgslayoutsize.h:41