Merge pull request #4514 from nyalldawson/gui_instance

Make a new global QgsGui singleton

Author: nyalldawson

cmake/FindQGIS.cmake

@@ -142,7 +142,7 @@ ELSE(WIN32)
     # also get other frameworks' headers folders on OS X
     IF (APPLE)
       FIND_PATH(QGIS_GUI_INCLUDE_DIR
-        NAMES qgisgui.h
+        NAMES qgsguiutils.h
         PATHS
           ${QGIS_BUILD_PATH}/output/lib
           ${QGIS_MAC_PATH}/Frameworks

doc/api_break.dox

@@ -63,6 +63,7 @@ Renamed Classes        {#qgis_api_break_3_0_renamed_classes}
 <table>
 <caption id="renamed_classes">Renamed classes</caption>
 <tr><th>API 2.x<th>API 3.X
+<tr><td>QgisGui<td>QgsGuiUtils
 <tr><td>QgsAttributeAction<td>QgsActionManager
 <tr><td>QgsAbstractGeometryV2<td>QgsAbstractGeometry
 <tr><td>QgsCategorizedSymbolRendererV2<td>QgsCategorizedSymbolRenderer
@@ -1011,7 +1012,7 @@ QgsEditFormConfig        {#qgis_api_break_3_0_QgsEditFormConfig}
 
 - Does no longer inherit QObject
 - widgetType() and widgetConfig() now reflect only the user configured values.
-QgsEditorWidgetRegistry::instance()->findBest() must be used instead.
+QgsEditorWidgetRegistry::findBest() must be used instead.
 - widgetConfig(), setWidgetType(), setWidgetConfig() and removeWidgetConfig() now only take a string as first parameter. Access by index has been removed.
 - widgetType() has been removed in favor of QgsVectorLayer::editorWidgetSetup()
 - expression(), setExpression(), expressionDescription() and setExpressionDescription()
@@ -1213,6 +1214,7 @@ plugins calling this method will need to be updated.
 QgsEditorWidgetRegistry        {#qgis_api_break_3_0_QgsEditorWidgetRegistry}
 -----------------------
 
+- The instance() singleton was removed. Use QgsGui::editorWidgetRegistry() instead.
 - The signature of isFieldSupported() has been changed to return an unsigned
   integer (how good it supports the given field) and is now const.
 
@@ -1307,6 +1309,12 @@ QgsLayerPropertiesWidget        {#qgis_api_break_3_0_QgsLayerPropertiesWidget}
 - expressionContext(), setExpressionContext(), setMapCanvas() and mapCanvas() have been removed in favor of setContext()/context()
 
 
+QgsLayerTreeEmbeddedWidgetRegistry        {#qgis_api_break_3_0_QgsLayerTreeEmbeddedWidgetRegistry}
+----------------------------------
+
+- QgsLayerTreeEmbeddedWidgetRegistry::instance() has been removed. Use QgsGui::layerTreeEmbeddedWidgetRegistry() instead.
+
+
 QgsLayerTreeGroup        {#qgis_api_break_3_0_QgsLayerTreeGroup}
 -----------------
 
@@ -1438,6 +1446,13 @@ screenUpdateRequested() were removed. These members have had no effect for a num
 - the invalidTransformInput() slot was removed - calling this slot had no effect
 - metadata() was renamed to htmlMetadata()
 
+
+QgsMapLayerActionRegistry        {#qgis_api_break_3_0_QgsMapLayerActionRegistry}
+-------------------------
+
+- This class is no longer a singleton and instance() has been removed. Instead use QgsGui::mapLayerActionRegistry().
+
+
 QgsMapOverviewCanvas        {#qgis_api_break_3_0_QgsMapOverviewCanvas}
 --------------------
 
@@ -1822,10 +1837,10 @@ QgsRenderChecker        {#qgis_api_break_3_0_QgsRenderChecker}
 setExcludeAttributesWms()
 - excludeAttributesWFS() and setExcludeAttributesWFS() have been renamed to excludeAttributesWfs() and
 setExcludeAttributesWfs()
-- editorWidgetV2() and editorWidgetV2Config() have been removed and QgsEditorWidgetRegistry::instance()->findBest() must be used instead.
+- editorWidgetV2() and editorWidgetV2Config() have been removed and QgsEditorWidgetRegistry::findBest() must be used instead.
 - setEditorWidgetV2(), setEditorWidgetV2Config() have been removed and their equivalent in editFormConfig() must be used instead.
 - setCheckedState() is removed. Use `editFormConfig()->setWidgetConfig()` instead.
-- valueMap(), valueRelation(), dateFormat(), widgetSize() have been removed. Use QgsEditorWidgetRegistry::instance()->findBest().config() instead.
+- valueMap(), valueRelation(), dateFormat(), widgetSize() have been removed. Use QgsEditorWidgetRegistry::findBest().config() instead.
 
 
 QgsRenderContext        {#qgis_api_break_3_0_QgsRenderContext}
@@ -1909,6 +1924,10 @@ QgsServer       {#qgis_api_break_3_0_QgsServer}
 -  QgsServer::handleRequest( const QString &urlstr ) has been removed in favour of the new
 -  QgsServer::handleRequest( QgsServerRequest &request, QgsServerResponse &response ) has been added
 
+QgsShortcutsManager       {#qgis_api_break_3_0_QgsShortcutsManager}
+-------------------
+
+-  QgsShortcutsManager::instance() was removed. Use QgsGui::shortcutsManager() instead.
 
 
 QgsSimpleMarkerSymbolLayer        {#qgis_api_break_3_0_QgsSimpleMarkerSymbolLayer}

python/gui/editorwidgets/core/qgseditorwidgetregistry.sip

@@ -13,24 +13,24 @@
 class QgsEditorWidgetRegistry : QObject
 {
 %Docstring
- This class manages all known edit widget factories
+ This class manages all known edit widget factories.
+
+ QgsEditorWidgetRegistry is not usually directly created, but rather accessed through
+ QgsGui.editorWidgetRegistry().
 %End
 
 %TypeHeaderCode
 #include "qgseditorwidgetregistry.h"
 %End
   public:
 
-    static QgsEditorWidgetRegistry *instance();
+    QgsEditorWidgetRegistry();
 %Docstring
- This class is a singleton and has therefore to be accessed with this method instead
- of a constructor.
-
- :return: The one and only instance of the editor widget registry
- :rtype: QgsEditorWidgetRegistry
+ Constructor for QgsEditorWidgetRegistry. QgsEditorWidgetRegistry is not usually directly created, but rather accessed through
+ QgsGui.editorWidgetRegistry().
 %End
 
-    static void initEditors( QgsMapCanvas *mapCanvas = 0, QgsMessageBar *messageBar = 0 );
+    void initEditors( QgsMapCanvas *mapCanvas = 0, QgsMessageBar *messageBar = 0 );
 %Docstring
  Registers all the default widgets.
  Only call this once on startup of an application.
@@ -171,9 +171,6 @@ class QgsEditorWidgetRegistry : QObject
  \param plugin The plugin (ownership is transferred)
 %End
 
-  protected:
-    QgsEditorWidgetRegistry();
-
 };
 
 /************************************************************************

python/gui/gui.sip

@@ -81,6 +81,7 @@
 %Include qgsfloatingwidget.sip
 %Include qgsfocuswatcher.sip
 %Include qgsformannotation.sip
+%Include qgsgui.sip
 %Include qgsgeometryrubberband.sip
 %Include qgsgradientcolorrampdialog.sip
 %Include qgsgradientstopeditor.sip

python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip

@@ -47,8 +47,7 @@ class QgsLayerTreeEmbeddedWidgetRegistry
 
   public:
 
-    /** Means of accessing canonical single instance */
-    static QgsLayerTreeEmbeddedWidgetRegistry *instance();
+    QgsLayerTreeEmbeddedWidgetRegistry();
 
     ~QgsLayerTreeEmbeddedWidgetRegistry();
 
@@ -66,10 +65,6 @@ class QgsLayerTreeEmbeddedWidgetRegistry
      * Returns true on success, false if the provider was not registered. */
     bool removeProvider( const QString &providerId );
 
-  protected:
-    //! Protected constructor - use instance() to access the registry.
-    QgsLayerTreeEmbeddedWidgetRegistry();
-
   private:
 
     QgsLayerTreeEmbeddedWidgetRegistry( const QgsLayerTreeEmbeddedWidgetRegistry &other );

python/gui/qgsbusyindicatordialog.sip

@@ -15,7 +15,7 @@ class QgsBusyIndicatorDialog : QDialog
      * @param parent parent object (owner)
      * @param fl widget flags
      */
-    QgsBusyIndicatorDialog( const QString &message = "", QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgisGui::ModalDialogFlags );
+    QgsBusyIndicatorDialog( const QString &message = "", QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags );
     ~QgsBusyIndicatorDialog();
 
     QString message() const;

python/gui/qgscharacterselectdialog.sip

@@ -4,7 +4,7 @@ class QgsCharacterSelectorDialog : QDialog
 #include <qgscharacterselectdialog.h>
 %End
   public:
-    QgsCharacterSelectorDialog( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgisGui::ModalDialogFlags );
+    QgsCharacterSelectorDialog( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags );
     ~QgsCharacterSelectorDialog();
 
   public slots:

python/gui/qgscolordialog.sip

@@ -23,7 +23,7 @@ class QgsColorDialog : QDialog
 %End
   public:
 
-    QgsColorDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgisGui::ModalDialogFlags,
+    QgsColorDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags,
                     const QColor &color = QColor() );
 %Docstring
  Create a new color picker dialog

python/gui/qgscredentialdialog.sip

@@ -20,7 +20,7 @@ class QgsCredentialDialog : QDialog, QgsCredentials
 #include "qgscredentialdialog.h"
 %End
   public:
-    QgsCredentialDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
+    QgsCredentialDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
 %Docstring
 QgsCredentialDialog constructor
 %End

python/gui/qgsdialog.sip

@@ -21,7 +21,7 @@ class QgsDialog : QDialog
 %End
   public:
 
-    QgsDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgisGui::ModalDialogFlags,
+    QgsDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags,
                QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Close,
                Qt::Orientation orientation = Qt::Horizontal );
 %Docstring