QGIS API Documentation  2.99.0-Master (23ddace)
Public Slots | Public Member Functions | Protected Slots | Protected Member Functions | Friends | List of all members
QgsDateTimeSearchWidgetWrapper Class Reference

Wraps a date/time edit widget for searching. More...

#include <qgsdatetimesearchwidgetwrapper.h>

Inheritance diagram for QgsDateTimeSearchWidgetWrapper:
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

 QgsDateTimeSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=0)
 Constructor for QgsDateTimeSearchWidgetWrapper. More...
 
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 () 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
 Return true if the widget has been properly initialized. More...
 
QVariant value () const
 Returns a variant representing the current state of the widget, respecting the editor widget's configured field format for date/time values. More...
 
- Public Member Functions inherited from QgsSearchWidgetWrapper
 QgsSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=0)
 Create a new widget wrapper. 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...
 
- 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 (QString exp) override
 
- Protected Slots inherited from QgsSearchWidgetWrapper
virtual void setExpression (QString value)=0
 
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 QgsDateTimeEditFactory
 

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
}
 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 date/time edit widget for searching.

Since
QGIS 2.16

Definition at line 36 of file qgsdatetimesearchwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsDateTimeSearchWidgetWrapper()

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

Constructor for QgsDateTimeSearchWidgetWrapper.

Parameters
vlassociated vector layer
fieldIdxindex of associated field
parentparent widget

Definition at line 28 of file qgsdatetimesearchwidgetwrapper.cpp.

Member Function Documentation

◆ applyDirectly()

bool QgsDateTimeSearchWidgetWrapper::applyDirectly ( )
overridevirtual

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

Implements QgsSearchWidgetWrapper.

Definition at line 35 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ clearWidget

void QgsDateTimeSearchWidgetWrapper::clearWidget ( )
overridevirtualslot

Definition at line 95 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ createExpression()

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

Definition at line 64 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ createWidget()

QWidget * QgsDateTimeSearchWidgetWrapper::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 141 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ defaultFlags()

QgsSearchWidgetWrapper::FilterFlags QgsDateTimeSearchWidgetWrapper::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 59 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ expression()

QString QgsDateTimeSearchWidgetWrapper::expression ( )
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 40 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ initWidget()

void QgsDateTimeSearchWidgetWrapper::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 148 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ setEnabled

void QgsDateTimeSearchWidgetWrapper::setEnabled ( bool  enabled)
overridevirtualslot

Definition at line 103 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ setExpression

void QgsDateTimeSearchWidgetWrapper::setExpression ( QString  exp)
overrideprotectedslot

Definition at line 116 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ supportedFlags()

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

Returns filter flags supported by the search widget.

Since
QGIS 2.16
See also
defaultFlags()

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 54 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ valid()

bool QgsDateTimeSearchWidgetWrapper::valid ( ) const
overridevirtual

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 111 of file qgsdatetimesearchwidgetwrapper.cpp.

◆ value()

QVariant QgsDateTimeSearchWidgetWrapper::value ( ) const

Returns a variant representing the current state of the widget, respecting the editor widget's configured field format for date/time values.

Definition at line 45 of file qgsdatetimesearchwidgetwrapper.cpp.

Friends And Related Function Documentation

◆ QgsDateTimeEditFactory

friend class QgsDateTimeEditFactory
friend

Definition at line 80 of file qgsdatetimesearchwidgetwrapper.h.


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