QgsRelationAggregateSearchWidgetWrapper class

Search widget for the children of a relation.

Reference

For each attribute of the child, an additional QgsAggregateToolButton will be shown to determine how the values should be aggregated for searching.

Base classes

class QgsSearchWidgetWrapper: Shows a search widget on a filter form.

Constructors, destructors, conversion operators

QgsRelationAggregateSearchWidgetWrapper(QgsVectorLayer* layer, QgsRelationWidgetWrapper* wrapper, QWidget*parent SIP_TRANSFERTHIS = nullptr) explicit: Constructor.

Public functions

auto applyDirectly() -> bool override: If this is true, then this search widget should take effect directly when its expression changes.
auto createWidget(QWidget* parent) -> QWidget* override: This method should create a new widget with the provided parent.
auto expression() const -> QString override: Will be used to access the widget's value.
void setExpression(const QString& expression) override: Set the expression which is currently used as filter for this widget.
auto valid() const -> bool override: Returns true if the widget has been properly initialized.

Function documentation

QWidget* QgsRelationAggregateSearchWidgetWrapper::createWidget(QWidget* parent) override

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

Parameters
parent	You should set this parent on the created widget.
Returns	A new widget

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().

QString QgsRelationAggregateSearchWidgetWrapper::expression() const override

Will be used to access the widget's value.

Returns	The current value the widget represents

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.

bool QgsRelationAggregateSearchWidgetWrapper::valid() const override

Returns true if the widget has been properly initialized.

Returns	Validity status of this widget.

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.