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

#include <qgsgui.h>

Inheritance diagram for QgsGui:

Public Types
enum	HigFlag { HigMenuTextIsTitleCase = 1 << 0 , HigDialogTitleIsTitleCase = 1 << 1 }
	HIG flags, which indicate the Human Interface Guidelines for the current platform. More...

typedef QFlags< HigFlag >	HigFlags

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.

Public Member Functions
	QgsGui (const QgsGui &other)=delete

	~QgsGui ()

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

Static Public Member Functions
static QgsAdvancedDigitizingToolsRegistry *	advancedDigitizingToolsRegistry ()
	Returns the global advanced digitizing tools registry, used for registering advanced digitizing tools.

static QgsAnnotationItemGuiRegistry *	annotationItemGuiRegistry ()
	Returns the global annotation item GUI registry, used for registering the GUI behavior of annotation items.

static QgsCodeEditorColorSchemeRegistry *	codeEditorColorSchemeRegistry ()
	Returns the global code editor color scheme registry, used for registering the color schemes for QgsCodeEditor widgets.

static QgsDataItemGuiProviderRegistry *	dataItemGuiProviderRegistry ()
	Returns the global data item GUI provider registry, used for tracking providers which affect the browser GUI.

static QgsEditorWidgetRegistry *	editorWidgetRegistry ()
	Returns the global editor widget registry, used for managing all known edit widget factories.

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.

static QScreen *	findScreenAt (QPoint point)
	Returns the screen at the given global point (pixel).

static bool	hasWebEngine ()
	Checks whether QWebEngineView is available to display HTML content.

static QgsGui::HigFlags	higFlags ()
	Returns the platform's HIG flags.

static QgsHistoryProviderRegistry *	historyProviderRegistry ()
	Returns the global history provider registry, used for tracking history providers.

static void	initCalloutWidgets ()
	Initializes callout widgets.

static QgsInputControllerManager *	inputControllerManager ()
	Returns the global input controller manager.

static QgsGui *	instance ()
	Returns a pointer to the singleton instance.

static QgsLayerTreeEmbeddedWidgetRegistry *	layerTreeEmbeddedWidgetRegistry ()
	Returns the global layer tree embedded widget registry, used for registering widgets that may be embedded into layer tree view.

static QgsLayoutItemGuiRegistry *	layoutItemGuiRegistry ()
	Returns the global layout item GUI registry, used for registering the GUI behavior of layout items.

static QgsMapLayerActionRegistry *	mapLayerActionRegistry ()
	Returns the global map layer action registry, used for registering map layer actions.

static QgsMapToolShapeRegistry *	mapToolShapeRegistry ()
	Returns the registry of shape map tools.

static QgsNative *	nativePlatformInterface ()
	Returns the global native interface, which offers abstraction to the host OS's underlying public interfaces.

static QgsNumericFormatGuiRegistry *	numericFormatGuiRegistry ()
	Returns the global numeric format gui registry, used for registering the GUI widgets associated with QgsNumericFormats.

static QgsProcessingFavoriteAlgorithmManager *	processingFavoriteAlgorithmManager ()
	Returns the global Processing favorite algorithm manager, used for tracking favorite Processing algorithms.

static QgsProcessingGuiRegistry *	processingGuiRegistry ()
	Returns the global processing gui registry, used for registering the GUI behavior of processing algorithms.

static QgsProcessingRecentAlgorithmLog *	processingRecentAlgorithmLog ()
	Returns the global processing recent algorithm log, used for tracking recently used processing algorithms.

static QgsProjectStorageGuiRegistry *	projectStorageGuiRegistry ()
	Returns the global GUI-related project storage registry.

static QgsProviderGuiRegistry *	providerGuiRegistry ()
	Returns the registry of GUI-related components of data providers.

static bool	pythonEmbeddedInProjectAllowed (void(lambda)()=nullptr, QgsMessageBar messageBar=nullptr, Qgis::PythonEmbeddedType embeddedType=Qgis::PythonEmbeddedType::Macro)
	Returns `true` if python embedded in a project is currently allowed to be loaded.

static QgsRelationWidgetRegistry *	relationWidgetRegistry ()
	Returns the global relation widget registry, used for managing all known relation widget factories.

static QColor	sampleColor (QPoint point)
	Samples the color on screen at the specified global point (pixel).

static QgsSensorGuiRegistry *	sensorGuiRegistry ()
	Returns the registry of GUI-related components for sensors.

static QgsSettingsEditorWidgetRegistry *	settingsEditorWidgetRegistry ()
	Returns the registry of settings editors.

static QgsSettingsRegistryGui *	settingsRegistryGui ()
	Returns the gui's settings registry, used for managing gui settings.

static void	setWindowManager (QgsWindowManagerInterface *manager)
	Sets the global window manager.

static QgsShortcutsManager *	shortcutsManager ()
	Returns the global shortcuts manager, used for managing a QAction and QShortcut sequences.

static QgsSourceSelectProviderRegistry *	sourceSelectProviderRegistry ()
	Returns the global source select provider registry, used for managing all known source select widget factories.

static QgsProviderSourceWidgetProviderRegistry *	sourceWidgetProviderRegistry ()
	Returns the registry of provider source widget providers.

static QgsSubsetStringEditorProviderRegistry *	subsetStringEditorProviderRegistry ()
	Returns the registry of subset string editors of data providers.

static QgsWindowManagerInterface *	windowManager ()
	Returns the global window manager, if set.

Static Public Attributes
static QgsSettingsTreeNode *	sTtreeWidgetLastUsedValues = QgsSettingsTree::sTreeApp->createChildNode( QStringLiteral( "widget-last-used-values" ) )

Detailed Description

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

Definition at line 63 of file qgsgui.h.

Member Typedef Documentation

◆ HigFlags

typedef QFlags< HigFlag > QgsGui::HigFlags

Definition at line 273 of file qgsgui.h.

Member Enumeration Documentation

◆ HigFlag

enum QgsGui::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 268 of file qgsgui.h.

◆ ProjectCrsBehavior

enum QgsGui::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 74 of file qgsgui.h.

Constructor & Destructor Documentation

◆ QgsGui()

QgsGui::QgsGui ( const QgsGui & other )

delete

◆ ~QgsGui()

QgsGui::~QgsGui ( )

Definition at line 245 of file qgsgui.cpp.

Member Function Documentation

◆ advancedDigitizingToolsRegistry()

QgsAdvancedDigitizingToolsRegistry * QgsGui::advancedDigitizingToolsRegistry ( )

static

Returns the global advanced digitizing tools registry, used for registering advanced digitizing tools.

Since: QGIS 3.40

Definition at line 149 of file qgsgui.cpp.

◆ 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 144 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 164 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 179 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 94 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 209 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 291 of file qgsgui.cpp.

◆ hasWebEngine()

bool QgsGui::hasWebEngine ( )

static

Checks whether QWebEngineView is available to display HTML content.

Since: QGIS 3.42

Definition at line 530 of file qgsgui.cpp.

◆ higFlags()

QgsGui::HigFlags QgsGui::higFlags ( )

static

Returns the platform's HIG flags.

Since: QGIS 3.4

Definition at line 233 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 199 of file qgsgui.cpp.

◆ initCalloutWidgets()

void QgsGui::initCalloutWidgets ( )

static

Initializes callout widgets.

Note: Not available in Python bindings

Since: QGIS 3.40

Definition at line 497 of file qgsgui.cpp.

◆ inputControllerManager()

QgsInputControllerManager * QgsGui::inputControllerManager ( )

static

Returns the global input controller manager.

Since: QGIS 3.32

Definition at line 223 of file qgsgui.cpp.

◆ instance()

QgsGui * QgsGui::instance ( )

static

Returns a pointer to the singleton instance.

Definition at line 78 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 129 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 139 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 134 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 104 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 84 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 159 of file qgsgui.cpp.

◆ operator=()

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

delete

◆ 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

◆ processingFavoriteAlgorithmManager()

QgsProcessingFavoriteAlgorithmManager * QgsGui::processingFavoriteAlgorithmManager ( )

static

Returns the global Processing favorite algorithm manager, used for tracking favorite Processing algorithms.

Since: QGIS 3.40

Definition at line 169 of file qgsgui.cpp.

◆ 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 154 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 174 of file qgsgui.cpp.

