QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Slots | Public Member Functions | Protected Slots | Protected Member Functions | Friends | List of all members
QgsRelationReferenceSearchWidgetWrapper Class Reference

Wraps a relation reference search widget. More...

#include <qgsrelationreferencesearchwidgetwrapper.h>

Inheritance diagram for QgsRelationReferenceSearchWidgetWrapper:
Inheritance graph
[legend]

Public Slots

void clearWidget () override
 
Q_DECL_DEPRECATED void onValueChanged (const QVariant &value)
 Called when current value of search widget changes. More...
 
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. More...
 
void setEnabled (bool enabled) override
 Toggles whether the search widget is enabled or disabled. More...
 
- Public Slots inherited from QgsWidgetWrapper
virtual void setEnabled (bool enabled)
 Is used to enable or disable the edit functionality of the managed widget. More...
 
virtual void setFeature (const QgsFeature &feature)=0
 Is called when the value of the widget needs to be changed. More...
 

Public Member Functions

 QgsRelationReferenceSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QgsMapCanvas *canvas, QWidget *parent=nullptr)
 Constructor for QgsRelationReferenceSearchWidgetWrapper. More...
 
bool applyDirectly () override
 If this is true, then this search widget should take effect directly when its expression changes. More...
 
QString createExpression (QgsSearchWidgetWrapper::FilterFlags flags) const override
 
QgsSearchWidgetWrapper::FilterFlags defaultFlags () const override
 Returns the default flags (equalTo) More...
 
QString expression () const override
 Will be used to access the widget's value. More...
 
QgsSearchWidgetWrapper::FilterFlags supportedFlags () const override
 Returns filter flags supported by the search widget. More...
 
bool valid () const override
 Returns true if the widget has been properly initialized. More...
 
QVariant value () const
 Returns a variant representing the current state of the widget. More...
 
- Public Member Functions inherited from QgsSearchWidgetWrapper
 QgsSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=nullptr)
 Create a new widget wrapper. More...
 
QString aggregate () const
 If in AggregateSearch mode, which aggregate should be used to construct the filter expression. More...
 
virtual QString createExpression (FilterFlags flags) const
 Creates a filter expression based on the current state of the search widget and the specified filter flags. More...
 
QString createFieldIdentifier () const
 Gets a field name or expression to use as field comparison. More...
 
int fieldIndex () const
 Returns the field index. More...
 
void setAggregate (const QString &aggregate)
 If in AggregateSearch mode, which aggregate should be used to construct the filter expression. More...
 
- Public Member Functions inherited from QgsWidgetWrapper
 QgsWidgetWrapper (QgsVectorLayer *vl, QWidget *editor=nullptr, QWidget *parent=nullptr)
 Create a new widget wrapper. More...
 
QVariant config (const QString &key, const QVariant &defaultVal=QVariant()) const
 Use this inside your overridden classes to access the configuration. More...
 
QVariantMap config () const
 Returns the whole config. More...
 
const QgsAttributeEditorContextcontext () const
 Returns information about the context in which this widget is shown. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the editor widget's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the editor widget's property collection, used for data defined overrides. More...
 
QgsVectorLayerlayer () const
 Returns the vector layer associated with the widget. More...
 
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. More...
 
void setConfig (const QVariantMap &config)
 Will set the config of this wrapper to the specified config. More...
 
void setContext (const QgsAttributeEditorContext &context)
 Set the context in which this widget is shown. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the editor widget's property collection, used for data defined overrides. More...
 
QWidget * widget ()
 Access the widget managed by this wrapper. More...
 
template<class T >
T * widget ()
 Access the widget managed by this wrapper and cast it to a given type. More...
 

Protected Slots

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. More...
 
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. More...
 
void initWidget (QWidget *editor) override
 This method should initialize the editor widget with runtime data. More...
 
- Protected Member Functions inherited from QgsSearchWidgetWrapper
void clearExpression ()
 clears the expression to search for all features More...
 

Friends

class QgsRelationReferenceWidgetFactory
 

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...
 
- Public Types inherited from QgsWidgetWrapper
enum  Property { RootPath = 0, DocumentViewerContent }
 Data defined properties for different editor widgets. More...
 
- Signals inherited from QgsSearchWidgetWrapper
void expressionChanged (const QString &exp)
 Emitted whenever the expression changes. More...
 
void valueChanged ()
 Emitted when a user changes the value of the search widget. More...
 
void valueCleared ()
 Emitted when a user changes the value of the search widget back to an empty, default state. More...
 
- Signals inherited from QgsWidgetWrapper
void contextChanged ()
 Signal when QgsAttributeEditorContext mContext changed. More...
 
