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:

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

Public Member Functions inherited from QLineEdit
	QLineEdit (QWidget *parent)

	QLineEdit (const QString &contents, QWidget *parent)

	QLineEdit (const QString &contents, QWidget parent, const char name)

	QLineEdit (const QString &contents, const QString &inputMask, QWidget parent, const char name)

	QLineEdit (QWidget parent, const char name)

	~QLineEdit ()

Qt::Alignment	alignment () const

void	backspace ()

int	characterAt (int xpos, QChar *chr) const

void	clear ()

void	clearModified ()

void	clearValidator ()

QCompleter *	completer () const

void	copy () const

QMenu *	createStandardContextMenu ()

void	cursorBackward (bool mark, int steps)

void	cursorForward (bool mark, int steps)

void	cursorLeft (bool mark, int steps)

Qt::CursorMoveStyle	cursorMoveStyle () const

int	cursorPosition () const

int	cursorPositionAt (const QPoint &pos)

void	cursorPositionChanged (int old, int new)

void	cursorRight (bool mark, int steps)

void	cursorWordBackward (bool mark)

void	cursorWordForward (bool mark)

void	cut ()

void	del ()

void	deselect ()

QString	displayText () const

bool	dragEnabled () const

EchoMode	echoMode () const

bool	edited () const

void	editingFinished ()

void	end (bool mark)

virtual bool	event (QEvent *e)

bool	frame () const

bool	getSelection (int start, int end)

void	getTextMargins (int left, int top, int right, int bottom) const

bool	hasAcceptableInput () const

bool	hasFrame () const

bool	hasMarkedText () const

bool	hasSelectedText () const

void	home (bool mark)

QString	inputMask () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery property) const

void	insert (const QString &newText)

bool	isModified () const

bool	isReadOnly () const

bool	isRedoAvailable () const

bool	isUndoAvailable () const

void	lostFocus ()

int	margin () const

QString	markedText () const

int	maxLength () const

virtual QSize	minimumSizeHint () const

void	paste ()

QString	placeholderText () const

void	redo ()

void	returnPressed ()

void	selectAll ()

QString	selectedText () const

void	selectionChanged ()

int	selectionStart () const

void	setAlignment (QFlags< Qt::AlignmentFlag > flag)

void	setCompleter (QCompleter *c)

void	setCursorMoveStyle (Qt::CursorMoveStyle style)

void	setCursorPosition (int)

void	setDragEnabled (bool b)

void	setEchoMode (EchoMode)

void	setEdited (bool on)

void	setFrame (bool)

void	setInputMask (const QString &inputMask)

void	setMargin (int margin)

void	setMaxLength (int)

void	setModified (bool)

void	setPlaceholderText (const QString &)

void	setReadOnly (bool)

void	setSelection (int start, int length)

void	setText (const QString &)

void	setTextMargins (const QMargins &margins)

void	setTextMargins (int left, int top, int right, int bottom)

void	setValidator (const QValidator *v)

virtual QSize	sizeHint () const

QString	text () const

void	textChanged (const QString &text)

void	textEdited (const QString &text)

QMargins	textMargins () const

void	undo ()

bool	validateAndSet (const QString &newText, int newPos, int newMarkAnchor, int newMarkDrag)

const QValidator *	validator () const

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

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

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const=0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

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

Protected Member Functions inherited from QLineEdit
virtual void	changeEvent (QEvent *ev)

virtual void	contextMenuEvent (QContextMenuEvent *event)

QRect	cursorRect () const

virtual void	dragEnterEvent (QDragEnterEvent *e)

virtual void	dragLeaveEvent (QDragLeaveEvent *e)

virtual void	dragMoveEvent (QDragMoveEvent *e)

virtual void	dropEvent (QDropEvent *e)

virtual void	focusOutEvent (QFocusEvent *e)

void	initStyleOption (QStyleOptionFrame *option) const

virtual void	inputMethodEvent (QInputMethodEvent *e)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *e)

virtual void	mouseReleaseEvent (QMouseEvent *e)

void	repaintArea (int a, int b)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	closeEvent (QCloseEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	enterEvent (QEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	moveEvent (QMoveEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

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)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Properties
ClearMode	clearMode

QString	defaultValue

QString	nullValue

bool	showClearButton

QString	value

Properties inherited from QLineEdit
	acceptableInput

	alignment

	cursorMoveStyle

	cursorPosition

	displayText

	dragEnabled

	echoMode

	frame

	hasSelectedText

	inputMask

	maxLength

	modified

	placeholderText

	readOnly

	redoAvailable

	selectedText

	text

	undoAvailable

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

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 Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

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

enum QgsFilterLineEdit::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

parent	parent widget
nullValue	string 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 2.18

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 2.18

Definition at line 105 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 2.18

Definition at line 117 of file qgsfilterlineedit.h.

◆ focusInEvent()

void QgsFilterLineEdit::focusInEvent ( QFocusEvent * e )

overrideprotectedvirtual

Reimplemented from QLineEdit.

Definition at line 95 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 )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 143 of file qgsfilterlineedit.cpp.

◆ mouseMoveEvent()

void QgsFilterLineEdit::mouseMoveEvent ( QMouseEvent * e )

overrideprotectedvirtual

Reimplemented from QLineEdit.

Definition at line 75 of file qgsfilterlineedit.cpp.

◆ mousePressEvent()

void QgsFilterLineEdit::mousePressEvent ( QMouseEvent * e )

overrideprotectedvirtual

Reimplemented from QLineEdit.

Definition at line 62 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 )

overrideprotectedvirtual

Reimplemented from QLineEdit.

Definition at line 129 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 2.18

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

defaultValue default value

See also: defaultValue(); clearMode()

Note: added in QGIS 2.18

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

nullValue string 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

visible set to false to hide the clear button

See also: showClearButton()

Note: added in QGIS 2.18

Definition at line 51 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

value 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: 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 2.18

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

value The 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:

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

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ClearMode

Constructor & Destructor Documentation

◆ QgsFilterLineEdit()

Member Function Documentation

◆ cleared

◆ clearMode()

◆ clearValue

◆ defaultValue()

◆ focusInEvent()

◆ isNull()

◆ leaveEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ nullValue()

◆ paintEvent()

◆ setClearMode()

◆ setDefaultValue()

◆ setNullValue()

◆ setShowClearButton()

◆ setValue()

◆ showClearButton()

◆ value()

◆ valueChanged

Property Documentation

◆ clearMode

◆ defaultValue

◆ nullValue

◆ showClearButton

◆ value