QgsSensorAbstractGuiMetadata Class Reference

Stores GUI metadata about one sensor class. More...

#include <qgssensorguiregistry.h>

Inheritance diagram for QgsSensorAbstractGuiMetadata:

Public Member Functions
	QgsSensorAbstractGuiMetadata (const QString &type, const QString &visibleName)
	Constructor for QgsSensorAbstractGuiMetadata with the specified class type.
virtual	~QgsSensorAbstractGuiMetadata ()=default
virtual QgsAbstractSensor *	createSensor (QObject *parent)
	Creates an instance of the corresponding sensor type.
virtual QgsAbstractSensorWidget *	createSensorWidget (QgsAbstractSensor *sensor)
	Creates a configuration widget for an sensor of this type.
virtual QIcon	creationIcon () const
	Returns an icon representing creation of the sensor type.
QString	type () const
	Returns the unique type code for the sensor class.
QString	visibleName () const
	Returns a translated, user visible name identifying the corresponding sensor.

Detailed Description

Stores GUI metadata about one sensor class.

This is a companion to QgsSensorAbstractMetadata, storing only the components related to the GUI behavior of sensor.

Note

In C++ you can use QgsSensorGuiMetadata convenience class.

Since

QGIS 3.32

Definition at line 37 of file qgssensorguiregistry.h.

Constructor & Destructor Documentation

QgsSensorAbstractGuiMetadata()

QgsSensorAbstractGuiMetadata::QgsSensorAbstractGuiMetadata ( const QString &  type, const QString &  visibleName  )

inline

Constructor for QgsSensorAbstractGuiMetadata with the specified class type.

visibleName should be set to a translated, user visible name identifying the corresponding sensor type.

Definition at line 45 of file qgssensorguiregistry.h.

~QgsSensorAbstractGuiMetadata()

virtual QgsSensorAbstractGuiMetadata::~QgsSensorAbstractGuiMetadata ( )

virtualdefault

Member Function Documentation

createSensor()

virtual QgsAbstractSensor * QgsSensorAbstractGuiMetadata::createSensor ( QObject *  parent )

inlinevirtual

Creates an instance of the corresponding sensor type.

Reimplemented in QgsSensorGuiMetadata.

Definition at line 94 of file qgssensorguiregistry.h.

createSensorWidget()

virtual QgsAbstractSensorWidget * QgsSensorAbstractGuiMetadata::createSensorWidget ( QgsAbstractSensor *  sensor )

inlinevirtual

Creates a configuration widget for an sensor of this type.

Can return nullptr if no configuration GUI is required.

Reimplemented in QgsSensorGuiMetadata.

Definition at line 85 of file qgssensorguiregistry.h.

creationIcon()

virtual QIcon QgsSensorAbstractGuiMetadata::creationIcon ( ) const

inlinevirtual

Returns an icon representing creation of the sensor type.

Reimplemented in QgsSensorGuiMetadata.

Definition at line 65 of file qgssensorguiregistry.h.

type()

QString QgsSensorAbstractGuiMetadata::type ( ) const

inline

Returns the unique type code for the sensor class.

Definition at line 55 of file qgssensorguiregistry.h.

visibleName()

QString QgsSensorAbstractGuiMetadata::visibleName ( ) const

inline

Returns a translated, user visible name identifying the corresponding sensor.

Definition at line 60 of file qgssensorguiregistry.h.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/sensor/qgssensorguiregistry.h