Wraps a value relation search widget. More...

#include <qgsvaluerelationsearchwidgetwrapper.h>

Inheritance diagram for QgsValueRelationSearchWidgetWrapper:

[legend]

Public Slots
void	clearWidget () override

void	setEnabled (bool enabled) override

Public Slots inherited from QgsSearchWidgetWrapper
virtual void	clearWidget ()
	Clears the widget's current value and resets it back to the default state.

void	setEnabled (bool enabled) override
	Toggles whether the search widget is enabled or disabled.

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
	QgsValueRelationSearchWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget parent=nullptr)
	Constructor for QgsValueRelationSearchWidgetWrapper.

bool	applyDirectly () override
	If this is `true`, then this search widget should take effect directly when its expression changes.

QString	createExpression (QgsSearchWidgetWrapper::FilterFlags flags) const override
	Creates a filter expression based on the current state of the search widget and the specified filter flags.

QgsSearchWidgetWrapper::FilterFlags	defaultFlags () const override
	Returns the filter flags which should be set by default for the search widget.

QString	expression () const override
	Will be used to access the widget's value.

QgsSearchWidgetWrapper::FilterFlags	supportedFlags () const override
	Returns filter flags supported by the search widget.

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

QVariant	value () const

Public Member Functions inherited from QgsSearchWidgetWrapper
	QgsSearchWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget parent=nullptr)
	Create a new widget wrapper.

QString	aggregate () const
	If in AggregateSearch mode, which aggregate should be used to construct the filter expression.

QString	createFieldIdentifier () const
	Gets a field name or expression to use as field comparison.

int	fieldIndex () const
	Returns the field index.

void	setAggregate (const QString &aggregate)
	If in AggregateSearch mode, which aggregate should be used to construct the filter expression.

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.

Protected Slots
void	onValueChanged ()
	Called when current value of search widget changes.

void	setExpression (const QString &exp) override

Protected Slots inherited from QgsSearchWidgetWrapper
virtual void	setExpression (const QString &expression)=0
	Set the expression which is currently used as filter for this widget.

void	setFeature (const QgsFeature &feature) override

Protected Member Functions
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.

Protected Member Functions inherited from QgsSearchWidgetWrapper
void	clearExpression ()
	clears the expression to search for all features

Friends
class	QgsValueRelationWidgetFactory

Additional Inherited Members
Public Types inherited from QgsSearchWidgetWrapper
enum	FilterFlag { EqualTo = 1 << 1 , NotEqualTo = 1 << 2 , GreaterThan = 1 << 3 , LessThan = 1 << 4 , GreaterThanOrEqualTo = 1 << 5 , LessThanOrEqualTo = 1 << 6 , Between = 1 << 7 , CaseInsensitive = 1 << 8 , Contains = 1 << 9 , DoesNotContain = 1 << 10 , IsNull = 1 << 11 , IsNotBetween = 1 << 12 , IsNotNull = 1 << 13 , StartsWith = 1 << 14 , EndsWith = 1 << 15 }
	Flags which indicate what types of filtering and searching is possible using the widget. More...

typedef QFlags< FilterFlag >	FilterFlags

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

Signals inherited from QgsSearchWidgetWrapper
void	expressionChanged (const QString &exp)
	Emitted whenever the expression changes.

void	valueChanged ()
	Emitted when a user changes the value of the search widget.

void	valueCleared ()
	Emitted when a user changes the value of the search widget back to an empty, default state.

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

Static Public Member Functions inherited from QgsSearchWidgetWrapper
static QList< QgsSearchWidgetWrapper::FilterFlag >	exclusiveFilterFlags ()
	Returns a list of exclusive filter flags, which cannot be combined with other flags (e.g., EqualTo/NotEqualTo)

static QList< QgsSearchWidgetWrapper::FilterFlag >	nonExclusiveFilterFlags ()
	Returns a list of non-exclusive filter flags, which can be combined with other flags (e.g., CaseInsensitive)

static QString	toString (QgsSearchWidgetWrapper::FilterFlag flag)
	Returns a translated string representing a filter flag.

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 QgsSearchWidgetWrapper
QString	mExpression

