qgsdoublespinbox: Introduce isCleared method

qgis · Nov 19, 2024 · 8e065a4 · 8e065a4
1 parent a34442d
commit 8e065a4
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 0 deletions.
diff --git a/python/PyQt6/gui/auto_generated/editorwidgets/qgsdoublespinbox.sip.in b/python/PyQt6/gui/auto_generated/editorwidgets/qgsdoublespinbox.sip.in
@@ -113,6 +113,15 @@ Defines if the clear value should be the minimum or maximum values of the widget
 Returns the value used when :py:func:`~QgsDoubleSpinBox.clear` is called.
 
 .. seealso:: :py:func:`setClearValue`
+%End
+
+    bool isCleared() const;
+%Docstring
+Returns ``True`` if the value is equal to the clear value.
+
+.. seealso:: :py:func:`clearValue`
+
+.. versionadded:: 3.42
 %End
 
     void setLineEditAlignment( Qt::Alignment alignment );

diff --git a/python/gui/auto_generated/editorwidgets/qgsdoublespinbox.sip.in b/python/gui/auto_generated/editorwidgets/qgsdoublespinbox.sip.in
@@ -113,6 +113,15 @@ Defines if the clear value should be the minimum or maximum values of the widget
 Returns the value used when :py:func:`~QgsDoubleSpinBox.clear` is called.
 
 .. seealso:: :py:func:`setClearValue`
+%End
+
+    bool isCleared() const;
+%Docstring
+Returns ``True`` if the value is equal to the clear value.
+
+.. seealso:: :py:func:`clearValue`
+
+.. versionadded:: 3.42
 %End
 
     void setLineEditAlignment( Qt::Alignment alignment );

diff --git a/src/gui/editorwidgets/qgsdoublespinbox.cpp b/src/gui/editorwidgets/qgsdoublespinbox.cpp
@@ -282,3 +282,8 @@ bool QgsDoubleSpinBox::shouldShowClearForValue( const double value ) const
   }
   return value != clearValue();
 }
+
+bool QgsDoubleSpinBox::isCleared() const
+{
+  return value() == clearValue();
+}
diff --git a/src/gui/editorwidgets/qgsdoublespinbox.h b/src/gui/editorwidgets/qgsdoublespinbox.h
@@ -124,6 +124,14 @@ class GUI_EXPORT QgsDoubleSpinBox : public QDoubleSpinBox
      */
     double clearValue() const;
 
+    /**
+     * Returns TRUE if the value is equal to the clear value.
+     * \see clearValue()
+     *
+     * \since QGIS 3.42
+     */
+    bool isCleared() const;
+
     /**
      * Set alignment in the embedded line edit widget
      * \param alignment

diff --git a/tests/src/gui/testqgsdoublespinbox.cpp b/tests/src/gui/testqgsdoublespinbox.cpp
@@ -59,15 +59,21 @@ void TestQgsDoubleSpinBox::clear()
   spinBox->setMinimum( 1.0 );
   spinBox->setValue( 5.0 );
   spinBox->setClearValueMode( QgsDoubleSpinBox::MinimumValue );
+  QVERIFY( !spinBox->isCleared() );
   spinBox->clear();
+  QVERIFY( spinBox->isCleared() );
   QCOMPARE( spinBox->value(), 1.0 );
   QCOMPARE( spinBox->clearValue(), 1.0 );
   spinBox->setClearValueMode( QgsDoubleSpinBox::MaximumValue );
+  QVERIFY( !spinBox->isCleared() );
   spinBox->clear();
+  QVERIFY( spinBox->isCleared() );
   QCOMPARE( spinBox->value(), 10.0 );
   QCOMPARE( spinBox->clearValue(), 10.0 );
   spinBox->setClearValue( 7.0 );
+  QVERIFY( !spinBox->isCleared() );
   spinBox->clear();
+  QVERIFY( spinBox->isCleared() );
   QCOMPARE( spinBox->value(), 7.0 );
   QCOMPARE( spinBox->clearValue(), 7.0 );
   delete spinBox;