QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Types | Signals | Public Member Functions | Static Public Member Functions | List of all members
QgsGui Class Reference

QgsGui is a singleton class containing various registry and other global members related to GUI classes. More...

#include <qgsgui.h>

Inheritance diagram for QgsGui:
Inheritance graph
[legend]

Public Types

enum  HigFlag { HigMenuTextIsTitleCase = 1 << 0 , HigDialogTitleIsTitleCase = 1 << 1 }
 HIG flags, which indicate the Human Interface Guidelines for the current platform. More...
 
enum  ProjectCrsBehavior { UseCrsOfFirstLayerAdded = 1 , UsePresetCrs = 2 }
 Defines the behavior to use when setting the CRS for a newly created project. More...
 

Signals

void optionsChanged ()
 This signal is emitted whenever the application options have been changed. More...
 

Public Member Functions

 QgsGui (const QgsGui &other)=delete
 QgsGui cannot be copied. More...
 
 ~QgsGui ()
 
QgsGuioperator= (const QgsGui &other)=delete
 QgsGui cannot be copied. More...
 

Static Public Member Functions

static QgsAnnotationItemGuiRegistryannotationItemGuiRegistry ()
 Returns the global annotation item GUI registry, used for registering the GUI behavior of annotation items. More...
 
static QgsCodeEditorColorSchemeRegistrycodeEditorColorSchemeRegistry ()
 Returns the global code editor color scheme registry, used for registering the color schemes for QgsCodeEditor widgets. More...
 
static QgsDataItemGuiProviderRegistrydataItemGuiProviderRegistry ()
 Returns the global data item GUI provider registry, used for tracking providers which affect the browser GUI. More...
 
static QgsEditorWidgetRegistryeditorWidgetRegistry ()
 Returns the global editor widget registry, used for managing all known edit widget factories. More...
 
static void enableAutoGeometryRestore (QWidget *widget, const QString &key=QString())
 Register the widget to allow its position to be automatically saved and restored when open and closed. More...
 
static QScreen * findScreenAt (QPoint point)
 Returns the screen at the given global point (pixel). More...
 
static QgsGui::HigFlags higFlags ()
 Returns the platform's HIG flags. More...
 
static QgsHistoryProviderRegistryhistoryProviderRegistry ()
 Returns the global history provider registry, used for tracking history providers. More...
 
static QgsGuiinstance ()
 Returns a pointer to the singleton instance. More...
 
static QgsLayerTreeEmbeddedWidgetRegistrylayerTreeEmbeddedWidgetRegistry ()
 Returns the global layer tree embedded widget registry, used for registering widgets that may be embedded into layer tree view. More...
 
static QgsLayoutItemGuiRegistrylayoutItemGuiRegistry ()
 Returns the global layout item GUI registry, used for registering the GUI behavior of layout items. More...
 
static QgsMapLayerActionRegistrymapLayerActionRegistry ()
 Returns the global map layer action registry, used for registering map layer actions. More...
 
static QgsMapToolShapeRegistrymapToolShapeRegistry ()
 Returns the registry of shape map tools. More...
 
static QgsNative * nativePlatformInterface ()
 Returns the global native interface, which offers abstraction to the host OS's underlying public interfaces. More...
 
static QgsNumericFormatGuiRegistrynumericFormatGuiRegistry ()
 Returns the global numeric format gui registry, used for registering the GUI widgets associated with QgsNumericFormats. More...
 
static QgsProcessingGuiRegistryprocessingGuiRegistry ()
 Returns the global processing gui registry, used for registering the GUI behavior of processing algorithms. More...
 
static QgsProcessingRecentAlgorithmLog * processingRecentAlgorithmLog ()
 Returns the global processing recent algorithm log, used for tracking recently used processing algorithms. More...
 
static QgsProjectStorageGuiRegistryprojectStorageGuiRegistry ()
 Returns the global GUI-related project storage registry. More...
 
