QGIS API Documentation: QgsLayerMetadataResultsModel Class Reference

QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)

The QgsLayerMetadataResultsModel class handles the metadata fetching from the registered layer metadata providers. More...

#include <qgslayermetadataresultsmodel.h>

Inheritance diagram for QgsLayerMetadataResultsModel:

Inheritance graph

[legend]

Public Types
enum	Roles { Metadata = Qt::ItemDataRole::UserRole }
	The Roles enum represents the user roles for the model. More...

enum	Sections { Identifier , Title , Abstract , DataProviderName , GeometryType }
	The Sections enum represents the data columns. More...

Public Slots
void	cancel ()
	Cancels the results fetching. More...

void	resultsReady (const QgsLayerMetadataSearchResults &results)
	Triggered when metadata results have been fetched and can be added to the model. More...

Signals
void	progressChanged (int progress)
	Emitted when the progress changed to progress. More...

Public Member Functions
	QgsLayerMetadataResultsModel (const QgsMetadataSearchContext &searchContext, QObject *parent=nullptr)
	Constructs a QgsLayerMetadataResultsModel from a searchContext and an optional parent. More...

	~QgsLayerMetadataResultsModel ()

int	columnCount (const QModelIndex &parent) const override

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

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

void	reload ()
	Load/Reload model data synchronously. More...

void	reloadAsync ()
	Load/Reload model data asynchronously using threads. More...

int	rowCount (const QModelIndex &parent) const override

Detailed Description

The QgsLayerMetadataResultsModel class handles the metadata fetching from the registered layer metadata providers.

Since: QGIS 3.28

Definition at line 71 of file qgslayermetadataresultsmodel.h.

Member Enumeration Documentation

◆ Roles

enum QgsLayerMetadataResultsModel::Roles

The Roles enum represents the user roles for the model.

Enumerator
Metadata	Layer metadata role.

Definition at line 102 of file qgslayermetadataresultsmodel.h.

◆ Sections

enum QgsLayerMetadataResultsModel::Sections

The Sections enum represents the data columns.

Enumerator
Identifier	Metadata identifier.
Title	Metadata title.
Abstract	Metadata abstract.
DataProviderName	Layer data provider name.
GeometryType	Layer geometry type.

Definition at line 111 of file qgslayermetadataresultsmodel.h.

Constructor & Destructor Documentation

◆ QgsLayerMetadataResultsModel()

QgsLayerMetadataResultsModel::QgsLayerMetadataResultsModel	(	const QgsMetadataSearchContext &	searchContext,
		QObject *	parent = `nullptr`
	)

explicit

Constructs a QgsLayerMetadataResultsModel from a searchContext and an optional parent.

Definition at line 26 of file qgslayermetadataresultsmodel.cpp.

◆ ~QgsLayerMetadataResultsModel()

QgsLayerMetadataResultsModel::~QgsLayerMetadataResultsModel ( )

Definition at line 34 of file qgslayermetadataresultsmodel.cpp.

Member Function Documentation

◆ cancel

void QgsLayerMetadataResultsModel::cancel ( )

slot

Cancels the results fetching.

Definition at line 196 of file qgslayermetadataresultsmodel.cpp.

◆ columnCount()

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

override

Definition at line 44 of file qgslayermetadataresultsmodel.cpp.

◆ data()

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

override

Definition at line 49 of file qgslayermetadataresultsmodel.cpp.

◆ headerData()

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

override

Definition at line 115 of file qgslayermetadataresultsmodel.cpp.

◆ progressChanged

void QgsLayerMetadataResultsModel::progressChanged ( int progress )

signal

Emitted when the progress changed to progress.

◆ reload()

void QgsLayerMetadataResultsModel::reload ( )

Load/Reload model data synchronously.

Definition at line 140 of file qgslayermetadataresultsmodel.cpp.

◆ reloadAsync()

void QgsLayerMetadataResultsModel::reloadAsync ( )

Load/Reload model data asynchronously using threads.

Definition at line 158 of file qgslayermetadataresultsmodel.cpp.

◆ resultsReady

void QgsLayerMetadataResultsModel::resultsReady ( const QgsLayerMetadataSearchResults & results )

slot

Triggered when metadata results have been fetched and can be added to the model.

Definition at line 184 of file qgslayermetadataresultsmodel.cpp.

◆ rowCount()

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

override

Definition at line 39 of file qgslayermetadataresultsmodel.cpp.

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

/build/qgis-3.28.0+99sid/src/gui/qgslayermetadataresultsmodel.h
/build/qgis-3.28.0+99sid/src/gui/qgslayermetadataresultsmodel.cpp