QGIS API Documentation  2.99.0-Master (cd0ba91)
Public Slots | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
QgsDefaultSearchWidgetWrapper Class Reference

Wraps a search widget. More...

#include <qgsdefaultsearchwidgetwrapper.h>

Inheritance diagram for QgsDefaultSearchWidgetWrapper:
Inheritance graph
[legend]

Public Slots

virtual void clearWidget () override
 
virtual 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...
 
virtual 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

 QgsDefaultSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=0)
 
bool applyDirectly () override
 If this is true, then this search widget should take effect directly when its expression changes. More...
 
virtual QString createExpression (QgsSearchWidgetWrapper::FilterFlags flags) const override
 
QgsSearchWidgetWrapper::FilterFlags defaultFlags () const override
 Returns the filter flags which should be set by default for the search widget. 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...
 
- Public Member Functions inherited from QgsSearchWidgetWrapper
 QgsSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=0)
 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
 Get a field name or expression to use as field comparison. 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
 Access the QgsVectorLayer, you are working on. 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 Example: QPushButton* pb = wrapper->widget<QPushButton*>();. 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

QCheckBox * caseSensitiveCheckBox ()
 Returns a pointer to the case sensitivity checkbox in the widget. More...
 
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...
 
QgsFilterLineEditlineEdit ()
 Returns a pointer to the line edit part of the widget. More...
 
bool valid () const override
 Return true if the widget has been properly initialized. More...
 
- Protected Member Functions inherited from QgsSearchWidgetWrapper
void clearExpression ()
 clears the expression to search for all features More...
 

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...
 
- 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 search widget.

Default form is just a QgsLineFilterEdit

Definition at line 31 of file qgsdefaultsearchwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsDefaultSearchWidgetWrapper()

QgsDefaultSearchWidgetWrapper::QgsDefaultSearchWidgetWrapper ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  parent = 0 
)
explicit

Definition at line 26 of file qgsdefaultsearchwidgetwrapper.cpp.

Member Function Documentation

◆ applyDirectly()

bool QgsDefaultSearchWidgetWrapper::applyDirectly ( )
overridevirtual

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

Implements QgsSearchWidgetWrapper.

Reimplemented in QgsTextEditSearchWidgetWrapper.

Definition at line 85 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ caseSensitiveCheckBox()

QCheckBox * QgsDefaultSearchWidgetWrapper::caseSensitiveCheckBox ( )
protected

Returns a pointer to the case sensitivity checkbox in the widget.

Note
this method is in place for unit testing only, and is not considered stable API

Definition at line 299 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ clearWidget

void QgsDefaultSearchWidgetWrapper::clearWidget ( )
overridevirtualslot

Definition at line 241 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ createExpression()

QString QgsDefaultSearchWidgetWrapper::createExpression ( QgsSearchWidgetWrapper::FilterFlags  flags) const
overridevirtual

Definition at line 145 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ createWidget()

QWidget * QgsDefaultSearchWidgetWrapper::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 80 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ defaultFlags()

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

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

Since
QGIS 2.16
See also
supportedFlags()

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 118 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ expression()

QString QgsDefaultSearchWidgetWrapper::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 32 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ initWidget()

void QgsDefaultSearchWidgetWrapper::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 253 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ lineEdit()

QgsFilterLineEdit * QgsDefaultSearchWidgetWrapper::lineEdit ( )
protected

Returns a pointer to the line edit part of the widget.

Note
this method is in place for unit testing only, and is not considered stable API

Definition at line 294 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ setEnabled

void QgsDefaultSearchWidgetWrapper::setEnabled ( bool  enabled)
overridevirtualslot

Definition at line 246 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ setExpression

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

Definition at line 54 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ supportedFlags()

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

Returns filter flags supported by the search widget.

Since
QGIS 2.16
See also
defaultFlags()

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 90 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ valid()

bool QgsDefaultSearchWidgetWrapper::valid ( ) const
overrideprotectedvirtual

Return 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 289 of file qgsdefaultsearchwidgetwrapper.cpp.


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