A model for representing the sublayers present in a URI. More...

#include <qgsprovidersublayermodel.h>

Inheritance diagram for QgsProviderSublayerModel:

[legend]

Classes
class	NonLayerItem
	Contains details for a non-sublayer item to include in a QgsProviderSublayerModel. More...

Public Types
enum class	Column : int { Name = 0 , Description = 1 }
	Model columns. More...

enum class	Role : int { ProviderKey = Qt::UserRole + 1 , LayerType , Uri , Name , Description , Path , FeatureCount , WkbType , GeometryColumnName , LayerNumber , IsNonLayerItem , NonLayerItemType , Flags }
	Custom model roles. More...

Public Member Functions
	QgsProviderSublayerModel (QObject *parent=nullptr)
	Constructor for QgsProviderSublayerModel, with the specified parent object.

void	addNonLayerItem (const QgsProviderSublayerModel::NonLayerItem &item)
	Adds a non-layer item (e.g.

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

QVariant	data (const QModelIndex &index, int role) const 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

QgsProviderSublayerModel::NonLayerItem	indexToNonLayerItem (const QModelIndex &index) const
	Returns the non layer item corresponding to the given index.

QgsProviderSublayerDetails	indexToSublayer (const QModelIndex &index) const
	Returns the sublayer corresponding to the given index.

QModelIndex	parent (const QModelIndex &index) const override

int	rowCount (const QModelIndex &parent) const override

void	setSublayerDetails (const QList< QgsProviderSublayerDetails > &details)
	Sets the sublayer details to show in the model.

QList< QgsProviderSublayerDetails >	sublayerDetails () const
	Returns the sublayer details shown in the model.

Protected Attributes
std::unique_ptr< QgsProviderSublayerModelGroup >	mRootNode

QList< QgsProviderSublayerDetails >	mSublayers
	Sublayer list.

Detailed Description

A model for representing the sublayers present in a URI.

QgsProviderSublayerModel is designed to present a tree view of the sublayers available for a URI, including any vector, raster or mesh sublayers present.

Additionally, QgsProviderSublayerModel can include some non-sublayer items, e.g. in order to represent other content available for a URI, such as embedded project items. The non-sublayer items can be added by calling addNonLayerItem().

Since: QGIS 3.22

Definition at line 54 of file qgsprovidersublayermodel.h.

Member Enumeration Documentation

◆ Column

enum class QgsProviderSublayerModel::Column : int

strong

Model columns.

Enumerator
Name	Layer name.
Description	Layer description.

Definition at line 79 of file qgsprovidersublayermodel.h.

◆ Role

enum class QgsProviderSublayerModel::Role : int

strong

Custom model roles.

Enumerator
ProviderKey	Provider key.
LayerType	Layer type.
Uri	Layer URI.
Name	Layer name.
Description	Layer description.
Path	Layer path.
FeatureCount	Feature count (for vector sublayers)
WkbType	WKB geometry type (for vector sublayers)
GeometryColumnName	Geometry column name (for vector sublayers)
LayerNumber	Layer number.
IsNonLayerItem	`true` if item is a non-sublayer item (e.g. an embedded project)
NonLayerItemType	Item type (for non-sublayer items)
Flags	Sublayer flags.