QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Public Member Functions | Public Attributes | List of all members
QgsPageSize Class Reference

A named page size for layouts. More...

#include <qgspagesizeregistry.h>

Public Member Functions

 QgsPageSize ()
 
 QgsPageSize (const QgsLayoutSize &size)
 Constructor for QgsPageSize, accepting a page size. More...
 
 QgsPageSize (const QString &name, const QgsLayoutSize &size, const QString &displayName=QString())
 Constructor for QgsPageSize, accepting the name of the page size and page size. More...
 
bool operator!= (const QgsPageSize &other) const
 
bool operator== (const QgsPageSize &other) const
 

Public Attributes

QString displayName
 Translated page name. More...
 
QString name
 Name of page size. More...
 
QgsLayoutSize size
 Page size. More...
 

Detailed Description

A named page size for layouts.

Since
QGIS 3.0

Definition at line 32 of file qgspagesizeregistry.h.

Constructor & Destructor Documentation

◆ QgsPageSize() [1/3]

QgsPageSize::QgsPageSize ( )

Definition at line 126 of file qgspagesizeregistry.cpp.

◆ QgsPageSize() [2/3]

QgsPageSize::QgsPageSize ( const QString &  name,
const QgsLayoutSize size,
const QString &  displayName = QString() 
)

Constructor for QgsPageSize, accepting the name of the page size and page size.

Definition at line 131 of file qgspagesizeregistry.cpp.

◆ QgsPageSize() [3/3]

QgsPageSize::QgsPageSize ( const QgsLayoutSize size)

Constructor for QgsPageSize, accepting a page size.

Definition at line 138 of file qgspagesizeregistry.cpp.

Member Function Documentation

◆ operator!=()

bool QgsPageSize::operator!= ( const QgsPageSize other) const

Definition at line 149 of file qgspagesizeregistry.cpp.

◆ operator==()

bool QgsPageSize::operator== ( const QgsPageSize other) const

Definition at line 144 of file qgspagesizeregistry.cpp.

Member Data Documentation

◆ displayName

QString QgsPageSize::displayName

Translated page name.

Definition at line 57 of file qgspagesizeregistry.h.

◆ name

QString QgsPageSize::name

Name of page size.

Definition at line 51 of file qgspagesizeregistry.h.

◆ size

QgsLayoutSize QgsPageSize::size

Page size.

Definition at line 54 of file qgspagesizeregistry.h.


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