Class: QgsOptionalQgsExpressionBase¶
- class qgis.core.QgsOptionalQgsExpressionBase¶
Bases:
sip.wrapper
QgsOptional
is a container for other classes and adds an additional enabled/disabled flag.Often it is used for configuration options which can be enabled or disabled but also have more internal configuration information that should not be lost when disabling and re-enabling.
Note
For Python you need to use implementations for specific template classes
Note
Not available in Python bindings (although SIP file is present for specific implementations).
QgsOptionalQgsExpressionBase() A
QgsOptional
is disabled by default if default constructed.QgsOptionalQgsExpressionBase(data:
QgsExpression
) AQgsOptional
is enabled by default if constructed with payload.QgsOptionalQgsExpressionBase(data:
QgsExpression
, enabled: bool) AQgsOptional
constructed with enabled status and dataQgsOptionalQgsExpressionBase(
QgsOptionalQgsExpressionBase
)Methods
Access the payload data
Check if this optional is enabled
Set the payload data
Set if this optional is enabled
- data(self) QgsExpression ¶
Access the payload data
- Return type:
- enabled(self) bool ¶
Check if this optional is enabled
- Return type:
bool
- setData(self, data: QgsExpression)¶
Set the payload data
- Parameters:
data (QgsExpression) –
- setEnabled(self, enabled: bool)¶
Set if this optional is enabled
- Parameters:
enabled (bool) –