The QgsFieldExpressionWidget class reates a widget to choose fields and edit expressions It contains a combo boxto display the fields and expression and a button to open the expression dialog. More...

#include <qgsfieldexpressionwidget.h>

Inheritance diagram for QgsFieldExpressionWidget:

[legend]

Public Types
typedef QgsExpressionContext(*	ExpressionContextCallback) (const void *context)
	Callback function for retrieving the expression context for the expression. More...

Public Slots
void	setExpression (const QString &expression)
	Sets the current expression text and if applicable also the field. More...

void	setField (const QString &fieldName)
	sets the current field or expression in the widget More...

void	setLayer (QgsVectorLayer *layer)
	set the layer used to display the fields and expression More...

void	setLayer (QgsMapLayer *layer)
	convenience slot to connect QgsMapLayerComboBox layer signal More...

void	setRow (int row)
	sets the current row in the widget More...

Signals
void	fieldChanged (const QString &fieldName)
	the signal is emitted when the currently selected field changes More...

void	fieldChanged (const QString &fieldName, bool isValid)
	fieldChanged signal with indication of the validity of the expression More...

Public Member Functions
	QgsFieldExpressionWidget (QWidget *parent=nullptr)
	QgsFieldExpressionWidget creates a widget with a combo box to display the fields and expression and a button to open the expression dialog. More...

QString	asExpression () const
	Returns the currently selected field or expression. More...

QString	currentField (bool isExpression=nullptr, bool isValid=nullptr) const
	currentField returns the currently selected field or expression if allowed More...

QString	currentText () const
	Return the current text that is set in the expression area. More...

QString	expression () const
	Returns the currently selected field or expression. More...

const QString	expressionDialogTitle ()
	return the title used for the expression dialog More...

QgsFieldProxyModel::Filters	filters () const
	currently used filter on list of fields More...

bool	isExpression () const
	If the content is not just a simple field this method will return true. More...

bool	isValidExpression (QString *expressionError=nullptr) const
	Return true if the current expression is valid. More...

QgsVectorLayer *	layer () const
	Returns the currently used layer. More...

void	registerGetExpressionContextCallback (ExpressionContextCallback fnGetExpressionContext, const void *context)
	Register callback function for retrieving the expression context for the expression. More...

void	setExpressionDialogTitle (const QString &title)
	define the title used in the expression dialog More...

void	setFilters (const QgsFieldProxyModel::Filters &filters)
	setFilters allows fitering according to the type of field More...

void	setGeomCalculator (const QgsDistanceArea &da)
	set the geometry calculator used in the expression dialog More...

void	setLeftHandButtonStyle (bool isLeft)

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

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) 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

virtual QSize	minimumSizeHint () 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

virtual QSize	sizeHint () 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 Slots
void	currentFieldChanged ()

void	editExpression ()
	open the expression dialog to edit the current or add a new expression More...

void	expressionEdited (const QString &expression)
	when expression is edited by the user in the line edit, it will be checked for validity More...

void	expressionEditingFinished ()
	when expression has been edited (finished) it will be added to the model More...

bool	isExpressionValid (const QString &expressionStr)

void	updateLineEditStyle (const QString &expression=QString())
	updateLineEditStyle will re-style (color/font) the line edit depending on content and status More...

