A model for items attached to a layout. More...

#include <qgslayoutmodel.h>

Inheritance diagram for QgsLayoutModel:

Public Types
enum	Columns { Visibility = 0, LockStatus, ItemId }
	Columns returned by the model. More...

Public Member Functions
	QgsLayoutModel (QgsLayout layout, QObject parent=nullptr)
	Constructor for a QgsLayoutModel attached to the specified layout. More...

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

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

bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

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

QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override

QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override

QModelIndex	indexForItem (QgsLayoutItem *item, int column=0)
	Returns the QModelIndex corresponding to a QgsLayoutItem item and column, if possible. More...

QgsLayoutItem *	itemFromIndex (const QModelIndex &index) const
	Returns the QgsLayoutItem corresponding to a QModelIndex index, if possible. More...

QMimeData *	mimeData (const QModelIndexList &indexes) const override

QStringList	mimeTypes () const override

QModelIndex	parent (const QModelIndex &index) const override

bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

bool	setData (const QModelIndex &index, const QVariant &value, int role) override

Qt::DropActions	supportedDropActions () const override

Friends
class	TestQgsLayoutGui

class	TestQgsLayoutModel

Detailed Description

A model for items attached to a layout.

The model also maintains the z-order for the layout, and must be notified whenever item stacking changes.

Internally, QgsLayoutModel maintains two lists. One contains a complete list of all items for the layout, ordered by their position within the z-order stack.

The second list contains only items which are currently displayed in the layout's scene. It is used as a cache of the last known stacking order, so that the model can compare the current stacking of items in the layout to the last known state, and emit the corresponding signals as required.

Since: QGIS 3.0

Definition at line 52 of file qgslayoutmodel.h.

Member Enumeration Documentation

enum QgsLayoutModel::Columns

Columns returned by the model.

Enumerator
Visibility	Item visibility checkbox.
LockStatus	Item lock status checkbox.
ItemId	Item ID.

Definition at line 59 of file qgslayoutmodel.h.

Constructor & Destructor Documentation

QgsLayoutModel::QgsLayoutModel	(	QgsLayout *	layout,
		QObject *	parent = `nullptr`
	)

explicit

Constructor for a QgsLayoutModel attached to the specified layout.

Definition at line 31 of file qgslayoutmodel.cpp.

Member Function Documentation

int QgsLayoutModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 113 of file qgslayoutmodel.cpp.

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

override

Definition at line 119 of file qgslayoutmodel.cpp.

bool QgsLayoutModel::dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)

override

Definition at line 312 of file qgslayoutmodel.cpp.

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

override

Definition at line 900 of file qgslayoutmodel.cpp.

QVariant QgsLayoutModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = `Qt::DisplayRole`
	)		const

override

Definition at line 234 of file qgslayoutmodel.cpp.

QModelIndex QgsLayoutModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = `QModelIndex()`
	)		const

override

Definition at line 50 of file qgslayoutmodel.cpp.

QModelIndex QgsLayoutModel::indexForItem	(	QgsLayoutItem *	item,
		int	column = `0`
	)

Returns the QModelIndex corresponding to a QgsLayoutItem item and column, if possible.

See also: itemFromIndex()

Definition at line 921 of file qgslayoutmodel.cpp.

QgsLayoutItem * QgsLayoutModel::itemFromIndex ( const QModelIndex & index ) const

Returns the QgsLayoutItem corresponding to a QModelIndex index, if possible.

See also: indexForItem()

Definition at line 38 of file qgslayoutmodel.cpp.

QMimeData * QgsLayoutModel::mimeData ( const QModelIndexList & indexes ) const

override

Definition at line 282 of file qgslayoutmodel.cpp.

QStringList QgsLayoutModel::mimeTypes ( ) const

override

Definition at line 275 of file qgslayoutmodel.cpp.

QModelIndex QgsLayoutModel::parent ( const QModelIndex & index ) const

override

Definition at line 85 of file qgslayoutmodel.cpp.

bool QgsLayoutModel::removeRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

override

Definition at line 417 of file qgslayoutmodel.cpp.

int QgsLayoutModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 93 of file qgslayoutmodel.cpp.

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

override

Definition at line 200 of file qgslayoutmodel.cpp.

Qt::DropActions QgsLayoutModel::supportedDropActions ( ) const

override

Definition at line 270 of file qgslayoutmodel.cpp.

Friends And Related Function Documentation

friend class TestQgsLayoutGui

friend

Definition at line 296 of file qgslayoutmodel.h.

friend class TestQgsLayoutModel

friend

Definition at line 295 of file qgslayoutmodel.h.

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

/build/qgis-3.4.15+24xenial/src/core/layout/qgslayoutmodel.h
/build/qgis-3.4.15+24xenial/src/core/layout/qgslayoutmodel.cpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation