Class: QgsExpressionItem

An expression item that can be used in the QgsExpressionBuilderWidget tree.

Class Hierarchy

Base classes

QStandardItem

class qgis.gui.QgsExpressionItem

Bases: QStandardItem

CUSTOM_SORT_ROLE: int = 257

ExpressionNode = 2

Field = 1

Header = 0

ITEM_NAME_ROLE: int = 260

ITEM_TYPE_ROLE: int = 258

LAYER_ID_ROLE: int = 261

SEARCH_TAGS_ROLE: int = 259

getExpressionText(self) → str

Return type:

str

getHelpText(self) → str

Gets the help text that is associated with this expression item.

Return type:

str

Returns:

The help text.

getItemType(self) → QgsExpressionItem.ItemType

Gets the type of expression item, e.g., header, field, ExpressionNode.

Return type:

QgsExpressionItem.ItemType

Returns:

The QgsExpressionItem.ItemType

setHelpText(self, helpText: str | None)

Set the help text for the current item

Note

The help text can be set as a html string.

Parameters:

helpText (Optional[str])