Merge pull request #4514 from nyalldawson/gui_instance

Make a new global QgsGui singleton
qgis · May 14, 2017 · f8f7d60 · f8f7d60
2 parents c3c694f + a8b10a2
commit f8f7d60
Show file tree

Hide file tree

Showing 161 changed files with 650 additions and 431 deletions.
diff --git a/cmake/FindQGIS.cmake b/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

diff --git a/doc/api_break.dox b/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}

diff --git a/python/gui/editorwidgets/core/qgseditorwidgetregistry.sip b/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();
-
 };
 
 /************************************************************************

diff --git a/python/gui/gui.sip b/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

diff --git a/python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip b/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 );

diff --git a/python/gui/qgsbusyindicatordialog.sip b/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;

diff --git a/python/gui/qgscharacterselectdialog.sip b/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:

diff --git a/python/gui/qgscolordialog.sip b/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

diff --git a/python/gui/qgscredentialdialog.sip b/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

diff --git a/python/gui/qgsdialog.sip b/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

diff --git a/python/gui/qgserrordialog.sip b/python/gui/qgserrordialog.sip
@@ -17,12 +17,12 @@ class QgsErrorDialog: QDialog
 %End
   public:
 
-    QgsErrorDialog( const QgsError &error, const QString &title, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
+    QgsErrorDialog( const QgsError &error, const QString &title, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
 %Docstring
  QgsErrorDialog constructor for QgsErrorDialog
 %End
 
-    static void show( const QgsError &error, const QString &title, QWidget *parent = 0, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
+    static void show( const QgsError &error, const QString &title, QWidget *parent = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
 %Docstring
  Show dialog with error
  \param error error

diff --git a/python/gui/qgsgroupwmsdatadialog.sip b/python/gui/qgsgroupwmsdatadialog.sip
@@ -15,7 +15,7 @@ class QgsGroupWmsDataDialog: QDialog
 #include "qgsgroupwmsdatadialog.h"
 %End
   public:
-    QgsGroupWmsDataDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
+    QgsGroupWmsDataDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
 %Docstring
 Constructor
 %End

diff --git a/python/gui/qgsgui.sip b/python/gui/qgsgui.sip
@@ -0,0 +1,70 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsgui.h                                                     *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+class QgsGui
+{
+%Docstring
+ QgsGui is a singleton class containing various registry and other global members
+ related to GUI classes.
+.. versionadded:: 3.0
+%End
+
+%TypeHeaderCode
+#include "qgsgui.h"
+%End
+  public:
+
+
+
+    static QgsGui *instance();
+%Docstring
+ Returns a pointer to the singleton instance.
+ :rtype: QgsGui
+%End
+
+    static QgsEditorWidgetRegistry *editorWidgetRegistry();
+%Docstring
+ Returns the global editor widget registry, used for managing all known edit widget factories.
+ :rtype: QgsEditorWidgetRegistry
+%End
+
+    static QgsShortcutsManager *shortcutsManager();
+%Docstring
+ Returns the global shortcuts manager, used for managing a QAction and QShortcut sequences.
+ :rtype: QgsShortcutsManager
+%End
+
+    static QgsLayerTreeEmbeddedWidgetRegistry *layerTreeEmbeddedWidgetRegistry();
+%Docstring
+ Returns the global layer tree embedded widget registry, used for registering widgets that may be embedded into layer tree view.
+ :rtype: QgsLayerTreeEmbeddedWidgetRegistry
+%End
+
+    static QgsMapLayerActionRegistry *mapLayerActionRegistry();
+%Docstring
+ Returns the global map layer action registry, used for registering map layer actions.
+ :rtype: QgsMapLayerActionRegistry
+%End
+
+    ~QgsGui();
+
+  private:
+    QgsGui( const QgsGui &other );
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsgui.h                                                     *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/python/gui/qgsludialog.sip b/python/gui/qgsludialog.sip
@@ -5,7 +5,7 @@ class QgsLUDialog: QDialog
 %End
 
   public:
-    QgsLUDialog( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgisGui::ModalDialogFlags );
+    QgsLUDialog( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags );
     ~QgsLUDialog();
     QString lowerValue() const;
     void setLowerValue( const QString &val );

diff --git a/python/gui/qgsmaplayeractionregistry.sip b/python/gui/qgsmaplayeractionregistry.sip
@@ -64,8 +64,8 @@ class QgsMapLayerActionRegistry : QObject
 %End
 
   public:
-    //! Returns the instance pointer, creating the object on the first call
-    static QgsMapLayerActionRegistry *instance();
+
+    QgsMapLayerActionRegistry( QObject *parent = 0 );
 
     ~QgsMapLayerActionRegistry();
 
@@ -83,10 +83,6 @@ class QgsMapLayerActionRegistry : QObject
     /** Returns the default action for a layer*/
     QgsMapLayerAction *defaultActionForLayer( QgsMapLayer *layer );
 
