gui

QgisInterface

QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugins.

Qgs3DSymbolDialog

A dialog for configuring a 3D symbol.

Qgs3DSymbolWidget

Base class for 3D symbol configuration widgets.

QgsAbstractDataSourceWidget

Abstract base Data Source Widget to create connections and add layers This class provides common functionality and the interface for all source select dialogs used by data providers to configure data sources and add layers.

QgsAbstractFileContentSourceLineEdit

Abstract base class for a widgets which allows users to select content from a file, embedding a file, etc.

QgsAbstractMapToolHandler

An abstract base class for map tool handlers which automatically handle all the necessary logic for toggling the map tool and enabling/disabling the associated action when the QGIS application is in a state permissible for the tool.

QgsAbstractRelationEditorConfigWidget

This class should be subclassed for every configurable relation widget type.

QgsAbstractRelationEditorWidget

Base class to build new relation widgets.

QgsAbstractRelationEditorWidgetFactory

Factory class for creating relation widgets and their corresponding config widgets

QgsAdvancedDigitizingCanvasItem

The QgsAdvancedDigitizingCanvasItem class draws the graphical elements of the CAD tools (QgsAdvancedDigitizingDockWidget) on the map canvas.

QgsAdvancedDigitizingDockWidget

The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of a selection of map tools. It handles both the UI and the constraints. Constraints are applied by implementing filters called from QgsMapToolAdvancedDigitizing.

QgsAdvancedDigitizingFloater

The QgsAdvancedDigitizingFloater class is widget that floats next to the mouse pointer, and allow interaction with the AdvancedDigitizing feature. It proxies display and actions to QgsMapToolAdvancedDigitizingDockWidget.

QgsAdvancedDigitizingTool

An abstract class for advanced digitizing tools.

QgsAdvancedDigitizingToolAbstractMetadata

Stores metadata about one advanced digitizing tool class.

QgsAdvancedDigitizingToolsRegistry

Registry of available advanced digitizing tools.

QgsAggregateToolButton

Offers a toolbutton to choose between different aggregate functions. Functions are filtered based on the type.

QgsAlignmentComboBox

A combo box which allows choice of alignment settings (e.g. left, right, …).

QgsAnimatedImageSourceLineEdit

A line edit widget with toolbutton for setting an animated raster image path.

QgsApplicationExitBlockerInterface

An interface that may be implemented to allow plugins or scripts to temporarily block the QGIS application from exiting.

QgsAttributeEditorContext

This class contains context information for attribute editor widgets. It will be passed to embedded widgets whenever this occurs (e.g. when showing an embedded form due to relations)

QgsAttributeForm

QgsAttributeFormEditorWidget

A widget consisting of both an editor widget and additional widgets for controlling the behavior of the editor widget depending on a number of possible modes. For instance, if the parent attribute form is in the multi edit mode, this widget will show both the editor widget and a tool button for controlling the multi edit results.

QgsAttributeFormInterface

QgsAttributeFormRelationEditorWidget

Widget to show for child relations on an attribute form.

QgsAttributeFormWidget

Base class for all widgets shown on a QgsAttributeForm. Consists of the widget which is visible in edit mode as well as the widget visible in search mode.

QgsAttributeTypeLoadDialog

QgsBlendModeComboBox

A combobox which lets the user select blend modes from a predefined list

QgsBrowserDockWidget

A dock widget containing a QgsBrowserWidget for navigating and managing data sources.

QgsBrowserTreeView

The QgsBrowserTreeView class extends QTreeView with save/restore tree state functionality.

QgsBrowserWidget

A widget showing a browser tree view along with toolbar and toggleable properties pane.

QgsBusyIndicatorDialog

A simple dialog to show an indeterminate busy progress indicator.

QgsCategoryDisplayLabelDelegate

A label delegate being able to display html encoded content

QgsCharacterSelectorDialog

A dialog for selecting a single character from a single font

QgsCheckableComboBox

QComboBox subclass which allows selecting multiple items.

QgsCollapsibleGroupBox

A groupbox that collapses/expands when toggled and can save its collapsed and checked states. By default, it auto-saves only its collapsed state to the global settings based on the widget and it’s parent names. Holding Alt modifier key when toggling collapsed state will synchronize the toggling across other collapsible group boxes with the same syncGroup QString value Holding Shift modifier key when attempting to toggle collapsed state will expand current group box, then collapse any others with

QgsCollapsibleGroupBoxBasic

A groupbox that collapses/expands when toggled. Basic class QgsCollapsibleGroupBoxBasic does not auto-save collapsed or checked state Holding Alt modifier key when toggling collapsed state will synchronize the toggling across other collapsible group boxes with the same syncGroup QString value Holding Shift modifier key when attempting to toggle collapsed state will expand current group box, then collapse any others with the same syncGroup QString value

QgsColorBox

A color box widget. This widget consists of a two dimensional rectangle filled with color variations, where a different color component varies along both the horizontal and vertical axis.

QgsColorBrewerColorRampDialog

A dialog which allows users to modify the properties of a QgsColorBrewerColorRamp.

QgsColorBrewerColorRampWidget

A widget which allows users to modify the properties of a QgsColorBrewerColorRamp.

QgsColorButton

A cross platform button subclass for selecting colors. Will open a color chooser dialog when clicked. Offers live updates to button from color chooser dialog. An attached drop-down menu allows for copying and pasting colors, picking colors from the screen, and selecting colors from color swatch grids.

QgsColorDialog

A custom QGIS dialog for selecting a color. Has many improvements over the standard Qt color picker dialog, including hue wheel supports, color swatches, and a color sampler.

QgsColorPreviewWidget

A preview box which displays one or two colors as swatches.

QgsColorRampButton

A cross platform button subclass for selecting color ramps. Will open color ramp dialogs when clicked. Offers live updates to button from color ramp dialog. An attached drop-down menu allows for access to saved color ramps, as well as option to invert the current color ramp and create new ramps.

QgsColorRampLegendNodeDialog

A dialog for configuring a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings).

QgsColorRampLegendNodeWidget

A widget for properties relating to a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings).

QgsColorRampWidget

A color ramp widget. This widget consists of an interactive box filled with a color which varies along its length by a single color component (e.g., varying saturation from 0 to 100%).

QgsColorSchemeList

An editable list of color swatches, taken from an associated QgsColorScheme.

QgsColorSchemeModel

A model for colors in a color scheme

QgsColorSliderWidget

A composite horizontal color ramp widget and associated spinbox for manual value entry.

QgsColorSwatchDelegate

A delegate for showing a color swatch in a list

QgsColorSwatchGrid

A grid of color swatches, which allows for user selection. Colors are taken from an associated QgsColorScheme.

QgsColorSwatchGridAction

A color swatch grid which can be embedded into a menu.

QgsColorTextWidget

A line edit widget which displays colors as text and accepts string representations of colors.

QgsColorWheel

A color wheel widget. This widget consists of an outer ring which allows for hue selection, and an inner rotating triangle which allows for saturation and value selection.

QgsColorWidget

A base class for interactive color widgets. Widgets can either allow setting a single component of a color (e.g., the red or green components), or an entire color. The QgsColorWidget also keeps track of any explicitly set hue for the color, so that this information is not lost when the widget is set to a color with an ambiguous hue (e.g., black or white shades).

QgsColorWidgetAction

An action containing a color widget, which can be embedded into a menu.

QgsCompoundColorWidget

A custom QGIS widget for selecting a color, including options for selecting colors via hue wheel, color swatches, and a color sampler.

QgsConfigureShortcutsDialog

Reusable dialog for allowing users to configure shortcuts contained in a QgsShortcutsManager.

QgsCredentialDialog

A generic dialog for requesting credentials

QgsCurveEditorWidget

A widget for manipulating QgsCurveTransform curves.

QgsCustomDropHandler

Abstract base class that may be implemented to handle new types of data to be dropped in QGIS.

QgsCustomProjectOpenHandler

Abstract base class that may be implemented to handle new project file types within the QGIS application.

QgsDataItemGuiContext

Encapsulates the context in which a QgsDataItem is shown within the application GUI.

QgsDataItemGuiProvider

Abstract base class for providers which affect how QgsDataItem items behave within the application GUI.

QgsDataItemGuiProviderRegistry

This class keeps a list of data item GUI providers that may affect how QgsDataItems behave within the application GUI.

QgsDataItemGuiProviderUtils

Utility functions for QgsDataItemGuiProviders.

QgsDataSourceSelectDialog

The QgsDataSourceSelectDialog class embeds the browser view to select an existing data source.

QgsDataSourceSelectWidget

The QgsDataSourceSelectWidget class embeds the browser view to select an existing data source.

QgsDatabaseSchemaComboBox

The QgsDatabaseSchemaComboBox class is a combo box which displays the list of schemas for a specific database connection.

QgsDatabaseTableComboBox

The QgsDatabaseTableComboBox class is a combo box which displays the list of tables for a specific database connection.