◆ projectStorageGuiRegistry()

QgsProjectStorageGuiRegistry * QgsGui::projectStorageGuiRegistry ( )

static

Returns the global GUI-related project storage registry.

Since: QGIS 3.10

Definition at line 184 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 189 of file qgsgui.cpp.

◆ pythonEmbeddedInProjectAllowed()

bool QgsGui::pythonEmbeddedInProjectAllowed	(	void(*)()	lambda = `nullptr`,
		QgsMessageBar *	messageBar = `nullptr`,
		Qgis::PythonEmbeddedType	embeddedType = `Qgis::PythonEmbeddedType::Macro`
	)

static

Returns true if python embedded in a project is currently allowed to be loaded.

If the global option is to ask user, a modal dialog will be shown for macros or a button to enable Python expressions will be shown in a message bar.

Parameters

lambda	a 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.
messageBar	the message bar must be provided if a lambda method is used.
embeddedType	enum value to identify if macros or expression functions should be checked.

Note: Not available in Python bindings

Since: QGIS 3.40

Definition at line 374 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 99 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 276 of file qgsgui.cpp.

◆ sensorGuiRegistry()

QgsSensorGuiRegistry * QgsGui::sensorGuiRegistry ( )

static

Returns the registry of GUI-related components for sensors.

Since: QGIS 3.32

Definition at line 194 of file qgsgui.cpp.

◆ settingsEditorWidgetRegistry()

QgsSettingsEditorWidgetRegistry * QgsGui::settingsEditorWidgetRegistry ( )

static

Returns the registry of settings editors.

Since: QGIS 3.32

Definition at line 204 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 89 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 228 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 124 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 109 of file qgsgui.cpp.

◆ sourceWidgetProviderRegistry()

QgsProviderSourceWidgetProviderRegistry * QgsGui::sourceWidgetProviderRegistry ( )

static

Returns the registry of provider source widget providers.

Since: QGIS 3.18

Definition at line 119 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 114 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 218 of file qgsgui.cpp.

Member Data Documentation

◆ sTtreeWidgetLastUsedValues

QgsSettingsTreeNode* QgsGui::sTtreeWidgetLastUsedValues = QgsSettingsTree::sTreeApp->createChildNode( QStringLiteral( "widget-last-used-values" ) )

inlinestatic

Definition at line 69 of file qgsgui.h.

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

/build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/gui/qgsgui.h
/build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/gui/qgsgui.cpp

Public Types

Signals

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ HigFlags

Member Enumeration Documentation

◆ HigFlag

◆ ProjectCrsBehavior

Constructor & Destructor Documentation

◆ QgsGui()

◆ ~QgsGui()

Member Function Documentation

◆ advancedDigitizingToolsRegistry()

◆ annotationItemGuiRegistry()

◆ codeEditorColorSchemeRegistry()

◆ dataItemGuiProviderRegistry()

◆ editorWidgetRegistry()

◆ enableAutoGeometryRestore()

◆ findScreenAt()

◆ hasWebEngine()

◆ higFlags()

◆ historyProviderRegistry()

◆ initCalloutWidgets()

◆ inputControllerManager()

◆ instance()

◆ layerTreeEmbeddedWidgetRegistry()

◆ layoutItemGuiRegistry()

◆ mapLayerActionRegistry()

◆ mapToolShapeRegistry()

◆ nativePlatformInterface()

◆ numericFormatGuiRegistry()

◆ operator=()

◆ optionsChanged

◆ processingFavoriteAlgorithmManager()

◆ processingGuiRegistry()

◆ processingRecentAlgorithmLog()

◆ projectStorageGuiRegistry()

◆ providerGuiRegistry()

◆ pythonEmbeddedInProjectAllowed()

◆ relationWidgetRegistry()

◆ sampleColor()

◆ sensorGuiRegistry()

◆ settingsEditorWidgetRegistry()

◆ settingsRegistryGui()

◆ setWindowManager()

◆ shortcutsManager()

◆ sourceSelectProviderRegistry()

◆ sourceWidgetProviderRegistry()

◆ subsetStringEditorProviderRegistry()

◆ windowManager()

Member Data Documentation

◆ sTtreeWidgetLastUsedValues