Subgroup: Expression

Class: QgsExpressionItem¶

class qgis.gui.QgsExpressionItem¶

Bases: PyQt5.QtGui.QStandardItem

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

Methods

accessibleDescription

accessibleText

appendColumn

appendRow appendRow(self, QStandardItem)

appendRows

background

checkState

child

clone

column

columnCount

data

emitDataChanged

flags

font

foreground

getExpressionText

getHelpText Get the help text that is associated with this expression item.

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

hasChildren

icon

index

insertColumn

insertColumns

insertRow insertRow(self, int, QStandardItem)

insertRows insertRows(self, int, Iterable[QStandardItem])

isAutoTristate

isCheckable

isDragEnabled

isDropEnabled

isEditable

isEnabled

isSelectable

isTristate

isUserTristate

model

parent

read

removeColumn

removeColumns

removeRow

removeRows

row

rowCount

setAccessibleDescription

setAccessibleText

setAutoTristate

setBackground

setCheckState

setCheckable

setChild setChild(self, int, QStandardItem)

setColumnCount

setData

setDragEnabled

setDropEnabled

setEditable

setEnabled

setFlags

setFont

setForeground

setHelpText Set the help text for the current item

setIcon

setRowCount

setSelectable

setSizeHint

setStatusTip

setText

setTextAlignment

setToolTip

setTristate

setUserTristate

setWhatsThis

sizeHint

sortChildren

statusTip

takeChild

takeColumn

takeRow

text

textAlignment

toolTip

type

whatsThis

write

Attributes

CUSTOM_SORT_ROLE

ExpressionNode

Field

Header

ITEM_TYPE_ROLE

Type

UserType

CUSTOM_SORT_ROLE = 257¶

ExpressionNode = 2¶

Field = 1¶

Header = 0¶

ITEM_TYPE_ROLE = 258¶

class ItemType¶: Bases: int

emitDataChanged()¶

getExpressionText(self) → str¶

getHelpText(self) → str¶

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

Returns:	The help text.

getItemType(self) → QgsExpressionItem.ItemType¶

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

Returns:	The QgsExpressionItem.ItemType

setHelpText(self, helpText: str)¶: Set the help text for the current item

Note

The help text can be set as a html string.