QGIS API Documentation  2.99.0-Master (c42dad3)
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
QgsFilterLineEdit Class Reference

QLineEdit subclass with built in support for clearing the widget's value and handling custom null value representations. More...

#include <qgsfilterlineedit.h>

Inheritance diagram for QgsFilterLineEdit:
Inheritance graph
[legend]

Public Types

enum  ClearMode { ClearToNull = 0, ClearToDefault }
 Behaviour when clearing value of widget. More...
 

Public Slots

virtual void clearValue ()
 Clears the widget and resets it to the null value. More...
 

Signals

void cleared ()
 Emitted when the widget is cleared. More...
 
void valueChanged (const QString &value)
 Same as textChanged() but with support for null values. More...
 

Public Member Functions

 QgsFilterLineEdit (QWidget *parent=nullptr, const QString &nullValue=QString::null)
 Constructor for QgsFilterLineEdit. More...
 
ClearMode clearMode () const
 Returns the clear mode for the widget. More...
 
QString defaultValue () const
 Returns the default value for the widget. More...
 
bool isNull () const
 Determine if the current text represents null. More...
 
QString nullValue () const
 Returns the string used for representating null values in the widget. More...
 
void setClearMode (ClearMode mode)
 Sets the clear mode for the widget. More...
 
void setDefaultValue (const QString &defaultValue)
 Sets the default value for the widget. More...
 
void setNullValue (const QString &nullValue)
 Sets the string representation for null values in the widget. More...
 
void setShowClearButton (bool visible)
 Sets whether the widget's clear button is visible. More...
 
void setValue (const QString &value)
 Sets the current text for the widget with support for handling null values. More...
 
bool showClearButton () const
 Returns true if the widget's clear button is visible. More...
 
QString value () const
 Returns the text of this edit with support for handling null values. More...
 

Protected Member Functions

void focusInEvent (QFocusEvent *e) override
 
void leaveEvent (QEvent *e) override
 
void mouseMoveEvent (QMouseEvent *e) override
 
void mousePressEvent (QMouseEvent *e) override
 
void paintEvent (QPaintEvent *e) override
 

Properties

ClearMode clearMode
 
QString defaultValue
 
QString nullValue
 
bool showClearButton
 
QString value
 

Detailed Description

QLineEdit subclass with built in support for clearing the widget's value and handling custom null value representations.

When using QgsFilterLineEdit the value(), setValue() and clearValue() methods should be used instead of QLineEdit's text(), setText() and clear() methods, and the valueChanged() signal should be used instead of textChanged().

Definition at line 34 of file qgsfilterlineedit.h.

Member Enumeration Documentation

§ ClearMode

Behaviour when clearing value of widget.

Enumerator
ClearToNull 

Reset value to null.

ClearToDefault 

Reset value to default value (see defaultValue() )

Definition at line 47 of file qgsfilterlineedit.h.

Constructor & Destructor Documentation

§ QgsFilterLineEdit()

QgsFilterLineEdit::QgsFilterLineEdit ( QWidget *  parent = nullptr,
const QString &  nullValue = QString::null 
)

Constructor for QgsFilterLineEdit.

Parameters
parentparent widget
nullValuestring for representing null values

Definition at line 26 of file qgsfilterlineedit.cpp.

Member Function Documentation

§ cleared

void QgsFilterLineEdit::cleared ( )
signal

Emitted when the widget is cleared.

See also
clearValue()

§ clearMode()

ClearMode QgsFilterLineEdit::clearMode ( ) const
inline

Returns the clear mode for the widget.

The clear mode defines the behaviour of the widget when its value is cleared. This defaults to ClearToNull.

See also
setClearMode()
Note
added in QGIS 3.0

Definition at line 77 of file qgsfilterlineedit.h.

§ clearValue

void QgsFilterLineEdit::clearValue ( )
virtualslot

Clears the widget and resets it to the null value.

See also
nullValue()
Note
added in QGIS 3.0

Definition at line 101 of file qgsfilterlineedit.cpp.

§ defaultValue()

QString QgsFilterLineEdit::defaultValue ( ) const
inline

Returns the default value for the widget.

The default value is a value which the widget will be reset to if it is cleared and the clearMode() is equal to ClearToDefault.

See also
setDefaultValue()
clearMode()
Note
added in QGIS 3.0

Definition at line 117 of file qgsfilterlineedit.h.

§ focusInEvent()

void QgsFilterLineEdit::focusInEvent ( QFocusEvent *  e)
overrideprotected

Definition at line 91 of file qgsfilterlineedit.cpp.

