QGIS API Documentation  3.4.3-Madeira (2f64a3c)
qgspagesizeregistry.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgspagesizeregistry.h
3  --------------------
4  begin : June 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSPAGESIZEREGISTRY_H
19 #define QGSPAGESIZEREGISTRY_H
20 
21 #include "qgslayoutsize.h"
22 #include <QString>
23 #include <QSizeF>
24 #include <QList>
25 
32 class CORE_EXPORT QgsPageSize
33 {
34 
35  public:
36 
37  QgsPageSize();
38 
43  QgsPageSize( const QString &name, const QgsLayoutSize &size, const QString &displayName = QString() );
44 
48  QgsPageSize( const QgsLayoutSize &size );
49 
51  QString name;
52 
55 
57  QString displayName;
58 
59  bool operator==( const QgsPageSize &other ) const;
60  bool operator!=( const QgsPageSize &other ) const;
61 };
62 
73 class CORE_EXPORT QgsPageSizeRegistry
74 {
75  public:
76 
81 
85  void add( const QgsPageSize &size );
86 
90  QList< QgsPageSize > entries() const;
91 
96  QList< QgsPageSize > find( const QString &name ) const;
97 
105  QString find( const QgsLayoutSize &size ) const;
106 
112  bool decodePageSize( const QString &string, QgsPageSize &size );
113 
114  private:
115 
116  QList< QgsPageSize > mPageSizes;
117 };
118 
119 #endif //QGSPAGESIZEREGISTRY_H
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
bool operator!=(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
QString name
Name of page size.
A registry for known page sizes.
A named page size for layouts.
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
Definition: qgslayoutsize.h:40
QgsLayoutSize size
Page size.
QString displayName
Translated page name.