Fix docstrings and respond to feedback

stev-0 · stev-0 · commit 08b7ecab37b2 · 2019-11-23T21:54:59.000Z
diff --git a/python/gui/auto_generated/qgsattributeform.sip.in b/python/gui/auto_generated/qgsattributeform.sip.in
@@ -44,7 +44,16 @@ class QgsAttributeForm : QWidget
 
     const QgsFeature &feature();
 
-    void displayWarning( QString message );
+    void displayWarning( const QString& message );
+%Docstring
+Displays a warning message in the form message bar 
+
+:param message: message string
+
+.. seealso:: :py:func:`mode`
+
+.. versionadded:: 3.12
+%End
 
 
     void hideButtonBox();
diff --git a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
@@ -360,7 +360,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
      */
     bool setFormFeatureAttribute( const QString &attributeName, const QVariant &attributeValue );
 
-  protected:
+  private:
 
     /**
     * Is called, when the value of the widget needs to be changed. Update the widget representation
diff --git a/src/gui/editorwidgets/qgstexteditwrapper.cpp b/src/gui/editorwidgets/qgstexteditwrapper.cpp
@@ -203,12 +203,12 @@ void QgsTextEditWrapper::setFeature( const QgsFeature &feature )
 {
   // Do nothing if the value has not changed
   if ( mInvalidJSON )
-    mForm->displayWarning( tr( "Your JSON is invalid and will be reverted back to what was in the datastore before editing" ) );
+    mForm->displayWarning( tr( "Your JSON is invalid and will be reverted back to the last valid edit or the original data" ) );
   {
     mInvalidJSON = false;
   }
   setFormFeature( feature );
-  setValue( feature.attribute( mFieldIdx ) );
+  setValue( feature.attribute( fieldIdx() ) );
 }
 
 void QgsTextEditWrapper::updateValues( const QVariant &val, const QVariantList & )
diff --git a/src/gui/editorwidgets/qgstexteditwrapper.h b/src/gui/editorwidgets/qgstexteditwrapper.h
@@ -74,7 +74,7 @@ class GUI_EXPORT QgsTextEditWrapper : public QgsEditorWidgetWrapper
 
   public slots:
     void setEnabled( bool enabled ) override;
-    void setFeature( const QgsFeature &feature );
+    void setFeature( const QgsFeature &feature ) override;
 
   private slots:
     void textChanged( const QString &text );
diff --git a/src/gui/qgsattributeform.cpp b/src/gui/qgsattributeform.cpp
@@ -591,7 +591,7 @@ void QgsAttributeForm::pushSelectedFeaturesMessage()
   }
 }
 
-void QgsAttributeForm::displayWarning( QString message )
+void QgsAttributeForm::displayWarning( const QString& message )
 {
   mMessageBar->pushMessage( QString(),
                             message,
diff --git a/src/gui/qgsattributeform.h b/src/gui/qgsattributeform.h
@@ -75,7 +75,14 @@ class GUI_EXPORT QgsAttributeForm : public QWidget
 
     const QgsFeature &feature() { return mFeature; }
 
-    void displayWarning( QString message );
+    /**
+     * Displays a warning message in the form message bar 
+     * \param message message string
+     * \see mode()
+     * \since QGIS 3.12
+     * 
+     */
+    void displayWarning( const QString& message );
 
     // TODO QGIS 4.0 - make private
 

Original file line number	Diff line number	Diff line change
`@@ -203,12 +203,12 @@ void QgsTextEditWrapper::setFeature( const QgsFeature &feature )`
`203`	`203`	`{`
`204`	`204`	`// Do nothing if the value has not changed`
`205`	`205`	`if ( mInvalidJSON )`
`206`		`- mForm->displayWarning( tr( "Your JSON is invalid and will be reverted back to what was in the datastore before editing" ) );`
	`206`	`+ mForm->displayWarning( tr( "Your JSON is invalid and will be reverted back to the last valid edit or the original data" ) );`
`207`	`207`	`{`
`208`	`208`	`mInvalidJSON = false;`
`209`	`209`	`}`
`210`	`210`	`setFormFeature( feature );`
`211`		`- setValue( feature.attribute( mFieldIdx ) );`
	`211`	`+ setValue( feature.attribute( fieldIdx() ) );`
`212`	`212`	`}`
`213`	`213`
`214`	`214`	`void QgsTextEditWrapper::updateValues( const QVariant &val, const QVariantList & )`
Original file line number	Diff line number	Diff line change
`@@ -591,7 +591,7 @@ void QgsAttributeForm::pushSelectedFeaturesMessage()`
`591`	`591`	`}`
`592`	`592`	`}`
`593`	`593`
`594`		`-void QgsAttributeForm::displayWarning( QString message )`
	`594`	`+void QgsAttributeForm::displayWarning( const QString& message )`
`595`	`595`	`{`
`596`	`596`	`mMessageBar->pushMessage( QString(),`
`597`	`597`	`message,`