Wraps a text edit widget for searching. More...
#include <qgstexteditsearchwidgetwrapper.h>
Inheritance diagram for QgsTextEditSearchWidgetWrapper:
Public Member Functions | |
| QgsTextEditSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=nullptr) | |
| Constructor for QgsTextEditSearchWidgetWrapper. More... | |
| bool | applyDirectly () override |
| If this is true, then this search widget should take effect directly when its expression changes. More... | |
 Public Member Functions inherited from QgsDefaultSearchWidgetWrapper | |
| QgsDefaultSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=nullptr) | |
| virtual QString | createExpression (FilterFlags flags) const override |
| Creates a filter expression based on the current state of the search widget and the specified filter flags. More... | |
| 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... | |
| 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=nullptr) | |
| Create a new widget wrapper. 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... | |
| QgsEditorWidgetConfig | config () const |
| Returns the whole config. More... | |
| const QgsAttributeEditorContext & | context () const |
| Returns information about the context in which this widget is shown. More... | |
| QgsVectorLayer * | layer () const |
| Access the QgsVectorLayer, you are working on. More... | |
| void | setConfig (const QgsEditorWidgetConfig &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... | |
| 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... | |
| Public Member Functions inherited from QObject | |
| QObject (QObject *parent) | |
| QObject (QObject *parent, const char *name) | |
| virtual | ~QObject () |
| bool | blockSignals (bool block) |
| QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
| const QObjectList & | children () const |
| const char * | className () const |
| bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
| void | deleteLater () |
| void | destroyed (QObject *obj) |
| bool | disconnect (const QObject *receiver, const char *method) |
| bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
| void | dumpObjectInfo () |
| void | dumpObjectTree () |
| QList< QByteArray > | dynamicPropertyNames () const |
| virtual bool | event (QEvent *e) |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| T | findChild (const QString &name) const |
| QList< T > | findChildren (const QRegExp ®Exp) const |
| QList< T > | findChildren (const QString &name) const |
| bool | inherits (const char *className) const |
| void | insertChild (QObject *object) |
| void | installEventFilter (QObject *filterObj) |
| bool | isA (const char *className) const |
| bool | isWidgetType () const |
| void | killTimer (int id) |
| virtual const QMetaObject * | metaObject () const |
| void | moveToThread (QThread *targetThread) |
| const char * | name () const |
| const char * | name (const char *defaultName) const |
| QString | objectName () const |
| QObject * | parent () const |
| QVariant | property (const char *name) const |
| void | removeChild (QObject *object) |
| void | removeEventFilter (QObject *obj) |
| void | setName (const char *name) |
| void | setObjectName (const QString &name) |
| void | setParent (QObject *parent) |
| bool | setProperty (const char *name, const QVariant &value) |
| bool | signalsBlocked () const |
| int | startTimer (int interval) |
| QThread * | thread () const |
Friends | |
| class | QgsTextEditWidgetFactory |
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 Slots inherited from QgsDefaultSearchWidgetWrapper | |
| 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... | |
| 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< FilterFlag > | exclusiveFilterFlags () |
| Returns a list of exclusive filter flags, which cannot be combined with other flags (eg EqualTo/NotEqualTo) More... | |
| static QList< FilterFlag > | nonExclusiveFilterFlags () |
| Returns a list of non-exclusive filter flags, which can be combined with other flags (eg CaseInsensitive) More... | |
| static QString | toString (FilterFlag flag) |
| Returns a translated string representing a filter flag. More... | |
| Static Public Member Functions inherited from QgsWidgetWrapper | |
| static QgsWidgetWrapper * | fromWidget (QWidget *widget) |
| Will return a wrapper for a given widget. More... | |
| Static Public Member Functions inherited from QObject | |
| bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
| bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
| bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
| bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
| QString | tr (const char *sourceText, const char *disambiguation, int n) |
| QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
| Protected Slots inherited from QgsDefaultSearchWidgetWrapper | |
| 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 inherited from QgsDefaultSearchWidgetWrapper | |
| QCheckBox * | caseSensitiveCheckBox () |
| Returns a pointer to the case sensitivity check box 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... | |
| QgsFilterLineEdit * | lineEdit () |
| 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... | |
| Protected Member Functions inherited from QObject | |
| bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
| virtual void | childEvent (QChildEvent *event) |
| virtual void | connectNotify (const char *signal) |
| virtual void | customEvent (QEvent *event) |
| virtual void | disconnectNotify (const char *signal) |
| int | receivers (const char *signal) const |
| QObject * | sender () const |
| int | senderSignalIndex () const |
| virtual void | timerEvent (QTimerEvent *event) |
| Static Protected Member Functions inherited from QObject | |
| QByteArray | normalizeSignalSlot (const char *signalSlot) |
| Protected Attributes inherited from QgsSearchWidgetWrapper | |
| QString | mExpression |
| int | mFieldIdx |
| Properties inherited from QObject | |
| objectName | |
Detailed Description
Wraps a text edit widget for searching.
- Note
- Added in version 2.16
- not available in Python bindings
Definition at line 30 of file qgstexteditsearchwidgetwrapper.h.
Constructor & Destructor Documentation
◆ QgsTextEditSearchWidgetWrapper()
|
explicit |
Constructor for QgsTextEditSearchWidgetWrapper.
- Parameters
-
vl associated vector layer fieldIdx index of associated field parent parent widget
Definition at line 21 of file qgstexteditsearchwidgetwrapper.cpp.
Member Function Documentation
◆ applyDirectly()
|
overridevirtual |
If this is true, then this search widget should take effect directly when its expression changes.
Reimplemented from QgsDefaultSearchWidgetWrapper.
Definition at line 26 of file qgstexteditsearchwidgetwrapper.cpp.
Friends And Related Function Documentation
◆ QgsTextEditWidgetFactory
|
friend |
Definition at line 47 of file qgstexteditsearchwidgetwrapper.h.
The documentation for this class was generated from the following files:
- /tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h
- /tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.cpp