static QgsProviderGuiRegistryproviderGuiRegistry ()
 Returns the registry of GUI-related components of data providers. More...
 
static bool pythonMacroAllowed (void(*lambda)()=nullptr, QgsMessageBar *messageBar=nullptr)
 Returns true if python macros are currently allowed to be run If the global option is to ask user, a modal dialog will be shown. More...
 
static QgsRelationWidgetRegistryrelationWidgetRegistry ()
 Returns the global relation widget registry, used for managing all known relation widget factories. More...
 
static QColor sampleColor (QPoint point)
 Samples the color on screen at the specified global point (pixel). More...
 
static QgsSettingsRegistryGuisettingsRegistryGui ()
 Returns the gui's settings registry, used for managing gui settings. More...
 
static void setWindowManager (QgsWindowManagerInterface *manager)
 Sets the global window manager. More...
 
static QgsShortcutsManagershortcutsManager ()
 Returns the global shortcuts manager, used for managing a QAction and QShortcut sequences. More...
 
static QgsSourceSelectProviderRegistrysourceSelectProviderRegistry ()
 Returns the global source select provider registry, used for managing all known source select widget factories. More...
 
static QgsProviderSourceWidgetProviderRegistrysourceWidgetProviderRegistry ()
 Returns the registry of provider source widget providers. More...
 
static QgsSubsetStringEditorProviderRegistrysubsetStringEditorProviderRegistry ()
 Returns the registry of subset string editors of data providers. More...
 
static QgsWindowManagerInterface * windowManager ()
 Returns the global window manager, if set. More...
 

Detailed Description

QgsGui is a singleton class containing various registry and other global members related to GUI classes.

Since
QGIS 3.0

Definition at line 57 of file qgsgui.h.

Member Enumeration Documentation

◆ HigFlag

HIG flags, which indicate the Human Interface Guidelines for the current platform.

Since
QGIS 3.4
Enumerator
HigMenuTextIsTitleCase 

Menu action texts should be title case.

HigDialogTitleIsTitleCase 

Dialog titles should be title case.

Definition at line 232 of file qgsgui.h.

◆ ProjectCrsBehavior

Defines the behavior to use when setting the CRS for a newly created project.

Enumerator
UseCrsOfFirstLayerAdded 

Set the project CRS to the CRS of the first layer added to a new project.

UsePresetCrs 

Always set new projects to use a preset default CRS.

Definition at line 66 of file qgsgui.h.

Constructor & Destructor Documentation

◆ QgsGui()

QgsGui::QgsGui ( const QgsGui other)
delete

QgsGui cannot be copied.

◆ ~QgsGui()

QgsGui::~QgsGui ( )

Definition at line 209 of file qgsgui.cpp.

Member Function Documentation

◆ annotationItemGuiRegistry()

QgsAnnotationItemGuiRegistry * QgsGui::annotationItemGuiRegistry ( )
static

Returns the global annotation item GUI registry, used for registering the GUI behavior of annotation items.

Since
QGIS 3.22

Definition at line 133 of file qgsgui.cpp.

◆ codeEditorColorSchemeRegistry()

QgsCodeEditorColorSchemeRegistry * QgsGui::codeEditorColorSchemeRegistry ( )
static

Returns the global code editor color scheme registry, used for registering the color schemes for QgsCodeEditor widgets.

Since
QGIS 3.16

Definition at line 148 of file qgsgui.cpp.

◆ dataItemGuiProviderRegistry()

QgsDataItemGuiProviderRegistry * QgsGui::dataItemGuiProviderRegistry ( )
static

Returns the global data item GUI provider registry, used for tracking providers which affect the browser GUI.

Since
QGIS 3.6

Definition at line 158 of file qgsgui.cpp.

◆ editorWidgetRegistry()

QgsEditorWidgetRegistry * QgsGui::editorWidgetRegistry ( )
static