§ isNull()

bool QgsFilterLineEdit::isNull ( ) const
inline

Determine if the current text represents null.

Returns
True if the widget's value is null.
See also
nullValue()

Definition at line 144 of file qgsfilterlineedit.h.

§ leaveEvent()

void QgsFilterLineEdit::leaveEvent ( QEvent *  e)
overrideprotected

Definition at line 139 of file qgsfilterlineedit.cpp.

§ mouseMoveEvent()

void QgsFilterLineEdit::mouseMoveEvent ( QMouseEvent *  e)
overrideprotected

Definition at line 71 of file qgsfilterlineedit.cpp.

§ mousePressEvent()

void QgsFilterLineEdit::mousePressEvent ( QMouseEvent *  e)
overrideprotected

Definition at line 58 of file qgsfilterlineedit.cpp.

§ nullValue()

QString QgsFilterLineEdit::nullValue ( ) const
inline

Returns the string used for representating null values in the widget.

See also
setNullValue()
isNull()

Definition at line 98 of file qgsfilterlineedit.h.

§ paintEvent()

void QgsFilterLineEdit::paintEvent ( QPaintEvent *  e)
overrideprotected

Definition at line 125 of file qgsfilterlineedit.cpp.

§ setClearMode()

void QgsFilterLineEdit::setClearMode ( ClearMode  mode)
inline

Sets the clear mode for the widget.

The clear mode defines the behaviour of the widget when its value is cleared. This defaults to ClearToNull.

See also
clearMode()
Note
added in QGIS 3.0

Definition at line 84 of file qgsfilterlineedit.h.

§ setDefaultValue()

void QgsFilterLineEdit::setDefaultValue ( const QString &  defaultValue)
inline

Sets the default value for the widget.

The default value is a value which the widget will be reset to if it is cleared and the clearMode() is equal to ClearToDefault.

Parameters
defaultValuedefault value
See also
defaultValue()
clearMode()
Note
added in QGIS 3.0

Definition at line 108 of file qgsfilterlineedit.h.

§ setNullValue()

void QgsFilterLineEdit::setNullValue ( const QString &  nullValue)
inline

Sets the string representation for null values in the widget.

This does not affect the values returned for null values by value(), rather it only affects the text that is shown to users when the widget's value is null.

Parameters
nullValuestring to show when widget's value is null
See also
nullValue()

Definition at line 92 of file qgsfilterlineedit.h.

§ setShowClearButton()

void QgsFilterLineEdit::setShowClearButton ( bool  visible)

Sets whether the widget's clear button is visible.

Parameters
visibleset to false to hide the clear button
See also
showClearButton()
Note
added in QGIS 3.0

Definition at line 47 of file qgsfilterlineedit.cpp.

§ setValue()

void QgsFilterLineEdit::setValue ( const QString &  value)
inline

Sets the current text for the widget with support for handling null values.

Parameters
valueThe text to set. If a null string is provided, the text shown in the widget will be set to the current nullValue().
See also
value()

Definition at line 126 of file qgsfilterlineedit.h.

§ showClearButton()

bool QgsFilterLineEdit::showClearButton ( ) const
inline

Returns true if the widget's clear button is visible.

See also
setShowClearButton()
Note
added in QGIS 3.0

Definition at line 63 of file qgsfilterlineedit.h.

§ value()

QString QgsFilterLineEdit::value ( ) const
inline

Returns the text of this edit with support for handling null values.

If the text in the widget matches the current nullValue() then the returned value will be a null string.

Returns
Current text (or null string if it matches the nullValue() property )
See also
setValue()

Definition at line 136 of file qgsfilterlineedit.h.

§ valueChanged

void QgsFilterLineEdit::valueChanged ( const QString &  value)
signal

Same as textChanged() but with support for null values.

Parameters
valueThe current text or null string if it matches the nullValue() property.

Property Documentation

§ clearMode

ClearMode QgsFilterLineEdit::clearMode
readwrite

Definition at line 38 of file qgsfilterlineedit.h.

§ defaultValue

QString QgsFilterLineEdit::defaultValue
readwrite

Definition at line 40 of file qgsfilterlineedit.h.

§ nullValue

QString QgsFilterLineEdit::nullValue
readwrite

Definition at line 39 of file qgsfilterlineedit.h.

§ showClearButton

bool QgsFilterLineEdit::showClearButton
readwrite

Definition at line 42 of file qgsfilterlineedit.h.

§ value

QString QgsFilterLineEdit::value
readwrite

Definition at line 41 of file qgsfilterlineedit.h.


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