Implement QgsEditorWidgetWrapper::showIndeterminateState() for setting

editor widgets into an indeterminant "unknown value" state Works for all editor widgets except date time, range and uuid widgets.
qgis · Apr 5, 2016 · 22f1a1d · 22f1a1d
1 parent 16274d5
commit 22f1a1d
Show file tree

Hide file tree

Showing 30 changed files with 226 additions and 21 deletions.
diff --git a/python/gui/editorwidgets/core/qgseditorwidgetwrapper.sip b/python/gui/editorwidgets/core/qgseditorwidgetwrapper.sip
@@ -83,6 +83,11 @@ class QgsEditorWidgetWrapper : QgsWidgetWrapper
      */
     void setEnabled( bool enabled );
 
+    /** Sets the widget to display in an indeterminate "mixed value" state.
+     * @note added in QGIS 2.16
+     */
+    virtual void showIndeterminateState();
+
   signals:
     /**
      * Emit this signal, whenever the value changed.

diff --git a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
@@ -105,6 +105,11 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
      */
     void setEnabled( bool enabled ) override;
 
+    /** Sets the widget to display in an indeterminate "mixed value" state.
+     * @note added in QGIS 2.16
+     */
+    virtual void showIndeterminateState() {}
+
   signals:
     /**
      * Emit this signal, whenever the value changed.

diff --git a/src/gui/editorwidgets/qgscheckboxwidgetwrapper.cpp b/src/gui/editorwidgets/qgscheckboxwidgetwrapper.cpp
@@ -37,6 +37,14 @@ QVariant QgsCheckboxWidgetWrapper::value() const
   return v;
 }
 
+void QgsCheckboxWidgetWrapper::showIndeterminateState()
+{
+  if ( mCheckBox )
+  {
+    whileBlocking( mCheckBox )->setCheckState( Qt::PartiallyChecked );
+  }
+}
+
 QWidget* QgsCheckboxWidgetWrapper::createWidget( QWidget* parent )
 {
   return new QCheckBox( parent );
@@ -60,13 +68,14 @@ bool QgsCheckboxWidgetWrapper::valid() const
 
 void QgsCheckboxWidgetWrapper::setValue( const QVariant& value )
 {
+  bool state = ( value == config( "CheckedState" ) );
   if ( mGroupBox )
   {
-    mGroupBox->setChecked( value == config( "CheckedState" ) );
+    mGroupBox->setChecked( state );
   }
 
   if ( mCheckBox )
   {
-    mCheckBox->setChecked( value == config( "CheckedState" ) );
+    mCheckBox->setChecked( state );
   }
 }
diff --git a/src/gui/editorwidgets/qgscheckboxwidgetwrapper.h b/src/gui/editorwidgets/qgscheckboxwidgetwrapper.h
@@ -43,6 +43,8 @@ class GUI_EXPORT QgsCheckboxWidgetWrapper : public QgsEditorWidgetWrapper
   public:
     QVariant value() const override;
 
+    void showIndeterminateState() override;
+
   protected:
     QWidget* createWidget( QWidget* parent ) override;
     void initWidget( QWidget* editor ) override;

diff --git a/src/gui/editorwidgets/qgsclassificationwidgetwrapper.cpp b/src/gui/editorwidgets/qgsclassificationwidgetwrapper.cpp
@@ -29,6 +29,11 @@ QVariant QgsClassificationWidgetWrapper::value() const
   return mComboBox->itemData( mComboBox->currentIndex() );
 }
 
+void QgsClassificationWidgetWrapper::showIndeterminateState()
+{
+  whileBlocking( mComboBox )->setCurrentIndex( -1 );
+}
+
 QWidget*QgsClassificationWidgetWrapper::createWidget( QWidget* parent )
 {
   return new QComboBox( parent );

diff --git a/src/gui/editorwidgets/qgsclassificationwidgetwrapper.h b/src/gui/editorwidgets/qgsclassificationwidgetwrapper.h
@@ -33,6 +33,7 @@ class GUI_EXPORT QgsClassificationWidgetWrapper : public QgsEditorWidgetWrapper
     // QgsEditorWidgetWrapper interface
   public:
     QVariant value() const override;
+    void showIndeterminateState() override;
 
   protected:
     QWidget*createWidget( QWidget* parent ) override;

diff --git a/src/gui/editorwidgets/qgscolorwidgetwrapper.cpp b/src/gui/editorwidgets/qgscolorwidgetwrapper.cpp
@@ -32,6 +32,14 @@ QVariant QgsColorWidgetWrapper::value() const
   return v;
 }
 
+void QgsColorWidgetWrapper::showIndeterminateState()
+{
+  if ( mColorButton )
+  {
+    whileBlocking( mColorButton )->setColor( QColor() );
+  }
+}
+
 QWidget* QgsColorWidgetWrapper::createWidget( QWidget* parent )
 {
   QgsColorButtonV2* button = new QgsColorButtonV2( parent );

diff --git a/src/gui/editorwidgets/qgscolorwidgetwrapper.h b/src/gui/editorwidgets/qgscolorwidgetwrapper.h
@@ -35,6 +35,7 @@ class GUI_EXPORT  QgsColorWidgetWrapper : public QgsEditorWidgetWrapper
     // QgsEditorWidgetWrapper interface
   public:
     QVariant value() const override;
+    void showIndeterminateState() override;
 
   protected:
     QWidget* createWidget( QWidget* parent ) override;

diff --git a/src/gui/editorwidgets/qgsenumerationwidgetwrapper.cpp b/src/gui/editorwidgets/qgsenumerationwidgetwrapper.cpp
@@ -35,6 +35,14 @@ QVariant QgsEnumerationWidgetWrapper::value() const
   return value;
 }
 
+void QgsEnumerationWidgetWrapper::showIndeterminateState()
+{
+  if ( mComboBox )
+  {
+    whileBlocking( mComboBox )->setCurrentIndex( -1 );
+  }
+}
+
 QWidget* QgsEnumerationWidgetWrapper::createWidget( QWidget* parent )
 {
   return new QComboBox( parent );

diff --git a/src/gui/editorwidgets/qgsenumerationwidgetwrapper.h b/src/gui/editorwidgets/qgsenumerationwidgetwrapper.h
@@ -33,6 +33,7 @@ class GUI_EXPORT QgsEnumerationWidgetWrapper : public QgsEditorWidgetWrapper
     // QgsEditorWidgetWrapper interface
   public:
     QVariant value() const override;
+    void showIndeterminateState() override;
 
   protected:
     QWidget* createWidget( QWidget* parent ) override;

diff --git a/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.cpp b/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.cpp
@@ -54,6 +54,24 @@ QVariant QgsExternalResourceWidgetWrapper::value() const
   return QVariant( field().type() );
 }
 
+void QgsExternalResourceWidgetWrapper::showIndeterminateState()
+{
+  if ( mLineEdit )
+  {
+    whileBlocking( mLineEdit )->clear();
+  }
+
+  if ( mLabel )
+  {
+    mLabel->clear();
+  }
+
+  if ( mQgsWidget )
+  {
+    whileBlocking( mQgsWidget )->setDocumentPath( QString() );
+  }
+}
+
 bool QgsExternalResourceWidgetWrapper::valid() const
 {
   return mLineEdit || mLabel || mQgsWidget;

diff --git a/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h b/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h
@@ -42,6 +42,7 @@ class GUI_EXPORT QgsExternalResourceWidgetWrapper : public QgsEditorWidgetWrappe
     // QgsEditorWidgetWrapper interface
   public:
     QVariant value() const override;
+    void showIndeterminateState() override;
 
   protected:
     QWidget* createWidget( QWidget* parent ) override;

diff --git a/src/gui/editorwidgets/qgsfilenamewidgetwrapper.cpp b/src/gui/editorwidgets/qgsfilenamewidgetwrapper.cpp
@@ -53,6 +53,17 @@ bool QgsFileNameWidgetWrapper::valid() const
   return mLineEdit || mLabel;
 }
 
+void QgsFileNameWidgetWrapper::showIndeterminateState()
+{
+  if ( mLineEdit )
+  {
+    whileBlocking( mLineEdit )->clear();
+  }
+
+  if ( mLabel )
+    mLabel->clear();
+}
+
 QWidget* QgsFileNameWidgetWrapper::createWidget( QWidget* parent )
 {
   QWidget* container = new QWidget( parent );

diff --git a/src/gui/editorwidgets/qgsfilenamewidgetwrapper.h b/src/gui/editorwidgets/qgsfilenamewidgetwrapper.h
@@ -41,6 +41,7 @@ class GUI_EXPORT QgsFileNameWidgetWrapper : public QgsEditorWidgetWrapper
   public:
     QVariant value() const override;
     bool valid() const override;
+    void showIndeterminateState() override;
 
   protected:
     QWidget* createWidget( QWidget* parent ) override;

diff --git a/src/gui/editorwidgets/qgsphotowidgetwrapper.cpp b/src/gui/editorwidgets/qgsphotowidgetwrapper.cpp
@@ -115,6 +115,18 @@ QVariant QgsPhotoWidgetWrapper::value() const
   return v;
 }
 
+void QgsPhotoWidgetWrapper::showIndeterminateState()
+{
+  if ( mLineEdit )
+  {
+    whileBlocking( mLineEdit )->clear();
+  }
+  if ( mPhotoLabel )
+    mPhotoLabel->clear();
+  if ( mPhotoPixmapLabel )
+    mPhotoPixmapLabel->clear();
+}
+
 QWidget* QgsPhotoWidgetWrapper::createWidget( QWidget* parent )
 {
   QWidget* container = new QWidget( parent );

diff --git a/src/gui/editorwidgets/qgsphotowidgetwrapper.h b/src/gui/editorwidgets/qgsphotowidgetwrapper.h
@@ -49,6 +49,7 @@ class GUI_EXPORT QgsPhotoWidgetWrapper : public QgsEditorWidgetWrapper
     // QgsEditorWidgetWrapper interface
   public:
     QVariant value() const override;
+    void showIndeterminateState() override;
 
   protected:
     QWidget* createWidget( QWidget* parent ) override;

diff --git a/src/gui/editorwidgets/qgsrelationreferencewidget.cpp b/src/gui/editorwidgets/qgsrelationreferencewidget.cpp
@@ -346,6 +346,20 @@ QgsFeature QgsRelationReferenceWidget::referencedFeature()
   return f;
 }
 
+void QgsRelationReferenceWidget::showIndeterminateState()
+{
+  if ( mReadOnlySelector )
+  {
+    whileBlocking( mLineEdit )->setText( QString() );
+  }
+  else
+  {
+    whileBlocking( mComboBox )->setCurrentIndex( -1 );
+  }
+  mRemoveFKButton->setEnabled( false );
+  updateAttributeEditorFrame( QgsFeature() );
+}
+
 QVariant QgsRelationReferenceWidget::foreignKey()
 {
   if ( mReadOnlySelector )

diff --git a/src/gui/editorwidgets/qgsrelationreferencewidget.h b/src/gui/editorwidgets/qgsrelationreferencewidget.h
@@ -108,6 +108,11 @@ class GUI_EXPORT QgsRelationReferenceWidget : public QWidget
     //! if no feature is related, it returns an invalid feature
     QgsFeature referencedFeature();
 
+    /** Sets the widget to display in an indeterminate "mixed value" state.
+     * @note added in QGIS 2.16
+     */
+    void showIndeterminateState();
+
   public slots:
     //! open the form of the related feature in a new dialog
     void openForm();