-  protected:
-    //! protected constructor
-    QgsMapLayerActionRegistry( QObject *parent = 0 );
-
   signals:
     /** Triggered when an action is added or removed from the registry */
     void changed();

diff --git a/python/gui/qgsmessagelogviewer.sip b/python/gui/qgsmessagelogviewer.sip
@@ -21,7 +21,7 @@ class QgsMessageLogViewer: QDialog
 %End
   public:
 
-    QgsMessageLogViewer( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
+    QgsMessageLogViewer( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
 %Docstring
  Create a new message log viewer. The viewer will automatically connect to the system's
  QgsApplication.messageLog() instance.

diff --git a/python/gui/qgsmessageviewer.sip b/python/gui/qgsmessageviewer.sip
@@ -6,7 +6,7 @@ class QgsMessageViewer: QDialog, QgsMessageOutput //, Ui::QgsMessageViewer
 %End
 
   public:
-    QgsMessageViewer( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgisGui::ModalDialogFlags );
+    QgsMessageViewer( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags );
     ~QgsMessageViewer();
 
     virtual void setMessage( const QString &message, MessageType msgType );

diff --git a/python/gui/qgsnewgeopackagelayerdialog.sip b/python/gui/qgsnewgeopackagelayerdialog.sip
@@ -7,7 +7,7 @@ class QgsNewGeoPackageLayerDialog : QDialog
 
   public:
     /** Constructor */
-    QgsNewGeoPackageLayerDialog( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgisGui::ModalDialogFlags );
+    QgsNewGeoPackageLayerDialog( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags );
 
     ~QgsNewGeoPackageLayerDialog();
 

diff --git a/python/gui/qgsnewhttpconnection.sip b/python/gui/qgsnewhttpconnection.sip
@@ -6,7 +6,7 @@ class QgsNewHttpConnection : QDialog
 
   public:
     //! Constructor
-    QgsNewHttpConnection( QWidget *parent /TransferThis/ = 0, const QString &baseKey = "/Qgis/connections-wms/", const QString &connName = QString::null, const Qt::WindowFlags &fl = QgisGui::ModalDialogFlags );
+    QgsNewHttpConnection( QWidget *parent /TransferThis/ = 0, const QString &baseKey = "/Qgis/connections-wms/", const QString &connName = QString::null, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags );
     //! Destructor
     ~QgsNewHttpConnection();
   public slots:

diff --git a/python/gui/qgsnewmemorylayerdialog.sip b/python/gui/qgsnewmemorylayerdialog.sip
@@ -26,7 +26,7 @@ class QgsNewMemoryLayerDialog: QDialog
  :rtype: QgsVectorLayer
 %End
 
-    QgsNewMemoryLayerDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
+    QgsNewMemoryLayerDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
     ~QgsNewMemoryLayerDialog();
 
     QgsWkbTypes::Type selectedType() const;

diff --git a/python/gui/qgsnewnamedialog.sip b/python/gui/qgsnewnamedialog.sip
@@ -23,7 +23,7 @@ class QgsNewNameDialog : QgsDialog
     QgsNewNameDialog( const QString& source = QString::null, const QString& initial = QString::null,
                       const QStringList& extensions = QStringList(), const QStringList& existing = QStringList(),
                       const QRegExp& regexp = QRegExp(), Qt::CaseSensitivity cs = Qt::CaseSensitive,
-                      QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &flags = QgisGui::ModalDialogFlags );
+                      QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &flags = QgsGuiUtils::ModalDialogFlags );
 
     /** Sets the hint string for the dialog (the text shown above the name
      * input box).

diff --git a/python/gui/qgsnewvectorlayerdialog.sip b/python/gui/qgsnewvectorlayerdialog.sip
@@ -10,7 +10,7 @@ class QgsNewVectorLayerDialog : QDialog
     // @return fileName on success, empty string use aborted, QString::null if creation failed
     static QString runAndCreateLayer( QWidget *parent = 0, QString *enc = 0 );
 
-    QgsNewVectorLayerDialog( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgisGui::ModalDialogFlags );
+    QgsNewVectorLayerDialog( QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags );
     ~QgsNewVectorLayerDialog();
     /** Returns the selected geometry type*/
     QgsWkbTypes::Type selectedType() const;

diff --git a/python/gui/qgsowssourceselect.sip b/python/gui/qgsowssourceselect.sip
@@ -23,7 +23,7 @@ class QgsOWSSourceSelect : QDialog
     };
 
     //! Constructor
-    QgsOWSSourceSelect( const QString &service, QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgisGui::ModalDialogFlags, bool managerMode = false, bool embeddedMode = false );
+    QgsOWSSourceSelect( const QString &service, QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags, bool managerMode = false, bool embeddedMode = false );
     //! Destructor
     ~QgsOWSSourceSelect();