gui library module

The GUI library is build on top of the CORE library and adds reusable GUI widgets.

Contents

Namespaces

namespace QgsGuiUtils
The QgsGuiUtils namespace contains constants and helper functions used throughout the QGIS GUI.

Classes

class QgsAdvancedDigitizingDockWidget::CadConstraint
The CadConstraint is an abstract class for all basic constraints (angle/distance/x/y).
class QgsMapCanvas::CanvasProperties
Deprecated to be deleted, stuff from here should be moved elsewhere.
class CharacterWidget
A widget for displaying characters available in a preset font, and allowing users to select an individual character.
class ConstraintItemDelegate
Special delegate for the constraint view in the metadata wizard.
class FromDbTablePlugin
Widget auto conf plugin that reads the widget setup to use from what the data provider says.
class FromFactoriesPlugin
Widget auto conf plugin that guesses what widget type to use in function of what the widgets support.
class LinkItemDelegate
\@cond PRIVATE
class QgisInterface
QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugins.
class 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.
class QgsAbstractFileContentSourceLineEdit
Abstract base class for a widgets which allows users to select content from a file, embedding a file, etc.
class QgsAbstractProcessingParameterWidgetWrapper
A widget wrapper for Processing parameter value widgets.
class QgsActionMenu
This class is a menu that is populated automatically with the actions defined for a given layer.
class QgsAdvancedDigitizingCanvasItem
The QgsAdvancedDigitizingCanvasItem class draws the graphical elements of the CAD tools (.
class QgsAdvancedDigitizingDockWidget
The QgsAdvancedDigitizingDockWidget class is a dockable widget used to handle the CAD tools on top of a selection of map tools.
class QgsAggregateToolButton
Offers a toolbutton to choose between different aggregate functions.
class QgsAttributeEditorContext
This class contains context information for attribute editor widgets.
class 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.
class QgsAttributeFormLegacyInterface
This class helps to support legacy open form scripts to be compatible with the new QgsAttributeForm style interface.
class QgsAttributeFormRelationEditorWidget
Widget to show for child relations on an attribute form.
class QgsAttributeFormWidget
Base class for all widgets shown on a QgsAttributeForm.
class QgsAttributeTableDelegate
A delegate item class for QgsAttributeTable (see Qt documentation for QItemDelegate).
class QgsAttributeTableModel
A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a QAbstractItemView.
class QgsAttributeTableView
Provides a table view of features of a QgsVectorLayer.
class QgsAuthAuthoritiesEditor
Widget for viewing and editing authentication identities database.
class QgsAuthCertEditors
Wrapper widget to manage available certificate editors.
class QgsAuthCertInfo
Widget for viewing detailed info on a certificate and its hierarchical trust chain.
class QgsAuthCertInfoDialog
Dialog wrapper for widget displaying detailed info on a certificate and its hierarchical trust chain.
class QgsAuthCertManager
Dialog wrapper for widget to manage available certificate editors.
class QgsAuthCertTrustPolicyComboBox
Widget for editing the trust policy associated with a Certificate (Intermediate) Authority.
class QgsAuthConfigEdit
Widget for editing an authentication configuration.
class QgsAuthConfigEditor
Widget for editing authentication configuration database.
class QgsAuthConfigIdEdit
Custom widget for editing an authentication configuration ID.
class QgsAuthConfigSelect
Selector widget for authentication configs.
class QgsAuthConfigUriEdit
Dialog wrapper of select widget to edit an authcfg in a data source URI.
class QgsAuthEditorWidgets
Wrapper widget for available authentication editors.
class QgsAuthGuiUtils
Utility functions for use by authentication GUI widgets or standalone apps.
class QgsAuthIdentitiesEditor
Widget for viewing and editing authentication identities database.
class QgsAuthImportCertDialog
Widget for importing a certificate into the authentication database.
class QgsAuthImportIdentityDialog
Widget for importing an identity certificate/key bundle into the authentication database.
class QgsAuthMethodEdit
Abstract base class for the edit widget of authentication method plugins.
class QgsAuthMethodPlugins
Dialog for viewing available authentication method plugins.
class QgsAuthServersEditor
Widget for viewing and editing servers in authentication database.
class QgsAuthSettingsWidget
Widget for entering authentication credentials both in the form username/password and by using QGIS Authentication Database and its authentication configurations.
class QgsAuthSslConfigDialog
Dialog wrapper of widget for editing an SSL server configuration.
class QgsAuthSslConfigWidget
Widget for editing an SSL server configuration.
class QgsAuthSslErrorsDialog
Widget for reporting SSL errors and offering an option to store an SSL server exception into the authentication database.
class QgsAuthSslImportDialog
Widget for importing an SSL server certificate exception into the authentication database.
class QgsAuthTrustedCAsDialog
Widget for listing trusted Certificate (Intermediate) Authorities used in secure connections.
class QgsBinaryWidgetFactory
Editor widget factory for binary (BLOB) widgets.
class QgsBinaryWidgetWrapper
Widget wrapper for binary (BLOB) fields.
class QgsBlendModeComboBox
A combobox which lets the user select blend modes from a predefined list.
class QgsBrowserDockWidget
The QgsBrowserDockWidget class.
class QgsBrowserTreeView
The QgsBrowserTreeView class extends QTreeView with save/restore tree state functionality.
class QgsBusyIndicatorDialog
A simple dialog to show an indeterminate busy progress indicator.
class QgsCharacterSelectorDialog
A dialog for selecting a single character from a single font.
class QgsCheckableComboBox
QComboBox subclass which allows selecting multiple items.
class QgsCheckableItemModel
QStandardItemModel subclass which makes all items checkable by default.
class QgsCheckBoxConfigDlg
class QgsCheckBoxDelegate
QStyledItemDelegate subclass for QgsCheckableComboBox.
class QgsCheckboxSearchWidgetWrapper
Wraps a checkbox edit widget for searching.
class QgsCheckboxWidgetFactory
class QgsCheckboxWidgetWrapper
Wraps a checkbox widget.
class QgsClassificationWidgetWrapper
class QgsClassificationWidgetWrapperFactory
class QgsCodeEditor
A text editor based on QScintilla2.
class QgsCodeEditorCSS
A CSS editor based on QScintilla2.
class QgsCodeEditorExpression
A QGIS expression editor based on QScintilla2.
class QgsCodeEditorHTML
A HTML editor based on QScintilla2.
class QgsCodeEditorPython
A Python editor based on QScintilla2.
class QgsCodeEditorSQL
A SQL editor based on QScintilla2.
class QgsCollapsibleGroupBox
A groupbox that collapses/expands when toggled and can save its collapsed and checked states.
class QgsCollapsibleGroupBoxBasic
A groupbox that collapses/expands when toggled.
class QgsColorBox
A color box widget.
class QgsColorBrewerColorRampDialog
A dialog which allows users to modify the properties of a QgsColorBrewerColorRamp.
class QgsColorBrewerColorRampWidget
A widget which allows users to modify the properties of a QgsColorBrewerColorRamp.
class QgsColorButton
A cross platform button subclass for selecting colors.
class QgsColorDialog
A custom QGIS dialog for selecting a color.
class QgsColorPreviewWidget
A preview box which displays one or two colors as swatches.
class QgsColorRampButton
A cross platform button subclass for selecting color ramps.
class QgsColorRampShaderWidget
It has 2 ways how to use it.
class QgsColorRampWidget
A color ramp widget.
class QgsColorSchemeList
An editable list of color swatches, taken from an associated QgsColorScheme.
class QgsColorSchemeModel
A model for colors in a color scheme.
class QgsColorSliderWidget
A composite horizontal color ramp widget and associated spinbox for manual value entry.
class QgsColorSwatchDelegate
A delegate for showing a color swatch in a list.
class QgsColorSwatchGrid
A grid of color swatches, which allows for user selection.
class QgsColorSwatchGridAction
A color swatch grid which can be embedded into a menu.
class QgsColorTextWidget
A line edit widget which displays colors as text and accepts string representations of colors.
class QgsColorWheel
A color wheel widget.
class QgsColorWidget
A base class for interactive color widgets.
class QgsColorWidgetAction
An action containing a color widget, which can be embedded into a menu.
class QgsColorWidgetFactory
class QgsColorWidgetWrapper
Wraps a color widget.
class QgsCompoundColorWidget
A custom QGIS widget for selecting a color, including options for selecting colors via hue wheel, color swatches, and a color sampler.
class QgsConfigureShortcutsDialog
Reusable dialog for allowing users to configure shortcuts contained in a QgsShortcutsManager.
class QgsCptCityColorRampDialog
A dialog which allows users to modify the properties of a QgsCptCityColorRamp.
class QgsCredentialDialog
A generic dialog for requesting credentials.
class QgsCurveEditorWidget
A widget for manipulating QgsCurveTransform curves.
class QgsCustomDropHandler
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS.
class QgsCustomLayerOrderWidget
The QgsCustomLayerOrderWidget class provides a list box where the user can define custom order for drawing of layers.
class QgsDashSpaceDialog
A dialog to enter a custom dash space pattern for lines.
class QgsDataDefinedSizeLegendWidget
Widget for configuration of appearance of legend for marker symbols with data-defined size.
class QgsDataDefinedValueDialog
Utility classes for "en masse" size definition.
class QgsDataItemGuiContext
Encapsulates the context in which a QgsDataItem is shown within the application GUI.
class QgsDataItemGuiProvider
Abstract base class for providers which affect how QgsDataItem items behave within the application GUI.
class QgsDataItemGuiProviderRegistry
This class keeps a list of data item GUI providers that may affect how QgsDataItems behave within the application GUI.
class QgsDataSourceManagerDialog
The QgsDataSourceManagerDialog class embeds the browser panel and all the provider dialogs.
class QgsDataSourceSelectDialog
The QgsDataSourceSelectDialog class embeds the browser view to select an existing data source.
class QgsDateTimeEdit
The QgsDateTimeEdit class is a QDateTimeEdit with the capability of setting/reading null date/times.
class QgsDateTimeEditConfig
class QgsDateTimeEditFactory
class QgsDateTimeEditWrapper
Wraps a date time widget.
class QgsDateTimeSearchWidgetWrapper
Wraps a date/time edit widget for searching.
class QgsDatumTransformDialog
class QgsDefaultSearchWidgetWrapper
Wraps a search widget.
class QgsDetailedItemData
This class is the data only representation of a QgsDetailedItemWidget, designed to be used in custom views.
class QgsDetailedItemDelegate
A custom model/view delegate that can display an icon, heading and detail sections.
class QgsDetailedItemWidget
A widget renderer for detailed item views.
class QgsDialog
A generic dialog with layout and button box.
class QgsDockWidget
QgsDockWidget subclass with more fine-grained control over how the widget is closed or opened.
class QgsDoubleSpinBox
The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value.
class QgsDualView
This widget is used to show the attributes of a set of features of a QgsVectorLayer.
class QgsDummyConfigDlg
class QgsEditorConfigWidget
This class should be subclassed for every configurable editor widget type.
class QgsEditorWidgetAutoConfPlugin
Base class for plugins allowing to pick automatically a widget type for editing fields.
class QgsEditorWidgetFactory
Every attribute editor widget needs a factory, which inherits this class.
class QgsEditorWidgetRegistry
This class manages all known edit widget factories.
class QgsEditorWidgetWrapper
Manages an editor widget Widget and wrapper share the same parent.
class QgsEffectDrawModeComboBox
A combo box allowing selection of paint effect draw modes.
class QgsEffectStackCompactWidget
A small widget consisting of a checkbox for enabling/disabling an effect stack and a button for opening an effect stack customization dialog.
class QgsEffectStackPropertiesDialog
A dialog for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack.
class QgsEffectStackPropertiesWidget
A widget for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack.
class QgsEncodingFileDialog
A file dialog which lets the user select the preferred encoding type for a data provider.
class QgsEncodingSelectionDialog
A dialog which presents the user with a choice of file encodings.
class QgsEnumerationWidgetFactory
class QgsEnumerationWidgetWrapper
class QgsExpressionBuilderDialog
A generic dialog for building expression strings.
class QgsExpressionBuilderWidget
A reusable widget that can be used to build a expression string.
class QgsExpressionItem
An expression item that can be used in the QgsExpressionBuilderWidget tree.
class QgsExpressionItemSearchProxy
Search proxy used to filter the QgsExpressionBuilderWidget tree.
class QgsExpressionLineEdit
The QgsExpressionLineEdit widget includes a line edit for entering expressions together with a button to open the expression creation dialog.
class QgsExpressionSelectionDialog
This class offers a dialog to change feature selections.
class QgsExtentGroupBox
Collapsible group box for configuration of extent, typically for a save operation.
class QgsExternalResourceConfigDlg
class 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.
class QgsExternalResourceWidgetFactory
class QgsExternalResourceWidgetWrapper
Wraps a file name widget.
class QgsFeatureListComboBox
This offers a combobox with autocompleter that allows selecting features from a layer.
class QgsFeatureListView
Shows a list of features and renders a edit button next to each feature.
class QgsFieldComboBox
The QgsFieldComboBox is a combo box which displays the list of fields of a given layer.
class QgsFieldConditionalFormatWidget
A widget for customizing conditional formatting options.
class QgsFieldExpressionWidget
The QgsFieldExpressionWidget class reates a widget to choose fields and edit expressions It contains a combo boxto display the fields and expression and a button to open the expression dialog.
class QgsFieldValuesLineEdit
A line edit with an autocompleter which takes unique values from a vector layer's fields.
class QgsFileDownloaderDialog
QgsFileDownloaderDialog is a QProgressDialog subclass which handles file downloads and user feedback.
class QgsFileWidget
The QgsFileWidget class creates a widget for selecting a file or a folder.
class QgsFilledMarkerSymbolLayerWidget
Widget for configuring QgsFilledMarkerSymbolLayer symbol layers.
class QgsFilterLineEdit
QLineEdit subclass with built in support for clearing the widget's value and handling custom null value representations.
class QgsFloatingWidget
A QWidget subclass for creating widgets which float outside of the normal Qt layout system.
class QgsFocusWatcher
A event filter for watching for focus events on a parent object.
class QgsFontButton
A button for customizing QgsTextFormat settings.
class QgsFormAnnotation
An annotation item that embeds a designer form showing the feature attribute.
class QgsGenericFeatureSelectionManager
This selection manager synchronizes a local set of selected features with an attribute table.
class QgsGeometryRubberBand
A rubberband class for QgsAbstractGeometry (considering curved geometries)
class QgsGradientColorRampDialog
A dialog which allows users to modify the properties of a QgsGradientColorRamp.
class QgsGradientStopEditor
An interactive editor for previewing a gradient color ramp and modifying the position of color stops along the gradient.
class QgsGraduatedHistogramWidget
Graphical histogram for displaying distribution of field values and editing range breaks for a QgsGraduatedSymbolRenderer renderer.
class QgsGui
QgsGui is a singleton class containing various registry and other global members related to GUI classes.
class QgsHelp
Helper class for showing help topic URI for the given key.
class QgsHiddenWidgetFactory
class QgsHiddenWidgetWrapper
Wraps a hidden widget.
class QgsHighlight
A class for highlight features on the map.
class QgsHillshadeRendererWidget
Renderer widget for the hill shade renderer.
class QgsHistogramWidget
Graphical histogram for displaying distributions of field values.
class QgsIdentifyMenu
The QgsIdentifyMenu class builds a menu to be used with identify results (.
class QgsIFeatureSelectionManager
Is an interface class to abstract feature selection handling.
class QgsImageSourceLineEdit
A line edit widget with toolbutton for setting a raster image path.
class QgsInvertedPolygonRendererWidget
A widget used represent options of a QgsInvertedPolygonRenderer.
class QgsKeyValueWidget
Widget allowing to edit a QVariantMap, using a table.
class QgsKeyValueWidgetFactory
Factory for widgets for editing a QVariantMap.
class QgsKeyValueWidgetWrapper
Wraps a key/value widget.
class QgsLayerTreeEmbeddedConfigWidget
A widget to configure layer tree embedded widgets for a particular map layer.
class QgsLayerTreeEmbeddedWidgetProvider
Provider interface to be implemented in order to introduce new kinds of embedded widgets for use in layer tree.
class QgsLayerTreeEmbeddedWidgetRegistry
Registry of widgets that may be embedded into layer tree view.
class QgsLayerTreeMapCanvasBridge
The QgsLayerTreeMapCanvasBridge class takes care of updates of layer set for QgsMapCanvas from a layer tree.
class QgsLayerTreeView
The QgsLayerTreeView class extends QTreeView and provides some additional functionality when working with a layer tree.
class QgsLayerTreeViewDefaultActions
The QgsLayerTreeViewDefaultActions class serves as a factory of actions that can be used together with a layer tree view.
class QgsLayerTreeViewIndicator
Indicator that can be used in a layer tree view to display icons next to items of the layer tree.
class QgsLayerTreeViewMenuProvider
Implementation of this interface can be implemented to allow QgsLayerTreeView instance to provide custom context menus (opened upon right-click).
class QgsLayoutConfigObject
An object for property widgets for layout items.
class QgsLayoutCustomDropHandler
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS layouts.
class QgsLayoutDesignerInterface
A common interface for layout designer dialogs and widgets.
class QgsLayoutItemAbstractGuiMetadata
Stores GUI metadata about one layout item class.
class QgsLayoutItemBaseWidget
A base class for property widgets for layout items.
class QgsLayoutItemComboBox
The QgsLayoutItemComboBox class is a combo box which displays items of a matching type from a layout.
class QgsLayoutItemGuiGroup
Stores GUI metadata about a group of layout item classes.
class QgsLayoutItemGuiMetadata
Convenience metadata class that uses static functions to handle layout item GUI behavior.
class QgsLayoutItemPropertiesDialog
A dialog for configuring properties like the size and position of layout items.
class QgsLayoutItemPropertiesWidget
A widget for controlling the common properties of layout items (e.g.
class QgsLayoutRuler
A custom ruler widget for use with QgsLayoutView, displaying the current zoom and position of the visible layout and for interacting with guides in a layout.
class QgsLayoutUnitsComboBox
A custom combo box for selecting units for layout settings.
class QgsLayoutView
A graphical widget to display and interact with QgsLayouts.
class QgsLayoutViewEllipticalRubberBand
QgsLayoutViewEllipseRubberBand is elliptical rubber band for use within QgsLayoutView widgets.
class QgsLayoutViewMenuProvider
Interface for a QgsLayoutView context menu.
class QgsLayoutViewMouseEvent
A QgsLayoutViewMouseEvent is the result of a user interaction with the mouse on a QgsLayoutView.
class QgsLayoutViewRectangularRubberBand
QgsLayoutViewRectangularRubberBand is rectangular rubber band for use within QgsLayoutView widgets.
class QgsLayoutViewRubberBand
QgsLayoutViewRubberBand is an abstract base class for temporary rubber band items in various shapes, for use within QgsLayoutView widgets.
class QgsLayoutViewTool
Abstract base class for all layout view tools.
class QgsLayoutViewToolAddItem
Layout view tool for adding items to a layout.
class QgsLayoutViewToolAddNodeItem
Layout view tool for adding node based items to a layout.
class QgsLayoutViewToolEditNodes
Layout view tool for edit node based items in the layout.
class QgsLayoutViewToolMoveItemContent
Layout view tool for moving and zooming item content.
class QgsLayoutViewToolPan
Layout view tool for panning the layout.
class QgsLayoutViewToolSelect
Layout view tool for selecting items in the layout.
class QgsLayoutViewToolTemporaryKeyPan
Layout view tool for temporarily panning a layout while a key is depressed.
class QgsLayoutViewToolTemporaryKeyZoom
Layout view tool for temporarily zooming a layout while a key is depressed.
class QgsLayoutViewToolTemporaryMousePan
Layout view tool for temporarily panning a layout while a mouse button is depressed.
class QgsLayoutViewToolZoom
Layout view tool for zooming into and out of the layout.
class QgsLayoutViewTriangleRubberBand
QgsLayoutViewTriangleRubberBand is triangular rubber band for use within QgsLayoutView widgets.
class QgsLegendFilterButton
A tool button that allows enabling or disabling legend filter by contents of the map.
class QgsLimitedRandomColorRampDialog
A dialog which allows users to modify the properties of a QgsLimitedRandomColorRamp.
class QgsLimitedRandomColorRampWidget
A widget which allows users to modify the properties of a QgsLimitedRandomColorRamp.
class QgsListWidget
Widget allowing to edit a QVariantList, using a table.
class QgsListWidgetFactory
Factory for widgets for editing a QVariantList or a QStringList.
class QgsListWidgetWrapper
Wraps a list widget.
class QgsLocatorWidget
A special locator widget which allows searching for matching results from a QgsLocator and presenting them to users for selection.
class QgsMapCanvas
Map canvas is a class for displaying all GIS data types on a canvas.
class QgsMapCanvasAnnotationItem
An interactive map canvas item which displays a QgsAnnotation.
class QgsMapCanvasItem
An abstract class for items that can be placed on the map canvas.
class 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.
class QgsMapCanvasTracer
Extension of QgsTracer that provides extra functionality:
class QgsMapLayerAction
An action which can run on map layers.
class QgsMapLayerActionRegistry
This class tracks map layer actions.
class QgsMapLayerComboBox
The QgsMapLayerComboBox class is a combo box which displays the list of layers.
class QgsMapLayerConfigWidget
A panel widget that can be shown in the map style dock.
class QgsMapLayerConfigWidgetFactory
Factory class for creating custom map layer property pages.
class QgsMapLayerStyleManagerWidget
The QgsMapLayerStyleManagerWidget class which is used to visually manage the layer styles.
class QgsMapMouseEvent
A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas.
class QgsMapOverviewCanvas
A widget that displays an overview map.
class QgsMapTip
A maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature.
class QgsMapTool
Abstract base class for all map tools.
class QgsMapToolAdvancedDigitizing
The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates and allows filtering its events.
class QgsMapToolEdit
Base class for map tools that edit vector geometry.
class QgsMapToolEmitPoint
A map tool that simply emits a point when clicking on the map.
class QgsMapToolExtent
A map tool that emits an extent from a rectangle drawn onto the map canvas.
class QgsMapToolIdentify
Map tool for identifying features in layers.
class QgsMapToolIdentifyFeature
The QgsMapToolIdentifyFeature class is a map tool to identify a feature on a chosen layer.
class QgsMapToolPan
A map tool for panning the map.
class QgsMapToolZoom
A map tool for zooming into the map.
class QgsMapUnitScaleDialog
A dialog which allows the user to choose the minimum and maximum scale of an object in map units and millimeters.
class QgsMapUnitScaleWidget
A widget which allows the user to choose the minimum and maximum scale of an object in map units and millimeters.
class QgsMasterPasswordResetDialog
Dialog to verify current master password and initiate reset of authentication database with a new password.
class QgsMenuHeader
Custom widget for displaying subheaders within a QMenu in a standard style.
class QgsMenuHeaderWidgetAction
Custom QWidgetAction for displaying subheaders within a QMenu in a standard style.
class QgsMessageBar
A bar for displaying non-blocking messages to the user.
class QgsMessageLogViewer
A generic dialog widget for displaying QGIS log messages.
class QgsMessageViewer
A generic message view for displaying QGIS messages.
class QgsMetadataWidget
A wizard to edit metadata on a map layer.
class 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.
class QgsNewAuxiliaryFieldDialog
A dialog to create a new auxiliary field.
class QgsNewAuxiliaryLayerDialog
A dialog to create a new auxiliary layer.
class QgsNewGeoPackageLayerDialog
Dialog to set up parameters to create a new GeoPackage layer, and on accept() to create it and add it to the layers.
class QgsNewHttpConnection
Dialog to allow the user to configure and save connection information for an HTTP Server for WMS, etc.
class QgsNewNameDialog
New name, for example new layer name dialog.
class QgsNewOgrConnection
Dialog to allow the user to define, test and save connection information for OGR databases.
class QgsNullSymbolRendererWidget
Blank widget for customizing QgsNullSymbolRenderer.
class QgsOpacityWidget
A widget for setting an opacity value.
class QgsOptionsDialogBase
A base dialog for options and properties dialogs that offers vertical tabs.
class QgsOptionsDialogHighlightButton
A highlight widget for buttons.
class QgsOptionsDialogHighlightCheckBox
A highlight widget for checkboxes.
class QgsOptionsDialogHighlightGroupBox
A highlight widget for group boxes.
class QgsOptionsDialogHighlightLabel
A highlight widget for labels.
class QgsOptionsDialogHighlightTree
A highlight widget for trees.
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.
class QgsOptionsPageWidget
Base class for widgets for pages included in the options dialog.
class QgsOptionsWidgetFactory
A factory class for creating custom options pages.
class QgsOrderByDialog
This is a dialog to build and manage a list of order by clauses.
class QgsOrganizeTableColumnsDialog
Dialog for organising (hiding and reordering) columns in the attributes table.
class QgsOWSSourceSelect
Dialog to create connections and add layers WCS etc.
class QgsPaintEffectPropertiesWidget
A widget which modifies the properties of a QgsPaintEffect.
class QgsPaintEffectWidget
Base class for effect properties widgets.
class QgsPanelWidget
Base class for any widget that can be shown as a inline panel.
class QgsPanelWidgetStack
A stack widget to manage panels in the interface.
class QgsPanelWidgetWrapper
Wrapper widget for existing widgets which can't have the inheritance tree changed, e.g dialogs.
class QgsPasswordLineEdit
QLineEdit subclass with built in support for showing/hiding entered password.
class 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.
class QgsPointClusterRendererWidget
A widget which allows configuration of the properties for a QgsPointClusterRenderer.
class QgsPresetColorRampDialog
A dialog which allows users to modify the properties of a QgsPresetSchemeColorRamp.
class QgsPresetColorRampWidget
A widget which allows users to modify the properties of a QgsPresetSchemeColorRamp.
class QgsPreviewEffect
A graphics effect which can be applied to a widget to simulate various printing and color blindness modes.
class QgsProcessingAlgorithmConfigurationWidget
A configuration widget for processing algorithms allows providing additional configuration options directly on algorithm level, in addition to parameters.
class QgsProcessingAlgorithmConfigurationWidgetFactory
Interface base class for factories for algorithm configuration widgets.
class QgsProcessingContextGenerator
An interface for objects which can create Processing contexts.
class QgsProcessingGui
Contains general functions and values related to Processing GUI components.
class QgsProcessingGuiRegistry
The QgsProcessingGuiRegistry is a home for widgets for processing configuration widgets.
class QgsProcessingModelerParameterWidget
A widget for customising the value of Processing algorithm parameter inside a Processing model.
class 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.
class QgsProcessingParameterWidgetFactoryInterface
An interface for Processing widget wrapper factories.
class QgsProcessingToolboxModel
A model for providers and algorithms shown within the Processing toolbox.
class 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.
class QgsProjectionSelectionDialog
A generic dialog to prompt the user for a Coordinate Reference System.
class QgsProjectionSelectionTreeWidget
A widget for selecting a coordinate reference system from a tree.
class QgsProjectionSelectionWidget
A widget for selecting a projection.
class QgsPropertyAssistantWidget
Shows a user-friendly assistant guiding users through the creation of QgsProperty overrides.
class QgsPropertyOverrideButton
A button for controlling property overrides which may apply to a widget.
class 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.
class QgsQmlWidgetWrapper
Wraps a QQuickWidget to display QML code.
class QgsQueryBuilder
Query Builder for layers.
class QgsRangeConfigDlg
class QgsRangeWidgetFactory
class QgsRangeWidgetWrapper
Wraps a range widget.
class QgsRasterBandComboBox
A combobox widget which displays the bands present in a raster layer.
class QgsRasterFormatSaveOptionsWidget
A widget to select format-specific raster saving options.
class QgsRasterHistogramWidget
Histogram widget.
class QgsRasterMarkerSymbolLayerWidget
Widget for configuring QgsRasterMarkerSymbolLayer symbol layers.
class QgsRasterPyramidsOptionsWidget
A widget to select format-specific raster saving options.
class QgsRasterTransparencyWidget
Widget to control a layers transparency and related options.
class QgsRatioLockButton
A cross platform button subclass used to represent a locked / unlocked ratio state.
class QgsRelationAggregateSearchWidgetWrapper
Search widget for the children of a relation.
class QgsRelationReferenceConfigDlg
class QgsRelationReferenceFactory
class QgsRelationReferenceSearchWidgetWrapper
Wraps a relation reference search widget.
class QgsRelationReferenceWidgetWrapper
Wraps a relation reference widget.
class QgsRendererWidget
Base class for renderer settings widgets.
class QgsRubberBand
A class for drawing transient features (e.g.
class QgsRuleBasedRendererModel
Tree model for the rules:
class QgsScaleComboBox
A combobox which lets the user select map scale from predefined list and highlights nearest to current scale value.
class QgsScaleRangeWidget
A widget allowing entry of a range of map scales, e.g.
class QgsScaleVisibilityDialog
A dialog allowing users to enter a scale visibility range.
class QgsScaleWidget
A combobox which lets the user select map scale from predefined list and highlights nearest to current scale value.
class QgsScrollArea
A QScrollArea subclass with improved scrolling behavior.
class QgsSearchQueryBuilder
Query Builder for search strings.
class 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.
class QgsSearchWidgetWrapper
Shows a search widget on a filter form.
class QgsShortcutsManager
Shortcuts manager is a class that contains a list of QActions and QShortcuts that have been registered and their shortcuts can be changed.
class QgsSingleBandPseudoColorRendererWidget
Single band pseudo color renderer widget consists of a color ramp shader widget, a raster min max widget and a band selector.
class QgsSnapIndicator
Class that shows snapping marker on map canvas for the current snapping match.
class QgsSnapToGridCanvasItem
Shows a grid on the map canvas given a spatial resolution.
class QgsSourceSelectProvider
This is the interface for those who want to add entries to the QgsDataSourceManagerDialog.
class 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.
class QgsSpinBox
The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value.
class QgsSQLComposerDialog
SQL composer dialog.
class QgsStatusBar
A proxy widget for QStatusBar.
class QgsStyleManagerDialog
A dialog allowing users to customize and populate a QgsStyle.
class QgsStyleSaveDialog
a dialog for setting properties of a newly saved style.
class 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.
class 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.
class QgsSvgSelectorGroupsModel
A model for displaying SVG search paths.
class QgsSvgSelectorListModel
A model for displaying SVG files with a preview icon.
class QgsSvgSourceLineEdit
A line edit widget with toolbutton for setting an SVG image path.
class QgsSymbolButton
A button for creating and modifying QgsSymbol settings.
class QgsSymbolLevelsDialog
A dialog which allows the user to modify the rendering order of symbol layers.
class QgsSymbolLevelsWidget
A widget which allows the user to modify the rendering order of symbol layers.
class QgsSymbolSelectorWidget
Symbol selector widget that can be used to select and build a symbol.
class 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.
class QgsTableWidgetBase
Base widget allowing to edit a collection, using a table.
class QgsTableWidgetItem
This can be used like a regular QTableWidgetItem with the difference that a specific role can be set to sort.
class QgsTabWidget
The QgsTabWidget class is the same as the QTabWidget but with additional methods to temporarily hide/show tabs.
class QgsTaskManagerWidget
A widget which displays tasks from a QgsTaskManager and allows for interaction with the manager.
class QgsTemporaryCursorOverride
Temporarily sets a cursor override for the QApplication for the lifetime of the object.
class QgsTextEditConfigDlg
class QgsTextEditSearchWidgetWrapper
Wraps a text edit widget for searching.
class QgsTextEditWidgetFactory
class QgsTextEditWrapper
Wraps a text widget.
class QgsTextFormatDialog
A simple dialog for customizing text formatting settings.
class QgsTextFormatPanelWidget
A panel widget for customizing text formatting settings.
class QgsTextFormatWidget
A widget for customizing text formatting settings.
class QgsTextPreview
A widget for previewing text formatting settings.
class QgsTreeWidgetItem
QTreeWidgetItem subclass with custom handling for item sorting.
class QgsTreeWidgetItemObject
Custom QgsTreeWidgetItem with extra signals when item is edited.
class QgsUniqueValuesConfigDlg
class QgsUniqueValuesWidgetWrapper
Wraps a unique value widget.
class QgsUniqueValueWidgetFactory
class QgsUnitSelectionWidget
A widget displaying a combobox allowing the user to choose between various display units, such as millimeters or map unit.
class QgsUserInputWidget
The QgsUserInputWidget class is a floating widget that shall be used to display widgets for user inputs.
class QgsUuidWidgetFactory
class QgsUuidWidgetWrapper
Wraps a uuid widget.
class QgsValidityCheckRegistry
This class keeps a list of QgsAbstractValidityCheck checks which can be used when performing validity checks.
class QgsValidityCheckResultsModel
A QAbstractItemModel subclass for displaying the results from a QgsAbtractValidityCheck.
class QgsValidityCheckResultsWidget
A reusable widget which displays a summary of the results from a QgsAbstractValidityCheck (or checks).
class QgsValueMapConfigDlg
class QgsValueMapSearchWidgetWrapper
Wraps a value map search widget.
class QgsValueMapWidgetFactory
class QgsValueMapWidgetWrapper
Wraps a value map widget.
class QgsValueRelationConfigDlg
class QgsValueRelationSearchWidgetWrapper
Wraps a value relation search widget.
class QgsValueRelationWidgetFactory
class QgsValueRelationWidgetWrapper
Wraps a value relation widget.
class QgsVariableEditorWidget
A tree based widget for editing expression context scope variables.
class QgsVectorLayerSaveAsDialog
Class to select destination file, type and CRS for ogr layers.
class QgsVectorLayerSelectionManager
class QgsVertexMarker
A class for marking vertices of features using e.g.
class QgsVScrollArea
QgsVScrollArea is a QScrollArea subclass which only displays a vertical scrollbar and fits the width to the contents.
class QgsWidgetStateHelper
QgsWidgetStateHelper is a helper class to save and restore the geometry of QWidgets in the application.
class QgsWidgetWrapper
Manages an editor widget Widget and wrapper share the same parent.
class QgsSQLComposerDialog::SQLValidatorCallback
Callback to do validation check on dialog validation.
class QgsSQLComposerDialog::TableSelectedCallback
Callback to do actions on table selection.