QgsGeospatialPdfLayerTreeModel Class Reference

Layer tree model for Geo-PDF layers. More...

#include <qgsgeopdflayertreemodel.h>

Inheritance diagram for QgsGeospatialPdfLayerTreeModel:

Public Types
enum	Columns { LayerColumn = 0 , GroupColumn , InitiallyVisible , IncludeVectorAttributes }
	Model columns. More...
Public Types inherited from QgsMapLayerModel
enum class	CustomRole : int { LayerId = Qt::UserRole + 1 , Layer , Empty , Additional }
	Custom model roles. More...

Public Member Functions
	QgsGeospatialPdfLayerTreeModel (const QList< QgsMapLayer * > &layers, QObject *parent=nullptr)
	constructor
void	checkAll (bool checked, const QModelIndex &parent=QModelIndex(), int column=IncludeVectorAttributes)
	Checks (or unchecks) all rows and children from the specified parent index.
int	columnCount (const QModelIndex &parent) const override
QVariant	data (const QModelIndex &index, int role) const override
Qt::ItemFlags	flags (const QModelIndex &idx) const override
QVariant	headerData (int section, Qt::Orientation orientation, int role) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role) override
Public Member Functions inherited from QgsMapLayerModel
	QgsMapLayerModel (const QList< QgsMapLayer * > &layers, QObject *parent=nullptr, QgsProject *project=nullptr)
	QgsMapLayerModel creates a model to display a specific list of layers in a widget.
	QgsMapLayerModel (QObject *parent=nullptr, QgsProject *project=nullptr)
	QgsMapLayerModel creates a model to display layers in widgets.
QStringList	additionalItems () const
	Returns the list of additional (non map layer) items included at the end of the model.
QList< QgsMapLayer * >	additionalLayers () const
	Returns the list of additional layers added to the model.
bool	allowEmptyLayer () const
	Returns true if the model allows the empty layer ("not set") choice.
bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const override
void	checkAll (Qt::CheckState checkState)
	checkAll changes the checkstate for all the layers
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) 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
QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
QModelIndex	indexFromLayer (QgsMapLayer *layer) const
	indexFromLayer returns the model index for a given layer
bool	insertRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
bool	itemsCanBeReordered () const
	Returns true if items in the model can be reordered via drag and drop.
bool	itemsCheckable () const
	Returns whether the items can be checked or not.
QgsMapLayer *	layerFromIndex (const QModelIndex &index) const
	Returns the map layer corresponding to the specified index.
QList< QgsMapLayer * >	layersChecked (Qt::CheckState checkState=Qt::Checked)
	Returns the list of layers which are checked (or unchecked).
QMimeData *	mimeData (const QModelIndexList &indexes) const override
QStringList	mimeTypes () const override
QModelIndex	parent (const QModelIndex &child) const override
bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
QHash< int, QByteArray >	roleNames () const override
	Returns strings for all roles supported by this model.
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
void	setAdditionalItems (const QStringList &items)
	Sets a list of additional (non map layer) items to include at the end of the model.
void	setAdditionalLayers (const QList< QgsMapLayer * > &layers)
	Sets a list of additional layers to include in the model.
void	setAllowEmptyLayer (bool allowEmpty, const QString &text=QString(), const QIcon &icon=QIcon())
	Sets whether an optional empty layer ("not set") option is present in the model.
bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
void	setItemsCanBeReordered (bool allow)
	Sets whether items in the model can be reordered via drag and drop.
void	setItemsCheckable (bool checkable)
	Defines if layers should be selectable in the widget.
void	setLayersChecked (const QList< QgsMapLayer * > &layers)
	Sets which layers are checked in the model.
void	setProject (QgsProject *project)
	Sets the QgsProject from which map layers are shown.
void	setShowCrs (bool showCrs)
	Sets whether the CRS of layers is also included in the model's display role.
bool	showCrs () const
	Returns true if the model includes layer's CRS in the display role.
Qt::DropActions	supportedDropActions () const override

Additional Inherited Members
Static Public Member Functions inherited from QgsMapLayerModel
static QIcon	iconForLayer (QgsMapLayer *layer)
	Returns the icon corresponding to a specified map layer.
Protected Slots inherited from QgsMapLayerModel
void	addLayers (const QList< QgsMapLayer * > &layers)
void	removeLayers (const QStringList &layerIds)
Protected Attributes inherited from QgsMapLayerModel
QList< QPointer< QgsMapLayer > >	mAdditionalLayers
bool	mCanReorder = false
bool	mItemCheckable = false
QList< QgsMapLayer * >	mLayers
QMap< QString, Qt::CheckState >	mLayersChecked
QgsProject *	mProject = nullptr
Properties inherited from QgsMapLayerModel
QStringList	additionalItems
bool	allowEmptyLayer
bool	itemsCheckable
bool	showCrs

Detailed Description

Layer tree model for Geo-PDF layers.

Note

This class is not a part of public API

Since

QGIS 3.12

Definition at line 39 of file qgsgeopdflayertreemodel.h.

Member Enumeration Documentation

Columns

enum QgsGeospatialPdfLayerTreeModel::Columns

Model columns.

Enumerator
LayerColumn	Layer name.
GroupColumn	PDF group.
InitiallyVisible	Initial visibility state.
IncludeVectorAttributes	Vector attribute.

Definition at line 45 of file qgsgeopdflayertreemodel.h.

Constructor & Destructor Documentation

QgsGeospatialPdfLayerTreeModel()

QgsGeospatialPdfLayerTreeModel::QgsGeospatialPdfLayerTreeModel	(	const QList< QgsMapLayer * > &	layers,
		QObject *	parent = nullptr )

constructor

Definition at line 28 of file qgsgeopdflayertreemodel.cpp.

Member Function Documentation

checkAll()

void QgsGeospatialPdfLayerTreeModel::checkAll	(	bool	checked,
		const QModelIndex &	parent = QModelIndex(),
		int	column = IncludeVectorAttributes )

Checks (or unchecks) all rows and children from the specified parent index.

Definition at line 225 of file qgsgeopdflayertreemodel.cpp.

columnCount()

int QgsGeospatialPdfLayerTreeModel::columnCount ( const QModelIndex & parent ) const

override

Definition at line 34 of file qgsgeopdflayertreemodel.cpp.

data()

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

override

Definition at line 98 of file qgsgeopdflayertreemodel.cpp.

flags()

Qt::ItemFlags QgsGeospatialPdfLayerTreeModel::flags ( const QModelIndex & idx ) const

override

Definition at line 40 of file qgsgeopdflayertreemodel.cpp.

headerData()

QVariant QgsGeospatialPdfLayerTreeModel::headerData ( int section, Qt::Orientation orientation, int role ) const

override

Definition at line 74 of file qgsgeopdflayertreemodel.cpp.

setData()

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

override

Definition at line 173 of file qgsgeopdflayertreemodel.cpp.

---

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

• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/gui/layout/qgsgeopdflayertreemodel.h
• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/gui/layout/qgsgeopdflayertreemodel.cpp