Class: QgsFilterLineEdit¶
-
class
qgis.gui.
QgsFilterLineEdit
(parent: QWidget = None, nullValue: str = '')¶ Bases:
PyQt5.QtWidgets.QLineEdit
Constructor for QgsFilterLineEdit.
- Parameters
parent (QWidget = None) – parent widget
nullValue (str = '') – string for representing null values
QLineEdit subclass with built in support for clearing the widget’s value and handling custom null value representations.
When using
QgsFilterLineEdit
thevalue()
,setValue()
andclearValue()
methods should be used instead of QLineEdit’stext()
,setText()
andclear()
methods, and thevalueChanged()
signal should be used instead oftextChanged()
.Methods
Returns the clear mode for the widget.
Clears the widget and resets it to the null value.
Returns the default value for the widget.
Reimplemented to enable/disable the clear action depending on read-only status
- param e
Returns if a state is already saved
Determine if the current text represents null.
- param e
Returns the string used for representing null values in the widget.
Restores the current state of the line edit (selection and cursor position)
Will select all text when this widget receives the focus.
Sets the clear mode for the widget.
Sets the default value for the widget.
Sets the string representation for null values in the widget.
Will select all text when this widget receives the focus.
Sets whether the widget’s clear button is visible.
Define if a search icon shall be shown on the left of the image when no text is entered
Show a spinner icon.
Sets the current text for the widget with support for handling null values.
Returns
True
if the widget’s clear button is visible.Returns if a search icon shall be shown on the left of the image when no text is entered
Show a spinner icon.
Stores the current state of the line edit (selection and cursor position)
Returns the text of this edit with support for handling null values.
Signals
Emitted when the widget is cleared
Will select all text when this widget receives the focus.
Show a spinner icon.
Same as
textChanged()
but with support for null values.Attributes
-
class
ClearMode
¶ Bases:
int
-
baseClass
¶ alias of
QgsFilterLineEdit
-
-
ClearToDefault
= 1¶
-
ClearToNull
= 0¶
-
actionEvent
(self, QActionEvent)¶
-
changeEvent
(self, QEvent)¶
-
childEvent
(self, QChildEvent)¶
-
clearMode
(self) → QgsFilterLineEdit.ClearMode¶ Returns the clear mode for the widget. The clear mode defines the behavior of the widget when its value is cleared. This defaults to ClearToNull.
See also
New in version 3.0.
- Return type
-
clearValue
(self)¶ Clears the widget and resets it to the null value.
See also
New in version 3.0.
-
cleared
¶ Emitted when the widget is cleared
See also
clearValue()
[signal]
-
closeEvent
(self, QCloseEvent)¶
-
connectNotify
(self, QMetaMethod)¶
-
contextMenuEvent
(self, QContextMenuEvent)¶
-
create
(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
-
cursorRect
(self) → QRect¶
-
customEvent
(self, QEvent)¶
-
defaultValue
(self) → str¶ 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
See also
New in version 3.0.
- Return type
str
-
destroy
(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
-
disconnectNotify
(self, QMetaMethod)¶
-
dragEnterEvent
(self, QDragEnterEvent)¶
-
dragLeaveEvent
(self, QDragLeaveEvent)¶
-
dragMoveEvent
(self, QDragMoveEvent)¶
-
dropEvent
(self, QDropEvent)¶
-
enterEvent
(self, QEvent)¶
-
event
(self, event: QEvent) → bool¶ Reimplemented to enable/disable the clear action depending on read-only status
New in version 3.0.1.
- Parameters
event (QEvent) –
- Return type
bool
-
focusInEvent
(self, e: QFocusEvent)¶ - Parameters
e (QFocusEvent) –
-
focusNextChild
(self) → bool¶
-
focusNextPrevChild
(self, bool) → bool¶
-
focusOutEvent
(self, QFocusEvent)¶
-
focusPreviousChild
(self) → bool¶
-
hasStateStored
(self) → bool¶ Returns if a state is already saved
New in version 3.14.
- Return type
bool
-
hideEvent
(self, QHideEvent)¶
-
initPainter
(self, QPainter)¶
-
initStyleOption
(self, QStyleOptionFrame)¶
-
inputMethodEvent
(self, QInputMethodEvent)¶
-
isNull
(self) → bool¶ Determine if the current text represents null.
- Return type
bool
- Returns
True
if the widget’s value is null.
See also
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
keyPressEvent
(self, QKeyEvent)¶
-
keyReleaseEvent
(self, QKeyEvent)¶
-
leaveEvent
(self, QEvent)¶
-
metric
(self, QPaintDevice.PaintDeviceMetric) → int¶
-
mouseDoubleClickEvent
(self, QMouseEvent)¶
-
mouseMoveEvent
(self, QMouseEvent)¶
-
mousePressEvent
(self, QMouseEvent)¶
-
mouseReleaseEvent
(self, e: QMouseEvent)¶ - Parameters
e (QMouseEvent) –
-
moveEvent
(self, QMoveEvent)¶
-
nativeEvent
(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]¶
-
nullValue
(self) → str¶ Returns the string used for representing null values in the widget.
See also
See also
- Return type
str
-
paintEvent
(self, QPaintEvent)¶
-
receivers
(self, PYQT_SIGNAL) → int¶
-
resizeEvent
(self, QResizeEvent)¶
-
restoreState
(self)¶ Restores the current state of the line edit (selection and cursor position)
New in version 3.14.
-
selectOnFocus
(self) → bool¶ Will select all text when this widget receives the focus.
New in version 3.0.
- Return type
bool
-
selectOnFocusChanged
¶ Will select all text when this widget receives the focus.
New in version 3.0: [signal]
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setClearMode
(self, mode: QgsFilterLineEdit.ClearMode)¶ Sets the clear mode for the widget. The clear mode defines the behavior of the widget when its value is cleared. This defaults to ClearToNull.
See also
New in version 3.0.
- Parameters
mode (QgsFilterLineEdit.ClearMode) –
-
setDefaultValue
(self, defaultValue: str)¶ 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
defaultValue (str) – default value
See also
See also
New in version 3.0.
-
setNullValue
(self, nullValue: str)¶ 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
nullValue (str) – string to show when widget’s value is null
See also
-
setSelectOnFocus
(self, selectOnFocus: bool)¶ Will select all text when this widget receives the focus.
New in version 3.0.
- Parameters
selectOnFocus (bool) –
-
setShowClearButton
(self, visible: bool)¶ Sets whether the widget’s clear button is visible.
- Parameters
visible (bool) – set to
False
to hide the clear button
See also
New in version 3.0.
-
setShowSearchIcon
(self, visible: bool)¶ Define if a search icon shall be shown on the left of the image when no text is entered
- Parameters
visible (bool) – set to
False
to hide the search icon
New in version 3.0.
-
setShowSpinner
(self, showSpinner: bool)¶ Show a spinner icon. This can be used for search boxes to indicate that something is going on in the background.
New in version 3.0.
- Parameters
showSpinner (bool) –
-
setValue
(self, value: str)¶ Sets the current text for the widget with support for handling null values.
- Parameters
value (str) – The text to set. If a null string is provided, the text shown in the widget will be set to the current
nullValue()
.
See also
-
showClearButton
(self) → bool¶ Returns
True
if the widget’s clear button is visible.See also
New in version 3.0.
- Return type
bool
-
showEvent
(self, QShowEvent)¶
-
showSearchIcon
(self) → bool¶ Returns if a search icon shall be shown on the left of the image when no text is entered
New in version 3.0.
- Return type
bool
-
showSpinner
(self) → bool¶ Show a spinner icon. This can be used for search boxes to indicate that something is going on in the background.
New in version 3.0.
- Return type
bool
-
showSpinnerChanged
¶ Show a spinner icon. This can be used for search boxes to indicate that something is going on in the background.
New in version 3.0: [signal]
-
storeState
(self)¶ Stores the current state of the line edit (selection and cursor position)
New in version 3.14.
-
tabletEvent
(self, QTabletEvent)¶
-
timerEvent
(self, QTimerEvent)¶
-
updateMicroFocus
(self)¶
-
value
(self) → str¶ 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.- Return type
str
- Returns
Current text (or null string if it matches the
nullValue()
property )
See also
-
valueChanged
¶ Same as
textChanged()
but with support for null values.- Parameters
value (str) – The current text or null string if it matches the
nullValue()
property. [signal]
-
wheelEvent
(self, QWheelEvent)¶