QgsDbRelationDialog

A dialog for configuration of the properties of a relationship in a database.

QgsDbRelationWidget

A widget for configuration of the properties of a relationship in a database.

QgsDetailedItemData

This class is the data only representation of a QgsDetailedItemWidget, designed to be used in custom views.

QgsDetailedItemDelegate

A custom model/view delegate that can display an icon, heading and detail sections.

QgsDetailedItemWidget

A widget renderer for detailed item views.

QgsDial

Constructor for QgsDial

QgsDialog

A generic dialog with layout and button box

QgsDirectionalLightWidget

Widget for direction light settings

QgsDockWidget

QgsDockWidget subclass with more fine-grained control over how the widget is closed or opened.

QgsDoubleValidator

QgsDoubleValidator is a QLineEdit Validator that combines QDoubleValidator and QRegularExpressionValidator to allow users to enter doubles with both local and C interpretation as a fallback.

QgsEncodingFileDialog

A file dialog which lets the user select the preferred encoding type for a data provider.

QgsEncodingSelectionDialog

A dialog which presents the user with a choice of file encodings.

QgsErrorDialog

Constructor for QgsErrorDialog

QgsExpressionBuilderDialog

A generic dialog for building expression strings

QgsExpressionBuilderWidget

A reusable widget that can be used to build a expression string. See QgsExpressionBuilderDialog for example of usage.

QgsExpressionHighlighter

QgsExpressionItem

An expression item that can be used in the QgsExpressionBuilderWidget tree.

QgsExpressionItemSearchProxy

Search proxy used to filter the QgsExpressionBuilderWidget tree. The default search for a tree model only searches top level this will handle one level down

QgsExpressionLineEdit

The QgsExpressionLineEdit widget includes a line edit for entering expressions together with a button to open the expression creation dialog.

QgsExpressionPreviewWidget

QgsExpressionPreviewWidget is a widget to preview an expression result. If the layer is set, one can browse across features to see the different outputs.

QgsExpressionSelectionDialog

This class offers a dialog to change feature selections. To do so, a QgsExpressionBuilderWidget is shown in a dialog. It offers the possibilities to create a new selection, add to the current selection remove from the current selection or select within the current selection.

QgsExpressionStoreDialog

A generic dialog for editing expression text, label and help text.

QgsExpressionTreeView

QgsExpressionTreeView is a tree view to list all expressions functions, variables and fields that can be used in an expression.

QgsExtentGroupBox

Collapsible group box for configuration of extent, typically for a save operation.

QgsExtentWidget

A widget for configuration of a map extent.

QgsExternalResourceWidget

Widget to display file path with a push button for an “open file” dialog It can also be used to display a picture or a web page.

QgsExternalStorageFileWidget

The QgsExternalStorageFileWidget class creates a widget for selecting a file or a folder and stores it to a given external storage backend if defined

QgsFeatureListComboBox

This offers a combobox with autocompleter that allows selecting features from a layer.

QgsFeaturePickerWidget

This offers a combobox with autocompleter that allows selecting features from a layer.

QgsFeatureSelectionDlg

Constructor for QgsFeatureSelectionDlg

QgsFieldComboBox

The QgsFieldComboBox is a combo box which displays the list of fields of a given layer. It might be combined with a QgsMapLayerComboBox to automatically update fields according to a chosen layer. If expression must be used, QgsFieldExpressionWidget shall be used instead.

QgsFieldDomainDialog

A dialog for configuration of the properties of a QgsFieldDomain.

QgsFieldDomainWidget

A widget for configuration of the properties of a QgsFieldDomain.

QgsFieldExpressionWidget

The QgsFieldExpressionWidget class creates a widget to choose fields and edit expressions It contains a combo box to display the fields and expression and a button to open the expression dialog. The combo box is editable, allowing expressions to be edited inline. The validity of the expression is checked live on key press, invalid expressions are displayed in red. The expression will be added to the model (and the fieldChanged signals emitted) only when editing in the line edit is fi

QgsFieldMappingModel

The QgsFieldMappingModel holds mapping information for mapping from one set of QgsFields to another, for each set of “destination” fields an expression defines how to obtain the values of the “destination” fields. The model can be optionally set “editable” allowing to modify all the fields, by default only the mapping expression is editable.

QgsFieldMappingWidget

The QgsFieldMappingWidget class creates a mapping from one set of QgsFields to another, for each set of “destination” fields an expression defines how to obtain the values of the “destination” fields.

QgsFieldValidator

QgsFieldValuesLineEdit

A line edit with an autocompleter which takes unique values from a vector layer’s fields. The autocompleter is populated from the vector layer in the background to ensure responsive interaction with the widget.

QgsFileDownloaderDialog

QgsFileDownloaderDialog is a QProgressDialog subclass which handles file downloads and user feedback.

QgsFileWidget

The QgsFileWidget class creates a widget for selecting a file or a folder.

QgsFilterLineEdit

QLineEdit subclass with built in support for clearing the widget’s value and handling custom null value representations.

QgsFindFilesByPatternDialog

A dialog for finding files (recursively) by file pattern.

QgsFindFilesByPatternWidget

A reusable widget for finding files (recursively) by file pattern.

QgsFloatingWidget

A QWidget subclass for creating widgets which float outside of the normal Qt layout system. Floating widgets use an “anchor widget” to determine how they are anchored within their parent widget.

QgsFocusWatcher

A event filter for watching for focus events on a parent object. Usually QObjects must subclass and override methods like focusOutEvent to handle focus events. Using this class as an event filter avoids the need to subclass objects and the focus events can be directly caught using the emitted signals.

QgsFontButton

A button for customizing QgsTextFormat settings.

QgsGeometryRubberBand

A rubberband class for QgsAbstractGeometry (considering curved geometries).

QgsGeometryWidget

A widget for storing and interacting with a QgsGeometry object.

QgsGradientColorRampDialog

A dialog which allows users to modify the properties of a QgsGradientColorRamp.

QgsGradientStopEditor

An interactive editor for previewing a gradient color ramp and modifying the position of color stops along the gradient.

QgsGroupBoxCollapseButton

QgsGroupWmsDataDialog

QgsGui

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

QgsHelp

Helper class for showing help topic URI for the given key.

QgsHighlight

A class for highlight features on the map.

QgsHighlightableLineEdit

A QgsFilterLineEdit subclass with the ability to “highlight” the edges of the widget.

QgsHistogramWidget

Graphical histogram for displaying distributions of field values.

QgsHttpHeaderWidget

Display referer http header field and collapsible table of key/value

QgsIdentifyMenu

The QgsIdentifyMenu class builds a menu to be used with identify results (QgsMapToolIdentify). It is customizable and can display attribute actions (QgsAction) as well as map layer actions (QgsMapLayerAction). It can also embed custom map layer actions, defined for this menu exclusively. If used in a QgsMapToolIdentify, it is accessible via QgsMapToolIdentify.identifyMenu() and can be customized in the map tool sub-class.

QgsImageSourceLineEdit

A line edit widget with toolbutton for setting a raster image path.

QgsKeyValueWidget

Widget allowing to edit a QVariantMap, using a table.

QgsLUDialog

QgsLayerMetadataResultsModel

The QgsLayerMetadataResultsModel class handles the metadata fetching from the registered layer metadata providers.

QgsLayerMetadataResultsProxyModel

The QgsLayerMetadataResultsProxyModel class is a proxy model for QgsLayerMetadataResultsModel, it handles text and extent filtering.

QgsLayerMetadataSearchWidget

The QgsLayerMetadataSearchWidget class offers layer metadata search and filtering. It is designed to be embedded in the data source manager dialog.

QgsLayerPropertiesDialog

Base class for “layer properties” dialogs, containing common utilities for handling functionality in these dialog.

QgsLegendFilterButton

A tool button that allows enabling or disabling legend filter by contents of the map. An additional pop down menu allows defining a boolean expression to refine the filtering.

QgsLegendPatchShapeButton

A button for creating and modifying QgsLegendPatchShape settings.

QgsLegendPatchShapeDialog

A dialog for configuring a custom legend patch shape.

QgsLegendPatchShapeWidget

Widget for configuring a custom legend patch shape.

QgsLimitedRandomColorRampDialog

A dialog which allows users to modify the properties of a QgsLimitedRandomColorRamp.

QgsLimitedRandomColorRampWidget

A widget which allows users to modify the properties of a QgsLimitedRandomColorRamp.

QgsListWidget

Widget allowing to edit a QVariantList, using a table.

QgsLongLongValidator

QgsManageConnectionsDialog

Constructor for QgsManageConnectionsDialog.

QgsMapCanvas

Map canvas is a class for displaying all GIS data types on a canvas.

QgsMapCanvasAnnotationItem

An interactive map canvas item which displays a QgsAnnotation.

QgsMapCanvasInteractionBlocker

An interface for objects which block interactions with a QgsMapCanvas.

QgsMapCanvasItem

An abstract class for items that can be placed on the map canvas.

QgsMapCanvasSnappingUtils

Snapping utils instance that is connected to a canvas and updates the configuration (map settings + current layer) whenever that is changed in the canvas.

QgsMapCanvasTracer

Extension of QgsTracer that provides extra functionality:

QgsMapCanvasUtils

Utility functions for working with QgsMapCanvas widgets.

QgsMapLayerComboBox

A combobox which displays a dynamic list of layers from a QGIS project.

QgsMapLayerConfigWidget

A panel widget that can be shown in the map style dock

QgsMapLayerConfigWidgetContext

Encapsulates the context for a QgsMapLayerConfigWidget.

QgsMapLayerConfigWidgetFactory

Factory class for creating custom map layer property pages

QgsMapLayerStyleCategoriesModel

Model for layer style categories

QgsMapLayerStyleManagerWidget

The QgsMapLayerStyleManagerWidget class which is used to visually manage the layer styles.

QgsMapMouseEvent

A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas. It is sent whenever the user moves, clicks, releases or double clicks the mouse. In addition to the coordinates in pixel space it also knows the coordinates in the mapcanvas’ CRS as well as it knows the concept of snapping.

QgsMapOverviewCanvas

A widget that displays an overview map.

QgsMapTip

A maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature.

QgsMapUnitScaleDialog

A dialog which allows the user to choose the minimum and maximum scale of an object in map units and millimeters. This dialog is designed to allow users to edit the properties of a QgsMapUnitScale object.

QgsMapUnitScaleWidget

A widget which allows the user to choose the minimum and maximum scale of an object in map units and millimeters. This widget is designed to allow users to edit the properties of a QgsMapUnitScale object.

QgsMediaWidget

The QgsMediaWidget class creates a widget for playing back audio and video media files.

QgsMenuHeader

Custom widget for displaying subheaders within a QMenu in a standard style.

QgsMenuHeaderWidgetAction

Custom QWidgetAction for displaying subheaders within a QMenu in a standard style.

QgsMessageBar

A bar for displaying non-blocking messages to the user.

QgsMessageBarItem

Represents an item shown within a QgsMessageBar widget.

QgsMessageLogViewer

A generic dialog widget for displaying QGIS log messages.

QgsMessageViewer

A generic message view for displaying QGIS messages.

QgsMetadataWidget

A wizard to edit metadata on a map layer.

QgsNewAuxiliaryFieldDialog

A dialog to create a new auxiliary field

QgsNewAuxiliaryLayerDialog

A dialog to create a new auxiliary layer

QgsNewDatabaseTableNameDialog

QgsNewDatabaseTableNameDialog is a dialog which allows selection of a DB schema and a new table name.

QgsNewDatabaseTableNameWidget

The QgsNewDatabaseTableNameWidget class embeds the browser view to select a DB schema and a new table name.

QgsNewGeoPackageLayerDialog

Dialog to set up parameters to create a new GeoPackage layer, and on accept() to create it and add it to the layers

QgsNewHttpConnection

Dialog to allow the user to configure and save connection information for an HTTP Server for WMS, etc.

QgsNewMemoryLayerDialog

New dialog constructor.

QgsNewNameDialog

New name, for example new layer name dialog. If existing names are provided, the dialog warns users if an entered name already exists.

QgsNewVectorLayerDialog

New dialog constructor.

QgsNewVectorTableDialog

The QgsNewVectorTableDialog class is a provider-agnostic database vector and aspatial table designer dialog based on the connections API.

QgsOWSSourceSelect

Dialog to create connections and add layers WCS etc.

QgsOpacityWidget

A widget for setting an opacity value.

QgsOptionsDialogBase

A base dialog for options and properties dialogs that offers vertical tabs. It handles saving/restoring of geometry, splitter and current tab states, switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left), and connecting QDialogButtonBox’s accepted/rejected signals to dialog’s accept/reject slots

QgsOptionsDialogHighlightButton

A highlight widget for buttons. This is used to search and highlight text in QgsOptionsDialogBase implementations.

QgsOptionsDialogHighlightCheckBox

A highlight widget for checkboxes. This is used to search and highlight text in QgsOptionsDialogBase implementations.

QgsOptionsDialogHighlightGroupBox

A highlight widget for group boxes. This is used to search and highlight text in QgsOptionsDialogBase implementations.

QgsOptionsDialogHighlightLabel

A highlight widget for labels. This is used to search and highlight text in QgsOptionsDialogBase implementations.

QgsOptionsDialogHighlightTable

A highlight widget for table widgets. This is used to search and highlight text in QgsOptionsDialogBase implementations.

QgsOptionsDialogHighlightTree

A highlight widget for trees. This is used to search and highlight text in QgsOptionsDialogBase implementations. Highlighting is only available for tree widgets only while searching can be performed in any tree view or inherited class.

QgsOptionsDialogHighlightWidget

Container for a widget to be used to search text in the option dialog If the widget type is handled, it is valid. It can perform a text search in the widget and highlight it in case of success. This uses stylesheets.

QgsOptionsPageWidget

Base class for widgets for pages included in the options dialog.

QgsOptionsWidgetFactory

QgsOrderByDialog

This is a dialog to build and manage a list of order by clauses.

QgsOverlayWidgetLayout

A custom layout which can be used to overlay child widgets over a parent widget.

QgsPanelWidget

Base class for any widget that can be shown as a inline panel

QgsPanelWidgetStack

A stack widget to manage panels in the interface. Handles the open and close events for added panels. Any widgets that want to have a non blocking panel based interface should use this class to manage the panels.

QgsPanelWidgetWrapper

Wrapper widget for existing widgets which can’t have the inheritance tree changed, e.g dialogs.

QgsPasswordLineEdit

QLineEdit subclass with built in support for showing/hiding entered password.

QgsPercentageWidget

A widget for setting a percentage value.

QgsPictureSourceLineEditBase

A line edit widget with toolbutton for setting a raster image path.

QgsPixmapLabel

The QgsPixmapLabel class shows a pixmap and adjusts its size to the space given to the widget by the layout and keeping its aspect ratio.

QgsPlaybackControllerWidget

A compound widget containing a set of buttons for controlling media playback.

QgsPluginManagerInterface

QgsPointCloudAttributeComboBox

The QgsPointCloudAttributeComboBox is a combo box which displays the list of attributes of a given point cloud layer. It might be combined with a QgsMapLayerComboBox to automatically update attributes according to a chosen layer.

QgsPointCloudQueryBuilder

Query Builder for layers.

QgsPresetColorRampDialog

A dialog which allows users to modify the properties of a QgsPresetSchemeColorRamp.

QgsPresetColorRampWidget

A widget which allows users to modify the properties of a QgsPresetSchemeColorRamp.

QgsPreviewEffect

A graphics effect which can be applied to a widget to simulate various printing and color blindness modes.

QgsProjectStorageGuiProvider

Abstract interface for project storage GUI - to be implemented by various backends and registered in QgsProjectStorageGuiRegistry.

QgsProjectStorageGuiRegistry

A registry / canonical manager of GUI parts of project storage backends.

QgsPropertyAssistantWidget

Shows a user-friendly assistant guiding users through the creation of QgsProperty overrides.

QgsPropertyOverrideButton

A button for controlling property overrides which may apply to a widget.

QgsProviderConnectionComboBox

The QgsProviderConnectionComboBox class is a combo box which displays the list of connections registered for a given provider.

QgsProviderGuiMetadata

Holds data for GUI part of the data providers

QgsProviderGuiRegistry

A registry / canonical manager of GUI parts of data providers.

QgsProviderSourceWidget

Base class for widgets which allow customization of a provider’s source URI.

QgsProviderSourceWidgetProvider

An interface for providers of widgets designed to configure a data provider’s source.

QgsProviderSourceWidgetProviderRegistry

This class keeps a list of provider source widget providers.

QgsProviderSublayersDialog

Dialog for selecting provider sublayers.

QgsProxyStyle

A QProxyStyle subclass which correctly sets the base style to match the QGIS application style, and handles object lifetime by correctly parenting to a parent widget.

QgsQueryBuilder

Query Builder for layers.

QgsQueryResultWidget

The QgsQueryResultWidget class allows users to enter and run an SQL query on a DB connection (an instance of QgsAbstractDatabaseProviderConnection).

QgsRangeSlider

A slider control with two interactive endpoints, for interactive selection of a range of values.

QgsRasterFormatSaveOptionsWidget

A widget to select format-specific raster saving options

QgsRasterLayerSaveAsDialog

Constructor for QgsRasterLayerSaveAsDialog

QgsRasterPyramidsOptionsWidget

A widget to select format-specific raster saving options

QgsRatioLockButton

A cross platform button subclass used to represent a locked / unlocked ratio state.

QgsRelationEditorConfigWidget

Creates a new configuration widget for the relation editor widget

QgsRelationEditorWidget

The default relation widget in QGIS.

QgsRelationWidgetRegistry

Keeps track of the registered relations widgets. New widgets can be registered, old ones deleted. The default {QgsRelationEditorWidget} is protected from removing.

QgsRichTextEditor

A widget for editing rich text documents, with support for user controlled formatting of text and insertion of hyperlinks and images.

QgsRubberBand

A class for drawing transient features (e.g. digitizing lines) on the map.

QgsScaleComboBox

A combobox which lets the user select map scale from predefined list and highlights nearest to current scale value

QgsScaleRangeWidget

A widget allowing entry of a range of map scales, e.g. minimum scale and maximum scale.

QgsScaleVisibilityDialog

A dialog allowing users to enter a scale visibility range.

QgsScaleWidget

A combobox which lets the user select map scale from predefined list and highlights nearest to current scale value

QgsScreenHelper

A utility class for dynamic handling of changes to screen properties.

QgsScrollArea

A QScrollArea subclass with improved scrolling behavior.

QgsScrollBarHighlight

Encapsulates the details of a highlight in a scrollbar, used alongside QgsScrollBarHighlightController.

QgsScrollBarHighlightController

Adds highlights (colored markers) to a scrollbar.

QgsSearchQueryBuilder

Query Builder for search strings

QgsShortcutsManager

Shortcuts manager is a class that contains a list of QActions and QShortcuts that have been registered and their shortcuts can be changed.

QgsSlider

Constructor for QgsSlider

QgsSnapIndicator

Class that shows snapping marker on map canvas for the current snapping match.

QgsSnapToGridCanvasItem

Shows a grid on the map canvas given a spatial resolution.

QgsSourceSelectProvider

This is the interface for those who want to add entries to the QgsDataSourceManagerDialog

QgsSourceSelectProviderRegistry

This class keeps a list of source select providers that may add items to the QgsDataSourceManagerDialog When created, it automatically adds providers from data provider plugins (e.g. PostGIS, WMS, …)

QgsStatusBar

A proxy widget for QStatusBar.

QgsStyleItemsListWidget

A reusable widget for showing a filtered list of entities from a QgsStyle database.

QgsSublayersDialog

Deprecated since version 3.40.

QgsSubsetStringEditorInterface

Interface for a dialog that can edit subset strings

QgsSubsetStringEditorProvider

This is the interface for those who want to provide a dialog to edit a subset string.

QgsSubsetStringEditorProviderRegistry

This class keeps a list of subset string editor providers.

QgsSubstitutionListDialog

A dialog which allows users to specify a list of substitutions to apply to a string, with options for exporting and importing substitution lists.

QgsSubstitutionListWidget

A widget which allows users to specify a list of substitutions to apply to a string, with options for exporting and importing substitution lists.

QgsSvgSourceLineEdit

A line edit widget with toolbutton for setting an SVG image path.

QgsSymbolButton

A button for creating and modifying QgsSymbol settings.

QgsTabWidget

The QgsTabWidget class is the same as the QTabWidget but with additional methods to temporarily hide/show tabs.

QgsTableView

A QTableView subclass with QGIS specific tweaks and improvements.

QgsTableWidgetBase

Base widget allowing to edit a collection, using a table.

QgsTableWidgetItem

This can be used like a regular QTableWidgetItem with the difference that a specific role can be set to sort.

QgsTaskManagerWidget

A widget which displays tasks from a QgsTaskManager and allows for interaction with the manager.

QgsTemporalControllerWidget

A widget for controlling playback properties of a QgsTemporalController.

QgsTextFormatDialog

A simple dialog for customizing text formatting settings.

QgsTextFormatPanelWidget

A panel widget for customizing text formatting settings.

QgsTextFormatWidget

A widget for customizing text formatting settings.

QgsTextPreview

A widget for previewing text formatting settings.

QgsToolTipComboBox

QComboBox subclass which features a tooltip when mouse hovering the combobox. The tooltip string is taken from the current item’s Qt.ToolTipRole data.

QgsTreeWidgetItem

QTreeWidgetItem subclass with custom handling for item sorting.

QgsTreeWidgetItemObject

Custom QgsTreeWidgetItem with extra signals when item is edited.

QgsUnitSelectionWidget

A widget displaying a combobox allowing the user to choose between various display units, such as millimeters or map units.

QgsUserInputWidget

The QgsUserInputWidget class is a floating widget that shall be used to display widgets for user inputs. It can be used by map tools, plugins, etc. Several widgets can be displayed at once, they will be separated by a separator. Widgets will be either layout horizontally or vertically. The widget is automatically hidden if it contains no widget.

QgsVScrollArea

QgsVScrollArea is a QScrollArea subclass which only displays a vertical scrollbar and fits the width to the contents.

QgsValidityCheckResultsModel

A QAbstractItemModel subclass for displaying the results from a QgsAbstractValidityCheck.

QgsValidityCheckResultsWidget

A reusable widget which displays a summary of the results from a QgsAbstractValidityCheck (or checks).

QgsVariableEditorWidget

A tree based widget for editing expression context scope variables. The widget allows editing variables from a QgsExpressionContextScope, and can optionally also show inherited variables from a QgsExpressionContext.

QgsVectorLayerTemporalPropertiesWidget

A widget for configuring the temporal properties for a vector layer.

QgsVertexMarker

A class for marking vertices of features using e.g. circles or ‘x’.

QgsWindowManagerInterface

Interface for window manager.

Annotations and Annotation Layers

QgsAnnotationItemAbstractGuiMetadata

Stores GUI metadata about one annotation item class.

QgsAnnotationItemBaseWidget

A base class for property widgets for annotation items.

QgsAnnotationItemCommonPropertiesWidget

A widget for configuring common properties for QgsAnnotationItems

QgsAnnotationItemGuiGroup

Stores GUI metadata about a group of annotation item classes.

QgsAnnotationItemGuiRegistry

Registry of available annotation item GUI behavior.

QgsCreateAnnotationItemMapToolHandler

A handler object for map tools which create annotation items.

QgsCreateAnnotationItemMapToolInterface

An interface for map tools which create annotation items.

QgsFormAnnotation

An annotation item that embeds a designer form showing the feature

Attribute Editor Widgets

QgsActionWidgetWrapper

Wraps a button widget to launch a layer action.

QgsCheckboxSearchWidgetWrapper

Wraps a checkbox edit widget for searching.

QgsDateEdit

The QgsDateEdit class is a QDateEdit widget with the capability of setting/reading null dates.

QgsDateTimeEdit

The QgsDateTimeEdit class is a QDateTimeEdit with the capability of setting/reading null date/times.

QgsDateTimeSearchWidgetWrapper

Wraps a date/time edit widget for searching.

QgsDefaultSearchWidgetWrapper

Wraps a search widget. Default form is just a QgsLineFilterEdit

QgsDoubleSpinBox

The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. The clear value can be either the minimum or the maiximum value of the spin box or a custom value. This value can then be handled by a special value text.

QgsHtmlWidgetWrapper

Wraps a QQuickWidget to display HTML code

QgsJsonEditWidget

The QgsJsonEditWidget is a widget to display JSON data in a code highlighted text or tree form.

QgsMultiEditToolButton

A tool button widget which is displayed next to editor widgets in attribute forms, and allows for controlling how the widget behaves and interacts with the form while in multi edit mode.

QgsQmlWidgetWrapper

Wraps a QQuickWidget to display QML code

QgsRelationAggregateSearchWidgetWrapper

Search widget for the children of a relation. For each attribute of the child, an additional QgsAggregateToolButton will be shown to determine how the values should be aggregated for searching.

QgsRelationReferenceSearchWidgetWrapper

Wraps a relation reference search widget.

QgsRelationReferenceWidget

QgsRelationReferenceWidgetWrapper

Wraps a relation reference widget.

QgsRelationWidgetWrapper

Constructor for QgsRelationWidgetWrapper

QgsSearchWidgetToolButton

A tool button widget which is displayed next to search widgets in forms, and allows for controlling how the widget behaves and how the filtering/searching operates.

QgsSpacerWidgetWrapper

Wraps a spacer widget.

QgsSpinBox

The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. The clear value can be either the minimum or the maiximum value of the spin box or a custom value. This value can then be handled by a special value text.

QgsTextWidgetWrapper

Wraps a label widget to display text

QgsTimeEdit

The QgsTimeEdit class is a QTimeEdit widget with the capability of setting/reading null date/times.

QgsValueMapSearchWidgetWrapper

Wraps a value map search widget. This widget will offer a combobox with values from another layer referenced by a foreign key (a constraint may be set but is not required on data level). It will be used as a search widget and produces expression to look for in the layer.

QgsValueRelationSearchWidgetWrapper

Wraps a value relation search widget. This widget will offer a combobox with values from another layer referenced by a foreign key (a constraint may be set but is not required on data level). It will be used as a search widget and produces expression to look for in the layer.

Attribute Editor Widgets - Core

QgsEditorConfigWidget

This class should be subclassed for every configurable editor widget type.

QgsEditorWidgetAutoConfPlugin

Base class for plugins allowing to pick automatically a widget type for editing fields.

QgsEditorWidgetFactory

Every attribute editor widget needs a factory, which inherits this class

QgsEditorWidgetRegistry

This class manages all known edit widget factories.

QgsEditorWidgetWrapper

Manages an editor widget Widget and wrapper share the same parent

QgsSearchWidgetWrapper

Shows a search widget on a filter form.

QgsWidgetWrapper

Manages an editor widget Widget and wrapper share the same parent

Attribute Table and Forms

QgsAttributeTableAction

Create a new attribute table action.

QgsAttributeTableDelegate

A delegate item class for QgsAttributeTable (see Qt documentation for QItemDelegate).

QgsAttributeTableFilterModel

Make sure, the master model is already loaded, so the selection will get synchronized.

QgsAttributeTableMapLayerAction

QgsAttributeTableModel

A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a QAbstractItemView.

QgsAttributeTableView

Provides a table view of features of a QgsVectorLayer.

QgsDualView

This widget is used to show the attributes of a set of features of a QgsVectorLayer. The attributes can be edited. It supports two different layouts: the table layout, in which the attributes for the features are shown in a table and the editor layout, where the features are shown as a selectable list and the attributes for the currently selected feature are shown in a form.

QgsEditConditionalFormatRuleWidget

A widget for customizing an individual conditional formatting rule.

QgsFeatureListModel

Constructor for QgsFeatureListModel

QgsFeatureListView

Shows a list of features and renders a edit button next to each feature.

QgsFeatureListViewDelegate

QgsFeatureModel

QgsFeatureSelectionModel

QgsFieldConditionalFormatWidget

A widget for customizing conditional formatting options.

QgsIFeatureSelectionManager

Is an interface class to abstract feature selection handling.

QgsOrganizeTableColumnsDialog

Dialog for organising (hiding and reordering) columns in the attributes table.

Authentication Framework

QgsAuthAuthoritiesEditor

Widget for viewing and editing authentication identities database

QgsAuthCertEditors

Wrapper widget to manage available certificate editors

QgsAuthCertInfo

Widget for viewing detailed info on a certificate and its hierarchical trust chain

QgsAuthCertInfoDialog

Dialog wrapper for widget displaying detailed info on a certificate and its hierarchical trust chain

QgsAuthCertManager

Dialog wrapper for widget to manage available certificate editors

QgsAuthCertTrustPolicyComboBox

Widget for editing the trust policy associated with a Certificate (Intermediate) Authority

QgsAuthConfigEditor

Widget for editing authentication configuration database

QgsAuthConfigSelect

Selector widget for authentication configs

QgsAuthConfigUriEdit

Dialog wrapper of select widget to edit an authcfg in a data source URI

QgsAuthEditorWidgets

Wrapper widget for available authentication editors

QgsAuthIdentitiesEditor

Widget for viewing and editing authentication identities database

QgsAuthImportCertDialog

Widget for importing a certificate into the authentication database

QgsAuthImportIdentityDialog

Widget for importing an identity certificate/key bundle into the authentication database

QgsAuthMethodEdit

Abstract base class for the edit widget of authentication method plugins

QgsAuthMethodPlugins

Dialog for viewing available authentication method plugins

QgsAuthServersEditor

Widget for viewing and editing servers in authentication database

QgsAuthSettingsWidget

Widget for entering authentication credentials both in the form username/password and by using QGIS Authentication Database and its authentication configurations.

QgsAuthSslConfigDialog

Dialog wrapper of widget for editing an SSL server configuration

QgsAuthSslConfigWidget

Widget for editing an SSL server configuration

QgsAuthSslErrorsDialog

Widget for reporting SSL errors and offering an option to store an SSL server exception into the authentication database

QgsAuthSslImportDialog

Widget for importing an SSL server certificate exception into the authentication database

QgsAuthTrustedCAsDialog

Widget for listing trusted Certificate (Intermediate) Authorities used in secure connections

Browser

QgsBrowserGuiModel

A model for showing available data sources and other items in a structured tree.

Code Editors

QgsCodeEditor

A text editor based on QScintilla2.

QgsCodeEditorCSS

A CSS editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorColorScheme

Defines a color scheme for use in QgsCodeEditor widgets.

QgsCodeEditorColorSchemeRegistry

A registry of color schemes for use in QgsCodeEditor widgets.

QgsCodeEditorDockWidget

A custom dock widget for code editors.

QgsCodeEditorExpression

A QGIS expression editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorHTML

A HTML editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorJavascript

A Javascript editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorJson

A JSON editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorPython

A Python editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorR

A R stats code editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorSQL

A SQL editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorShell

A shell script code editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

QgsCodeEditorWidget

A widget which wraps a QgsCodeEditor in additional functionality.

QgsCodeInterpreter

An interface for code interpreters.

Coordinate Systems and Transformations

QgsCoordinateBoundsPreviewMapWidget

A widget for showing the bounds of a rectangular region on an interactive map.

QgsCoordinateOperationWidget

A widget for selecting the coordinate operation to use when transforming between a source and destination coordinate reference system.

QgsCoordinateReferenceSystemModel

A tree model for display of known coordinate reference systems.

QgsCoordinateReferenceSystemProxyModel

A sort/filter proxy model for coordinate reference systems.

QgsCrsDefinitionWidget

A widget for definition a custom coordinate reference system.

QgsCrsSelectionWidget

A generic widget allowing users to pick a Coordinate Reference System (or define their own).

QgsProjectionSelectionDialog

A generic dialog to prompt the user for a Coordinate Reference System.

QgsProjectionSelectionTreeWidget

A widget for selecting a coordinate reference system from a tree.

QgsProjectionSelectionWidget

A widget for selecting a projection.

QgsRecentCoordinateReferenceSystemsModel

A model for display of recently used coordinate reference systems.

QgsRecentCoordinateReferenceSystemsProxyModel

A sort/filter proxy model for recent coordinate reference systems.

Data Providers

QgsAbstractDbSourceSelect

The QgsAbstractDbSourceSelect class is a base class for database source widget selector

QgsProviderSublayerDialogModel

A model for representing the sublayers present in a URI for the QgsProviderSublayersDialog.

Data Providers - GDAL

QgsGdalCredentialOptionsWidget

A widget for configuring GDAL credential options.

Data Providers - OGR

QgsVectorLayerSaveAsDialog

Class to select destination file, type and CRS for ogr layers

Development Tools

QgsDevToolWidget

A panel widget that can be shown in the developer tools panel.

QgsDevToolWidgetFactory

Factory class for creating custom developer/debugging tool pages

Elevation Handling

QgsElevationControllerSettingsAction

QgsElevationControllerWidget

A widget for configuring vertical elevation slicing behavior for maps.

QgsElevationProfileCanvas

A canvas for elevation profiles.

Geocoding

QgsGeocoderLocatorFilter

An adapter class which implements a locator filter populated from a QgsGeocoderInterface.

Input Controller Handling

QgsAbstract2DMapController

Abstract base class for all 2D map controllers.

QgsAbstract3DMapController

Abstract base class for all 3D map controllers.

QgsAbstractInputController

Abstract base class for all input controllers.

QgsInputControllerManager

Manages input control devices.

Label Callouts

QgsCalloutPanelWidget

A panel widget for configuration of callouts.

QgsCalloutWidget

Base class for widgets which allow control over the properties of callouts.

Labeling

QgsLabelLineAnchorWidget

A widget for customising label line anchor settings.

QgsLabelObstacleSettingsWidget

A widget for customising label obstacle settings.

QgsLabelSettingsWidgetBase

Base class for widgets which allow customization of label engine properties, such as label placement settings.

QgsLabelSettingsWidgetDialog

A blocking dialog containing a QgsLabelSettingsWidgetBase.

QgsLabelingEngineRuleWidget

Base class for widgets which allow control over the properties of QgsAbstractLabelingEngineRule subclasses

QgsLabelingEngineRulesDialog

A dialog which allows configuration of a list of labeling engine rules.

QgsLabelingEngineRulesWidget

A widget which allows configuration of a list of labeling engine rules.

Layer Tree and Legends

QgsCustomLayerOrderWidget

The QgsCustomLayerOrderWidget class provides a list box where the user can define custom order for drawing of layers. It also features a checkbox for enabling or disabling the custom order. Any changes made by the user are automatically propagated to the assigned QgsLayerTreeMapCanvasBridge. Also, any updates to the layer tree cause refresh of the list.

QgsLayerTreeEmbeddedConfigWidget

A widget to configure layer tree embedded widgets for a particular map layer.

QgsLayerTreeEmbeddedWidgetProvider

Provider interface to be implemented in order to introduce new kinds of embedded widgets for use in layer tree. Embedded widgets are assigned per individual map layers and they are shown before any legend entries.

QgsLayerTreeEmbeddedWidgetRegistry

Registry of widgets that may be embedded into layer tree view. Embedded widgets are assigned per individual map layers and they are shown before any legend entries. Layer tree must have UseEmbeddedWidgets flag enabled in order to show assigned widgets.

QgsLayerTreeMapCanvasBridge

The QgsLayerTreeMapCanvasBridge class takes care of updates of layer set for QgsMapCanvas from a layer tree. The class listens to the updates in the layer tree and updates the list of layers for rendering whenever some layers are added, removed, or their visibility changes.

QgsLayerTreeProxyModel

The QgsLayerTreeProxyModel class is a proxy model for QgsLayerTreeModel, supports private layers and text filtering.

QgsLayerTreeView

The QgsLayerTreeView class extends QTreeView and provides some additional functionality when working with a layer tree.

QgsLayerTreeViewDefaultActions

The QgsLayerTreeViewDefaultActions class serves as a factory of actions that can be used together with a layer tree view.

QgsLayerTreeViewIndicator

Indicator that can be used in a layer tree view to display icons next to items of the layer tree. They add extra context to the item and interactivity (using clicked() signal).

QgsLayerTreeViewMenuProvider

Implementation of this interface can be implemented to allow QgsLayerTreeView instance to provide custom context menus (opened upon right-click).

Locator Bar

QgsLocatorWidget

A special locator widget which allows searching for matching results from a QgsLocator and presenting them to users for selection.

Map Actions

QgsActionMenu

This class is a menu that is populated automatically with the actions defined for a given layer.

QgsAttributeDialog

Create an attribute dialog for a given layer and feature

QgsMapLayerAction

An action which can run on map layers The class can be used in two manners: * by instantiating it and connecting to its signals to perform an action * by subclassing and reimplementing its method (only since QGIS 3.18.2)

QgsMapLayerActionContext

Encapsulates the context in which a QgsMapLayerAction action is executed.

QgsMapLayerActionContextGenerator

An interface for objects which can create a QgsMapLayerActionContext.

QgsMapLayerActionRegistry

This class tracks map layer actions.

Map Tools

QgsMapTool

Abstract base class for all map tools. Map tools are user interactive tools for manipulating the map canvas. For example map pan and zoom features are implemented as map tools.

QgsMapToolAdvancedDigitizing

