QGIS API Documentation  3.21.0-Master (56b4176581)
qgsgui.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgui.h
3  --------
4  begin : May 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSGUI_H
19 #define QGSGUI_H
20 
21 #include "qgis_gui.h"
22 #include "qgis_sip.h"
23 #include <QWidget>
24 #include <memory>
25 
26 class QgsSettingsRegistryGui;
32 class QgsNative;
37 class QgsProcessingRecentAlgorithmLog;
38 class QgsWindowManagerInterface;
44 class QgsMessageBar;
48 
55 class GUI_EXPORT QgsGui : public QObject
56 {
57  Q_OBJECT
58 
59  public:
60 
65  {
66  UseCrsOfFirstLayerAdded = 1,
67  UsePresetCrs = 2,
68  };
69  Q_ENUM( ProjectCrsBehavior )
70 
71 
72  QgsGui( const QgsGui &other ) = delete;
73 
75  QgsGui &operator=( const QgsGui &other ) = delete;
76 
80  static QgsGui *instance();
81 
87  SIP_SKIP static QgsNative *nativePlatformInterface();
88 
93  static QgsSettingsRegistryGui *settingsRegistryGui() SIP_KEEPREFERENCE;
94 
98  static QgsEditorWidgetRegistry *editorWidgetRegistry() SIP_KEEPREFERENCE;
99 
103  static QgsSourceSelectProviderRegistry *sourceSelectProviderRegistry() SIP_KEEPREFERENCE;
104 
108  static QgsShortcutsManager *shortcutsManager();
109 
113  static QgsLayerTreeEmbeddedWidgetRegistry *layerTreeEmbeddedWidgetRegistry() SIP_KEEPREFERENCE;
114 
118  static QgsMapLayerActionRegistry *mapLayerActionRegistry() SIP_KEEPREFERENCE;
119 
123  static QgsLayoutItemGuiRegistry *layoutItemGuiRegistry() SIP_KEEPREFERENCE;
124 
130  static QgsAnnotationItemGuiRegistry *annotationItemGuiRegistry() SIP_KEEPREFERENCE;
131 
136  static QgsProcessingGuiRegistry *processingGuiRegistry() SIP_KEEPREFERENCE;
137 
142  static QgsNumericFormatGuiRegistry *numericFormatGuiRegistry() SIP_KEEPREFERENCE;
143 
148  static QgsCodeEditorColorSchemeRegistry *codeEditorColorSchemeRegistry() SIP_KEEPREFERENCE;
149 
154  static QgsProcessingRecentAlgorithmLog *processingRecentAlgorithmLog();
155 
161  static QgsDataItemGuiProviderRegistry *dataItemGuiProviderRegistry() SIP_KEEPREFERENCE;
162 
167  static QgsProjectStorageGuiRegistry *projectStorageGuiRegistry() SIP_KEEPREFERENCE;
168 
173  static QgsProviderGuiRegistry *providerGuiRegistry() SIP_KEEPREFERENCE;
174 
179  static QgsSubsetStringEditorProviderRegistry *subsetStringEditorProviderRegistry() SIP_KEEPREFERENCE;
180 
185  static QgsProviderSourceWidgetProviderRegistry *sourceWidgetProviderRegistry() SIP_KEEPREFERENCE;
186 
191  static QgsRelationWidgetRegistry *relationWidgetRegistry() SIP_KEEPREFERENCE;
192 
197  static void enableAutoGeometryRestore( QWidget *widget, const QString &key = QString() );
198 
204  static QgsWindowManagerInterface *windowManager();
205 
211  static void setWindowManager( QgsWindowManagerInterface *manager SIP_TRANSFER );
212 
217  enum HigFlag
218  {
219  HigMenuTextIsTitleCase = 1 << 0,
220  HigDialogTitleIsTitleCase = 1 << 1
221  };
222  Q_DECLARE_FLAGS( HigFlags, HigFlag )
223 
224 
228  static QgsGui::HigFlags higFlags();
229 
230  ~QgsGui();
231 
237  static QColor sampleColor( QPoint point );
238 
244  static QScreen *findScreenAt( QPoint point );
245 
255  static bool pythonMacroAllowed( void ( *lambda )() = nullptr, QgsMessageBar *messageBar = nullptr ) SIP_SKIP;
256 
258  void emitOptionsChanged() SIP_SKIP;
260 
261  signals:
262 
273  void optionsChanged();
274 
275  private:
276 
277  QgsGui();
278 
279  QgsSettingsRegistryGui *mSettingsRegistryGui = nullptr;
280  QgsProviderGuiRegistry *mProviderGuiRegistry = nullptr;
281  QgsWidgetStateHelper *mWidgetStateHelper = nullptr;
282  QgsNative *mNative = nullptr;
283  QgsEditorWidgetRegistry *mEditorWidgetRegistry = nullptr;
284  QgsSourceSelectProviderRegistry *mSourceSelectProviderRegistry = nullptr;
285  QgsShortcutsManager *mShortcutsManager = nullptr;
286  QgsLayerTreeEmbeddedWidgetRegistry *mLayerTreeEmbeddedWidgetRegistry = nullptr;
287  QgsMapLayerActionRegistry *mMapLayerActionRegistry = nullptr;
288  QgsLayoutItemGuiRegistry *mLayoutItemGuiRegistry = nullptr;
289  QgsAnnotationItemGuiRegistry *mAnnotationItemGuiRegistry = nullptr;
290  QgsProcessingGuiRegistry *mProcessingGuiRegistry = nullptr;
291  QgsProcessingRecentAlgorithmLog *mProcessingRecentAlgorithmLog = nullptr;
292  QgsNumericFormatGuiRegistry *mNumericFormatGuiRegistry = nullptr;
293  QgsDataItemGuiProviderRegistry *mDataItemGuiProviderRegistry = nullptr;
294  QgsCodeEditorColorSchemeRegistry *mCodeEditorColorSchemeRegistry = nullptr;
295  QgsProjectStorageGuiRegistry *mProjectStorageGuiRegistry = nullptr;
296  QgsSubsetStringEditorProviderRegistry *mSubsetStringEditorProviderRegistry = nullptr;
297  QgsProviderSourceWidgetProviderRegistry *mProviderSourceWidgetProviderRegistry = nullptr;
298  QgsRelationWidgetRegistry *mRelationEditorRegistry = nullptr;
299  std::unique_ptr< QgsWindowManagerInterface > mWindowManager;
300 
301 #ifdef SIP_RUN
302  QgsGui( const QgsGui &other );
303 #endif
304 
305 };
306 
307 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsGui::HigFlags )
308 
309 #endif // QGSGUI_H
Registry of available annotation item GUI behavior.
A registry of color schemes for use in QgsCodeEditor widgets.
This class keeps a list of data item GUI providers that may affect how QgsDataItems behave within the...
This class manages all known edit widget factories.
QgsGui is a singleton class containing various registry and other global members related to GUI class...
Definition: qgsgui.h:56
HigFlag
HIG flags, which indicate the Human Interface Guidelines for the current platform.
Definition: qgsgui.h:218
ProjectCrsBehavior
Defines the behavior to use when setting the CRS for a newly created project.
Definition: qgsgui.h:65
Registry of widgets that may be embedded into layer tree view.
Registry of available layout item GUI behavior.
This class tracks map layer actions.
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:61
The QgsNumericFormatGuiRegistry is a home for widgets for configuring QgsNumericFormat objects.
The QgsProcessingGuiRegistry is a home for widgets for processing configuration widgets.
A registry / canonical manager of GUI parts of project storage backends.
A registry / canonical manager of GUI parts of data providers.
This class keeps a list of provider source widget providers.
Keeps track of the registered relations widgets.
Shortcuts manager is a class that contains a list of QActions and QShortcuts that have been registere...
This class keeps a list of source select providers that may add items to the QgsDataSourceManagerDial...
This class keeps a list of subset string editor providers.
QgsWidgetStateHelper is a helper class to save and restore the geometry of QWidgets in the applicatio...
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Definition: qgsgeos.h:79
#define SIP_KEEPREFERENCE
Definition: qgis_sip.h:86
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_TRANSFER
Definition: qgis_sip.h:36
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsField::ConfigurationFlags) CORE_EXPORT QDataStream &operator<<(QDataStream &out
Writes the field to stream out. QGIS version compatibility is not guaranteed.