Class: QgsStoredExpressionManager¶
- class qgis.core.QgsStoredExpressionManager¶
Bases:
PyQt5.QtCore.QObject
Manages stored expressions regarding creation, modification and storing in the project
New in version 3.10.
QgsStoredExpressionManager() Constructor for QgsStoredExpressionManager
Methods
Adds an expression to the list
Appends a list of expressions to the existing list
Clears list of stored expressions
Returns an expression according to the
expression
textReads the stored expressions in in XML format
Removes an expression to the list
Returns an expression according to the
id
Returns the list of named expressions
Updates an expression by
id
.Writes the stored expressions out in XML format
- addStoredExpression(self, name: str, expression: str, tag: QgsStoredExpression.Category = QgsStoredExpression.Category.FilterExpression) str ¶
Adds an expression to the list
- Parameters:
name (str) – optional name of the expression
expression (str) – expression text
tag (QgsStoredExpression.Category = QgsStoredExpression.Category.FilterExpression) – category of the expression use case - default FilterExpression
- Return type:
str
- Returns:
generated id
- addStoredExpressions(self, storedExpressions: Iterable[QgsStoredExpression])¶
Appends a list of expressions to the existing list
- Parameters:
storedExpressions (Iterable[QgsStoredExpression]) – list of expressions and the optional name
- childEvent(self, QChildEvent)¶
- clearStoredExpressions(self)¶
Clears list of stored expressions
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- findStoredExpressionByExpression(self, expression: str, tag: QgsStoredExpression.Category = QgsStoredExpression.Category.All) QgsStoredExpression ¶
Returns an expression according to the
expression
text- Parameters:
expression (str) – id of the expression as identification
tag (QgsStoredExpression.Category = QgsStoredExpression.Category.All) – category of the expression use case - default all
- Return type:
- isSignalConnected(self, QMetaMethod) bool ¶
- readXml(self, layerNode: QDomNode) bool ¶
Reads the stored expressions in in XML format
- Parameters:
layerNode (QDomNode) –
- Return type:
bool
- receivers(self, PYQT_SIGNAL) int ¶
- removeStoredExpression(self, id: str)¶
Removes an expression to the list
- Parameters:
id (str) – id of the expression as identification
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- storedExpression(self, id: str) QgsStoredExpression ¶
Returns an expression according to the
id
- Parameters:
id (str) – id of the expression as identification
- Return type:
- storedExpressions(self, tag: QgsStoredExpression.Category = QgsStoredExpression.Category.All) List[QgsStoredExpression] ¶
Returns the list of named expressions
- Parameters:
tag (QgsStoredExpression.Category = QgsStoredExpression.Category.All) – category of the expression use case - default all
- Return type:
List[QgsStoredExpression]
- timerEvent(self, QTimerEvent)¶
- updateStoredExpression(self, id: str, name: str, expression: str, tag: QgsStoredExpression.Category)¶
Updates an expression by
id
.- Parameters:
id (str) – id of the expression as identification
name (str) – new name of the expression
expression (str) – new expression text
tag (QgsStoredExpression.Category) – new category of the expression use case
- writeXml(self, layerNode: QDomNode) bool ¶
Writes the stored expressions out in XML format
- Parameters:
layerNode (QDomNode) –
- Return type:
bool