Wraps a label widget to display text. More...

#include <qgstextwidgetwrapper.h>

Inheritance diagram for QgsTextWidgetWrapper:

[legend]

Public Slots
void	setFeature (const QgsFeature &feature) override

Public Slots inherited from QgsWidgetWrapper
virtual void	setEnabled (bool enabled)
	Is used to enable or disable the edit functionality of the managed widget.

virtual void	setFeature (const QgsFeature &feature)=0
	Is called when the value of the widget needs to be changed.

Public Member Functions
	QgsTextWidgetWrapper (QgsVectorLayer layer, QWidget editor, QWidget *parent)
	Create a text widget wrapper.

QWidget *	createWidget (QWidget *parent) override
	This method should create a new widget with the provided parent.

void	initWidget (QWidget *editor) override
	This method should initialize the editor widget with runtime data.

bool	needsGeometry () const
	Returns true if the widget needs feature geometry.

void	reinitWidget ()
	Clears the content and makes new initialization.

void	setText (const QString &text)
	Sets the text code to htmlCode.

bool	valid () const override
	Returns `true` if the widget has been properly initialized.

Public Member Functions inherited from QgsWidgetWrapper
	QgsWidgetWrapper (QgsVectorLayer vl, QWidget editor=nullptr, QWidget *parent=nullptr)
	Create a new widget wrapper.

QVariantMap	config () const
	Returns the whole config.

QVariant	config (const QString &key, const QVariant &defaultVal=QVariant()) const
	Use this inside your overridden classes to access the configuration.

const QgsAttributeEditorContext &	context () const
	Returns information about the context in which this widget is shown.

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the editor widget's property collection, used for data defined overrides.

const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the editor widget's property collection, used for data defined overrides.

QgsVectorLayer *	layer () const
	Returns the vector layer associated with the widget.

void	notifyAboutToSave ()
	Notify this widget, that the containing form is about to save and that any pending changes should be pushed to the edit buffer or they might be lost.

void	setConfig (const QVariantMap &config)
	Will set the config of this wrapper to the specified config.

void	setContext (const QgsAttributeEditorContext &context)
	Set the context in which this widget is shown.

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the editor widget's property collection, used for data defined overrides.

QWidget *	widget ()
	Access the widget managed by this wrapper.

template<class T >
T *	widget ()
	Access the widget managed by this wrapper and cast it to a given type.

Friends
class	TestQgsTextWidgetWrapper

Additional Inherited Members
Public Types inherited from QgsWidgetWrapper
enum class	Property : int { RootPath = 0 , DocumentViewerContent , StorageUrl }
	Data defined properties for different editor widgets. More...

Signals inherited from QgsWidgetWrapper
void	contextChanged ()
	Signal when QgsAttributeEditorContext mContext changed.

Static Public Member Functions inherited from QgsWidgetWrapper
static QgsWidgetWrapper *	fromWidget (QWidget *widget)
	Will return a wrapper for a given widget.

static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the editor widget property definitions.

Protected Attributes inherited from QgsWidgetWrapper
QgsPropertyCollection	mPropertyCollection
	Data defined property collection.

Detailed Description

Wraps a label widget to display text.

Since: QGIS 3.30

Definition at line 28 of file qgstextwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsTextWidgetWrapper()

QgsTextWidgetWrapper::QgsTextWidgetWrapper	(	QgsVectorLayer *	layer,
		QWidget *	editor,
		QWidget *	parent
	)

Create a text widget wrapper.

Parameters

layer	The layer on which the feature is
editor	An editor widget. Can be `nullptr` if one should be autogenerated.
parent	A parent widget

Definition at line 24 of file qgstextwidgetwrapper.cpp.

Member Function Documentation

◆ createWidget()

QWidget * QgsTextWidgetWrapper::createWidget ( QWidget * parent )

overridevirtual

This method should create a new widget with the provided parent.

This will only be called if the form did not already provide a widget, so it is not guaranteed to be called! You should not do initialization stuff, which also has to be done for custom editor widgets inside this method. Things like filling comboboxes and assigning other data which will also be used to make widgets on forms created in the QtDesigner usable should be assigned in initWidget().

Parameters

parent You should set this parent on the created widget.

Returns: A new widget

Implements QgsWidgetWrapper.

Definition at line 35 of file qgstextwidgetwrapper.cpp.

◆ initWidget()

void QgsTextWidgetWrapper::initWidget ( QWidget * editor )

overridevirtual

This method should initialize the editor widget with runtime data.

Fill your comboboxes here.

Parameters

editor The widget which will represent this attribute editor in a form.

Reimplemented from QgsWidgetWrapper.

Definition at line 56 of file qgstextwidgetwrapper.cpp.

◆ needsGeometry()

bool QgsTextWidgetWrapper::needsGeometry ( ) const

Returns true if the widget needs feature geometry.

Definition at line 105 of file qgstextwidgetwrapper.cpp.

◆ reinitWidget()

void QgsTextWidgetWrapper::reinitWidget ( )

Clears the content and makes new initialization.

Definition at line 78 of file qgstextwidgetwrapper.cpp.

◆ setFeature

void QgsTextWidgetWrapper::setFeature ( const QgsFeature & feature )

overrideslot

Definition at line 126 of file qgstextwidgetwrapper.cpp.

◆ setText()

void QgsTextWidgetWrapper::setText ( const QString & text )

Sets the text code to htmlCode.

Definition at line 87 of file qgstextwidgetwrapper.cpp.

◆ valid()

bool QgsTextWidgetWrapper::valid ( ) const

overridevirtual

Returns true if the widget has been properly initialized.

This acts as hint for the calling party if this wrapper can be used after initializing it. If it cannot be used this is a hint to the caller that he may try to find another suitable widget type instead.

Returns: Validity status of this widget.

Implements QgsWidgetWrapper.

Definition at line 30 of file qgstextwidgetwrapper.cpp.

Friends And Related Symbol Documentation

◆ TestQgsTextWidgetWrapper

friend class TestQgsTextWidgetWrapper

friend

Definition at line 76 of file qgstextwidgetwrapper.h.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/editorwidgets/qgstextwidgetwrapper.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/editorwidgets/qgstextwidgetwrapper.cpp

Public Slots

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsTextWidgetWrapper()

Member Function Documentation

◆ createWidget()

◆ initWidget()

◆ needsGeometry()

◆ reinitWidget()

◆ setFeature

◆ setText()

◆ valid()

Friends And Related Symbol Documentation

◆ TestQgsTextWidgetWrapper