A QgsFilterLineEdit subclass with the ability to "highlight" the edges of the widget. More...
#include <qgshighlightablelineedit.h>
Inheritance diagram for QgsHighlightableLineEdit:
Public Member Functions | |
| QgsHighlightableLineEdit (QWidget *parent=nullptr) | |
| Constructor for QgsHighlightableLineEdit, with the specified parent widget. More... | |
| bool | isHighlighted () const |
Returns true if the line edit is currently highlighted. More... | |
| void | setHighlighted (bool highlighted) |
| Sets whether the line edit is currently highlighted. More... | |
 Public Member Functions inherited from QgsFilterLineEdit | |
| QgsFilterLineEdit (QWidget *parent=nullptr, const QString &nullValue=QString()) | |
| 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 | event (QEvent *event) override |
| Reimplemented to enable/disable the clear action depending on read-only status. More... | |
| bool | hasStateStored () const |
| Returns if a state is already saved. More... | |
| bool | isNull () const |
| Determine if the current text represents null. More... | |
| QString | nullValue () const |
| Returns the string used for representing null values in the widget. More... | |
| bool | selectOnFocus () const |
| Will select all text when this widget receives the focus. 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 | setSelectOnFocus (bool selectOnFocus) |
| Will select all text when this widget receives the focus. More... | |
| void | setShowClearButton (bool visible) |
| Sets whether the widget's clear button is visible. More... | |
| void | setShowSearchIcon (bool visible) |
| Define if a search icon shall be shown on the left of the image when no text is entered. More... | |
| void | setShowSpinner (bool showSpinner) |
| Show a spinner icon. 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... | |
| bool | showSearchIcon () const |
| Returns if a search icon shall be shown on the left of the image when no text is entered. More... | |
| bool | showSpinner () const |
| Show a spinner icon. More... | |
| QString | value () const |
| Returns the text of this edit with support for handling null values. More... | |
Protected Member Functions | |
| void | paintEvent (QPaintEvent *e) override |
| Protected Member Functions inherited from QgsFilterLineEdit | |
| void | focusInEvent (QFocusEvent *e) override |
| void | mouseReleaseEvent (QMouseEvent *e) override |
Additional Inherited Members | |
| Public Types inherited from QgsFilterLineEdit | |
| enum | ClearMode { ClearToNull = 0 , ClearToDefault } |
| Behavior when clearing value of widget. More... | |
| Public Slots inherited from QgsFilterLineEdit | |
| virtual void | clearValue () |
| Clears the widget and resets it to the null value. More... | |
| void | restoreState () |
| Restores the current state of the line edit (selection and cursor position) More... | |
| void | storeState () |
| Stores the current state of the line edit (selection and cursor position) More... | |
| Signals inherited from QgsFilterLineEdit | |
| void | cleared () |
| Emitted when the widget is cleared. More... | |
| void | selectOnFocusChanged () |
| Will select all text when this widget receives the focus. More... | |
| void | showSpinnerChanged () |
| Show a spinner icon. More... | |
| void | valueChanged (const QString &value) |
| Same as textChanged() but with support for null values. More... | |
| Properties inherited from QgsFilterLineEdit | |
| ClearMode | clearMode |
| QString | defaultValue |
| QString | nullValue |
| bool | showClearButton |
| bool | showSearchIcon |
| bool | showSpinner |
| QString | value |
Detailed Description
A QgsFilterLineEdit subclass with the ability to "highlight" the edges of the widget.
- Since
- QGIS 3.14
Definition at line 33 of file qgshighlightablelineedit.h.
Constructor & Destructor Documentation
◆ QgsHighlightableLineEdit()
| QgsHighlightableLineEdit::QgsHighlightableLineEdit | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsHighlightableLineEdit, with the specified parent widget.
Definition at line 20 of file qgshighlightablelineedit.cpp.
Member Function Documentation
◆ isHighlighted()
|
inline |
Returns true if the line edit is currently highlighted.
- See also
- setHighlighted()
Definition at line 48 of file qgshighlightablelineedit.h.
◆ paintEvent()
|
overrideprotected |
Definition at line 24 of file qgshighlightablelineedit.cpp.
◆ setHighlighted()
| void QgsHighlightableLineEdit::setHighlighted | ( | bool | highlighted | ) |
Sets whether the line edit is currently highlighted.
- See also
- isHighlighted()
Definition at line 37 of file qgshighlightablelineedit.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/qgshighlightablelineedit.h
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/qgshighlightablelineedit.cpp
