QgsLayoutManagerModel Class Reference

List model representing the print layouts and reports available in a layout manager. More...

#include <qgslayoutmanager.h>

Inheritance diagram for QgsLayoutManagerModel:

Public Types
enum class	CustomRole : int { Layout = Qt::UserRole + 1 }
	Custom model roles. More...

Public Member Functions
	QgsLayoutManagerModel (QgsLayoutManager *manager, QObject *parent=nullptr)
	Constructor for QgsLayoutManagerModel, showing the layouts from the specified manager.
bool	allowEmptyLayout () const
	Returns true if the model allows the empty layout ("not set") choice.
QVariant	data (const QModelIndex &index, int role) const override
Qt::ItemFlags	flags (const QModelIndex &index) const override
QModelIndex	indexFromLayout (QgsMasterLayoutInterface *layout) const
	Returns the model index corresponding to a layout.
QgsMasterLayoutInterface *	layoutFromIndex (const QModelIndex &index) const
	Returns the layout at the corresponding index.
int	rowCount (const QModelIndex &parent) const override
void	setAllowEmptyLayout (bool allowEmpty)
	Sets whether an optional empty layout ("not set") option is present in the model.
bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

Detailed Description

List model representing the print layouts and reports available in a layout manager.

Since

QGIS 3.8

Definition at line 171 of file qgslayoutmanager.h.

Member Enumeration Documentation

CustomRole

enum class QgsLayoutManagerModel::CustomRole : int

strong

Custom model roles.

Note

Prior to QGIS 3.36 this was available as QgsLayoutManagerModel::Role

Since

QGIS 3.36

Enumerator
Layout	Layout object.

Definition at line 185 of file qgslayoutmanager.h.

Constructor & Destructor Documentation

QgsLayoutManagerModel()

QgsLayoutManagerModel::QgsLayoutManagerModel ( QgsLayoutManager *  manager, QObject *  parent = nullptr  )

explicit

Constructor for QgsLayoutManagerModel, showing the layouts from the specified manager.

Definition at line 339 of file qgslayoutmanager.cpp.

Member Function Documentation

allowEmptyLayout()

bool QgsLayoutManagerModel::allowEmptyLayout ( ) const

inline

Returns true if the model allows the empty layout ("not set") choice.

See also

setAllowEmptyLayout()

Definition at line 224 of file qgslayoutmanager.h.

data()

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

override

Definition at line 356 of file qgslayoutmanager.cpp.

flags()

Qt::ItemFlags QgsLayoutManagerModel::flags ( const QModelIndex &  index ) const

override

Definition at line 437 of file qgslayoutmanager.cpp.

indexFromLayout()

QModelIndex QgsLayoutManagerModel::indexFromLayout

(

QgsMasterLayoutInterface *

layout

)

const

Returns the model index corresponding to a layout.

See also

layoutFromIndex()

Definition at line 466 of file qgslayoutmanager.cpp.

layoutFromIndex()

QgsMasterLayoutInterface * QgsLayoutManagerModel::layoutFromIndex

(

const QModelIndex &

index

)

const

Returns the layout at the corresponding index.

See also

indexFromLayout()

Definition at line 453 of file qgslayoutmanager.cpp.

rowCount()

int QgsLayoutManagerModel::rowCount ( const QModelIndex &  parent ) const

override

Definition at line 350 of file qgslayoutmanager.cpp.

setAllowEmptyLayout()

void QgsLayoutManagerModel::setAllowEmptyLayout

(

bool

allowEmpty

)

Sets whether an optional empty layout ("not set") option is present in the model.

See also

allowEmptyLayout()

Definition at line 486 of file qgslayoutmanager.cpp.

setData()

bool QgsLayoutManagerModel::setData ( const QModelIndex &  index, const QVariant &  value, int  role = Qt::EditRole  )

override

Definition at line 393 of file qgslayoutmanager.cpp.

---

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

• /build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/layout/qgslayoutmanager.h
• /build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/layout/qgslayoutmanager.cpp