Class PrintLayoutListModel

ClassList > PrintLayoutListModel

Inherits the following classes: QAbstractListModel

Public Properties

Type	Name
property QgsVectorLayer *	atlasCoverageLayer
property QgsProject *	project

Public Signals

Type	Name
signal void	atlasCoverageLayerChanged
signal void	projectChanged

Public Functions

Type	Name
	PrintLayoutListModel (QObject * parent=nullptr)
QgsVectorLayer *	atlasCoverageLayer () const Returns the vector layer used to filter layouts to match atlas coverage layer.
QVariant	data (const QModelIndex & index, int role) override const
QgsProject *	project () const Returns the current project from which layouts are retrieved.
Q_INVOKABLE void	reloadModel () triggered when set another project
QHash< int, QByteArray >	roleNames () override const
int	rowCount (const QModelIndex & parent) override const
void	setAtlasCoverageLayer (QgsVectorLayer * layer) Sets the vector layer used to filter layouts to match atlas coverage layer.
void	setProject (QgsProject * project) Sets the project to be used to retrieve layouts.
Q_INVOKABLE const QString	titleAt (int row) const

Public Properties Documentation

property atlasCoverageLayer [1/2]

QgsVectorLayer * PrintLayoutListModel::atlasCoverageLayer;

---

property project [1/2]

QgsProject * PrintLayoutListModel::project;

---

Public Signals Documentation

signal atlasCoverageLayerChanged

void PrintLayoutListModel::atlasCoverageLayerChanged;

---

signal projectChanged

void PrintLayoutListModel::projectChanged;

---

Public Functions Documentation

function PrintLayoutListModel

explicit PrintLayoutListModel::PrintLayoutListModel (
    QObject * parent=nullptr
) 

---

function atlasCoverageLayer [2/2]

Returns the vector layer used to filter layouts to match atlas coverage layer.

QgsVectorLayer * PrintLayoutListModel::atlasCoverageLayer () const

---

function data

QVariant PrintLayoutListModel::data (
    const QModelIndex & index,
    int role
) override const

---

function project [2/2]

Returns the current project from which layouts are retrieved.

QgsProject * PrintLayoutListModel::project () const

---

function reloadModel

triggered when set another project

Q_INVOKABLE void PrintLayoutListModel::reloadModel () 

---

function roleNames

QHash< int, QByteArray > PrintLayoutListModel::roleNames () override const

---

function rowCount

int PrintLayoutListModel::rowCount (
    const QModelIndex & parent
) override const

---

function setAtlasCoverageLayer

Sets the vector layer used to filter layouts to match atlas coverage layer.

void PrintLayoutListModel::setAtlasCoverageLayer (
    QgsVectorLayer * layer
) 

---

function setProject

Sets the project to be used to retrieve layouts.

void PrintLayoutListModel::setProject (
    QgsProject * project
) 

---

function titleAt

Q_INVOKABLE const QString PrintLayoutListModel::titleAt (
    int row
) const

---

---

The documentation for this class was generated from the following file src/core/printlayoutlistmodel.h