int	mFieldIdx

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

Detailed Description

Wraps a value relation search widget.

This widget will offer a combobox with values from another layer referenced by a foreign key (a constraint may be set but is not required on data level). It will be used as a search widget and produces expression to look for in the layer.

Definition at line 36 of file qgsvaluerelationsearchwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsValueRelationSearchWidgetWrapper()

QgsValueRelationSearchWidgetWrapper::QgsValueRelationSearchWidgetWrapper	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		QWidget *	parent = `nullptr`
	)

explicit

Constructor for QgsValueRelationSearchWidgetWrapper.

Definition at line 30 of file qgsvaluerelationsearchwidgetwrapper.cpp.

Member Function Documentation

◆ applyDirectly()

bool QgsValueRelationSearchWidgetWrapper::applyDirectly ( )

overridevirtual

If this is true, then this search widget should take effect directly when its expression changes.

Implements QgsSearchWidgetWrapper.

Definition at line 36 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ clearWidget

void QgsValueRelationSearchWidgetWrapper::clearWidget ( )

overrideslot

Definition at line 128 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ createExpression()

QString QgsValueRelationSearchWidgetWrapper::createExpression ( QgsSearchWidgetWrapper::FilterFlags flags ) const

overridevirtual

Creates a filter expression based on the current state of the search widget and the specified filter flags.

Parameters

flags filter flags

Returns: filter expression

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 85 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ createWidget()

QWidget * QgsValueRelationSearchWidgetWrapper::createWidget ( QWidget * parent )

overrideprotectedvirtual

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 192 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ defaultFlags()

QgsSearchWidgetWrapper::FilterFlags QgsValueRelationSearchWidgetWrapper::defaultFlags ( ) const

overridevirtual

Returns the filter flags which should be set by default for the search widget.

See also: supportedFlags()

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 80 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ expression()

QString QgsValueRelationSearchWidgetWrapper::expression ( ) const

overridevirtual

Will be used to access the widget's value.

Read the value from the widget and return it properly formatted to be saved in the attribute.

If an invalid variant is returned this will be interpreted as no change. Be sure to return a NULL QVariant if it should be set to NULL.

Returns: The current value the widget represents

Implements QgsSearchWidgetWrapper.

Definition at line 41 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ initWidget()

void QgsValueRelationSearchWidgetWrapper::initWidget ( QWidget * editor )

overrideprotectedvirtual

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 211 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ onValueChanged

void QgsValueRelationSearchWidgetWrapper::onValueChanged ( )

protectedslot

Called when current value of search widget changes.

Definition at line 157 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ setEnabled

void QgsValueRelationSearchWidgetWrapper::setEnabled ( bool enabled )

overrideslot

Definition at line 140 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ setExpression

void QgsValueRelationSearchWidgetWrapper::setExpression ( const QString & exp )

overrideprotectedslot

Definition at line 173 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ supportedFlags()

QgsSearchWidgetWrapper::FilterFlags QgsValueRelationSearchWidgetWrapper::supportedFlags ( ) const

overridevirtual

Returns filter flags supported by the search widget.

See also: defaultFlags()

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 75 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ valid()

bool QgsValueRelationSearchWidgetWrapper::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 152 of file qgsvaluerelationsearchwidgetwrapper.cpp.

◆ value()

QVariant QgsValueRelationSearchWidgetWrapper::value ( ) const

Definition at line 46 of file qgsvaluerelationsearchwidgetwrapper.cpp.

Friends And Related Symbol Documentation

◆ QgsValueRelationWidgetFactory

friend class QgsValueRelationWidgetFactory

friend

Definition at line 70 of file qgsvaluerelationsearchwidgetwrapper.h.

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

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

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsValueRelationSearchWidgetWrapper()

Member Function Documentation

◆ applyDirectly()

◆ clearWidget

◆ createExpression()

◆ createWidget()

◆ defaultFlags()

◆ expression()

◆ initWidget()

◆ onValueChanged

◆ setEnabled

◆ setExpression

◆ supportedFlags()

◆ valid()

◆ value()

Friends And Related Symbol Documentation

◆ QgsValueRelationWidgetFactory