QgsNumericFormatGuiRegistry Class Reference

The QgsNumericFormatGuiRegistry is a home for widgets for configuring QgsNumericFormat objects. More...

#include <qgsnumericformatguiregistry.h>

Public Member Functions
	QgsNumericFormatGuiRegistry ()
	Constructor. More...
	~QgsNumericFormatGuiRegistry ()
void	addFormatConfigurationWidgetFactory (const QString &id, QgsNumericFormatConfigurationWidgetFactory *factory)
	Add a new configuration widget factory for customizing a numeric format with the specified id. More...
QgsNumericFormatWidget *	formatConfigurationWidget (const QgsNumericFormat *format) const
	Returns a new configuration widget for an format. More...
void	removeFormatConfigurationWidgetFactory (const QString &id)
	Removes the configuration widget factory for customizing numeric formats with the specified id. More...

Detailed Description

The QgsNumericFormatGuiRegistry is a home for widgets for configuring QgsNumericFormat objects.

QgsNumericFormatGuiRegistry is not usually directly created, but rather accessed through QgsGui::numericFormatGuiRegistry().

Since

QGIS 3.12

Definition at line 55 of file qgsnumericformatguiregistry.h.

Constructor & Destructor Documentation

QgsNumericFormatGuiRegistry()

QgsNumericFormatGuiRegistry::QgsNumericFormatGuiRegistry

(

)

Constructor.

Should never be called manually, is already created by QgsGui.

Definition at line 84 of file qgsnumericformatguiregistry.cpp.

~QgsNumericFormatGuiRegistry()

QgsNumericFormatGuiRegistry::~QgsNumericFormatGuiRegistry

(

)

Definition at line 94 of file qgsnumericformatguiregistry.cpp.

Member Function Documentation

addFormatConfigurationWidgetFactory()

void QgsNumericFormatGuiRegistry::addFormatConfigurationWidgetFactory	(	const QString &	id,
		QgsNumericFormatConfigurationWidgetFactory *	factory
	)

Add a new configuration widget factory for customizing a numeric format with the specified id.

Ownership is taken by the reigstry.

Definition at line 99 of file qgsnumericformatguiregistry.cpp.

formatConfigurationWidget()

QgsNumericFormatWidget * QgsNumericFormatGuiRegistry::formatConfigurationWidget

(

const QgsNumericFormat *

format

)

const

Returns a new configuration widget for an format.

Returns nullptr if no configuration widgets are available for the specified format.

Definition at line 110 of file qgsnumericformatguiregistry.cpp.

removeFormatConfigurationWidgetFactory()

void QgsNumericFormatGuiRegistry::removeFormatConfigurationWidgetFactory

(

const QString &

id

)

Removes the configuration widget factory for customizing numeric formats with the specified id.

Definition at line 104 of file qgsnumericformatguiregistry.cpp.

---

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

• /build/qgis-3.18.1+99unstable/src/gui/numericformats/qgsnumericformatguiregistry.h
• /build/qgis-3.18.1+99unstable/src/gui/numericformats/qgsnumericformatguiregistry.cpp