Complete documentation for connectionsChanged signals

qgis · Jul 18, 2017 · f6c8ef3 · f6c8ef3
1 parent c4e26d7
commit f6c8ef3
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/python/core/qgsdataitem.sip b/python/core/qgsdataitem.sip
@@ -320,7 +320,7 @@ Refresh connections: update GUI and emit signal
     void stateChanged( QgsDataItem *item, QgsDataItem::State oldState );
     void connectionsChanged( );
 %Docstring
-Emitted when the provider's connections of the child items have changed
+open browsers
 %End
 
   protected slots:

diff --git a/python/gui/qgsabstractdatasourcewidget.sip b/python/gui/qgsabstractdatasourcewidget.sip
@@ -52,7 +52,7 @@ The default implementation does nothing
 
     void connectionsChanged();
 %Docstring
-Emitted when the provider's connections have changed
+This signal is normally forwarded the app and used to refresh browser items
 %End
 
 };

diff --git a/src/core/qgsdataitem.h b/src/core/qgsdataitem.h
@@ -296,6 +296,9 @@ class CORE_EXPORT QgsDataItem : public QObject
     void dataChanged( QgsDataItem *item );
     void stateChanged( QgsDataItem *item, QgsDataItem::State oldState );
     //! Emitted when the provider's connections of the child items have changed
+    //! This signal is normally forwarded to the app in order to refresh the connection
+    //! item in the provider dialogs and to refresh the connection items in the other
+    //! open browsers
     void connectionsChanged( );
 
   protected slots:

diff --git a/src/gui/qgsabstractdatasourcewidget.h b/src/gui/qgsabstractdatasourcewidget.h
@@ -57,6 +57,7 @@ class GUI_EXPORT QgsAbstractDataSourceWidget : public QDialog
   signals:
 
     //! Emitted when the provider's connections have changed
+    //! This signal is normally forwarded the app and used to refresh browser items
     void connectionsChanged();
 
   private: