QGIS API Documentation 3.39.0-Master (3aed037ce22)
|
QgsGui is a singleton class containing various registry and other global members related to GUI classes. More...
#include <qgsgui.h>
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 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 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 | 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. | |
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. | |
QgsGui is a singleton class containing various registry and other global members related to GUI classes.
typedef QFlags< HigFlag > QgsGui::HigFlags |
enum QgsGui::HigFlag |
|
delete |
QgsGui::~QgsGui | ( | ) |
Definition at line 238 of file qgsgui.cpp.
|
static |
Returns the global annotation item GUI registry, used for registering the GUI behavior of annotation items.
Definition at line 142 of file qgsgui.cpp.
|
static |
Returns the global code editor color scheme registry, used for registering the color schemes for QgsCodeEditor widgets.
Definition at line 157 of file qgsgui.cpp.
|
static |
Returns the global data item GUI provider registry, used for tracking providers which affect the browser GUI.
Definition at line 172 of file qgsgui.cpp.
|
static |
Returns the global editor widget registry, used for managing all known edit widget factories.
Definition at line 92 of file qgsgui.cpp.
|
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 202 of file qgsgui.cpp.
|
static |
Returns the screen at the given global point (pixel).
Definition at line 283 of file qgsgui.cpp.
|
static |
|
static |
Returns the global history provider registry, used for tracking history providers.
Definition at line 192 of file qgsgui.cpp.
|
static |
Initializes callout widgets.
Definition at line 436 of file qgsgui.cpp.
|
static |
Returns the global input controller manager.
Definition at line 216 of file qgsgui.cpp.
|
static |
Returns a pointer to the singleton instance.
Definition at line 76 of file qgsgui.cpp.
|
static |
Returns the global layer tree embedded widget registry, used for registering widgets that may be embedded into layer tree view.
Definition at line 127 of file qgsgui.cpp.
|
static |
Returns the global layout item GUI registry, used for registering the GUI behavior of layout items.
Definition at line 137 of file qgsgui.cpp.
|
static |
Returns the global map layer action registry, used for registering map layer actions.
Definition at line 132 of file qgsgui.cpp.
|
static |
Returns the registry of shape map tools.
Definition at line 102 of file qgsgui.cpp.
|
static |
Returns the global native interface, which offers abstraction to the host OS's underlying public interfaces.
Definition at line 82 of file qgsgui.cpp.
|
static |
Returns the global numeric format gui registry, used for registering the GUI widgets associated with QgsNumericFormats.
Definition at line 152 of file qgsgui.cpp.
|
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.
|
static |
Returns the global Processing favorite algorithm manager, used for tracking favorite Processing algorithms.
Definition at line 162 of file qgsgui.cpp.
|
static |
Returns the global processing gui registry, used for registering the GUI behavior of processing algorithms.
Definition at line 147 of file qgsgui.cpp.
|
static |
Returns the global processing recent algorithm log, used for tracking recently used processing algorithms.
Definition at line 167 of file qgsgui.cpp.
|
static |
Returns the global GUI-related project storage registry.
Definition at line 177 of file qgsgui.cpp.
|
static |
Returns the registry of GUI-related components of data providers.
Definition at line 182 of file qgsgui.cpp.
|
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.
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. |
Definition at line 363 of file qgsgui.cpp.
|
static |
Returns the global relation widget registry, used for managing all known relation widget factories.
Definition at line 97 of file qgsgui.cpp.
|
static |
Samples the color on screen at the specified global point (pixel).
Definition at line 268 of file qgsgui.cpp.
|
static |
Returns the registry of GUI-related components for sensors.
Definition at line 187 of file qgsgui.cpp.
|
static |
|
static |
Returns the gui's settings registry, used for managing gui settings.
Definition at line 87 of file qgsgui.cpp.
|
static |
Sets the global window manager.
Ownership is transferred to the QgsGui instance.
Definition at line 221 of file qgsgui.cpp.
|
static |
Returns the global shortcuts manager, used for managing a QAction and QShortcut sequences.
Definition at line 122 of file qgsgui.cpp.
|
static |
Returns the global source select provider registry, used for managing all known source select widget factories.
Definition at line 107 of file qgsgui.cpp.
|
static |
Returns the registry of provider source widget providers.
Definition at line 117 of file qgsgui.cpp.
|
static |
Returns the registry of subset string editors of data providers.
Definition at line 112 of file qgsgui.cpp.
|
static |
Returns the global window manager, if set.
Definition at line 211 of file qgsgui.cpp.