Protected Member Functions
void	changeEvent (QEvent *event) override

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

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

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

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual bool	event (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	paintEvent (QPaintEvent *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
QString	expressionDialogTitle

QgsFieldProxyModel::Filters	filters

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

Friends
class	TestQgsFieldExpressionWidget

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

The QgsFieldExpressionWidget class reates a widget to choose fields and edit expressions It contains a combo boxto display the fields and expression and a button to open the expression dialog.

The combo box is editable, allowing expressions to be edited inline. The validity of the expression is checked live on key press, invalid expressions are displayed in red. The expression will be added to the model (and the fieldChanged signals emitted) only when editing in the line edit is finished (focus lost, enter key pressed).

Definition at line 40 of file qgsfieldexpressionwidget.h.

Member Typedef Documentation

◆ ExpressionContextCallback

typedef QgsExpressionContext( * QgsFieldExpressionWidget::ExpressionContextCallback) (const void *context)

Callback function for retrieving the expression context for the expression.

Definition at line 115 of file qgsfieldexpressionwidget.h.

Constructor & Destructor Documentation

◆ QgsFieldExpressionWidget()

QgsFieldExpressionWidget::QgsFieldExpressionWidget ( QWidget * parent = nullptr )

explicit

QgsFieldExpressionWidget creates a widget with a combo box to display the fields and expression and a button to open the expression dialog.

Definition at line 25 of file qgsfieldexpressionwidget.cpp.

Member Function Documentation

◆ asExpression()

QString QgsFieldExpressionWidget::asExpression ( ) const

Returns the currently selected field or expression.

If a field is currently selected, the returned value will be converted to a valid expression referencing this field (ie enclosing the field name with appropriate quotations).

Note: added in QGIS 2.14

Definition at line 106 of file qgsfieldexpressionwidget.cpp.

◆ changeEvent()

void QgsFieldExpressionWidget::changeEvent ( QEvent * event )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 251 of file qgsfieldexpressionwidget.cpp.

◆ currentField()

QString QgsFieldExpressionWidget::currentField	(	bool *	isExpression = `nullptr`,
		bool *	isValid = `nullptr`
	)		const

currentField returns the currently selected field or expression if allowed

Parameters

isExpression	determines if the string returned is the name of a field or an expression
isValid	determines if the expression (or field) returned is valid

Definition at line 127 of file qgsfieldexpressionwidget.cpp.

◆ currentFieldChanged

void QgsFieldExpressionWidget::currentFieldChanged ( )

protectedslot

Definition at line 276 of file qgsfieldexpressionwidget.cpp.

◆ currentText()

QString QgsFieldExpressionWidget::currentText ( ) const

Return the current text that is set in the expression area.

Definition at line 101 of file qgsfieldexpressionwidget.cpp.

◆ editExpression

void QgsFieldExpressionWidget::editExpression ( )

protectedslot

open the expression dialog to edit the current or add a new expression

Definition at line 213 of file qgsfieldexpressionwidget.cpp.

◆ expression()

QString QgsFieldExpressionWidget::expression ( ) const

Returns the currently selected field or expression.

If a field is currently selected, the returned value will be converted to a valid expression referencing this field (ie enclosing the field name with appropriate quotations).

Alias for asExpression()

Note: added in QGIS 2.18

Definition at line 111 of file qgsfieldexpressionwidget.cpp.

◆ expressionDialogTitle()

const QString QgsFieldExpressionWidget::expressionDialogTitle ( )

inline

return the title used for the expression dialog

Definition at line 57 of file qgsfieldexpressionwidget.h.

◆ expressionEdited

void QgsFieldExpressionWidget::expressionEdited ( const QString & expression )

protectedslot

when expression is edited by the user in the line edit, it will be checked for validity

Definition at line 234 of file qgsfieldexpressionwidget.cpp.

◆ expressionEditingFinished

void QgsFieldExpressionWidget::expressionEditingFinished ( )

protectedslot

when expression has been edited (finished) it will be added to the model

Definition at line 240 of file qgsfieldexpressionwidget.cpp.

◆ fieldChanged [1/2]

void QgsFieldExpressionWidget::fieldChanged ( const QString & fieldName )

signal

the signal is emitted when the currently selected field changes

◆ fieldChanged [2/2]

void QgsFieldExpressionWidget::fieldChanged	(	const QString &	fieldName,
		bool	isValid
	)

signal

fieldChanged signal with indication of the validity of the expression

◆ filters()

QgsFieldProxyModel::Filters QgsFieldExpressionWidget::filters ( ) const

inline

currently used filter on list of fields

Definition at line 65 of file qgsfieldexpressionwidget.h.

◆ isExpression()

bool QgsFieldExpressionWidget::isExpression ( ) const

If the content is not just a simple field this method will return true.

Definition at line 122 of file qgsfieldexpressionwidget.cpp.

◆ isExpressionValid

bool QgsFieldExpressionWidget::isExpressionValid ( const QString & expressionStr )

protectedslot

Definition at line 333 of file qgsfieldexpressionwidget.cpp.

◆ isValidExpression()

bool QgsFieldExpressionWidget::isValidExpression ( QString * expressionError = nullptr ) const

Return true if the current expression is valid.

Definition at line 116 of file qgsfieldexpressionwidget.cpp.

◆ layer()

QgsVectorLayer * QgsFieldExpressionWidget::layer ( ) const

Returns the currently used layer.

Definition at line 143 of file qgsfieldexpressionwidget.cpp.

◆ registerGetExpressionContextCallback()

void QgsFieldExpressionWidget::registerGetExpressionContextCallback	(	QgsFieldExpressionWidget::ExpressionContextCallback	fnGetExpressionContext,
		const void *	context
	)

Register callback function for retrieving the expression context for the expression.

Parameters

fnGetExpressionContext	call back function, will be called when the widget requires the current expression context
context	context for callback function

Note: added in QGIS 2.12; not available in Python bindings

Definition at line 148 of file qgsfieldexpressionwidget.cpp.

◆ setExpression

void QgsFieldExpressionWidget::setExpression ( const QString & expression )

slot

Sets the current expression text and if applicable also the field.

Alias for setField.

Note: Added in QGIS 2.18

Definition at line 208 of file qgsfieldexpressionwidget.cpp.

◆ setExpressionDialogTitle()

void QgsFieldExpressionWidget::setExpressionDialogTitle ( const QString & title )

define the title used in the expression dialog

Definition at line 71 of file qgsfieldexpressionwidget.cpp.

◆ setField

void QgsFieldExpressionWidget::setField ( const QString & fieldName )

slot

sets the current field or expression in the widget

Definition at line 180 of file qgsfieldexpressionwidget.cpp.

◆ setFilters()

void QgsFieldExpressionWidget::setFilters ( const QgsFieldProxyModel::Filters & filters )

setFilters allows fitering according to the type of field

Definition at line 76 of file qgsfieldexpressionwidget.cpp.

◆ setGeomCalculator()

void QgsFieldExpressionWidget::setGeomCalculator ( const QgsDistanceArea & da )

set the geometry calculator used in the expression dialog

Definition at line 96 of file qgsfieldexpressionwidget.cpp.

◆ setLayer [1/2]

void QgsFieldExpressionWidget::setLayer ( QgsVectorLayer * layer )

slot

set the layer used to display the fields and expression

Definition at line 163 of file qgsfieldexpressionwidget.cpp.

◆ setLayer [2/2]

void QgsFieldExpressionWidget::setLayer ( QgsMapLayer * layer )

slot

convenience slot to connect QgsMapLayerComboBox layer signal

Definition at line 154 of file qgsfieldexpressionwidget.cpp.

◆ setLeftHandButtonStyle()

void QgsFieldExpressionWidget::setLeftHandButtonStyle ( bool isLeft )

Definition at line 81 of file qgsfieldexpressionwidget.cpp.

◆ setRow

void QgsFieldExpressionWidget::setRow ( int row )

inlineslot

sets the current row in the widget

Definition at line 143 of file qgsfieldexpressionwidget.h.

◆ updateLineEditStyle

void QgsFieldExpressionWidget::updateLineEditStyle ( const QString & expression = QString() )

protectedslot

updateLineEditStyle will re-style (color/font) the line edit depending on content and status

Parameters

expression if expression is given it will be evaluated for the given string, otherwise it takes current expression from the model

Definition at line 298 of file qgsfieldexpressionwidget.cpp.

Friends And Related Function Documentation

◆ TestQgsFieldExpressionWidget

friend class TestQgsFieldExpressionWidget

friend

Definition at line 197 of file qgsfieldexpressionwidget.h.

Property Documentation

◆ expressionDialogTitle

QString QgsFieldExpressionWidget::expressionDialogTitle

readwrite

Definition at line 43 of file qgsfieldexpressionwidget.h.

◆ filters

QgsFieldProxyModel::Filters QgsFieldExpressionWidget::filters

readwrite

Definition at line 45 of file qgsfieldexpressionwidget.h.

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

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

Public Types

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ExpressionContextCallback

Constructor & Destructor Documentation

◆ QgsFieldExpressionWidget()

Member Function Documentation

◆ asExpression()

◆ changeEvent()

◆ currentField()

◆ currentFieldChanged

◆ currentText()

◆ editExpression

◆ expression()

◆ expressionDialogTitle()

◆ expressionEdited

◆ expressionEditingFinished

◆ fieldChanged [1/2]

◆ fieldChanged [2/2]

◆ filters()

◆ isExpression()

◆ isExpressionValid

◆ isValidExpression()

◆ layer()

◆ registerGetExpressionContextCallback()

◆ setExpression

◆ setExpressionDialogTitle()

◆ setField

◆ setFilters()

◆ setGeomCalculator()

◆ setLayer [1/2]

◆ setLayer [2/2]

◆ setLeftHandButtonStyle()

◆ setRow

◆ updateLineEditStyle

Friends And Related Function Documentation

◆ TestQgsFieldExpressionWidget

Property Documentation

◆ expressionDialogTitle

◆ filters