The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates and allows filtering its events. Events from QgsMapTool are caught and their QMouseEvent are transformed into QgsMapMouseEvent (with map coordinates). Events are then forwarded to corresponding virtual methods which can be reimplemented in subclasses. An event filter can be set on the map tool to filter and modify the events in map coordinates (:py:

QgsMapToolCapture

QgsMapToolCapture is a base class capable of capturing point, lines and polygons. The tool supports different techniques: straight segments, curves, streaming and shapes Once the the geometry is captured the virtual private handler geometryCaptured is called as well as a more specific handler (pointCaptured, lineCaptured or polygonCaptured)

QgsMapToolCaptureLayerGeometry

QgsMapToolCaptureLayerGeometry is a base class for map tools digitizing layer geometries This map tool subclass automatically handles intersection avoidance with other layers in the active project whenever a geometry is digitized by the user.

QgsMapToolDigitizeFeature

This tool digitizes geometry of new point/line/polygon features on already existing vector layers Once the map tool is enabled, user can digitize the feature geometry. A signal will then be emitted.

QgsMapToolEdit

Base class for map tools that edit vector geometry

QgsMapToolEmitPoint

A map tool that simply emits a point when clicking on the map. Connecting a slot to its canvasClicked() signal will let you implement custom behavior for the passed in point.

QgsMapToolExtent

A map tool that emits an extent from a rectangle drawn onto the map canvas.

QgsMapToolIdentify

Map tool for identifying features in layers

QgsMapToolIdentifyFeature

The QgsMapToolIdentifyFeature class is a map tool to identify a feature on a chosen layer. Once the map tool is enable, user can click on the map canvas to identify a feature. A signal will then be emitted.

QgsMapToolPan

A map tool for panning the map.

QgsMapToolZoom

A map tool for zooming into the map.

Mesh Layers

QgsMeshLayerProperties

Property sheet for a mesh map layer. Contains information, source and style tabs

Numeric Formats

QgsBasicNumericFormatWidget

A widget which allow control over the properties of a QgsBasicNumericFormat.

QgsBearingNumericFormatDialog

A dialog which allow control over the properties of a QgsBearingNumericFormat.

QgsBearingNumericFormatWidget

A widget which allow control over the properties of a QgsBearingNumericFormat.

QgsCurrencyNumericFormatWidget

A widget which allow control over the properties of a QgsCurrencyNumericFormat.

QgsExpressionBasedNumericFormatWidget

A widget which allow control over the properties of a QgsExpressionBasedNumericFormat.

QgsFractionNumericFormatWidget

A widget which allow control over the properties of a QgsFractionNumericFormat.

QgsGeographicCoordinateNumericFormatDialog

A dialog which allow control over the properties of a QgsGeographicCoordinateNumericFormat.

QgsGeographicCoordinateNumericFormatWidget

A widget which allow control over the properties of a QgsGeographicCoordinateNumericFormat.

QgsNumericFormatConfigurationWidgetFactory

Interface base class for factories for numeric format configuration widgets.

QgsNumericFormatGuiRegistry

The QgsNumericFormatGuiRegistry is a home for widgets for configuring QgsNumericFormat objects.

QgsNumericFormatSelectorDialog

A simple dialog for customizing a numeric format.

QgsNumericFormatSelectorWidget

A widget which allows choice of numeric formats and the properties of them.

QgsNumericFormatWidget

Base class for widgets which allow control over the properties of QgsNumericFormat subclasses

QgsPercentageNumericFormatWidget

A widget which allow control over the properties of a QgsPercentageNumericFormat.

QgsScientificNumericFormatWidget

A widget which allow control over the properties of a QgsScientificNumericFormat.

Paint Effects

QgsBlurWidget

QgsColorEffectWidget

QgsDrawSourceWidget

QgsEffectDrawModeComboBox

A combo box allowing selection of paint effect draw modes

QgsEffectStackCompactWidget

A small widget consisting of a checkbox for enabling/disabling an effect stack and a button for opening an effect stack customization dialog.

QgsEffectStackPropertiesDialog

A dialog for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack.

QgsEffectStackPropertiesWidget

A widget for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack.

QgsGlowWidget

QgsPaintEffectPropertiesWidget

A widget which modifies the properties of a QgsPaintEffect

QgsPaintEffectWidget

Base class for effect properties widgets.

QgsShadowEffectWidget

QgsTransformWidget

Plot and Graph Rendering

QgsPlotCanvas

Plot canvas is a class for displaying interactive 2d charts and plots.

QgsPlotCanvasItem

An abstract class for items that can be placed on a QgsPlotCanvas.

QgsPlotMouseEvent

A QgsPlotMouseEvent is the result of a user interaction with the mouse on a QgsPlotCanvas.

QgsPlotRectangularRubberBand

QgsPlotRectangularRubberBand is rectangular rubber band for use within QgsPlotCanvas widgets.

QgsPlotRubberBand

QgsPlotRubberBand is an abstract base class for temporary rubber band items in various shapes, for use within QgsPlotCanvas widgets.

QgsPlotTool

Abstract base class for all interactive plot tools.

QgsPlotToolPan

Plot tool for panning/zoom/navigating plots.

QgsPlotToolTemporaryKeyPan

Plot tool for temporarily panning a plot while a key is depressed.

QgsPlotToolTemporaryKeyZoom

Plot tool for temporarily zooming a plot while a key is depressed.

QgsPlotToolTemporaryMousePan

Plot tool for temporarily panning a plot while a mouse button is depressed.

QgsPlotToolZoom

Plot tool for zooming into and out of the plot.

Point Cloud Layers

QgsPointCloudRendererPropertiesWidget

A generic widget for setting the 2D renderer for a point cloud layer.

QgsPointCloudRendererWidget

Base class for point cloud 2D renderer settings widgets.

Processing Framework

QgsAbstractProcessingParameterWidgetWrapper

A widget wrapper for Processing parameter value widgets.

QgsAggregateMappingModel

The QgsAggregateMappingModel holds mapping information for defining sets of aggregates of fields from a QgsFields object.

QgsAggregateMappingWidget

The QgsAggregateMappingWidget class creates a mapping for defining sets of aggregates of fields from a QgsFields object.

QgsProcessingAbstractParameterDefinitionWidget

Abstract base class for widgets which allow users to specify the properties of a Processing parameter.

QgsProcessingAlgorithmConfigurationWidget

A configuration widget for processing algorithms allows providing additional configuration options directly on algorithm level, in addition to parameters.

QgsProcessingAlgorithmConfigurationWidgetFactory

Interface base class for factories for algorithm configuration widgets.

QgsProcessingAlgorithmDialogBase

Base class for processing algorithm dialogs.

QgsProcessingBatchAlgorithmDialogBase

Base class for processing batch algorithm dialogs.

QgsProcessingContextGenerator

An interface for objects which can create Processing contexts.

QgsProcessingFavoriteAlgorithmManager

A manager for tracking favorite Processing algorithms.

QgsProcessingGui

Contains general functions and values related to Processing GUI components.

QgsProcessingGuiRegistry

The QgsProcessingGuiRegistry is a home for widgets for processing configuration widgets.

QgsProcessingGuiUtils

Contains utility functions relating to Processing GUI components.

QgsProcessingHiddenWidgetWrapper

An widget wrapper for hidden widgets.

QgsProcessingHistoryDialog

A dialog for showing Processing algorithm execution history.

QgsProcessingHistoryProvider

History provider for operations performed through the Processing framework.

QgsProcessingHistoryWidget

A widget for showing Processing algorithm execution history.

QgsProcessingLayerOutputDestinationWidget

A widget which allows users to select the destination path for an output style Processing parameter.

QgsProcessingMapLayerComboBox

Processing map layer combo box.

QgsProcessingModelerParameterWidget

A widget for customising the value of Processing algorithm parameter inside a Processing model.

QgsProcessingMultipleInputDialog

A dialog for selection of multiple layer inputs.

QgsProcessingMultipleInputPanelWidget

A panel widget for selection of multiple inputs from a fixed list of options.

QgsProcessingMultipleSelectionDialog

A dialog for selection of multiple options from a fixed list of options.

QgsProcessingMultipleSelectionPanelWidget

A panel widget for selection of multiple options from a fixed list of options.

QgsProcessingParameterDefinitionDialog

A dialog which allow users to specify the properties of a Processing parameter.

QgsProcessingParameterDefinitionWidget

A widget which allow users to specify the properties of a Processing parameter.

QgsProcessingParameterWidgetContext

Contains settings which reflect the context in which a Processing parameter widget is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.

QgsProcessingParameterWidgetFactoryInterface

An interface for Processing widget wrapper factories.

QgsProcessingParametersGenerator

An interface for objects which can create sets of parameter values for processing algorithms.

QgsProcessingParametersWidget

A widget which allows users to select the value for the parameters for an algorithm.

QgsProcessingRecentAlgorithmLog

A log for tracking recently used processing algorithms.

QgsProcessingToolboxModel

A model for providers and algorithms shown within the Processing toolbox.

QgsProcessingToolboxModelAlgorithmNode

Processing toolbox model node corresponding to an algorithm.

QgsProcessingToolboxModelFavoriteNode

Processing toolbox model node corresponding to the favorite algorithms

QgsProcessingToolboxModelGroupNode

Processing toolbox model node corresponding to a group of algorithms.

QgsProcessingToolboxModelNode

Abstract base class for nodes contained within a QgsProcessingToolboxModel.

QgsProcessingToolboxModelProviderNode

Processing toolbox model node corresponding to a Processing provider.

QgsProcessingToolboxModelRecentNode

Processing toolbox model node corresponding to the recent algorithms

QgsProcessingToolboxProxyModel

A sort/filter proxy model for providers and algorithms shown within the Processing toolbox, which automatically sorts the toolbox in a logical fashion and supports filtering the results.

QgsProcessingToolboxTreeView

Processing toolbox tree view, showing algorithms and providers in a tree structure.

Processing Framework - Models

QgsModelArrowItem

A link arrow item for use in the model designer.

QgsModelChildAlgorithmGraphicItem

A graphic item representing a child algorithm in the model designer.

QgsModelChildDependenciesWidget

QgsModelCommentGraphicItem

A graphic item representing a model comment in the model designer.

QgsModelComponentGraphicItem

Base class for graphic items representing model components in the model designer.

QgsModelDesignerDialog

Model designer dialog base class

QgsModelDesignerFlatButtonGraphicItem

A flat button graphic item for use in the Processing model designer.

QgsModelDesignerFoldButtonGraphicItem

A button allowing folding or expanding component graphics in the Processing model designer.

QgsModelGraphicsScene

QGraphicsScene subclass representing the model designer.

QgsModelGraphicsView

QGraphicsView subclass representing the model designer.

QgsModelGroupBoxGraphicItem

A graphic item representing a group box in the model designer.

QgsModelOutputGraphicItem

A graphic item representing a model output in the model designer.

QgsModelParameterGraphicItem

A graphic item representing a model parameter (input) in the model designer.

QgsModelViewSnapMarker

A simple graphics item rendered as an ‘x’.

Raster Layers

QgsColorRampShaderWidget

It has 2 ways how to use it. For raster layers, raster data provider and band is assigned and the Quantile classification mode can be used and the LoadFromBandButton is visible.

QgsHillshadeRendererWidget

Renderer widget for the hill shade renderer.

QgsMultiBandColorRendererWidget

Constructor for QgsMultiBandColorRendererWidget.

QgsPalettedRendererWidget

Constructor for QgsSingleBandPseudoColorRendererWidget.

QgsRasterAttributeTableDialog

The QgsRasterAttributeTableDialog class embeds an attribute table widget.

QgsRasterAttributeTableModel

The QgsRasterAttributeTableModel class manages a QgsRasterAttributeTable

QgsRasterAttributeTableWidget

The QgsRasterAttributeTableWidget class provides an attribute table for rasters and methods to edit the table.

QgsRasterBandComboBox

A combobox widget which displays the bands present in a raster layer.

QgsRasterContourRendererWidget

Configuration widget for QgsRasterContourRenderer

QgsRasterHistogramWidget

Histogram widget

QgsRasterLayerProperties

Property sheet for a raster map layer

QgsRasterLayerTemporalPropertiesWidget

A widget for configuring the temporal properties for a raster layer.

QgsRasterMinMaxWidget

Constructor for QgsRasterMinMaxWidget

QgsRasterRendererWidget

Abstract base class for widgets which configure a QgsRasterRenderer.

QgsRasterTransparencyWidget

Widget to control a layers transparency and related options

QgsRendererRasterPropertiesWidget

A widget to hold the renderer properties for a raster layer.

QgsSingleBandGrayRendererWidget

Constructor for QgsSingleBandGrayRendererWidget.

QgsSingleBandPseudoColorRendererWidget

Single band pseudo color renderer widget consists of a color ramp shader widget, a raster min max widget and a band selector.

Sensor Handling

QgsAbstractSensorWidget

Base class for widgets which allow control over the properties of sensors.

QgsSensorAbstractGuiMetadata

Stores GUI metadata about one sensor class.

QgsSensorGuiRegistry

Registry of available sensor GUI behavior.

Settings Handling

PyQgsSettingsEnumEditorWidgetWrapper

A settings editor widget wrapper for enum settings as PyQgsSettingsEntryEnumFlag

QgsSettingsBoolCheckBoxWrapper

This class is a factory of editor for boolean settings with a checkbox

QgsSettingsColorButtonWrapper

This class is a factory of editor for color settings with a color button

QgsSettingsDoubleSpinBoxWrapper

This class is a factory of editor for double settings with a double spin

QgsSettingsEditorWidgetRegistry

This class manages editor widgets for settings

QgsSettingsEditorWidgetWrapper

Base class for settings editor wrappers

QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryBoolQCheckBoxboolBase

This class is a base factory of editor for settings

QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryColorQgsColorButtonQColorBase

This class is a base factory of editor for settings

QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryDoubleQDoubleSpinBoxdoubleBase

This class is a base factory of editor for settings

QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryIntegerQSpinBoxintBase

This class is a base factory of editor for settings

QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryStringQComboBoxQStringBase

This class is a base factory of editor for settings

QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryStringQLineEditQStringBase

This class is a base factory of editor for settings

QgsSettingsIntegerSpinBoxWrapper

This class is a factory of editor for integer settings with a spin box

QgsSettingsRegistryGui

QgsSettingsRegistryGui is used for settings introspection and collects all QgsSettingsEntry instances of gui.

QgsSettingsStringComboBoxWrapper

This class is a factory of editor for string settings with a combo box

QgsSettingsStringLineEditWrapper

This class is a factory of editor for string settings with a line edit

QgsSettingsTreeModel

QgsSettingsTreeModel is a tree model for the settings tree.

QgsSettingsTreeProxyModel

QgsSettingsTreeProxyModel allows filtering the settings tree

QgsSettingsTreeWidget

QgsSettingsTreeWidget is a widget with the settings tree to visualize, search and edit settings

Symbology and Vector Renderers

CharacterWidget

A widget for displaying characters available in a preset font, and allowing users to select an individual character.

Qgs25DRendererWidget

param layer:

the layer where this renderer is applied :param style: :param renderer: the mask renderer (will not take ownership)

QgsAnimatedMarkerSymbolLayerWidget

Widget for configuring QgsAnimatedMarkerSymbolLayer symbol layers.

QgsArrowSymbolLayerWidget

param layer:

the layer where this symbol layer is applied :param parent: the parent widget

QgsBrushStyleComboBox

QgsCategorizedSymbolRendererWidget

QgsCentroidFillSymbolLayerWidget

Constructor for QgsCentroidFillSymbolLayerWidget.

QgsCptCityColorRampDialog

A dialog which allows users to modify the properties of a QgsCptCityColorRamp.

QgsDashSpaceDialog

A dialog to enter a custom dash space pattern for lines

QgsDashSpaceWidget

A widget to enter a custom dash space pattern for lines

QgsDataDefinedRotationDialog

QgsDataDefinedSizeDialog

QgsDataDefinedSizeLegendWidget

Widget for configuration of appearance of legend for marker symbols with data-defined size.

QgsDataDefinedValueDialog

Utility classes for “en masse” size definition.

QgsDataDefinedWidthDialog

QgsEllipseSymbolLayerWidget

Constructor for QgsEllipseSymbolLayerWidget.

QgsEmbeddedSymbolRendererWidget

A widget used represent options of a QgsEmbeddedSymbolRenderer

QgsFilledLineSymbolLayerWidget

A widget for configuring QgsFilledLineSymbolLayer.

QgsFilledMarkerSymbolLayerWidget

Widget for configuring QgsFilledMarkerSymbolLayer symbol layers.

QgsFontMarkerSymbolLayerWidget

Constructor for QgsFontMarkerSymbolLayerWidget.

QgsGeometryGeneratorSymbolLayerWidget

Constructor for QgsGeometryGeneratorSymbolLayerWidget.

QgsGradientFillSymbolLayerWidget

Constructor for QgsGradientFillSymbolLayerWidget.

QgsGraduatedHistogramWidget

Graphical histogram for displaying distribution of field values and editing range breaks for a QgsGraduatedSymbolRenderer renderer.

QgsGraduatedSymbolRendererWidget

QgsHashedLineSymbolLayerWidget

Widget for controlling the properties of a QgsHashedLineSymbolLayer.

QgsHeatmapRendererWidget

param layer:

the layer where this renderer is applied :param style: :param renderer: the mask renderer (will not take ownership)

QgsInterpolatedLineSymbolLayerWidget

QgsInterpolatedLineSymbolLayerWidget

QgsInvertedPolygonRendererWidget

A widget used represent options of a QgsInvertedPolygonRenderer

QgsLayerPropertiesWidget

A widget which allows configuration of the properties of a single QgsSymbolLayer.

QgsLinePatternFillSymbolLayerWidget

Constructor for QgsLinePatternFillSymbolLayerWidget.

QgsLinearReferencingSymbolLayerWidget

Widget for controlling the properties of a QgsLinearReferencingSymbolLayer.

QgsLineburstSymbolLayerWidget

Widget for configuring QgsLineburstSymbolLayer symbol layers.

QgsMarkerLineSymbolLayerWidget

Constructor for QgsMarkerLineSymbolLayerWidget.

QgsMaskMarkerSymbolLayerWidget

Symbol layer widget for the handling of QgsMaskMarkerSymbolLayer.

QgsMergedFeatureRendererWidget

A widget used represent options of a QgsMergedFeatureRenderer

QgsNullSymbolRendererWidget

Blank widget for customizing QgsNullSymbolRenderer.

QgsPenCapStyleComboBox

QgsPenJoinStyleComboBox

QgsPenStyleComboBox

QgsPointClusterRendererWidget

A widget which allows configuration of the properties for a QgsPointClusterRenderer.

QgsPointDisplacementRendererWidget

QgsPointPatternFillSymbolLayerWidget

Constructor for QgsPointPatternFillSymbolLayerWidget.

QgsRandomMarkerFillSymbolLayerWidget

Widget for controlling the properties of a QgsRandomMarkerFillSymbolLayer.

QgsRasterFillSymbolLayerWidget

Constructor for QgsRasterFillSymbolLayerWidget.

QgsRasterLineSymbolLayerWidget

Widget for configuring QgsRasterLineSymbolLayer symbol layers.

QgsRasterMarkerSymbolLayerWidget

Widget for configuring QgsRasterMarkerSymbolLayer symbol layers.

QgsRendererPropertiesDialog

Constructor for QgsRendererPropertiesDialog.

QgsRendererRulePropsDialog

Constructor for QgsRendererRulePropsDialog

QgsRendererRulePropsWidget

Widget to edit the details of a rule based renderer rule.

QgsRendererWidget

Base class for renderer settings widgets.

QgsRuleBasedRendererModel

Tree model for the rules:

QgsRuleBasedRendererWidget

QgsSVGFillSymbolLayerWidget

Constructor for QgsSVGFillSymbolLayerWidget.

QgsShapeburstFillSymbolLayerWidget

Constructor for QgsShapeburstFillSymbolLayerWidget.

QgsSimpleFillSymbolLayerWidget

Constructor for QgsSimpleFillSymbolLayerWidget.

QgsSimpleLineSymbolLayerWidget

Constructor for QgsSimpleLineSymbolLayerWidget.

QgsSimpleMarkerSymbolLayerWidget

Constructor for QgsSimpleMarkerSymbolLayerWidget.

QgsSingleSymbolRendererWidget

QgsSmartGroupCondition

QgsSmartGroupEditorDialog

QgsStyleExportImportDialog

Constructor for QgsStyleExportImportDialog, with the specified parent widget.

QgsStyleGroupSelectionDialog

QgsStyleManagerDialog

A dialog allowing users to customize and populate a QgsStyle.

QgsStyleSaveDialog

a dialog for setting properties of a newly saved style.

QgsSvgMarkerSymbolLayerWidget

Constructor for QgsSvgMarkerSymbolLayerWidget.

QgsSvgSelectorDialog

Constructor for QgsSvgSelectorDialog.

QgsSvgSelectorFilterModel

A model for displaying SVG files with a preview icon which can be filtered by file name. Population of the model is performed in a background thread to ensure that initial creation of the model is responsive and does not block the GUI.

QgsSvgSelectorGroupsModel

A model for displaying SVG search paths. Population of the model is performed in a background thread to ensure that initial creation of the model is responsive and does not block the GUI.

QgsSvgSelectorListModel

A model for displaying SVG files with a preview icon. Population of the model is performed in a background thread to ensure that initial creation of the model is responsive and does not block the GUI.

QgsSvgSelectorWidget

A widget allowing selection of an SVG file, and configuration of SVG related parameters.

QgsSymbolAnimationSettingsDialog

A dialog for customising animation settings for a symbol.

QgsSymbolAnimationSettingsWidget

A widget for customising animation settings for a symbol.

QgsSymbolBufferSettingsDialog

A dialog for customising buffer settings for a symbol.

QgsSymbolBufferSettingsWidget

A widget for customising buffer settings for a symbol.

QgsSymbolLayerWidget

Constructor for QgsSymbolLayerWidget.

QgsSymbolLevelsDialog

A dialog which allows the user to modify the rendering order of symbol layers.

QgsSymbolLevelsWidget

A widget which allows the user to modify the rendering order of symbol layers.

QgsSymbolSelectorDialog

A dialog that can be used to select and build a symbol.

QgsSymbolSelectorWidget

Symbol selector widget that can be used to select and build a symbol

QgsSymbolWidgetContext

Contains settings which reflect the context in which a symbol (or renderer) widget is shown, e.g., the map canvas and relevant expression contexts.

QgsSymbolsListWidget

Constructor for QgsSymbolsListWidget.

QgsVectorFieldSymbolLayerWidget

Constructor for QgsVectorFieldSymbolLayerWidget.

Table Editor

QgsTableEditorDialog

A reusable window for editing simple spreadsheet-style tables.

QgsTableEditorWidget

A reusable widget for editing simple spreadsheet-style tables.

Tiled Scene Layers

QgsTiledSceneRendererPropertiesWidget

A generic widget for setting the 2D renderer for a tiled scene layer.

QgsTiledSceneRendererWidget

Base class for tiled scene 2D renderer settings widgets.

User History Tracking

QgsAbstractHistoryProvider

Abstract base class for objects which track user history (i.e. operations performed through the GUI).

QgsHistoryEntry

Encapsulates a history entry.

QgsHistoryEntryGroup

Base class for history entry “group” nodes, which contain children of their own.

QgsHistoryEntryModel

An item model representing history entries in a hierarchical tree structure.

QgsHistoryEntryNode

Base class for nodes representing a QgsHistoryEntry.

QgsHistoryProviderRegistry

The QgsHistoryProviderRegistry is a registry for objects which track user history (i.e. operations performed through the GUI).

QgsHistoryWidget

A widget showing entries from a QgsHistoryProviderRegistry.

QgsHistoryWidgetContext

Contains settings which reflect the context in which a history widget is shown, e.g., an associated message bar.

Vector Layers

QgsFieldCalculator

A dialog class that provides calculation of new fields using existing fields, values and a set of operators

QgsVectorLayerProperties

Vector Tile Layers

QgsVectorTileLayerProperties

Vectortile layer properties dialog