- Static Public Member Functions inherited from QgsSearchWidgetWrapper
static QList< QgsSearchWidgetWrapper::FilterFlagexclusiveFilterFlags ()
 Returns a list of exclusive filter flags, which cannot be combined with other flags (e.g., EqualTo/NotEqualTo) More...
 
static QList< QgsSearchWidgetWrapper::FilterFlagnonExclusiveFilterFlags ()
 Returns a list of non-exclusive filter flags, which can be combined with other flags (e.g., CaseInsensitive) More...
 
static QString toString (QgsSearchWidgetWrapper::FilterFlag flag)
 Returns a translated string representing a filter flag. More...
 
- Static Public Member Functions inherited from QgsWidgetWrapper
static QgsWidgetWrapperfromWidget (QWidget *widget)
 Will return a wrapper for a given widget. More...
 
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the editor widget property definitions. More...
 
- Protected Attributes inherited from QgsSearchWidgetWrapper
QString mExpression
 
int mFieldIdx
 
- Protected Attributes inherited from QgsWidgetWrapper
QgsPropertyCollection mPropertyCollection
 Data defined property collection. More...
 

Detailed Description

Wraps a relation reference search widget.

Since
QGIS 2.16

Definition at line 39 of file qgsrelationreferencesearchwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsRelationReferenceSearchWidgetWrapper()

QgsRelationReferenceSearchWidgetWrapper::QgsRelationReferenceSearchWidgetWrapper ( QgsVectorLayer vl,
int  fieldIdx,
QgsMapCanvas canvas,
QWidget *  parent = nullptr 
)
explicit

Constructor for QgsRelationReferenceSearchWidgetWrapper.

Parameters
vlassociated vector layer
fieldIdxassociated field index
canvasoptional map canvas
parentparent widget

Definition at line 29 of file qgsrelationreferencesearchwidgetwrapper.cpp.

Member Function Documentation

◆ applyDirectly()

bool QgsRelationReferenceSearchWidgetWrapper::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 qgsrelationreferencesearchwidgetwrapper.cpp.

◆ clearWidget

void QgsRelationReferenceSearchWidgetWrapper::clearWidget ( )
overrideslot

Definition at line 131 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ createExpression()

QString QgsRelationReferenceSearchWidgetWrapper::createExpression ( QgsSearchWidgetWrapper::FilterFlags  flags) const
override

Definition at line 80 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ createWidget()

QWidget * QgsRelationReferenceSearchWidgetWrapper::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
parentYou should set this parent on the created widget.
Returns
A new widget

Implements QgsWidgetWrapper.

Definition at line 196 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ defaultFlags()

QgsSearchWidgetWrapper::FilterFlags QgsRelationReferenceSearchWidgetWrapper::defaultFlags ( ) const
overridevirtual

Returns the default flags (equalTo)

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 75 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ expression()

QString QgsRelationReferenceSearchWidgetWrapper::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 qgsrelationreferencesearchwidgetwrapper.cpp.

◆ initWidget()

void QgsRelationReferenceSearchWidgetWrapper::initWidget ( QWidget *  editor)
overrideprotectedvirtual

This method should initialize the editor widget with runtime data.

Fill your comboboxes here.

Parameters
editorThe widget which will represent this attribute editor in a form.

Reimplemented from QgsWidgetWrapper.

Definition at line 201 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ onValueChanged

void QgsRelationReferenceSearchWidgetWrapper::onValueChanged ( const QVariant &  value)
slot

Called when current value of search widget changes.

Deprecated:
since QGIS 3.10 made private

Definition at line 152 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ setEnabled

void QgsRelationReferenceSearchWidgetWrapper::setEnabled ( bool  enabled)
overrideslot

Definition at line 139 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ setExpression

void QgsRelationReferenceSearchWidgetWrapper::setExpression ( const QString &  exp)
overrideprotectedslot

Definition at line 175 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ supportedFlags()

QgsSearchWidgetWrapper::FilterFlags QgsRelationReferenceSearchWidgetWrapper::supportedFlags ( ) const
overridevirtual

Returns filter flags supported by the search widget.

See also
defaultFlags()
Since
QGIS 2.16

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 70 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ valid()

bool QgsRelationReferenceSearchWidgetWrapper::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.
Since
QGIS 2.12

Implements QgsWidgetWrapper.

Definition at line 147 of file qgsrelationreferencesearchwidgetwrapper.cpp.

◆ value()

QVariant QgsRelationReferenceSearchWidgetWrapper::value ( ) const

Returns a variant representing the current state of the widget.

Definition at line 46 of file qgsrelationreferencesearchwidgetwrapper.cpp.

Friends And Related Function Documentation

◆ QgsRelationReferenceWidgetFactory

friend class QgsRelationReferenceWidgetFactory
friend

Definition at line 97 of file qgsrelationreferencesearchwidgetwrapper.h.


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