Class: QgsNumericFormatWidget¶
Base class for widgets which allow control over the properties of
QgsNumericFormat
subclasses.
Added in version 3.12.
Note
This is an abstract class, with methods which must be implemented by a subclass.
The following methods must be implemented: format()
, setFormat()
Class Hierarchy¶
Base classes¶
Base class for any widget that can be shown as an inline panel. |
|
Abstract interface for generating an expression context. |
Subclasses¶
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
Abstract Methods
Returns the format defined by the current settings in the widget. |
|
Sets the format to show in the widget. |
Methods
Register an expression context generator class that will be used to retrieve an expression context for the widget when required. |
Signals
Emitted whenever the configuration of the numeric format is changed. |
- class qgis.gui.QgsNumericFormatWidget[source]¶
Bases:
QgsPanelWidget
,QgsExpressionContextGenerator
- __init__(parent: QWidget | None = None)
Constructor for QgsNumericFormatWidget.
- Parameters:
parent (Optional[QWidget] = None)
- abstract format(self) QgsNumericFormat | None [source]¶
Returns the format defined by the current settings in the widget.
Ownership of the returned object is transferred to the caller
See also
- Return type:
Optional[QgsNumericFormat]
- registerExpressionContextGenerator(self, generator: QgsExpressionContextGenerator | None)[source]¶
Register an expression context generator class that will be used to retrieve an expression context for the widget when required.
Added in version 3.40.
- Parameters:
generator (Optional[QgsExpressionContextGenerator])
- abstract setFormat(self, format: QgsNumericFormat | None)[source]¶
Sets the
format
to show in the widget. Ownership is not transferred.See also
- Parameters:
format (Optional[QgsNumericFormat])