gui¶
QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugins. |
|
A dialog for configuring a 3D symbol. |
|
Base class for 3D symbol configuration widgets. |
|
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. |
|
Abstract base class for a widgets which allows users to select content from a file, embedding a file, etc. |
|
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. |
|
This class should be subclassed for every configurable relation widget type. |
|
Base class to build new relation widgets. |
|
Factory class for creating relation widgets and their corresponding config widgets |
|
The QgsAdvancedDigitizingCanvasItem class draws the graphical elements of the CAD tools ( |
|
The |
|
The |
|
An abstract class for advanced digitizing tools. |
|
Stores metadata about one advanced digitizing tool class. |
|
Registry of available advanced digitizing tools. |
|
Offers a toolbutton to choose between different aggregate functions. Functions are filtered based on the type. |
|
A combo box which allows choice of alignment settings (e.g. left, right, …). |
|
A line edit widget with toolbutton for setting an animated raster image path. |
|
An interface that may be implemented to allow plugins or scripts to temporarily block the QGIS application from exiting. |
|
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) |
|
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. |
|
Widget to show for child relations on an attribute form. |
|
Base class for all widgets shown on a |
|
A combobox which lets the user select blend modes from a predefined list |
|
A dock widget containing a |
|
The |
|
A widget showing a browser tree view along with toolbar and toggleable properties pane. |
|
A simple dialog to show an indeterminate busy progress indicator. |
|
A label delegate being able to display html encoded content |
|
A dialog for selecting a single character from a single font |
|
QComboBox subclass which allows selecting multiple items. |
|
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 |
|
A groupbox that collapses/expands when toggled. Basic class |
|
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. |
|
A dialog which allows users to modify the properties of a |
|
A widget which allows users to modify the properties of a |
|
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. |
|
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. |
|
A preview box which displays one or two colors as swatches. |
|
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. |
|
A dialog for configuring a |
|
A widget for properties relating to a |
|
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%). |
|
An editable list of color swatches, taken from an associated |
|
A model for colors in a color scheme |
|
A composite horizontal color ramp widget and associated spinbox for manual value entry. |
|
A delegate for showing a color swatch in a list |
|
A grid of color swatches, which allows for user selection. Colors are taken from an associated |
|
A color swatch grid which can be embedded into a menu. |
|
A line edit widget which displays colors as text and accepts string representations of colors. |
|
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. |
|
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 |
|
An action containing a color widget, which can be embedded into a menu. |
|
A custom QGIS widget for selecting a color, including options for selecting colors via hue wheel, color swatches, and a color sampler. |
|
Reusable dialog for allowing users to configure shortcuts contained in a |
|
A generic dialog for requesting credentials |
|
A widget for manipulating |
|
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS. |
|
Abstract base class that may be implemented to handle new project file types within the QGIS application. |
|
Encapsulates the context in which a |
|
Abstract base class for providers which affect how |
|
This class keeps a list of data item GUI providers that may affect how |
|
Utility functions for |
|
The |
|
The |
|
The |
|
The |
|
A dialog for configuration of the properties of a relationship in a database. |
|
A widget for configuration of the properties of a relationship in a database. |
|
This class is the data only representation of a |
|
A custom model/view delegate that can display an icon, heading and detail sections. |
|
A widget renderer for detailed item views. |
|
Constructor for QgsDial |
|
A generic dialog with layout and button box |
|
Widget for direction light settings |
|
|
|
|
|
A file dialog which lets the user select the preferred encoding type for a data provider. |
|
A dialog which presents the user with a choice of file encodings. |
|
Constructor for QgsErrorDialog |
|
A generic dialog for building expression strings |
|
A reusable widget that can be used to build a expression string. See |
|
An expression item that can be used in the |
|
Search proxy used to filter the |
|
The |
|
|
|
This class offers a dialog to change feature selections. To do so, a |
|
A generic dialog for editing expression text, label and help text. |
|
|
|
Collapsible group box for configuration of extent, typically for a save operation. |
|
A widget for configuration of a map extent. |
|
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. |
|
The |
|
This offers a combobox with autocompleter that allows selecting features from a layer. |
|
This offers a combobox with autocompleter that allows selecting features from a layer. |
|
Constructor for QgsFeatureSelectionDlg |
|
The |
|
A dialog for configuration of the properties of a |
|
A widget for configuration of the properties of a |
|
The |
|
The |
|
The |
|
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. |
|
|
|
The |
|
QLineEdit subclass with built in support for clearing the widget’s value and handling custom null value representations. |
|
A dialog for finding files (recursively) by file pattern. |
|
A reusable widget for finding files (recursively) by file pattern. |
|
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. |
|
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. |
|
A button for customizing |
|
A rubberband class for |
|
A widget for storing and interacting with a |
|
A dialog which allows users to modify the properties of a |
|
An interactive editor for previewing a gradient color ramp and modifying the position of color stops along the gradient. |
|
|
|
Helper class for showing help topic URI for the given key. |
|
A class for highlight features on the map. |
|
A |
|
Graphical histogram for displaying distributions of field values. |
|
Display referer http header field and collapsible table of key/value |
|
The QgsIdentifyMenu class builds a menu to be used with identify results ( |
|
A line edit widget with toolbutton for setting a raster image path. |
|
Widget allowing to edit a QVariantMap, using a table. |
|
The |
|
The |
|
The |
|
Base class for “layer properties” dialogs, containing common utilities for handling functionality in these dialog. |
|
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. |
|
A button for creating and modifying |
|
A dialog for configuring a custom legend patch shape. |
|
Widget for configuring a custom legend patch shape. |
|
A dialog which allows users to modify the properties of a |
|
A widget which allows users to modify the properties of a |
|
Widget allowing to edit a QVariantList, using a table. |
|
Constructor for QgsManageConnectionsDialog. |
|
Map canvas is a class for displaying all GIS data types on a canvas. |
|
An interactive map canvas item which displays a |
|
An interface for objects which block interactions with a |
|
An abstract class for items that can be placed on the map canvas. |
|
Snapping utils instance that is connected to a canvas and updates the configuration (map settings + current layer) whenever that is changed in the canvas. |
|
Extension of |
|
Utility functions for working with |
|
A combobox which displays a dynamic list of layers from a QGIS project. |
|
A panel widget that can be shown in the map style dock |
|
Encapsulates the context for a |
|
Factory class for creating custom map layer property pages |
|
Model for layer style categories |
|
The |
|
A |
|
A widget that displays an overview map. |
|
A maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature. |
|
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 |
|
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 |
|
The |
|
Custom widget for displaying subheaders within a QMenu in a standard style. |
|
Custom QWidgetAction for displaying subheaders within a QMenu in a standard style. |
|
A bar for displaying non-blocking messages to the user. |
|
Represents an item shown within a |
|
A generic dialog widget for displaying QGIS log messages. |
|
A generic message view for displaying QGIS messages. |
|
A wizard to edit metadata on a map layer. |
|
A dialog to create a new auxiliary field |
|
A dialog to create a new auxiliary layer |
|
|
|
The |
|
Dialog to set up parameters to create a new GeoPackage layer, and on |
|
Dialog to allow the user to configure and save connection information for an HTTP Server for WMS, etc. |
|
New dialog constructor. |
|
New name, for example new layer name dialog. If existing names are provided, the dialog warns users if an entered name already exists. |
|
New dialog constructor. |
|
The |
|
Dialog to create connections and add layers WCS etc. |
|
A widget for setting an opacity value. |
|
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 |
|
A highlight widget for buttons. This is used to search and highlight text in |
|
A highlight widget for checkboxes. This is used to search and highlight text in |
|
A highlight widget for group boxes. This is used to search and highlight text in |
|
A highlight widget for labels. This is used to search and highlight text in |
|
A highlight widget for table widgets. This is used to search and highlight text in |
|
A highlight widget for trees. This is used to search and highlight text in |
|
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. |
|
Base class for widgets for pages included in the options dialog. |
|
This is a dialog to build and manage a list of order by clauses. |
|
A custom layout which can be used to overlay child widgets over a parent widget. |
|
Base class for any widget that can be shown as a inline panel |
|
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. |
|
Wrapper widget for existing widgets which can’t have the inheritance tree changed, e.g dialogs. |
|
QLineEdit subclass with built in support for showing/hiding entered password. |
|
A widget for setting a percentage value. |
|
A line edit widget with toolbutton for setting a raster image path. |
|
The |
|
A compound widget containing a set of buttons for controlling media playback. |
|
The |
|
Query Builder for layers. |
|
A dialog which allows users to modify the properties of a |
|
A widget which allows users to modify the properties of a |
|
A graphics effect which can be applied to a widget to simulate various printing and color blindness modes. |
|
Abstract interface for project storage GUI - to be implemented by various backends and registered in |
|
A registry / canonical manager of GUI parts of project storage backends. |
|
Shows a user-friendly assistant guiding users through the creation of |
|
A button for controlling property overrides which may apply to a widget. |
|
The |
|
Holds data for GUI part of the data providers |
|
A registry / canonical manager of GUI parts of data providers. |
|
Base class for widgets which allow customization of a provider’s source URI. |
|
An interface for providers of widgets designed to configure a data provider’s source. |
|
This class keeps a list of provider source widget providers. |
|
Dialog for selecting provider sublayers. |
|
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. |
|
Query Builder for layers. |
|
The |
|
A slider control with two interactive endpoints, for interactive selection of a range of values. |
|
A widget to select format-specific raster saving options |
|
Constructor for QgsRasterLayerSaveAsDialog |
|
A widget to select format-specific raster saving options |
|
A cross platform button subclass used to represent a locked / unlocked ratio state. |
|
Creates a new configuration widget for the relation editor widget |
|
The default relation widget in QGIS. |
|
Keeps track of the registered relations widgets. New widgets can be registered, old ones deleted. The default { |
|
A widget for editing rich text documents, with support for user controlled formatting of text and insertion of hyperlinks and images. |
|
A class for drawing transient features (e.g. digitizing lines) on the map. |
|
A combobox which lets the user select map scale from predefined list and highlights nearest to current scale value |
|
A widget allowing entry of a range of map scales, e.g. minimum scale and maximum scale. |
|
A dialog allowing users to enter a scale visibility range. |
|
A combobox which lets the user select map scale from predefined list and highlights nearest to current scale value |
|
A utility class for dynamic handling of changes to screen properties. |
|
A QScrollArea subclass with improved scrolling behavior. |
|
Encapsulates the details of a highlight in a scrollbar, used alongside |
|
Adds highlights (colored markers) to a scrollbar. |
|
Query Builder for search strings |
|
Shortcuts manager is a class that contains a list of QActions and QShortcuts that have been registered and their shortcuts can be changed. |
|
Constructor for QgsSlider |
|
Class that shows snapping marker on map canvas for the current snapping match. |
|
Shows a grid on the map canvas given a spatial resolution. |
|
This is the interface for those who want to add entries to the |
|
This class keeps a list of source select providers that may add items to the |
|
A proxy widget for QStatusBar. |
|
A reusable widget for showing a filtered list of entities from a |
|
Deprecated since version 3.40. |
|
Interface for a dialog that can edit subset strings |
|
This is the interface for those who want to provide a dialog to edit a subset string. |
|
This class keeps a list of subset string editor providers. |
|
A dialog which allows users to specify a list of substitutions to apply to a string, with options for exporting and importing substitution lists. |
|
A widget which allows users to specify a list of substitutions to apply to a string, with options for exporting and importing substitution lists. |
|
A line edit widget with toolbutton for setting an SVG image path. |
|
A button for creating and modifying |
|
The |
|
A QTableView subclass with QGIS specific tweaks and improvements. |
|
Base widget allowing to edit a collection, using a table. |
|
This can be used like a regular QTableWidgetItem with the difference that a specific role can be set to sort. |
|
A widget which displays tasks from a |
|
A widget for controlling playback properties of a |
|
A simple dialog for customizing text formatting settings. |
|
A panel widget for customizing text formatting settings. |
|
A widget for customizing text formatting settings. |
|
A widget for previewing text formatting settings. |
|
QComboBox subclass which features a tooltip when mouse hovering the combobox. The tooltip string is taken from the current item’s Qt.ToolTipRole data. |
|
QTreeWidgetItem subclass with custom handling for item sorting. |
|
Custom |
|
A widget displaying a combobox allowing the user to choose between various display units, such as millimeters or map units. |
|
The |
|
|
|
A QAbstractItemModel subclass for displaying the results from a |
|
A reusable widget which displays a summary of the results from a |
|
A tree based widget for editing expression context scope variables. The widget allows editing variables from a |
|
A widget for configuring the temporal properties for a vector layer. |
|
A class for marking vertices of features using e.g. circles or ‘x’. |
|
Interface for window manager. |
Annotations and Annotation Layers¶
Stores GUI metadata about one annotation item class. |
|
A base class for property widgets for annotation items. |
|
A widget for configuring common properties for |
|
Stores GUI metadata about a group of annotation item classes. |
|
Registry of available annotation item GUI behavior. |
|
A handler object for map tools which create annotation items. |
|
An interface for map tools which create annotation items. |
|
An annotation item that embeds a designer form showing the feature |
Attribute Editor Widgets¶
Wraps a button widget to launch a layer action. |
|
Wraps a checkbox edit widget for searching. |
|
The |
|
The |
|
Wraps a date/time edit widget for searching. |
|
Wraps a search widget. Default form is just a |
|
The |
|
Wraps a QQuickWidget to display HTML code |
|
The |
|
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. |
|
Wraps a QQuickWidget to display QML code |
|
Search widget for the children of a relation. For each attribute of the child, an additional |
|
Wraps a relation reference search widget. |
|
Wraps a relation reference widget. |
|
Constructor for QgsRelationWidgetWrapper |
|
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. |
|
Wraps a spacer widget. |
|
The |
|
Wraps a label widget to display text |
|
The |
|
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. |
|
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¶
This class should be subclassed for every configurable editor widget type. |
|
Base class for plugins allowing to pick automatically a widget type for editing fields. |
|
Every attribute editor widget needs a factory, which inherits this class |
|
This class manages all known edit widget factories. |
|
Manages an editor widget Widget and wrapper share the same parent |
|
Shows a search widget on a filter form. |
|
Manages an editor widget Widget and wrapper share the same parent |
Attribute Table and Forms¶
Create a new attribute table action. |
|
A delegate item class for |
|
Make sure, the master model is already loaded, so the selection will get synchronized. |
|
A model backed by a |
|
Provides a table view of features of a |
|
This widget is used to show the attributes of a set of features of a |
|
A widget for customizing an individual conditional formatting rule. |
|
Constructor for QgsFeatureListModel |
|
Shows a list of features and renders a edit button next to each feature. |
|
A widget for customizing conditional formatting options. |
|
Is an interface class to abstract feature selection handling. |
|
Dialog for organising (hiding and reordering) columns in the attributes table. |
Authentication Framework¶
Widget for viewing and editing authentication identities database |
|
Wrapper widget to manage available certificate editors |
|
Widget for viewing detailed info on a certificate and its hierarchical trust chain |
|
Dialog wrapper for widget displaying detailed info on a certificate and its hierarchical trust chain |
|
Dialog wrapper for widget to manage available certificate editors |
|
Widget for editing the trust policy associated with a Certificate (Intermediate) Authority |
|
Widget for editing authentication configuration database |
|
Selector widget for authentication configs |
|
Dialog wrapper of select widget to edit an authcfg in a data source URI |
|
Wrapper widget for available authentication editors |
|
Widget for viewing and editing authentication identities database |
|
Widget for importing a certificate into the authentication database |
|
Widget for importing an identity certificate/key bundle into the authentication database |
|
Abstract base class for the edit widget of authentication method plugins |
|
Dialog for viewing available authentication method plugins |
|
Widget for viewing and editing servers in authentication database |
|
Widget for entering authentication credentials both in the form username/password and by using QGIS Authentication Database and its authentication configurations. |
|
Dialog wrapper of widget for editing an SSL server configuration |
|
Widget for editing an SSL server configuration |
|
Widget for reporting SSL errors and offering an option to store an SSL server exception into the authentication database |
|
Widget for importing an SSL server certificate exception into the authentication database |
|
Widget for listing trusted Certificate (Intermediate) Authorities used in secure connections |
Browser¶
A model for showing available data sources and other items in a structured tree. |
Code Editors¶
A text editor based on QScintilla2. |
|
A CSS editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
Defines a color scheme for use in |
|
A registry of color schemes for use in |
|
A custom dock widget for code editors. |
|
A QGIS expression editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
A HTML editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
A Javascript editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
A JSON editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
A Python editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
A R stats code editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
A SQL editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
A shell script code editor based on QScintilla2. Adds syntax highlighting and code autocompletion. |
|
A widget which wraps a |
|
An interface for code interpreters. |
Coordinate Systems and Transformations¶
A widget for showing the bounds of a rectangular region on an interactive map. |
|
A widget for selecting the coordinate operation to use when transforming between a source and destination coordinate reference system. |
|
A tree model for display of known coordinate reference systems. |
|
A sort/filter proxy model for coordinate reference systems. |
|
A widget for definition a custom coordinate reference system. |
|
A generic widget allowing users to pick a Coordinate Reference System (or define their own). |
|
A generic dialog to prompt the user for a Coordinate Reference System. |
|
A widget for selecting a coordinate reference system from a tree. |
|
A widget for selecting a projection. |
|
A model for display of recently used coordinate reference systems. |
|
A sort/filter proxy model for recent coordinate reference systems. |
Data Providers¶
The |
|
A model for representing the sublayers present in a URI for the |
Data Providers - GDAL¶
A widget for configuring GDAL credential options. |
Data Providers - OGR¶
Class to select destination file, type and CRS for ogr layers |
Development Tools¶
A panel widget that can be shown in the developer tools panel. |
|
Factory class for creating custom developer/debugging tool pages |
Elevation Handling¶
A widget for configuring vertical elevation slicing behavior for maps. |
|
A canvas for elevation profiles. |
Geocoding¶
An adapter class which implements a locator filter populated from a |
Input Controller Handling¶
Abstract base class for all 2D map controllers. |
|
Abstract base class for all 3D map controllers. |
|
Abstract base class for all input controllers. |
|
Manages input control devices. |
Label Callouts¶
A panel widget for configuration of callouts. |
|
Base class for widgets which allow control over the properties of callouts. |
Labeling¶
A widget for customising label line anchor settings. |
|
A widget for customising label obstacle settings. |
|
Base class for widgets which allow customization of label engine properties, such as label placement settings. |
|
A blocking dialog containing a |
|
Base class for widgets which allow control over the properties of |
|
A dialog which allows configuration of a list of labeling engine rules. |
|
A widget which allows configuration of a list of labeling engine rules. |
Layer Tree and Legends¶
The |
|
A widget to configure layer tree embedded widgets for a particular map layer. |
|
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. |
|
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. |
|
The |
|
The |
|
The |
|
The |
|
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 |
|
Implementation of this interface can be implemented to allow |
Locator Bar¶
A special locator widget which allows searching for matching results from a |
Map Actions¶
This class is a menu that is populated automatically with the actions defined for a given layer. |
|
Create an attribute dialog for a given layer and feature |
|
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) |
|
Encapsulates the context in which a |
|
An interface for objects which can create a |
|
This class tracks map layer actions. |
Map Tools¶
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. |
|
The |
|
|
|
|
|
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. |
|
Base class for map tools that edit vector geometry |
|
A map tool that simply emits a point when clicking on the map. Connecting a slot to its |
|
A map tool that emits an extent from a rectangle drawn onto the map canvas. |
|
Map tool for identifying features in layers |
|
The |
|
A map tool for panning the map. |
|
A map tool for zooming into the map. |
Mesh Layers¶
Property sheet for a mesh map layer. Contains information, source and style tabs |
Numeric Formats¶
A widget which allow control over the properties of a |
|
A dialog which allow control over the properties of a |
|
A widget which allow control over the properties of a |
|
A widget which allow control over the properties of a |
|
A widget which allow control over the properties of a |
|
A widget which allow control over the properties of a |
|
A dialog which allow control over the properties of a |
|
A widget which allow control over the properties of a |
|
Interface base class for factories for numeric format configuration widgets. |
|
The |
|
A simple dialog for customizing a numeric format. |
|
A widget which allows choice of numeric formats and the properties of them. |
|
Base class for widgets which allow control over the properties of |
|
A widget which allow control over the properties of a |
|
A widget which allow control over the properties of a |
Paint Effects¶
A combo box allowing selection of paint effect draw modes |
|
A small widget consisting of a checkbox for enabling/disabling an effect stack and a button for opening an effect stack customization dialog. |
|
A dialog for modifying the properties of a |
|
A widget for modifying the properties of a |
|
A widget which modifies the properties of a |
|
Base class for effect properties widgets. |
|
Plot and Graph Rendering¶
Plot canvas is a class for displaying interactive 2d charts and plots. |
|
An abstract class for items that can be placed on a |
|
A |
|
|
|
|
|
Abstract base class for all interactive plot tools. |
|
Plot tool for panning/zoom/navigating plots. |
|
Plot tool for temporarily panning a plot while a key is depressed. |
|
Plot tool for temporarily zooming a plot while a key is depressed. |
|
Plot tool for temporarily panning a plot while a mouse button is depressed. |
|
Plot tool for zooming into and out of the plot. |
Point Cloud Layers¶
A generic widget for setting the 2D renderer for a point cloud layer. |
|
Base class for point cloud 2D renderer settings widgets. |
Print Layouts and Reports¶
The |
|
An object for property widgets for layout items. All layout config type widgets should contain this object. |
|
Abstract base class that may be implemented to handle new types of data to be dropped or pasted in QGIS layouts. |
|
A common interface for layout designer dialogs and widgets. |
|
Stores GUI metadata about one layout item class. |
|
A base class for property widgets for layout items. All layout item widgets should inherit from this base class. |
|
The |
|
Stores GUI metadata about a group of layout item classes. |
|
Registry of available layout item GUI behavior. |
|
A dialog for configuring properties like the size and position of layout items. |
|
A widget for controlling the common properties of layout items (e.g. position and size, background, stroke, frame). This widget can be embedded into other layout item widgets. |
|
A custom ruler widget for use with |
|
A custom combo box for selecting units for layout settings. |
|
A graphical widget to display and interact with |
|
|
|
Interface for a |
|
A |
|
|
|
|
|
Abstract base class for all layout view tools. Layout view tools are user interactive tools for manipulating and adding items to |
|
Layout view tool for adding items to a layout. |
|
Layout view tool for adding node based items to a layout. |
|
Layout view tool for edit node based items in the layout. |
|
Layout view tool for moving and zooming item content. |
|
Layout view tool for panning the layout. |
|
Layout view tool for selecting items in the layout. |
|
Layout view tool for temporarily panning a layout while a key is depressed. |
|
Layout view tool for temporarily zooming a layout while a key is depressed. |
|
Layout view tool for temporarily panning a layout while a mouse button is depressed. |
|
Layout view tool for zooming into and out of the layout. |
|
|
Processing Framework¶
A widget wrapper for Processing parameter value widgets. |
|
The |
|
The |
|
Abstract base class for widgets which allow users to specify the properties of a Processing parameter. |
|
A configuration widget for processing algorithms allows providing additional configuration options directly on algorithm level, in addition to parameters. |
|
Interface base class for factories for algorithm configuration widgets. |
|
Base class for processing algorithm dialogs. |
|
Base class for processing batch algorithm dialogs. |
|
An interface for objects which can create Processing contexts. |
|
A manager for tracking favorite Processing algorithms. |
|
Contains general functions and values related to Processing GUI components. |
|
The |
|
Contains utility functions relating to Processing GUI components. |
|
An widget wrapper for hidden widgets. |
|
A dialog for showing Processing algorithm execution history. |
|
History provider for operations performed through the Processing framework. |
|
A widget for showing Processing algorithm execution history. |
|
A widget which allows users to select the destination path for an output style Processing parameter. |
|
Processing map layer combo box. |
|
A widget for customising the value of Processing algorithm parameter inside a Processing model. |
|
A dialog for selection of multiple layer inputs. |
|
A panel widget for selection of multiple inputs from a fixed list of options. |
|
A dialog for selection of multiple options from a fixed list of options. |
|
A panel widget for selection of multiple options from a fixed list of options. |
|
A dialog which allow users to specify the properties of a Processing parameter. |
|
A widget which allow users to specify the properties of a Processing parameter. |
|
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. |
|
An interface for Processing widget wrapper factories. |
|
An interface for objects which can create sets of parameter values for processing algorithms. |
|
A widget which allows users to select the value for the parameters for an algorithm. |
|
A log for tracking recently used processing algorithms. |
|
A model for providers and algorithms shown within the Processing toolbox. |
|
Processing toolbox model node corresponding to an algorithm. |
|
Processing toolbox model node corresponding to the favorite algorithms |
|
Processing toolbox model node corresponding to a group of algorithms. |
|
Abstract base class for nodes contained within a |
|
Processing toolbox model node corresponding to a Processing provider. |
|
Processing toolbox model node corresponding to the recent algorithms |
|
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. |
|
Processing toolbox tree view, showing algorithms and providers in a tree structure. |
Processing Framework - Models¶
A link arrow item for use in the model designer. |
|
A graphic item representing a child algorithm in the model designer. |
|
A graphic item representing a model comment in the model designer. |
|
Base class for graphic items representing model components in the model designer. |
|
Model designer dialog base class |
|
A flat button graphic item for use in the Processing model designer. |
|
A button allowing folding or expanding component graphics in the Processing model designer. |
|
QGraphicsScene subclass representing the model designer. |
|
QGraphicsView subclass representing the model designer. |
|
A graphic item representing a group box in the model designer. |
|
A graphic item representing a model output in the model designer. |
|
A graphic item representing a model parameter (input) in the model designer. |
|
A simple graphics item rendered as an ‘x’. |
Raster Layers¶
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. |
|
Renderer widget for the hill shade renderer. |
|
Constructor for QgsMultiBandColorRendererWidget. |
|
Constructor for |
|
The |
|
The |
|
The |
|
A combobox widget which displays the bands present in a raster layer. |
|
Configuration widget for |
|
Histogram widget |
|
Property sheet for a raster map layer |
|
A widget for configuring the temporal properties for a raster layer. |
|
Constructor for QgsRasterMinMaxWidget |
|
Abstract base class for widgets which configure a |
|
Widget to control a layers transparency and related options |
|
A widget to hold the renderer properties for a raster layer. |
|
Constructor for QgsSingleBandGrayRendererWidget. |
|
Single band pseudo color renderer widget consists of a color ramp shader widget, a raster min max widget and a band selector. |
Sensor Handling¶
Base class for widgets which allow control over the properties of sensors. |
|
Stores GUI metadata about one sensor class. |
|
Registry of available sensor GUI behavior. |
Settings Handling¶
A settings editor widget wrapper for enum settings as PyQgsSettingsEntryEnumFlag |
|
This class is a factory of editor for boolean settings with a checkbox |
|
This class is a factory of editor for color settings with a color button |
|
This class is a factory of editor for double settings with a double spin |
|
This class manages editor widgets for settings |
|
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 |
This class is a factory of editor for integer settings with a spin box |
|
|
|
This class is a factory of editor for string settings with a combo box |
|
This class is a factory of editor for string settings with a line edit |
|
|
|
|
|
|
Symbology and Vector Renderers¶
A widget for displaying characters available in a preset font, and allowing users to select an individual character. |
|
|
|
Widget for configuring |
|
|
|
Constructor for QgsCentroidFillSymbolLayerWidget. |
|
A dialog which allows users to modify the properties of a |
|
A dialog to enter a custom dash space pattern for lines |
|
A widget to enter a custom dash space pattern for lines |
|
Widget for configuration of appearance of legend for marker symbols with data-defined size. |
|
Utility classes for “en masse” size definition. |
|
Constructor for QgsEllipseSymbolLayerWidget. |
|
A widget used represent options of a |
|
A widget for configuring |
|
Widget for configuring |
|
Constructor for QgsFontMarkerSymbolLayerWidget. |
|
Constructor for QgsGeometryGeneratorSymbolLayerWidget. |
|
Constructor for QgsGradientFillSymbolLayerWidget. |
|
Graphical histogram for displaying distribution of field values and editing range breaks for a |
|
Widget for controlling the properties of a |
|
|
|
A widget used represent options of a |
|
A widget which allows configuration of the properties of a single |
|
Constructor for QgsLinePatternFillSymbolLayerWidget. |
|
Widget for controlling the properties of a |
|
Widget for configuring |
|
Constructor for QgsMarkerLineSymbolLayerWidget. |
|
Symbol layer widget for the handling of |
|
A widget used represent options of a |
|
Blank widget for customizing |
|
A widget which allows configuration of the properties for a |
|
Constructor for QgsPointPatternFillSymbolLayerWidget. |
|
Widget for controlling the properties of a |
|
Constructor for QgsRasterFillSymbolLayerWidget. |
|
Widget for configuring |
|
Widget for configuring |
|
Constructor for QgsRendererPropertiesDialog. |
|
Constructor for QgsRendererRulePropsDialog |
|
Widget to edit the details of a rule based renderer rule. |
|
Base class for renderer settings widgets. |
|
Tree model for the rules: |
|
Constructor for QgsSVGFillSymbolLayerWidget. |
|
Constructor for QgsShapeburstFillSymbolLayerWidget. |
|
Constructor for QgsSimpleFillSymbolLayerWidget. |
|
Constructor for QgsSimpleLineSymbolLayerWidget. |
|
Constructor for QgsSimpleMarkerSymbolLayerWidget. |
|
Constructor for QgsStyleExportImportDialog, with the specified |
|
A dialog allowing users to customize and populate a |
|
a dialog for setting properties of a newly saved style. |
|
Constructor for QgsSvgMarkerSymbolLayerWidget. |
|
Constructor for QgsSvgSelectorDialog. |
|
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. |
|
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. |
|
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. |
|
A widget allowing selection of an SVG file, and configuration of SVG related parameters. |
|
A dialog for customising animation settings for a symbol. |
|
A widget for customising animation settings for a symbol. |
|
A dialog for customising buffer settings for a symbol. |
|
A widget for customising buffer settings for a symbol. |
|
Constructor for QgsSymbolLayerWidget. |
|
A dialog which allows the user to modify the rendering order of symbol layers. |
|
A widget which allows the user to modify the rendering order of symbol layers. |
|
A dialog that can be used to select and build a symbol. |
|
Symbol selector widget that can be used to select and build a symbol |
|
Contains settings which reflect the context in which a symbol (or renderer) widget is shown, e.g., the map canvas and relevant expression contexts. |
|
Constructor for QgsSymbolsListWidget. |
|
Constructor for QgsVectorFieldSymbolLayerWidget. |
Table Editor¶
A reusable window for editing simple spreadsheet-style tables. |
|
A reusable widget for editing simple spreadsheet-style tables. |
Tiled Scene Layers¶
A generic widget for setting the 2D renderer for a tiled scene layer. |
|
Base class for tiled scene 2D renderer settings widgets. |
User History Tracking¶
Abstract base class for objects which track user history (i.e. operations performed through the GUI). |
|
Encapsulates a history entry. |
|
Base class for history entry “group” nodes, which contain children of their own. |
|
An item model representing history entries in a hierarchical tree structure. |
|
Base class for nodes representing a |
|
The |
|
A widget showing entries from a |
|
Contains settings which reflect the context in which a history widget is shown, e.g., an associated message bar. |
Vector Layers¶
A dialog class that provides calculation of new fields using existing fields, values and a set of operators |
|
Vector Tile Layers¶
Vectortile layer properties dialog |