Returns the global editor widget registry, used for managing all known edit widget factories.

Definition at line 83 of file qgsgui.cpp.

◆ enableAutoGeometryRestore()

void QgsGui::enableAutoGeometryRestore ( QWidget *  widget,
const QString &  key = QString() 
)
static

Register the widget to allow its position to be automatically saved and restored when open and closed.

Use this to avoid needing to call saveGeometry() and restoreGeometry() on your widget.

Definition at line 178 of file qgsgui.cpp.

◆ findScreenAt()

QScreen * QgsGui::findScreenAt ( QPoint  point)
static

Returns the screen at the given global point (pixel).

Since
QGIS 3.10

Definition at line 250 of file qgsgui.cpp.

◆ higFlags()

QgsGui::HigFlags QgsGui::higFlags ( )
static

Returns the platform's HIG flags.

Since
QGIS 3.4

Definition at line 197 of file qgsgui.cpp.

◆ historyProviderRegistry()

QgsHistoryProviderRegistry * QgsGui::historyProviderRegistry ( )
static

Returns the global history provider registry, used for tracking history providers.

Since
QGIS 3.24

Definition at line 173 of file qgsgui.cpp.

◆ instance()

QgsGui * QgsGui::instance ( )
static

Returns a pointer to the singleton instance.

Definition at line 67 of file qgsgui.cpp.

◆ layerTreeEmbeddedWidgetRegistry()

QgsLayerTreeEmbeddedWidgetRegistry * QgsGui::layerTreeEmbeddedWidgetRegistry ( )
static

Returns the global layer tree embedded widget registry, used for registering widgets that may be embedded into layer tree view.

Definition at line 118 of file qgsgui.cpp.

◆ layoutItemGuiRegistry()

QgsLayoutItemGuiRegistry * QgsGui::layoutItemGuiRegistry ( )
static

Returns the global layout item GUI registry, used for registering the GUI behavior of layout items.

Definition at line 128 of file qgsgui.cpp.

◆ mapLayerActionRegistry()

QgsMapLayerActionRegistry * QgsGui::mapLayerActionRegistry ( )
static

Returns the global map layer action registry, used for registering map layer actions.

Definition at line 123 of file qgsgui.cpp.

◆ mapToolShapeRegistry()

QgsMapToolShapeRegistry * QgsGui::mapToolShapeRegistry ( )
static

Returns the registry of shape map tools.

Note
Not available in Python bindings
Since
QGIS 3.26

Definition at line 93 of file qgsgui.cpp.

◆ nativePlatformInterface()

QgsNative * QgsGui::nativePlatformInterface ( )
static

Returns the global native interface, which offers abstraction to the host OS's underlying public interfaces.

Note
Not available in Python bindings

Definition at line 73 of file qgsgui.cpp.

◆ numericFormatGuiRegistry()

QgsNumericFormatGuiRegistry * QgsGui::numericFormatGuiRegistry ( )
static

Returns the global numeric format gui registry, used for registering the GUI widgets associated with QgsNumericFormats.

Since
QGIS 3.12

Definition at line 143 of file qgsgui.cpp.

◆ operator=()

QgsGui & QgsGui::operator= ( const QgsGui other)
delete

QgsGui cannot be copied.

◆ optionsChanged

void QgsGui::optionsChanged ( )
signal

This signal is emitted whenever the application options have been changed.

This signal is a "blanket" signal, and will be emitted whenever the options dialog has been accepted regardless of whether or not individual settings are changed. It is designed as a "last resort" fallback only, allowing widgets to respond to possible settings changes.

Since
QGIS 3.16

◆ processingGuiRegistry()

QgsProcessingGuiRegistry * QgsGui::processingGuiRegistry ( )
static

Returns the global processing gui registry, used for registering the GUI behavior of processing algorithms.

Since
QGIS 3.2

Definition at line 138 of file qgsgui.cpp.

