Wraps a search widget. More...

#include <qgsdefaultsearchwidgetwrapper.h>

Inheritance diagram for QgsDefaultSearchWidgetWrapper:

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=nullptr)

bool	applyDirectly () override
	If this is true, then this search widget should take effect directly when its expression changes. More...

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 &regExp) 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

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

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

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)

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

Default form is just a QgsLineFilterEdit

Definition at line 28 of file qgsdefaultsearchwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsDefaultSearchWidgetWrapper()

QgsDefaultSearchWidgetWrapper::QgsDefaultSearchWidgetWrapper	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		QWidget *	parent = `nullptr`
	)

explicit

Definition at line 24 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 86 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ caseSensitiveCheckBox()

QCheckBox * QgsDefaultSearchWidgetWrapper::caseSensitiveCheckBox ( )

protected

Returns a pointer to the case sensitivity check box in the widget.

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

Definition at line 283 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ clearWidget

void QgsDefaultSearchWidgetWrapper::clearWidget ( )

overridevirtualslot

Definition at line 236 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ createExpression()

QString QgsDefaultSearchWidgetWrapper::createExpression ( FilterFlags flags ) const

overridevirtual

Creates a filter expression based on the current state of the search widget and the specified filter flags.

Parameters

flags filter flags

Returns: filter expression

Note: added in QGIS 2.16

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 146 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(QWidget*).

Parameters

parent You should set this parent on the created widget.

Returns: A new widget

Implements QgsWidgetWrapper.

Definition at line 81 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.

Note: added in QGIS 2.16

See also: supportedFlags()

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 119 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ expression()

QString QgsDefaultSearchWidgetWrapper::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 33 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

editor The widget which will represent this attribute editor in a form.

Reimplemented from QgsWidgetWrapper.

Definition at line 248 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 278 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ setEnabled

void QgsDefaultSearchWidgetWrapper::setEnabled ( bool enabled )

overridevirtualslot

Definition at line 241 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ setExpression

void QgsDefaultSearchWidgetWrapper::setExpression ( QString exp )

overrideprotectedslot

Definition at line 55 of file qgsdefaultsearchwidgetwrapper.cpp.

◆ supportedFlags()

QgsSearchWidgetWrapper::FilterFlags QgsDefaultSearchWidgetWrapper::supportedFlags ( ) const

overridevirtual

Returns filter flags supported by the search widget.

Note: added in QGIS 2.16

See also: defaultFlags()

Reimplemented from QgsSearchWidgetWrapper.

Definition at line 91 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 tothe caller that he may try to find another suitable widget type instead.

Returns: Validity status of this widget.

Note: Added in 2.12

Implements QgsWidgetWrapper.

Definition at line 273 of file qgsdefaultsearchwidgetwrapper.cpp.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.cpp

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsDefaultSearchWidgetWrapper()

Member Function Documentation

◆ applyDirectly()

◆ caseSensitiveCheckBox()

◆ clearWidget

◆ createExpression()

◆ createWidget()

◆ defaultFlags()

◆ expression()

◆ initWidget()

◆ lineEdit()

◆ setEnabled

◆ setExpression

◆ supportedFlags()

◆ valid()