diff --git a/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.cpp b/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.cpp
@@ -24,6 +24,7 @@ QgsRelationReferenceWidgetWrapper::QgsRelationReferenceWidgetWrapper( QgsVectorL
     , mWidget( nullptr )
     , mCanvas( canvas )
     , mMessageBar( messageBar )
+    , mIndeterminateState( false )
 {
 }
 
@@ -103,11 +104,21 @@ bool QgsRelationReferenceWidgetWrapper::valid() const
   return mWidget;
 }
 
+void QgsRelationReferenceWidgetWrapper::showIndeterminateState()
+{
+  if ( mWidget )
+  {
+    mWidget->showIndeterminateState();
+  }
+  mIndeterminateState = true;
+}
+
 void QgsRelationReferenceWidgetWrapper::setValue( const QVariant& val )
 {
-  if ( !mWidget || val == value() )
+  if ( !mWidget || ( !mIndeterminateState && val == value() ) )
     return;
 
+  mIndeterminateState = false;
   mWidget->setForeignKey( val );
 }
 

diff --git a/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.h b/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.h
@@ -50,6 +50,7 @@ class GUI_EXPORT QgsRelationReferenceWidgetWrapper : public QgsEditorWidgetWrapp
     virtual void initWidget( QWidget* editor ) override;
     virtual QVariant value() const override;
     bool valid() const override;