◆ processingRecentAlgorithmLog()

QgsProcessingRecentAlgorithmLog * QgsGui::processingRecentAlgorithmLog ( )
static

Returns the global processing recent algorithm log, used for tracking recently used processing algorithms.

Since
QGIS 3.4

Definition at line 153 of file qgsgui.cpp.

◆ projectStorageGuiRegistry()

QgsProjectStorageGuiRegistry * QgsGui::projectStorageGuiRegistry ( )
static

Returns the global GUI-related project storage registry.

Since
QGIS 3.10

Definition at line 163 of file qgsgui.cpp.

◆ providerGuiRegistry()

QgsProviderGuiRegistry * QgsGui::providerGuiRegistry ( )
static

Returns the registry of GUI-related components of data providers.

Since
QGIS 3.10

Definition at line 168 of file qgsgui.cpp.

◆ pythonMacroAllowed()

bool QgsGui::pythonMacroAllowed ( void(*)()  lambda = nullptr,
QgsMessageBar messageBar = nullptr 
)
static

Returns true if python macros are currently allowed to be run If the global option is to ask user, a modal dialog will be shown.

Parameters
lambdaa pointer to a lambda method. If specified, the dialog is not modal, a message is shown with a button to enable macro. The lambda will be run either if macros are currently allowed or if the user accepts the message. The messageBar must be given in such case.
messageBarthe message bar must be provided if a lambda method is used.

Definition at line 320 of file qgsgui.cpp.

◆ relationWidgetRegistry()

QgsRelationWidgetRegistry * QgsGui::relationWidgetRegistry ( )
static

Returns the global relation widget registry, used for managing all known relation widget factories.

Since
QGIS 3.18

Definition at line 88 of file qgsgui.cpp.

◆ sampleColor()

QColor QgsGui::sampleColor ( QPoint  point)
static

Samples the color on screen at the specified global point (pixel).

Since
QGIS 3.10

Definition at line 235 of file qgsgui.cpp.

◆ settingsRegistryGui()

QgsSettingsRegistryGui * QgsGui::settingsRegistryGui ( )
static

Returns the gui's settings registry, used for managing gui settings.

Since
QGIS 3.22

Definition at line 78 of file qgsgui.cpp.

◆ setWindowManager()

void QgsGui::setWindowManager ( QgsWindowManagerInterface *  manager)
static

Sets the global window manager.

Ownership is transferred to the QgsGui instance.

See also
windowManager()
Since
QGIS 3.4

Definition at line 192 of file qgsgui.cpp.

◆ shortcutsManager()

QgsShortcutsManager * QgsGui::shortcutsManager ( )
static

Returns the global shortcuts manager, used for managing a QAction and QShortcut sequences.

Definition at line 113 of file qgsgui.cpp.

◆ sourceSelectProviderRegistry()

QgsSourceSelectProviderRegistry * QgsGui::sourceSelectProviderRegistry ( )
static

Returns the global source select provider registry, used for managing all known source select widget factories.

Definition at line 98 of file qgsgui.cpp.

◆ sourceWidgetProviderRegistry()

QgsProviderSourceWidgetProviderRegistry * QgsGui::sourceWidgetProviderRegistry ( )
static

Returns the registry of provider source widget providers.

Since
QGIS 3.18

Definition at line 108 of file qgsgui.cpp.

◆ subsetStringEditorProviderRegistry()

QgsSubsetStringEditorProviderRegistry * QgsGui::subsetStringEditorProviderRegistry ( )
static

Returns the registry of subset string editors of data providers.

Since
QGIS 3.18

Definition at line 103 of file qgsgui.cpp.

◆ windowManager()

QgsWindowManagerInterface * QgsGui::windowManager ( )
static

Returns the global window manager, if set.

See also
setWindowManager()
Since
QGIS 3.4

Definition at line 187 of file qgsgui.cpp.


The documentation for this class was generated from the following files: