[feature] Add 'Custom Expression' numeric format

python/PyQt6/core/auto_additions/qgsexpressionbasednumericformat.py

@@ -0,0 +1,5 @@
+# The following has been generated automatically from src/core/numericformats/qgsexpressionbasednumericformat.h
+try:
+    QgsExpressionBasedNumericFormat.__group__ = ['numericformats']
+except NameError:
+    pass

python/PyQt6/core/auto_generated/numericformats/qgsexpressionbasednumericformat.sip.in

@@ -0,0 +1,64 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/numericformats/qgsexpressionbasednumericformat.h            *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.py again   *
+ ************************************************************************/
+
+
+class QgsExpressionBasedNumericFormat : QgsNumericFormat
+{
+%Docstring(signature="appended")
+A numeric formatter which uses a :py:class:`QgsExpression` to calculate the text representation of a value.
+
+.. versionadded:: 3.40
+%End
+
+%TypeHeaderCode
+#include "qgsexpressionbasednumericformat.h"
+%End
+  public:
+
+    QgsExpressionBasedNumericFormat();
+
+    virtual QString id() const;
+
+    virtual QString visibleName() const;
+
+    virtual int sortKey();
+
+    virtual QString formatDouble( double value, const QgsNumericFormatContext &context ) const;
+
+    virtual QgsNumericFormat *clone() const /Factory/;
+
+    virtual QgsNumericFormat *create( const QVariantMap &configuration, const QgsReadWriteContext &context ) const /Factory/;
+
+    virtual QVariantMap configuration( const QgsReadWriteContext &context ) const;
+
+
+    void setExpression( const QString &expression );
+%Docstring
+Sets the ``expression`` used to calculate the text representation of a value.
+
+The expression can utilize `@value` to retrieve the numeric value to represent.
+
+.. seealso:: :py:func:`expression`
+%End
+
+    QString expression() const;
+%Docstring
+Returns the expression used to calculate the text representation of a value.
+
+.. seealso:: :py:func:`setExpression`
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/numericformats/qgsexpressionbasednumericformat.h            *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.py again   *
+ ************************************************************************/

python/PyQt6/core/auto_generated/numericformats/qgsnumericformat.sip.in

@@ -33,7 +33,6 @@ Constructor for QgsNumericFormatContext.
 The context will be populated based on the user's current locale settings.
 %End
 
-
     QChar thousandsSeparator() const;
 %Docstring
 Returns the thousands separator character.
@@ -155,6 +154,24 @@ Sets the ``interpretation`` of the numbers being converted.
 .. seealso:: :py:func:`interpretation`
 
 .. versionadded:: 3.26
+%End
+
+    QgsExpressionContext expressionContext() const;
+%Docstring
+Returns the expression context to use when evaluating :py:class:`QgsExpressions`.
+
+.. seealso:: :py:func:`setExpressionContext`
+
+.. versionadded:: 3.40
+%End
+
+    void setExpressionContext( const QgsExpressionContext &context );
+%Docstring
+Sets the expression ``context`` to use when evaluating :py:class:`QgsExpressions`.
+
+.. seealso:: :py:func:`expressionContext`
+
+.. versionadded:: 3.40
 %End
 
 };
@@ -167,6 +184,7 @@ Sets the ``interpretation`` of the numbers being converted.
 #include <qgspercentagenumericformat.h>
 #include <qgsscientificnumericformat.h>
 #include <qgscoordinatenumericformat.h>
+#include <qgsexpressionbasednumericformat.h>
 %End
 
 class QgsNumericFormat
@@ -201,6 +219,8 @@ This is an abstract base class and will always need to be subclassed.
       sipType = sipType_QgsBasicNumericFormat;
     else if ( dynamic_cast< QgsFractionNumericFormat * >( sipCpp ) )
       sipType = sipType_QgsFractionNumericFormat;
+    else if ( dynamic_cast< QgsExpressionBasedNumericFormat * >( sipCpp ) )
+      sipType = sipType_QgsExpressionBasedNumericFormat;
     else
       sipType = NULL;
 %End

python/PyQt6/core/core_auto.sip

@@ -543,6 +543,7 @@
 %Include auto_generated/numericformats/qgsbearingnumericformat.sip
 %Include auto_generated/numericformats/qgscoordinatenumericformat.sip
 %Include auto_generated/numericformats/qgscurrencynumericformat.sip
+%Include auto_generated/numericformats/qgsexpressionbasednumericformat.sip
 %Include auto_generated/numericformats/qgsfallbacknumericformat.sip
 %Include auto_generated/numericformats/qgsfractionnumericformat.sip
 %Include auto_generated/numericformats/qgsnumericformat.sip

python/PyQt6/gui/auto_additions/qgsnumericformatwidget.py

@@ -43,3 +43,7 @@
     QgsFractionNumericFormatWidget.__group__ = ['numericformats']
 except NameError:
     pass
+try:
+    QgsExpressionBasedNumericFormatWidget.__group__ = ['numericformats']
+except NameError:
+    pass

python/PyQt6/gui/auto_generated/numericformats/qgsnumericformatwidget.sip.in

@@ -73,11 +73,9 @@ Constructor for QgsBasicNumericFormatWidget, initially showing the specified ``f
 %End
     ~QgsBasicNumericFormatWidget();
 
-    virtual void setFormat( QgsNumericFormat *format );
-
-
-    virtual QgsNumericFormat *format() /Factory/;
+    void setFormat( QgsNumericFormat *format ) final;
 
+    QgsNumericFormat *format() final /Factory/;
 
 };
 
@@ -102,11 +100,9 @@ Constructor for QgsBearingNumericFormatWidget, initially showing the specified `
 %End
     ~QgsBearingNumericFormatWidget();
 
-    virtual void setFormat( QgsNumericFormat *format );
-
-
-    virtual QgsNumericFormat *format() /Factory/;
+    void setFormat( QgsNumericFormat *format ) final;
 
+    QgsNumericFormat *format() final /Factory/;
 
 };
 
@@ -160,11 +156,9 @@ Constructor for QgsGeographicCoordinateNumericFormatWidget, initially showing th
 %End
     ~QgsGeographicCoordinateNumericFormatWidget();
 
-    virtual void setFormat( QgsNumericFormat *format );
-
-
-    virtual QgsNumericFormat *format() /Factory/;
+    void setFormat( QgsNumericFormat *format ) final;
 
+    QgsNumericFormat *format() final /Factory/;
 
 };
 
@@ -219,11 +213,9 @@ Constructor for QgsCurrencyNumericFormatWidget, initially showing the specified
 %End
     ~QgsCurrencyNumericFormatWidget();
 
-    virtual void setFormat( QgsNumericFormat *format );
-
-
-    virtual QgsNumericFormat *format() /Factory/;
+    void setFormat( QgsNumericFormat *format ) final;
 
+    QgsNumericFormat *format() final /Factory/;
 
 };
 
@@ -249,11 +241,9 @@ Constructor for QgsPercentageNumericFormatWidget, initially showing the specifie
 %End
     ~QgsPercentageNumericFormatWidget();
 
-    virtual void setFormat( QgsNumericFormat *format );
-
-
-    virtual QgsNumericFormat *format() /Factory/;
+    void setFormat( QgsNumericFormat *format ) final;
 
+    QgsNumericFormat *format() final /Factory/;
 
 };
 
@@ -280,11 +270,9 @@ Constructor for QgsScientificNumericFormatWidget, initially showing the specifie
 %End
     ~QgsScientificNumericFormatWidget();
 
-    virtual void setFormat( QgsNumericFormat *format );
-
-
-    virtual QgsNumericFormat *format() /Factory/;
+    void setFormat( QgsNumericFormat *format ) final;
 
+    QgsNumericFormat *format() final /Factory/;
 
 };
 
@@ -309,11 +297,38 @@ Constructor for QgsFractionNumericFormatWidget, initially showing the specified
 %End
     ~QgsFractionNumericFormatWidget();
 
-    virtual void setFormat( QgsNumericFormat *format );
+    void setFormat( QgsNumericFormat *format ) final;
+
+    QgsNumericFormat *format() final /Factory/;
+
+};
+
+
+
+class QgsExpressionBasedNumericFormatWidget : QgsNumericFormatWidget, QgsExpressionContextGenerator
+{
+%Docstring(signature="appended")
+A widget which allow control over the properties of a :py:class:`QgsExpressionBasedNumericFormat`.
+
+.. versionadded:: 3.40
+%End
+
+%TypeHeaderCode
+#include "qgsnumericformatwidget.h"
+%End
+  public:
+
+    QgsExpressionBasedNumericFormatWidget( const QgsNumericFormat *format, QWidget *parent /TransferThis/ = 0 );
+%Docstring
+Constructor for QgsExpressionBasedNumericFormatWidget, initially showing the specified ``format``.
+%End
+    ~QgsExpressionBasedNumericFormatWidget();
 
+    QgsExpressionContext createExpressionContext() const final;
 
-    virtual QgsNumericFormat *format() /Factory/;
+    void setFormat( QgsNumericFormat *format ) final;
 
+    QgsNumericFormat *format() final /Factory/;
 
 };
 /************************************************************************

python/core/auto_additions/qgsexpressionbasednumericformat.py

@@ -0,0 +1,5 @@
+# The following has been generated automatically from src/core/numericformats/qgsexpressionbasednumericformat.h
+try:
+    QgsExpressionBasedNumericFormat.__group__ = ['numericformats']
+except NameError:
+    pass

python/core/auto_generated/numericformats/qgsexpressionbasednumericformat.sip.in

@@ -0,0 +1,64 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/numericformats/qgsexpressionbasednumericformat.h            *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.py again   *
+ ************************************************************************/
+
+
+class QgsExpressionBasedNumericFormat : QgsNumericFormat
+{
+%Docstring(signature="appended")
+A numeric formatter which uses a :py:class:`QgsExpression` to calculate the text representation of a value.
+
+.. versionadded:: 3.40
+%End
+
+%TypeHeaderCode
+#include "qgsexpressionbasednumericformat.h"
+%End
+  public:
+
+    QgsExpressionBasedNumericFormat();
+
+    virtual QString id() const;
+
+    virtual QString visibleName() const;
+
+    virtual int sortKey();
+
+    virtual QString formatDouble( double value, const QgsNumericFormatContext &context ) const;
+
+    virtual QgsNumericFormat *clone() const /Factory/;
+
+    virtual QgsNumericFormat *create( const QVariantMap &configuration, const QgsReadWriteContext &context ) const /Factory/;
+
+    virtual QVariantMap configuration( const QgsReadWriteContext &context ) const;
+
+
+    void setExpression( const QString &expression );
+%Docstring
+Sets the ``expression`` used to calculate the text representation of a value.
+
+The expression can utilize `@value` to retrieve the numeric value to represent.
+
+.. seealso:: :py:func:`expression`
+%End
+
+    QString expression() const;
+%Docstring
+Returns the expression used to calculate the text representation of a value.
+
+.. seealso:: :py:func:`setExpression`
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/numericformats/qgsexpressionbasednumericformat.h            *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.py again   *
+ ************************************************************************/

python/core/auto_generated/numericformats/qgsnumericformat.sip.in

@@ -33,7 +33,6 @@ Constructor for QgsNumericFormatContext.
 The context will be populated based on the user's current locale settings.
 %End
 
-
     QChar thousandsSeparator() const;
 %Docstring
 Returns the thousands separator character.
@@ -155,6 +154,24 @@ Sets the ``interpretation`` of the numbers being converted.
 .. seealso:: :py:func:`interpretation`
 
 .. versionadded:: 3.26
+%End
+
+    QgsExpressionContext expressionContext() const;
+%Docstring
+Returns the expression context to use when evaluating :py:class:`QgsExpressions`.
+
+.. seealso:: :py:func:`setExpressionContext`
+
+.. versionadded:: 3.40
+%End
+
+    void setExpressionContext( const QgsExpressionContext &context );
+%Docstring
+Sets the expression ``context`` to use when evaluating :py:class:`QgsExpressions`.
+
+.. seealso:: :py:func:`expressionContext`
+
+.. versionadded:: 3.40
 %End
 
 };
@@ -167,6 +184,7 @@ Sets the ``interpretation`` of the numbers being converted.
 #include <qgspercentagenumericformat.h>
 #include <qgsscientificnumericformat.h>
 #include <qgscoordinatenumericformat.h>
+#include <qgsexpressionbasednumericformat.h>
 %End
 
 class QgsNumericFormat
@@ -201,6 +219,8 @@ This is an abstract base class and will always need to be subclassed.
       sipType = sipType_QgsBasicNumericFormat;
     else if ( dynamic_cast< QgsFractionNumericFormat * >( sipCpp ) )
       sipType = sipType_QgsFractionNumericFormat;
+    else if ( dynamic_cast< QgsExpressionBasedNumericFormat * >( sipCpp ) )
+      sipType = sipType_QgsExpressionBasedNumericFormat;
     else
       sipType = NULL;
 %End

python/core/core_auto.sip

@@ -543,6 +543,7 @@
 %Include auto_generated/numericformats/qgsbearingnumericformat.sip
 %Include auto_generated/numericformats/qgscoordinatenumericformat.sip
 %Include auto_generated/numericformats/qgscurrencynumericformat.sip
+%Include auto_generated/numericformats/qgsexpressionbasednumericformat.sip
 %Include auto_generated/numericformats/qgsfallbacknumericformat.sip
 %Include auto_generated/numericformats/qgsfractionnumericformat.sip
 %Include auto_generated/numericformats/qgsnumericformat.sip

python/gui/auto_additions/qgsnumericformatwidget.py

@@ -43,3 +43,7 @@
     QgsFractionNumericFormatWidget.__group__ = ['numericformats']
 except NameError:
     pass
+try:
+    QgsExpressionBasedNumericFormatWidget.__group__ = ['numericformats']
+except NameError:
+    pass