17 #include <QMessageBox>
18 #include <QVersionNumber>
33 QString text = QStringLiteral(
"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>" )
34 .arg( QCoreApplication::translate(
"relation_help",
"relation %1" ).arg( relation.
name() ),
35 QObject::tr(
"Inserts the relation ID for the relation named '%1'." ).arg( relation.
name() ) );
37 text += QStringLiteral(
"<h4>%1</h4><div class=\"description\"><pre>%2</pre></div>" )
38 .arg( QObject::tr(
"Current value" ), relation.
id() );
47 QString text = QStringLiteral(
"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>" )
48 .arg( QCoreApplication::translate(
"layer_help",
"map layer %1" ).arg( layer->
name() ),
49 QObject::tr(
"Inserts the layer ID for the layer named '%1'." ).arg( layer->
name() ) );
51 text += QStringLiteral(
"<h4>%1</h4><div class=\"description\"><pre>%2</pre></div>" )
52 .arg( QObject::tr(
"Current value" ), layer->
id() );
60 QString text = QStringLiteral(
"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>" )
61 .arg( QCoreApplication::translate(
"recent_expression_help",
"expression %1" ).arg( label ),
62 QCoreApplication::translate(
"recent_expression_help",
"Recently used expression." ) );
64 text += QStringLiteral(
"<h4>%1</h4><div class=\"description\"><pre>%2</pre></div>" )
65 .arg( QObject::tr(
"Expression" ), expression );
73 QString text = QStringLiteral(
"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>" )
74 .arg( QCoreApplication::translate(
"user_expression_help",
"expression %1" ).arg( label ), description );
76 text += QStringLiteral(
"<h4>%1</h4><div class=\"description\"><pre>%2</pre></div>" )
77 .arg( QObject::tr(
"Expression" ), expression );
83 QString
formatVariableHelp(
const QString &variable,
const QString &description,
bool showValue,
const QVariant &value )
85 QString text = QStringLiteral(
"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>" )
86 .arg( QCoreApplication::translate(
"variable_help",
"variable %1" ).arg( variable ), description );
90 QString valueString = !value.isValid()
91 ? QCoreApplication::translate(
"variable_help",
"not set" )
94 text += QStringLiteral(
"<h4>%1</h4><div class=\"description\"><p>%2</p></div>" )
95 .arg( QObject::tr(
"Current value" ), valueString );
109 : QTreeView( parent )
112 connect(
this, &QTreeView::doubleClicked,
this, &QgsExpressionTreeView::onDoubleClicked );
114 mModel = qgis::make_unique<QStandardItemModel>();
115 mProxyModel = qgis::make_unique<QgsExpressionItemSearchProxy>();
116 mProxyModel->setDynamicSortFilter(
true );
117 mProxyModel->setSourceModel( mModel.get() );
118 setModel( mProxyModel.get() );
119 setSortingEnabled(
true );
120 sortByColumn( 0, Qt::AscendingOrder );
122 setSelectionMode( QAbstractItemView::SelectionMode::SingleSelection );
124 setContextMenuPolicy( Qt::CustomContextMenu );
125 connect(
this, &QWidget::customContextMenuRequested,
this, &QgsExpressionTreeView::showContextMenu );
126 connect( selectionModel(), &QItemSelectionModel::currentChanged,
this, &QgsExpressionTreeView::currentItemChanged );
128 updateFunctionTree();
133 QModelIndex firstItem = mProxyModel->index( 0, 0, QModelIndex() );
134 setCurrentIndex( firstItem );
151 mExpressionContext = context;
152 updateFunctionTree();
160 mMenuProvider = provider;
165 updateFunctionTree();
173 QModelIndex idx = mProxyModel->mapToSource( currentIndex() );
191 updateFunctionTree();
197 mProxyModel->setFilterWildcard( text );
198 if ( text.isEmpty() )
205 QModelIndex index = mProxyModel->index( 0, 0 );
206 if ( mProxyModel->hasChildren( index ) )
208 QModelIndex child = mProxyModel->index( 0, 0, index );
209 selectionModel()->setCurrentIndex( child, QItemSelectionModel::ClearAndSelect );
214 void QgsExpressionTreeView::onDoubleClicked(
const QModelIndex &index )
216 QModelIndex idx = mProxyModel->mapToSource( index );
228 void QgsExpressionTreeView::showContextMenu( QPoint pt )
230 QModelIndex idx = indexAt( pt );
231 idx = mProxyModel->mapToSource( idx );
236 if ( !mMenuProvider )
242 menu->popup( mapToGlobal( pt ) );
245 void QgsExpressionTreeView::currentItemChanged(
const QModelIndex &index,
const QModelIndex & )
248 QModelIndex idx = mProxyModel->mapToSource( index );
256 void QgsExpressionTreeView::updateFunctionTree()
259 mExpressionGroups.clear();
262 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"+" ), QStringLiteral(
" + " ) );
263 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"-" ), QStringLiteral(
" - " ) );
264 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"*" ), QStringLiteral(
" * " ) );
265 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"/" ), QStringLiteral(
" / " ) );
266 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"%" ), QStringLiteral(
" % " ) );
267 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"^" ), QStringLiteral(
" ^ " ) );
268 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"=" ), QStringLiteral(
" = " ) );
269 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"~" ), QStringLiteral(
" ~ " ) );
270 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
">" ), QStringLiteral(
" > " ) );
271 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"<" ), QStringLiteral(
" < " ) );
272 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"<>" ), QStringLiteral(
" <> " ) );
273 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"<=" ), QStringLiteral(
" <= " ) );
274 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
">=" ), QStringLiteral(
" >= " ) );
275 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"[]" ), QStringLiteral(
"[ ]" ) );
276 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"||" ), QStringLiteral(
" || " ) );
277 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"IN" ), QStringLiteral(
" IN " ) );
278 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"LIKE" ), QStringLiteral(
" LIKE " ) );
279 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"ILIKE" ), QStringLiteral(
" ILIKE " ) );
280 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"IS" ), QStringLiteral(
" IS " ) );
281 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"OR" ), QStringLiteral(
" OR " ) );
282 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"AND" ), QStringLiteral(
" AND " ) );
283 registerItem( QStringLiteral(
"Operators" ), QStringLiteral(
"NOT" ), QStringLiteral(
" NOT " ) );
285 QString casestring = QStringLiteral(
"CASE WHEN condition THEN result END" );
286 registerItem( QStringLiteral(
"Conditionals" ), QStringLiteral(
"CASE" ), casestring );
289 registerItem( QStringLiteral(
"Fields and Values" ), QStringLiteral(
"NULL" ), QStringLiteral(
"NULL" ), QString(),
QgsExpressionItem::ExpressionNode,
false, -1 );
293 for (
int i = 0; i < count; i++ )
296 QString name = func->
name();
297 if ( name.startsWith(
'_' ) )
307 if ( func->
params() != 0 )
309 else if ( !name.startsWith(
'$' ) )
310 name += QLatin1String(
"()" );
321 loadExpressionContext();
324 void QgsExpressionTreeView::registerItem(
const QString &group,
325 const QString &label,
326 const QString &expressionText,
327 const QString &helpText,
331 item->setData( label, Qt::UserRole );
335 item->setIcon( icon );
338 if ( mExpressionGroups.contains( group ) )
341 groupNode->appendRow( item );
347 newgroupNode->setData( group, Qt::UserRole );
350 newgroupNode->appendRow( item );
351 newgroupNode->setBackground( QBrush( QColor( 150, 150, 150, 150 ) ) );
352 mModel->appendRow( newgroupNode );
353 mExpressionGroups.insert( group, newgroupNode );
356 if ( highlightedItem )
360 topLevelItem->setData( label, Qt::UserRole );
362 QFont font = topLevelItem->font();
363 font.setBold(
true );
364 topLevelItem->setFont( font );
365 mModel->appendRow( topLevelItem );
369 void QgsExpressionTreeView::registerItemForAllGroups(
const QStringList &groups,
const QString &label,
const QString &expressionText,
const QString &helpText,
QgsExpressionItem::ItemType type,
bool highlightedItem,
int sortOrder,
const QStringList &tags )
371 const auto constGroups = groups;
372 for (
const QString &group : constGroups )
374 registerItem( group, label, expressionText, helpText, type, highlightedItem, sortOrder, QIcon(), tags );
378 void QgsExpressionTreeView::loadExpressionContext()
381 const auto constVariableNames = variableNames;
382 for (
const QString &variable : constVariableNames )
384 registerItem( QStringLiteral(
"Variables" ), variable,
" @" + variable +
' ',
391 QStringList contextFunctions = mExpressionContext.
functionNames();
392 const auto constContextFunctions = contextFunctions;
393 for (
const QString &functionName : constContextFunctions )
396 QString name = func->
name();
397 if ( name.startsWith(
'_' ) )
399 if ( func->
params() != 0 )
405 void QgsExpressionTreeView::loadLayers()
410 QMap<QString, QgsMapLayer *> layers = mProject->mapLayers();
411 QMap<QString, QgsMapLayer *>::const_iterator layerIt = layers.constBegin();
412 for ( ; layerIt != layers.constEnd(); ++layerIt )
414 registerItemForAllGroups( QStringList() << tr(
"Map Layers" ), layerIt.value()->name(), QStringLiteral(
"'%1'" ).arg( layerIt.key() ),
formatLayerHelp( layerIt.value() ) );
420 for (
int i = 0; i < fields.
count(); ++i )
429 void QgsExpressionTreeView::loadFieldNames()
432 if ( mExpressionGroups.contains( QStringLiteral(
"Fields and Values" ) ) )
434 QgsExpressionItem *node = mExpressionGroups.value( QStringLiteral(
"Fields and Values" ) );
435 node->removeRows( 0, node->rowCount() );
438 registerItem( QStringLiteral(
"Fields and Values" ), QStringLiteral(
"NULL" ), QStringLiteral(
"NULL" ), QString(),
QgsExpressionItem::ExpressionNode,
false, -1 );
450 void QgsExpressionTreeView::loadRelations()
455 QMap<QString, QgsRelation> relations = mProject->relationManager()->relations();
456 QMap<QString, QgsRelation>::const_iterator relIt = relations.constBegin();
457 for ( ; relIt != relations.constEnd(); ++relIt )
459 registerItemForAllGroups( QStringList() << tr(
"Relations" ), relIt->name(), QStringLiteral(
"'%1'" ).arg( relIt->id() ),
formatRelationHelp( relIt.value() ) );
465 mRecentKey = collection;
466 QString name = tr(
"Recent (%1)" ).arg( collection );
467 if ( mExpressionGroups.contains( name ) )
470 node->removeRows( 0, node->rowCount() );
474 const QString location = QStringLiteral(
"/expressions/recent/%1" ).arg( collection );
475 const QStringList expressions = settings.
value( location ).toStringList();
477 for (
const QString &expression : expressions )
480 QString label = expression;
481 label.replace(
'\n',
' ' );
490 QString location = QStringLiteral(
"/expressions/recent/%1" ).arg( collection );
491 QStringList expressions = settings.
value( location ).toStringList();
492 expressions.removeAll( expressionText );
494 expressions.prepend( expressionText );
496 while ( expressions.count() > 20 )
498 expressions.pop_back();
501 settings.
setValue( location, expressions );
508 const QString location = QStringLiteral(
"user" );
509 settings.
beginGroup( location, QgsSettings::Section::Expressions );
511 settings.
setValue( QStringLiteral(
"expression" ), expression );
512 settings.
setValue( QStringLiteral(
"helpText" ), helpText );
515 const QModelIndexList idxs { mModel->match( mModel->index( 0, 0 ), Qt::DisplayRole, label, 1, Qt::MatchFlag::MatchRecursive ) };
516 if ( ! idxs.isEmpty() )
518 scrollTo( idxs.first() );
525 settings.
remove( QStringLiteral(
"user/%1" ).arg( label ), QgsSettings::Section::Expressions );
533 if ( mExpressionGroups.contains( QStringLiteral(
"UserGroup" ) ) )
535 QgsExpressionItem *node = mExpressionGroups.value( QStringLiteral(
"UserGroup" ) );
536 node->removeRows( 0, node->rowCount() );
540 const QString location = QStringLiteral(
"user" );
541 settings.
beginGroup( location, QgsSettings::Section::Expressions );
547 for (
const auto &label : qgis::as_const( mUserExpressionLabels ) )
550 expression = settings.
value( QStringLiteral(
"expression" ) ).toString();
559 return mUserExpressionLabels;
564 const QString group = QStringLiteral(
"user" );
566 QJsonArray exportList;
567 QJsonObject exportObject
570 {
"exported_at", QDateTime::currentDateTime().toString( Qt::ISODate )},
572 {
"expressions", exportList}
575 settings.
beginGroup( group, QgsSettings::Section::Expressions );
579 for (
const QString &label : qgis::as_const( mUserExpressionLabels ) )
583 const QString expression = settings.
value( QStringLiteral(
"expression" ) ).toString();
584 const QString helpText = settings.
value( QStringLiteral(
"helpText" ) ).toString();
585 const QJsonObject expressionObject
588 {
"type",
"expression"},
589 {
"expression", expression},
591 {
"description", helpText}
593 exportList.push_back( expressionObject );
598 exportObject[
"expressions"] = exportList;
599 QJsonDocument exportJson = QJsonDocument( exportObject );
607 if ( ! expressionsDocument.isObject() )
610 QJsonObject expressionsObject = expressionsDocument.object();
613 if ( ! expressionsObject[
"qgis_version"].isString()
614 || ! expressionsObject[
"exported_at"].isString()
615 || ! expressionsObject[
"author"].isString()
616 || ! expressionsObject[
"expressions"].isArray() )
620 QVersionNumber qgisJsonVersion = QVersionNumber::fromString( expressionsObject[
"qgis_version"].toString() );
621 QVersionNumber qgisVersion = QVersionNumber::fromString(
Qgis::version() );
625 if ( qgisJsonVersion > qgisVersion )
627 QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::No;
628 switch ( QMessageBox::question(
this,
629 tr(
"QGIS Version Mismatch" ),
630 tr(
"The imported expressions are from newer version of QGIS (%1) "
631 "and some of the expression might not work the current version (%2). "
632 "Are you sure you want to continue?" ).arg( qgisJsonVersion.toString(), qgisVersion.toString() ), buttons ) )
634 case QMessageBox::No:
637 case QMessageBox::Yes:
646 QStringList skippedExpressionLabels;
647 bool isApplyToAll =
false;
648 bool isOkToOverwrite =
false;
651 settings.
beginGroup( QStringLiteral(
"user" ), QgsSettings::Section::Expressions );
654 for (
const QJsonValue && expressionValue : expressionsObject[
"expressions"].toArray() )
657 if ( ! expressionValue.isObject() )
660 skippedExpressionLabels.append( expressionValue.toString() );
664 QJsonObject expressionObj = expressionValue.toObject();
667 if ( ! expressionObj[
"name"].isString()
668 || ! expressionObj[
"type"].isString()
669 || ! expressionObj[
"expression"].isString()
670 || ! expressionObj[
"group"].isString()
671 || ! expressionObj[
"description"].isString() )
674 if ( ! expressionObj[
"name"].toString().isEmpty() )
675 skippedExpressionLabels.append( expressionObj[
"name"].toString() );
677 skippedExpressionLabels.append( expressionObj[
"expression"].toString() );
683 if ( expressionObj[
"type"].toString() != QLatin1String(
"expression" ) )
685 skippedExpressionLabels.append( expressionObj[
"name"].toString() );
690 if ( expressionObj[
"group"].toString() != QLatin1String(
"user" ) )
692 skippedExpressionLabels.append( expressionObj[
"name"].toString() );
696 const QString label = expressionObj[
"name"].toString();
697 const QString expression = expressionObj[
"expression"].toString();
698 const QString helpText = expressionObj[
"description"].toString();
701 if ( label.contains(
"\\" ) || label.contains(
'/' ) )
703 skippedExpressionLabels.append( expressionObj[
"name"].toString() );
708 const QString oldExpression = settings.
value( QStringLiteral(
"expression" ) ).toString();
712 if ( mUserExpressionLabels.contains( label ) && expression != oldExpression )
714 if ( ! isApplyToAll )
715 showMessageBoxConfirmExpressionOverwrite( isApplyToAll, isOkToOverwrite, label, oldExpression, expression );
717 if ( isOkToOverwrite )
721 skippedExpressionLabels.append( label );
733 if ( ! skippedExpressionLabels.isEmpty() )
735 QStringList skippedExpressionLabelsQuoted;
736 for (
const QString &skippedExpressionLabel : skippedExpressionLabels )
737 skippedExpressionLabelsQuoted.append( QStringLiteral(
"'%1'" ).arg( skippedExpressionLabel ) );
739 QMessageBox::information(
this,
740 tr(
"Skipped Expression Imports" ),
741 QStringLiteral(
"%1\n%2" ).arg( tr(
"The following expressions have been skipped:" ),
742 skippedExpressionLabelsQuoted.join(
", " ) ) );
748 QList<QgsExpressionItem *> result;
749 const QList<QStandardItem *> found { mModel->findItems( label, Qt::MatchFlag::MatchRecursive ) };
750 for (
const auto &item : qgis::as_const( found ) )
757 void QgsExpressionTreeView::showMessageBoxConfirmExpressionOverwrite(
759 bool &isOkToOverwrite,
760 const QString &label,
761 const QString &oldExpression,
762 const QString &newExpression )
764 QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::YesToAll | QMessageBox::No | QMessageBox::NoToAll;
765 switch ( QMessageBox::question(
this,
766 tr(
"Expression Overwrite" ),
767 tr(
"The expression with label '%1' was already defined."
768 "The old expression \"%2\" will be overwritten by \"%3\"."
769 "Are you sure you want to overwrite the expression?" ).arg( label, oldExpression, newExpression ), buttons ) )
771 case QMessageBox::NoToAll:
773 isOkToOverwrite =
false;
776 case QMessageBox::No:
777 isApplyToAll =
false;
778 isOkToOverwrite =
false;
781 case QMessageBox::YesToAll:
783 isOkToOverwrite =
true;
786 case QMessageBox::Yes:
787 isApplyToAll =
false;
788 isOkToOverwrite =
true;
805 setFilterCaseSensitivity( Qt::CaseInsensitive );
810 QModelIndex index = sourceModel()->index( source_row, 0, source_parent );
813 int count = sourceModel()->rowCount( index );
814 bool matchchild =
false;
815 for (
int i = 0; i < count; ++i )
831 if ( QSortFilterProxyModel::filterAcceptsRow( source_row, source_parent ) )
838 for (
const QString &tag : tags )
840 if ( tag.contains( filterRegExp() ) )
851 if ( leftSort != rightSort )
852 return leftSort < rightSort;
854 QString leftString = sourceModel()->data( left, Qt::DisplayRole ).toString();
855 QString rightString = sourceModel()->data( right, Qt::DisplayRole ).toString();
858 if ( leftString.startsWith(
'$' ) )
859 leftString = leftString.mid( 1 );
860 if ( rightString.startsWith(
'$' ) )
861 rightString = rightString.mid( 1 );
863 return QString::localeAwareCompare( leftString, rightString ) < 0;
static QString version()
Version string.
static QString userFullName()
Returns the user's operating system login account full display name.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QString description(const QString &name) const
Returns a translated description string for the variable with specified name.
QStringList functionNames() const
Retrieves a list of function names contained in the context.
bool isHighlightedFunction(const QString &name) const
Returns true if the specified function name is intended to be highlighted to the user.
QStringList filteredVariableNames() const
Returns a filtered list of variables names set by all scopes in the context.
bool isHighlightedVariable(const QString &name) const
Returns true if the specified variable name is intended to be highlighted to the user.
QgsExpressionFunction * function(const QString &name) const
Fetches a matching function from the context.
QVariant variable(const QString &name) const
Fetches a matching variable from the context.
A abstract base class for defining QgsExpression functions.
bool isContextual() const
Returns whether the function is only available if provided by a QgsExpressionContext object.
int params() const
The number of parameters this function takes.
QStringList groups() const
Returns a list of the groups the function belongs to.
virtual bool isDeprecated() const
Returns true if the function is deprecated and should not be presented as a valid option to users in ...
QString name() const
The name of the function.
const QString helpText() const
The help text for the function.
bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override
bool lessThan(const QModelIndex &left, const QModelIndex &right) const override
QgsExpressionItemSearchProxy()
An expression item that can be used in the QgsExpressionBuilderWidget tree.
QString getExpressionText() const
static const int SEARCH_TAGS_ROLE
Search tags role.
static const int ITEM_TYPE_ROLE
Item type role.
static const int CUSTOM_SORT_ROLE
Custom sort order role.
QgsExpressionItem::ItemType getItemType() const
Gets the type of expression item, e.g., header, field, ExpressionNode.
static const int ITEM_NAME_ROLE
Item name role.
QgsProject * project()
Returns the project currently associated with the widget.
void refresh()
Refreshes the content of the tree.
void setProject(QgsProject *project)
Sets the project currently associated with the widget.
void saveToUserExpressions(const QString &label, const QString expression, const QString &helpText)
Stores the user expression with given label and helpText.
QgsExpressionItem * currentItem() const
Returns the current item or a nullptr.
void setLayer(QgsVectorLayer *layer)
Sets layer in order to get the fields and values.
void setMenuProvider(MenuProvider *provider)
Sets the menu provider.
QStringList userExpressionLabels() const
Returns the user expression labels.
void expressionItemDoubleClicked(const QString &text)
Emitted when a expression item is double clicked.
void currentExpressionItemChanged(QgsExpressionItem *item)
Emitter when the current expression item changed.
QJsonDocument exportUserExpressions()
Create the expressions JSON document storing all the user expressions to be exported.
QgsExpressionTreeView(QWidget *parent=nullptr)
Constructor.
void loadExpressionsFromJson(const QJsonDocument &expressionsDocument)
Load and permanently store the expressions from the expressions JSON document.
void saveToRecent(const QString &expressionText, const QString &collection="generic")
Adds the current expression to the given collection.
void setSearchText(const QString &text)
Sets the text to filter the expression tree.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context for the tree view.
const QList< QgsExpressionItem * > findExpressions(const QString &label)
Returns the list of expression items matching a label.
void removeFromUserExpressions(const QString &label)
Removes the expression label from the user stored expressions.
void loadRecent(const QString &collection=QStringLiteral("generic"))
Loads the recent expressions from the given collection.
void loadUserExpressions()
Loads the user expressions.
Q_DECL_DEPRECATED QStandardItemModel * model()
Returns a pointer to the dialog's function item model.
void loadFieldNames(const QgsFields &fields)
This allows loading fields without specifying a layer.
static const QList< QgsExpressionFunction * > & Functions()
static int functionCount()
Returns the number of functions defined in the parser.
static QString formatPreviewString(const QVariant &value, bool htmlOutput=true, int maximumPreviewLength=60)
Formats an expression result for friendly display to the user.
static QStringList tags(const QString &name)
Returns a string list of search tags for a specified function.
static QString group(const QString &group)
Returns the translated name for a function group.
Encapsulate a field in an attribute table or data source.
QString displayNameWithAlias() const
Returns the name to use when displaying this field and adds the alias in parenthesis if it is defined...
Container of fields for a vector layer.
int count() const
Returns number of items.
QgsField at(int i) const
Gets field at particular index (must be in range 0..N-1)
QIcon iconForField(int fieldIdx, bool considerOrigin=false) const
Returns an icon corresponding to a field index, based on the field's type and source.
Base class for all map layer types.
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
This class is a composition of two QSettings instances:
QStringList childGroups() const
Returns a list of all key top-level groups that contain keys that can be read using the QSettings obj...
void endGroup()
Resets the group to what it was before the corresponding beginGroup() call.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void beginGroup(const QString &prefix, QgsSettings::Section section=QgsSettings::NoSection)
Appends prefix to the current group.
void remove(const QString &key, QgsSettings::Section section=QgsSettings::NoSection)
Removes the setting key and any sub-settings of key in a section.
void setValue(const QString &key, const QVariant &value, QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.
Represents a vector layer which manages a vector based data sets.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
QString formatLayerHelp(const QgsMapLayer *layer)
Returns a HTML formatted string for use as a layer item help.
QString formatUserExpressionHelp(const QString &label, const QString &expression, const QString &description)
Returns a HTML formatted string for use as a user expression item help.
QString formatVariableHelp(const QString &variable, const QString &description, bool showValue, const QVariant &value)
Returns a HTML formatted string for use as a variable item help.
QString formatRecentExpressionHelp(const QString &label, const QString &expression)
Returns a HTML formatted string for use as a recent expression item help.
QString formatRelationHelp(const QgsRelation &relation)
Returns a HTML formatted string for use as a relation item help.