Merge pull request #3398 from nyalldawson/grad

FEATURE: Open color dialog inside layer style panel

Author: nyalldawson

python/gui/qgscompoundcolorwidget.sip

@@ -6,7 +6,7 @@
  * \note Added in version 2.16
  */
 
-class QgsCompoundColorWidget : QWidget
+class QgsCompoundColorWidget : QgsPanelWidget
 {
 %TypeHeaderCode
 #include <qgscompoundcolorwidget.h>

python/gui/qgspanelwidget.sip

@@ -60,20 +60,28 @@ class QgsPanelWidget : public QWidget
 
     /**
      * The the auto delete property on the widget. True by default.
-     * When auto delete is enabeld when a panel is removed from the stack
+     * When auto delete is enabled when a panel is removed from the stack
      * it will be deleted.
      * @param autoDelete Enable or disable auto delete on the panel.
      */
     void setAutoDelete( bool autoDelete );
 
     /**
      * The the auto delete property on the widget. True by default.
-     * When auto delete is enabeld when a panel is removed from the stack
+     * When auto delete is enabled when a panel is removed from the stack
      * it will be deleted.
      * @returns The auto delete value for the widget.
      */
     bool autoDelete();
 
+    /** Traces through the parents of a widget to find if it is contained within a QgsPanelWidget
+     * widget.
+     * @param widget widget which may be contained within a panel widget
+     * @returns parent panel widget if found, otherwise nullptr
+     * @note added in QGIS 3.0
+     */
+    static QgsPanelWidget* findParentPanel( QWidget* widget );
+
   signals:
 
     /**

src/gui/qgscolorbutton.cpp

@@ -94,6 +94,17 @@ const QPixmap& QgsColorButton::transparentBackground()
 
 void QgsColorButton::showColorDialog()
 {
+  if ( QgsPanelWidget* panel = QgsPanelWidget::findParentPanel( this ) )
+  {
+    QgsCompoundColorWidget* colorWidget = new QgsCompoundColorWidget( panel, color() );
+    colorWidget->setPanelTitle( mColorDialogTitle );
+    colorWidget->setAllowAlpha( mAllowAlpha );
+    connect( colorWidget, SIGNAL( currentColorChanged( QColor ) ), this, SLOT( setValidTemporaryColor( QColor ) ) );
+    connect( colorWidget, SIGNAL( panelAccepted( QgsPanelWidget* ) ), this, SLOT( panelAccepted( QgsPanelWidget* ) ) );
+    panel->openPanel( colorWidget );
+    return;
+  }
+
   QColor newColor;
   QSettings settings;
 
@@ -358,6 +369,22 @@ void QgsColorButton::setValidColor( const QColor& newColor )
   }
 }
 
+void QgsColorButton::setValidTemporaryColor( const QColor& newColor )
+{
+  if ( newColor.isValid() )
+  {
+    setColor( newColor );
+  }
+}
+
+void QgsColorButton::panelAccepted( QgsPanelWidget* widget )
+{
+  if ( QgsCompoundColorWidget* colorWidget = qobject_cast< QgsCompoundColorWidget* >( widget ) )
+  {
+    addRecentColor( colorWidget->color() );
+  }
+}
+
 QPixmap QgsColorButton::createMenuIcon( const QColor &color, const bool showChecks )
 {
   //create an icon pixmap

src/gui/qgscolorbutton.h

@@ -21,6 +21,7 @@
 
 class QMimeData;
 class QgsColorSchemeRegistry;
+class QgsPanelWidget;
 
 /** \ingroup gui
  * \class QgsColorButton
@@ -419,6 +420,14 @@ class GUI_EXPORT QgsColorButton : public QToolButton
      */
     void setValidColor( const QColor& newColor );
 
+    /** Sets color for button, if valid. The color is treated as a temporary color, and is not
+     * added to the recent colors list.
+     */
+    void setValidTemporaryColor( const QColor& newColor );
+
+    //! Called when a color widget panel is accepted, and adds the final color to the recent colors list
+    void panelAccepted( QgsPanelWidget* widget );
+
     /** Adds a color to the recent colors list
      * @param color to add to recent colors list
      */

src/gui/qgscompoundcolorwidget.cpp

@@ -31,7 +31,7 @@
 
 
 QgsCompoundColorWidget::QgsCompoundColorWidget( QWidget *parent, const QColor& color )
-    : QWidget( parent )
+    : QgsPanelWidget( parent )
     , mAllowAlpha( true )
     , mLastCustomColorIndex( 0 )
     , mPickingColor( false )

src/gui/qgscompoundcolorwidget.h

@@ -17,6 +17,7 @@
 #define QGSCOMPOUNDCOLORWIDGET_H
 
 #include "qgisgui.h"
+#include "qgspanelwidget.h"
 #include "ui_qgscompoundcolorwidget.h"
 
 /** \ingroup gui
@@ -26,7 +27,7 @@
  * \note Added in version 2.16
  */
 
-class GUI_EXPORT QgsCompoundColorWidget : public QWidget, private Ui::QgsCompoundColorWidgetBase
+class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::QgsCompoundColorWidgetBase
 {
 
     Q_OBJECT

src/gui/qgspanelwidget.cpp

@@ -47,6 +47,19 @@ void QgsPanelWidget::setDockMode( bool dockMode )
   mDockMode = dockMode;
 }
 
+QgsPanelWidget*QgsPanelWidget::findParentPanel( QWidget* widget )
+{
+  QWidget* p = widget;
+  while ( p )
+  {
+    if ( QgsPanelWidget* panel = qobject_cast< QgsPanelWidget* >( p ) )
+      return panel;
+
+    p = p->parentWidget();
+  }
+  return nullptr;
+}
+
 void QgsPanelWidget::openPanel( QgsPanelWidget* panel )
 {
   if ( mDockMode )

src/gui/qgspanelwidget.h

@@ -79,20 +79,28 @@ class GUI_EXPORT QgsPanelWidget : public QWidget
 
     /**
      * The the auto delete property on the widget. True by default.
-     * When auto delete is enabeld when a panel is removed from the stack
+     * When auto delete is enabled when a panel is removed from the stack
      * it will be deleted.
      * @param autoDelete Enable or disable auto delete on the panel.
      */
     void setAutoDelete( bool autoDelete ) { mAutoDelete = autoDelete; }
 
     /**
      * The the auto delete property on the widget. True by default.
-     * When auto delete is enabeld when a panel is removed from the stack
+     * When auto delete is enabled when a panel is removed from the stack
      * it will be deleted.
      * @returns The auto delete value for the widget.
      */
     bool autoDelete() { return mAutoDelete; }
 
+    /** Traces through the parents of a widget to find if it is contained within a QgsPanelWidget
+     * widget.
+     * @param widget widget which may be contained within a panel widget
+     * @returns parent panel widget if found, otherwise nullptr
+     * @note added in QGIS 3.0
+     */
+    static QgsPanelWidget* findParentPanel( QWidget* widget );
+
   signals:
 
     /**

tests/src/python/CMakeLists.txt

@@ -64,6 +64,7 @@ ADD_PYTHON_TEST(PyQgsPalLabelingBase test_qgspallabeling_base.py)
 ADD_PYTHON_TEST(PyQgsPalLabelingCanvas test_qgspallabeling_canvas.py)
 ADD_PYTHON_TEST(PyQgsPalLabelingComposer test_qgspallabeling_composer.py)
 ADD_PYTHON_TEST(PyQgsPalLabelingPlacement test_qgspallabeling_placement.py)
+ADD_PYTHON_TEST(PyQgsPanelWidget test_qgspanelwidget.py)
 ADD_PYTHON_TEST(PyQgsPoint test_qgspoint.py)
 ADD_PYTHON_TEST(PyQgsRangeWidgets test_qgsrangewidgets.py)
 ADD_PYTHON_TEST(PyQgsRasterFileWriter test_qgsrasterfilewriter.py)

tests/src/python/test_qgspanelwidget.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+"""QGIS Unit tests for QgsPanelWidget.
+
+.. note:: This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+"""
+__author__ = 'Nyall Dawson'
+__date__ = '16/08/2016'
+__copyright__ = 'Copyright 2016, The QGIS Project'
+# This will get replaced with a git SHA1 when you do a git archive
+__revision__ = '$Format:%H$'
+
+import qgis  # NOQA
+
+from qgis.PyQt.QtWidgets import QWidget
+from qgis.gui import QgsPanelWidget
+from qgis.testing import start_app, unittest
+
+start_app()
+
+
+class TestQgsPanelWidget(unittest.TestCase):
+
+    def testFindParentPanel(self):
+        """ test QgsPanelWidget.findParentPanel """
+
+        # no widget
+        self.assertFalse(QgsPanelWidget.findParentPanel(None))
+
+        # widget with no parent
+        w = QWidget()
+        self.assertFalse(QgsPanelWidget.findParentPanel(w))
+
+        # widget with no panel parent
+        w2 = QWidget(w)
+        self.assertFalse(QgsPanelWidget.findParentPanel(w2))
+
+        # panel widget itself
+        w3 = QgsPanelWidget()
+        self.assertEqual(QgsPanelWidget.findParentPanel(w3), w3)
+
+        # widget with direct QgsPanelWidget parent
+        w4 = QWidget(w3)
+        self.assertEqual(QgsPanelWidget.findParentPanel(w4), w3)
+
+        # widget with QgsPanelWidget grandparent
+        w5 = QWidget(w4)
+        self.assertEqual(QgsPanelWidget.findParentPanel(w5), w3)
+
+
+if __name__ == '__main__':
+    unittest.main()