A reusable widget that can be used to build a expression string. More...

#include <qgsexpressionbuilderwidget.h>

Public Slots
void	currentChanged (const QModelIndex &index, const QModelIndex &)
void	loadAllValues ()
void	loadSampleValues ()
void	on_btnNewFile_pressed ()
void	on_btnRun_pressed ()
void	on_btnSaveFile_pressed ()
void	on_cmbFileNames_currentIndexChanged (int index)
void	on_expressionTree_doubleClicked (const QModelIndex &index)
void	on_lblPreview_linkActivated (QString link)
void	on_mValueListWidget_itemDoubleClicked (QListWidgetItem *item)
void	on_txtExpressionString_textChanged ()
void	on_txtSearchEdit_textChanged ()
void	operatorButtonClicked ()
void	showContextMenu (const QPoint &)

Signals
void	expressionParsed (bool isValid)
	Emitted when the user changes the expression in the widget.

Public Member Functions
	QgsExpressionBuilderWidget (QWidget *parent)
	~QgsExpressionBuilderWidget ()
QString	expressionText ()
	Gets the expression string that has been set in the expression area.
bool	isExpressionValid ()
void	loadCodeFromFile (QString path)
	Load code from the given file into the function editor.
void	loadFieldNames ()
	Loads all the field names from the layer.
void	loadFieldNames (const QgsFields &fields)
void	loadFunctionCode (QString code)
	Load code into the function editor.
void	loadRecent (QString key)
void	newFunctionFile (QString fileName="scratch")
	Create a new file in the function editor.
void	registerItem (QString group, QString label, QString expressionText, QString helpText="", QgsExpressionItem::ItemType type=QgsExpressionItem::ExpressionNode)
	Registers a node item for the expression builder.
void	saveFunctionFile (QString fileName)
	Save the current function editor text to the given file.
void	saveToRecent (QString key)
void	setExpressionText (const QString &expression)
	Sets the expression string for the widget.
void	setGeomCalculator (const QgsDistanceArea &da)
	Sets geometry calculator used in distance/area calculations.
void	setLayer (QgsVectorLayer *layer)
	Sets layer in order to get the fields and values.
void	updateFunctionFileList (QString path)
	Update the list of function files found at the given path.

Detailed Description

A reusable widget that can be used to build a expression string.

See QgsExpressionBuilderDialog for exmaple of usage.

Definition at line 107 of file qgsexpressionbuilderwidget.h.

Constructor & Destructor Documentation

QgsExpressionBuilderWidget::QgsExpressionBuilderWidget ( QWidget * parent )

Definition at line 31 of file qgsexpressionbuilderwidget.cpp.

QgsExpressionBuilderWidget::~QgsExpressionBuilderWidget ( )

Definition at line 87 of file qgsexpressionbuilderwidget.cpp.

Member Function Documentation

void QgsExpressionBuilderWidget::currentChanged	(	const QModelIndex &	index,
		const QModelIndex &
	)

slot

Definition at line 99 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::expressionParsed ( bool isValid )

signal

Emitted when the user changes the expression in the widget.

Users of this widget should connect to this signal to decide if to let the user continue.

Parameters

isValid Is true if the expression the user has typed is valid.

QString QgsExpressionBuilderWidget::expressionText ( )

Gets the expression string that has been set in the expression area.

Returns: The expression as a string.

Definition at line 428 of file qgsexpressionbuilderwidget.cpp.

bool QgsExpressionBuilderWidget::isExpressionValid ( )

Definition at line 325 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::loadAllValues ( )

slot

Definition at line 577 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::loadCodeFromFile ( QString path )

Load code from the given file into the function editor.

Definition at line 201 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::loadFieldNames ( )

Loads all the field names from the layer.

Remarks: Should this really be public couldn't we just do this for the user?

Definition at line 242 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::loadFieldNames ( const QgsFields & fields )

Definition at line 252 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::loadFunctionCode ( QString code )

Load code into the function editor.

Definition at line 209 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::loadRecent ( QString key )

Definition at line 348 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::loadSampleValues ( )

slot

Definition at line 562 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::newFunctionFile ( QString fileName = "scratch" )

Create a new file in the function editor.

Definition at line 175 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_btnNewFile_pressed ( )

slot

Definition at line 187 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_btnRun_pressed ( )

slot

Definition at line 121 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_btnSaveFile_pressed ( )

slot

Definition at line 214 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_cmbFileNames_currentIndexChanged ( int index )

slot

Definition at line 192 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_expressionTree_doubleClicked ( const QModelIndex & index )

slot

Definition at line 226 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_lblPreview_linkActivated ( QString link )

slot

Definition at line 520 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_mValueListWidget_itemDoubleClicked ( QListWidgetItem * item )

slot

Definition at line 529 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_txtExpressionString_textChanged ( )

slot

Definition at line 438 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::on_txtSearchEdit_textChanged ( )

slot

Definition at line 511 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::operatorButtonClicked ( )

slot

Definition at line 536 of file qgsexpressionbuilderwidget.cpp.

void QgsExpressionBuilderWidget::registerItem	(	QString	group,
		QString	label,
		QString	expressionText,
		QString	helpText = `""`,
		QgsExpressionItem::ItemType	type = `QgsExpressionItem::ExpressionNode`
	)

Registers a node item for the expression builder.

Parameters

group	The group the item will be show in the tree view. If the group doesn't exsit it will be created.
label	The label that is show to the user for the item in the tree.
expressionText	The text that is inserted into the expression area when the user double clicks on the item.
helpText	The help text that the user will see when item is selected.
type	The type of the expression item.