+    void showIndeterminateState() override;
 
   public slots:
     virtual void setValue( const QVariant& value ) override;
@@ -62,6 +63,7 @@ class GUI_EXPORT QgsRelationReferenceWidgetWrapper : public QgsEditorWidgetWrapp
     QgsRelationReferenceWidget* mWidget;
     QgsMapCanvas* mCanvas;
     QgsMessageBar* mMessageBar;
+    bool mIndeterminateState;
 };
 
 #endif // QGSRELATIONREFERENCEWIDGETWRAPPER_H
diff --git a/src/gui/editorwidgets/qgstexteditwrapper.cpp b/src/gui/editorwidgets/qgstexteditwrapper.cpp
@@ -135,7 +135,50 @@ bool QgsTextEditWrapper::valid() const
   return mLineEdit || mTextEdit || mPlainTextEdit;
 }
 
+void QgsTextEditWrapper::showIndeterminateState()
+{
+  //note - this is deliberately a zero length string, not a null string!
+  if ( mTextEdit )
+    mTextEdit->blockSignals( true );
+  if ( mPlainTextEdit )
+    mPlainTextEdit->blockSignals( true );
+  if ( mLineEdit )
+    mLineEdit->blockSignals( true );
+
+  setWidgetValue( QString( "" ) );
+
+  if ( mTextEdit )
+    mTextEdit->blockSignals( false );
+  if ( mPlainTextEdit )
+    mPlainTextEdit->blockSignals( false );
+  if ( mLineEdit )
+    mLineEdit->blockSignals( false );
+}
+
 void QgsTextEditWrapper::setValue( const QVariant& val )
+{
+  setWidgetValue( val );
+}
+
+void QgsTextEditWrapper::setEnabled( bool enabled )
+{
+  if ( mTextEdit )
+    mTextEdit->setReadOnly( !enabled );
+
+  if ( mPlainTextEdit )
+    mPlainTextEdit->setReadOnly( !enabled );
+
+  if ( mLineEdit )
+  {
+    mLineEdit->setReadOnly( !enabled );
+    if ( enabled )
+      mLineEdit->setPalette( mWritablePalette );
+    else
+      mLineEdit->setPalette( mReadOnlyPalette );
+  }
+}
+
+void QgsTextEditWrapper::setWidgetValue( const QVariant& val )
 {
   QString v;
   if ( val.isNull() )
@@ -166,21 +209,3 @@ void QgsTextEditWrapper::setValue( const QVariant& val )
   if ( mLineEdit )
     mLineEdit->setText( v );
 }
-
-void QgsTextEditWrapper::setEnabled( bool enabled )
-{
-  if ( mTextEdit )
-    mTextEdit->setReadOnly( !enabled );
-
-  if ( mPlainTextEdit )
-    mPlainTextEdit->setReadOnly( !enabled );
-
-  if ( mLineEdit )
-  {
-    mLineEdit->setReadOnly( !enabled );
-    if ( enabled )
-      mLineEdit->setPalette( mWritablePalette );
-    else
-      mLineEdit->setPalette( mReadOnlyPalette );
-  }
-}
diff --git a/src/gui/editorwidgets/qgstexteditwrapper.h b/src/gui/editorwidgets/qgstexteditwrapper.h
@@ -42,6 +42,7 @@ class GUI_EXPORT QgsTextEditWrapper : public QgsEditorWidgetWrapper
     // QgsEditorWidgetWrapper interface
   public:
     QVariant value() const override;
+    void showIndeterminateState() override;
 
   protected:
     QWidget*createWidget( QWidget* parent ) override;
@@ -58,6 +59,8 @@ class GUI_EXPORT QgsTextEditWrapper : public QgsEditorWidgetWrapper
     QLineEdit* mLineEdit;
     QPalette mReadOnlyPalette;
     QPalette mWritablePalette;
+
+    void setWidgetValue( const QVariant& value );
 };
 
 #endif // QGSTEXTEDITWRAPPER_H