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

#include <qgslayoutmanagermodel.h>

Inheritance diagram for QgsLayoutManagerModel:

[legend]

Public Types
enum class	CustomRole : int { Layout = Qt::UserRole + 1 }
	Custom model roles. More...
Public Types inherited from QgsProjectStoredObjectManagerModelBase
enum class	CustomRole : int { Object = 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.
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.
void	setAllowEmptyLayout (bool allowEmpty)
	Sets whether an optional empty layout ("not set") option is present in the model.
Public Member Functions inherited from QgsProjectStoredObjectManagerModel< QgsMasterLayoutInterface >
	QgsProjectStoredObjectManagerModel (QgsAbstractProjectStoredObjectManager< QgsMasterLayoutInterface > manager, QObject parent=nullptr)
	Constructor for QgsProjectStoredObjectManagerModel, showing the objects from the specified manager.
bool	allowEmptyObject () const
	Returns `true` if the model allows the empty object ("not set") choice.
QModelIndex	indexFromObject (QgsMasterLayoutInterface *object) const
	Returns the model index corresponding to an object.
QgsMasterLayoutInterface *	objectFromIndex (const QModelIndex &index) const
	Returns the object at the corresponding index.
void	setAllowEmptyObject (bool allowEmpty)
	Sets whether an optional empty object ("not set") option is present in the model.
Public Member Functions inherited from QgsProjectStoredObjectManagerModelBase
	QgsProjectStoredObjectManagerModelBase (QObject *parent=nullptr)
	Constructor for QgsProjectStoredObjectManagerModelBase, with the specified parent object.
QVariant	data (const QModelIndex &index, int role) const override
Qt::ItemFlags	flags (const QModelIndex &index) const override
int	rowCount (const QModelIndex &parent) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

Additional Inherited Members
Protected Attributes inherited from QgsProjectStoredObjectManagerModel< QgsMasterLayoutInterface >
PRIVATE QgsAbstractProjectStoredObjectManager< QgsMasterLayoutInterface > *	mObjectManager
	Object manager.

Detailed Description

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

Since: QGIS 3.8

Definition at line 47 of file qgslayoutmanagermodel.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 62 of file qgslayoutmanagermodel.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 29 of file qgslayoutmanagermodel.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 96 of file qgslayoutmanagermodel.h.

◆ indexFromLayout()

QModelIndex QgsLayoutManagerModel::indexFromLayout ( QgsMasterLayoutInterface * layout ) const

Returns the model index corresponding to a layout.

See also: layoutFromIndex()

Definition at line 40 of file qgslayoutmanagermodel.cpp.

◆ layoutFromIndex()

QgsMasterLayoutInterface * QgsLayoutManagerModel::layoutFromIndex ( const QModelIndex & index ) const

Returns the layout at the corresponding index.

See also: indexFromLayout()

Definition at line 35 of file qgslayoutmanagermodel.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 45 of file qgslayoutmanagermodel.cpp.

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/layout/qgslayoutmanagermodel.h
/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/layout/qgslayoutmanagermodel.cpp

Public Types

Public Member Functions

Additional Inherited Members