QgsGui Class Reference

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

#include <qgsgui.h>

Public Member Functions
	QgsGui (const QgsGui &other)=delete
	QgsGui cannot be copied. More...
	~QgsGui ()
QgsGui &	operator= (const QgsGui &other)=delete
	QgsGui cannot be copied. More...

Static Public Member Functions
static QgsEditorWidgetRegistry *	editorWidgetRegistry ()
	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 QgsGui *	instance ()
	Returns a pointer to the singleton instance. More...
static QgsLayerTreeEmbeddedWidgetRegistry *	layerTreeEmbeddedWidgetRegistry ()
	Returns the global layer tree embedded widget registry, used for registering widgets that may be embedded into layer tree view. More...
static QgsLayoutItemGuiRegistry *	layoutItemGuiRegistry ()
	Returns the global layout item GUI registry, used for registering the GUI behavior of layout items. More...
static QgsMapLayerActionRegistry *	mapLayerActionRegistry ()
	Returns the global map layer action registry, used for registering map layer actions. More...
static QgsNative *	nativePlatformInterface ()
	Returns the global native interface, which offers abstraction to the host OS's underlying public interfaces. More...
static QgsProcessingGuiRegistry *	processingGuiRegistry ()
	Returns the global processing gui registry, used for registering the GUI behavior of processing algorithms. More...
static QgsShortcutsManager *	shortcutsManager ()
	Returns the global shortcuts manager, used for managing a QAction and QShortcut sequences. More...
static QgsSourceSelectProviderRegistry *	sourceSelectProviderRegistry ()
	Returns the global source select provider registry, used for managing all known source select widget factories. 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 41 of file qgsgui.h.

Constructor & Destructor Documentation

QgsGui()

QgsGui::QgsGui ( const QgsGui &  other )

delete

QgsGui cannot be copied.

~QgsGui()

QgsGui::~QgsGui

(

)

Definition at line 91 of file qgsgui.cpp.

Member Function Documentation

editorWidgetRegistry()

QgsEditorWidgetRegistry * QgsGui::editorWidgetRegistry ( )

static

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

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

instance()

QgsGui * QgsGui::instance ( )

static

Returns a pointer to the singleton instance.

Definition at line 36 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 62 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 72 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 67 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 42 of file qgsgui.cpp.

operator=()

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

delete

QgsGui cannot be copied.

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 77 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 57 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 52 of file qgsgui.cpp.

---

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

• /tmp/buildd/qgis-3.2.0+99unstable/src/gui/qgsgui.h
• /tmp/buildd/qgis-3.2.0+99unstable/src/gui/qgsgui.cpp