gui¶
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 class for Data Source widgets to create connections and add layers. |
|
Abstract base class for widgets which allow users to select content from a file, embedding a file, etc. |
|
An abstract base class for map tool handlers, implementing application level UI logic. |
|
Abstract base class for configurable relation widget types. |
|
Base class to build new relation widgets. |
|
Factory class for creating relation widgets and their corresponding config widgets. |
|
Draws the graphical elements of the CAD tools ( |
|
A dockable widget used to handle the CAD tools on top of a selection of map tools. |
|
A widget that floats next to the mouse pointer, and allows interaction with the AdvancedDigitizing feature. |
|
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. |
|
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. |
|
Contains context information for attribute editor widgets. |
|
The attribute form widget for vector layer features. |
|
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. |
|
Interface class for custom attribute forms. |
|
Widget to show for child relations on an attribute form. |
|
Base class for all widgets shown on a |
|
A dialog which allows populating value maps using features present in a vector layer. |
|
A combobox which lets the user select blend modes from a predefined list. |
|
A dock widget containing a |
|
Extends QTreeView with save/restore tree state and other browser-specific functionality. |
|
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 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. |
|
A groupbox that collapses/expands when toggled. |
|
A color box widget. |
|
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. |
|
A custom QGIS dialog for selecting a color. |
|
A preview box which displays one or two colors as swatches. |
|
A cross platform button subclass for selecting color ramps. |
|
A dialog for configuring a |
|
A widget for properties relating to a |
|
A color ramp widget. |
|
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. |
|
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. |
|
A base class for interactive color widgets. |
|
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 |
|
A registry for data item GUI providers that may affect how |
|
Utility functions for |
|
A dialog which embeds the browser view to select an existing data source. |
|
Embeds the browser view to select an existing data source. |
|
A combo box which displays the list of schemas for a specific database connection. |
|
Dialog which displays selection of a schema for a specific database connection. |
|
A combobox which displays the list of tables for a specific database connection. |
|
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. |
|
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. |
|
A QDial subclass with additional refinements. |
|
A generic dialog with layout and button box. |
|
Widget for direction light settings. |
|
A QDockWidget subclass with more fine-grained control over how the widget is closed or opened. |
|
A custom validator which allows entry of doubles in a locale-tolerant way. |
|
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. |
|
A dialog which shows error details. |
|
A generic dialog for building expression strings. |
|
A reusable widget that can be used to build an expression string. |
|
Syntax highlighter for QGIS expressions. |
|
An expression item that can be used in the |
|
Search proxy used to filter the |
|
A widget which includes a line edit for entering expressions together with a button to open the expression creation dialog. |
|
A widget for previewing an expression result. |
|
A dialog for selecting features by expression. |
|
A generic dialog for editing expression text, label and help text. |
|
A tree view to list all expressions functions, variables and fields that can be used in an expression. |
|
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. |
|
A widget for selecting a file or a folder and optionally storing it to an external storage backend. |
|
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. |
|
A dialog for selecting features from a vector layer. |
|
A combobox which displays the list of fields of a given layer. |
|
A dialog for configuration of the properties of a |
|
A widget for configuration of the properties of a |
|
A widget for selection of layer fields or expression creation. |
|
Holds mapping information for mapping from one set of |
|
Creates a mapping from one set of |
|
A QValidator for validation against a |
|
A line edit with an autocompleter which takes unique values from a vector layer’s fields. |
|
A QProgressDialog subclass which handles file downloads and user feedback. |
|
A widget for selecting a file or a folder. |
|
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. |
|
An event filter for watching for focus events on a parent object. |
|
A button for customizing |
|
A rubberband class for |
|
A widget for storing and interacting with a |
|
Abstract interface class for the QGIS GPS tools. |
|
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. |
|
A collapse button widget for collapsible group boxes. |
|
A dialog for configuring a WMS group. |
|
A singleton class containing various registry and other global members related to GUI classes. |
|
Helper class for showing help topic URI for the given key. |
|
Highlights features on the map. |
|
A |
|
Graphical histogram for displaying distributions of field values. |
|
Displays referer HTTP header field and collapsible table of key/value pairs. |
|
Builds a menu to be used with identify results. |
|
A line edit widget with toolbutton for setting a raster image path. |
|
Widget allowing editing a QVariantMap, using a table. |
|
A dialog for setting a lower and upper range value. |
|
The |
|
A proxy model for |
|
Offers layer metadata search and filtering. |
|
Base class for “layer properties” dialogs, containing common utilities for handling functionality in these dialogs. |
|
A tool button that allows enabling or disabling legend filter by contents of the map. |
|
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 editing a QVariantList, using a table. |
|
A QValidator which allows validation of long long values. |
|
A dialog for importing or exporting stored connections. |
|
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. |
|
A widget which is used to visually manage the layer styles. |
|
A mouse event which is the result of a user interaction with a |
|
A widget that displays an overview map. |
|
Displays a tool tip on a map canvas when the 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. |
|
A widget which allows the user to choose the minimum and maximum scale of an object in map units and millimeters. |
|
A widget for playing back audio and video media files. |
|
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. |
|
A dialog which allows selection of a DB schema and a new table name. |
|
A widget which embeds the browser view to select a DB schema and a new table name. |
|
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. |
|
A dialog for configuring the properties of a new memory (scratch) layer. |
|
A dialog for prompting users for a new name, for example new layer name dialog. |
|
A dialog for configuring the properties of a new vector layer. |
|
A dialog for customising new tables created on a database. |
|
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. |
|
A highlight widget for buttons. |
|
A highlight widget for checkboxes. |
|
A highlight widget for group boxes. |
|
A highlight widget for labels. |
|
A highlight widget for table widgets. |
|
A highlight widget for trees. |
|
Container for a widget to be used to search text in the option dialog. |
|
Base class for widgets for pages included in the options dialog. |
|
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 an inline panel. |
|
A stack widget to manage multiple overlapping stacked 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 the entered password. |
|
A widget for setting a percentage value. |
|
A line edit widget with toolbutton for setting a raster image path. |
|
Shows a pixmap and adjusts its size to the space given to the widget by the layout and keeping its aspect ratio. |
|
A compound widget containing a set of buttons for controlling media playback. |
|
Abstract interface class for the QGIS plugin manager. |
|
A combobox which displays the list of attributes of a given point cloud layer. |
|
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. |
|
Contains general functions and values related to Processing GUI components. |
|
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. |
|
A combo box which displays the list of connections registered for a given provider. |
|
Holds data for the 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. |
|
A registry that 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. |
|
A dialog which allows users to enter and run an SQL query on a DB connection (an instance of |
|
A main window which allows users to enter and run an SQL query on a DB connection (an instance of |
|
A widget which allows users to enter and run an SQL query on a DB connection (an instance of |
|
A slider control with two interactive endpoints, for interactive selection of a range of values. |
|
A widget to select format-specific raster saving options. |
|
A dialog for configuring raster layer export parameters. |
|
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. |
|
A widget for editing rich text documents, with support for user controlled formatting of text and insertion of hyperlinks and images. |
|
Responsible 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 which lets the user select from scale calculation methods. |
|
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. |
|
A custom QSlider with additional refinements. |
|
Shows a snapping marker on map canvas for the current snapping match. |
|
Shows a grid on the map canvas given a spatial resolution. |
|
An interface for pages shown in a |
|
A registry for |
|
A proxy widget for QStatusBar. |
|
A manager for stored SQL queries. |
|
A reusable widget for showing a filtered list of entities from a |
|
Presents a choice of sublayers. |
|
Interface for a dialog that can edit subset strings. |
|
An interface for widgets which edit a subset string. |
|
A registry for 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 |
|
A QTabWidget with additional methods to temporarily hide/show tabs. |
|
A QTableView subclass with QGIS specific tweaks and improvements. |
|
Base widget allowing editing 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. |
|
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. |
|
A floating widget that can be used to display widgets for user inputs. |
|
A QScrollArea subclass which only displays a vertical scrollbar and fits the width to the contents. |
|
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. |
|
A widget for configuring the temporal properties for a vector layer. |
|
A map canvas item 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. |
Attribute Editor Widgets¶
Wraps a button widget to launch a layer action. |
|
Wraps a checkbox edit widget for searching. |
|
A QDateEdit widget with the capability of setting/reading null dates. |
|
A QDateTimeEdit with the capability of setting/reading null date/times. |
|
Wraps a date/time edit widget for searching. |
|
Wraps a search widget. |
|
The |
|
Wraps a QQuickWidget to display HTML code. |
|
A widget for displaying JSON data in a code highlighted text or tree form. |
|
A tool button for controlling how edits to multiple features are applied. |
|
Wraps a QQuickWidget to display QML code. |
|
Search widget for the children of a relation. |
|
Wraps a relation reference search widget. |
|
A widget which shows related features. |
|
Wraps a relation reference widget. |
|
A widget wrapper for relation widgets. |
|
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. |
|
A spin box with a clear button that will set the value to the defined clear value. |
|
Wraps a label widget to display text. |
|
A QTimeEdit widget with the capability of setting/reading null date/times. |
|
Wraps a value map search widget. |
|
Wraps a value relation search widget. |
Attribute Editor Widgets - Core¶
Base class for widgets which configure editor widget types. |
|
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. |
|
A registry that manages all known edit widget factories. |
|
Manages an editor widget. |
|
Shows a search widget on a filter form. |
|
Manages an editor widget. |
Attribute Table and Forms¶
A QAction subclass for map layer actions shown in an attribute table. |
|
A delegate item class for |
|
A proxy model for filtering an attribute table model. |
|
A QAction for attribute table map layer actions. |
|
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. |
|
A proxy model for feature lists. |
|
Shows a list of features and renders an edit button next to each feature. |
|
Custom item delegate for feature list views. |
|
Base class for feature models. |
|
Item selection model for selecting features. |
|
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. |
|
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. |
|
A HTML editor based on QScintilla2. |
|
A Javascript editor based on QScintilla2. |
|
A JSON editor based on QScintilla2. |
|
A Python editor based on QScintilla2. |
|
A R stats code editor based on QScintilla2. |
|
A SQL editor based on QScintilla2. |
|
A shell script code editor based on QScintilla2. |
|
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 defining 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¶
Base class for database source widget selectors. |
|
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¶
A dialog for configuring vector layer save to file operations. |
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. |
|
A widget for customising label duplicate removal 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. |
|
A dialog for entering a custom dash space pattern for lines. |
|
A widget for configuring |
Layer Tree and Legends¶
A list box where the user can define custom order for drawing of layers. |
|
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. |
|
Registry of widgets that may be embedded into layer tree view. |
|
Takes care of updates of layer sets for a |
|
A proxy model for |
|
Extends QTreeView and provides additional functionality when working with a layer tree. |
|
Serves as a factory of actions that can be used together with a layer tree view. |
|
Indicator that can be used in a layer tree view to display icons next to items of the layer tree. |
|
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¶
A menu that is populated automatically with the actions defined for a given layer. |
|
An attribute table dialog for a vector layer. |
|
An action which can run on map layers. |
|
Encapsulates the context in which a |
|
An interface for objects which can create a |
|
A registry which tracks map layer actions. |
Map Tools¶
Abstract base class for all map tools. |
|
A |
|
Base class for map tools capable of capturing point, lines and polygons. |
|
Base class for map tools digitizing layer geometries. |
|
This tool digitizes geometry of new point/line/polygon features on already existing vector layers. |
|
Base class for map tools that edit vector geometry. |
|
A map tool that simply emits a point when clicking on the map. |
|
A map tool that emits an extent from a rectangle drawn onto the map canvas. |
|
Map tool for identifying features in layers. |
|
A map tool to identify a feature on a chosen layer. |
|
A map tool for panning the map. |
|
A map tool for zooming into the map. |
Mesh Layers¶
A dialog for configuring mesh layer properties. |
Numeric Formats¶
A widget which allows control over the properties of a |
|
A dialog which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
A dialog which allows control over the properties of a |
|
A widget which allows control over the properties of a |
|
Interface base class for factories for numeric format configuration widgets. |
|
A registry for widgets which configure |
|
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 allows control over the properties of a |
|
A widget which allows control over the properties of a |
Paint Effects¶
A widget for configuring |
|
A widget for configuring |
|
A widget for configuring |
|
A combobox 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 for configuring |
|
A widget which modifies the properties of a |
|
Base class for effect properties widgets. |
|
A widget for configuring |
|
A widget for configuring |
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 mouse event which is the result of a user interaction with a |
|
A rectangular rubber band for use within |
|
An abstract base class for temporary rubber band items in various shapes, for use within |
|
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¶
A combobox which displays available layouts from a |
|
An object for property widgets for layout items. |
|
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. |
|
A combo box which displays items of a matching type from a layout. |
|
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 |
|
An elliptical rubber band for use within |
|
Interface for a |
|
A mouse event which is the result of a user interaction with a |
|
A rectangular rubber band for use within |
|
An abstract base class for temporary rubber band items in various shapes, for use within |
|
Abstract base class for all layout view tools. |
|
Layout view tool for adding items to a layout. |
|
Layout view tool for adding node based items to a layout. |
|
Layout view tool for editing 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. |
|
A triangular rubber band for use within |
Processing Framework¶
A widget wrapper for Processing parameter value widgets. |
|
Holds mapping information for defining sets of aggregates of fields from a |
|
A widget which creates a mapping for defining sets of aggregates of fields from a |
|
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. |
|
A registry for widgets for use with the Processing framework. |
|
Contains utility functions relating to Processing GUI components. |
|
A 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 parameters 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 allows users to specify the properties of a Processing parameter. |
|
A widget which allows users to specify the properties of a Processing parameter. |
|
Contains settings which reflect the context in which a Processing parameter widget is shown. |
|
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 group. |
|
Processing toolbox model node corresponding to a group of algorithms. |
|
Abstract base class for nodes contained within a |
|
Processing toolbox model node corresponding to the parameter group. |
|
Processing toolbox model node corresponding to a parameter. |
|
Processing toolbox model node corresponding to a Processing provider. |
|
Processing toolbox model node corresponding to the recent algorithms group. |
|
A proxy model for providers and algorithms shown within the Processing toolbox. |
|
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. |
|
A socket allowing linking component together. |
|
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¶
A widget for configuring numeric ranges associated with a color ramp. |
|
Renderer widget for the hill shade renderer. |
|
A widget for configuring a |
|
A widget for configuring |
|
A dialog which embeds a raster attribute table widget. |
|
A model which represents a |
|
The |
|
A combobox widget which displays the bands present in a raster layer. |
|
Configuration widget for |
|
A widget for display and configuring a raster layer histogram. |
|
A dialog for raster layer properties. |
|
A widget for configuring the temporal properties for a raster layer. |
|
A widget for configuring how the minimum and maximum value of a raster layer is determined. |
|
Abstract base class for widgets which configure a |
|
A widget for controlling a raster layer’s transparency and related options. |
|
A widget for configuring properties of a raster layer renderer. |
|
A widget for configuring a |
|
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 |
|
A factory for editors of boolean settings with a checkbox. |
|
A factory for editors of color settings with a color button. |
|
A factory for editors for double settings with a double spin box. |
|
A registry that manages editor widgets for settings. |
|
Base class for settings editor wrappers. |
|
QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryBoolQCheckBoxboolBase |
Base factory for editors for settings. |
QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryColorQgsColorButtonQColorBase |
Base factory for editors for settings. |
QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryDoubleQDoubleSpinBoxdoubleBase |
Base factory for editors for settings. |
QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryIntegerQSpinBoxintBase |
Base factory for editors for settings. |
QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryStringQComboBoxQStringBase |
Base factory for editors for settings. |
QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryStringQLineEditQStringBase |
Base factory for editors for settings. |
A factory for editors for integer settings with a spin box. |
|
Used for settings introspection and collects all |
|
A factory for editors of string settings with a combo box. |
|
A factory for editors for string settings with a line edit. |
|
A tree model for the settings tree. |
|
A proxy model which allows filtering the settings tree. |
|
A widget with the settings tree to visualize, search and edit settings. |
Symbology and Vector Renderers¶
A widget for displaying characters available in a preset font, and allowing users to select an individual character. |
|
A widget for configuring a Qgs25DRenderer. |
|
A widget for configuring |
|
A widget for configuring a |
|
A combobox which presents choices of Qt.BrushStyle. |
|
A widget for configuring a |
|
A widget for controlling the properties of a |
|
A dialog which allows users to modify the properties of a |
|
A dialog for entering a custom dash space pattern for lines. |
|
A widget for entering a custom dash space pattern for lines. |
|
A dialog for configuring symbol-level data defined rotation. |
|
A dialog for configuring symbol-level data defined size. |
|
Widget for configuration of appearance of legend for marker symbols with data-defined size. |
|
Utility classes for “en masse” size definition. |
|
A dialog for configuring symbol-level data defined width. |
|
A widget for configuring a |
|
A widget for configuring options for a |
|
A widget for configuring |
|
A widget for configuring |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
Graphical histogram for displaying distribution of field values and editing range breaks for a |
|
A widget for configuring a |
|
A widget for controlling the properties of a |
|
A widget for configuring a |
|
A widget for configuring a |
|
A widget for configuring options for a |
|
A widget which allows configuration of the properties of a single |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
A widget for configuring |
|
A widget for controlling the properties of a |
|
Symbol layer widget for the handling of |
|
A widget for configuring options for a |
|
Blank widget for customizing |
|
A combobox widget for selection of Qt.PenCapStyle. |
|
A combobox widget for selection of Qt.PenJoinStyle. |
|
A combobox widget for selection of Qt.PenStyle. |
|
A widget which allows configuration of the properties for a |
|
A widget for configuring |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
A widget for configuring |
|
A widget for configuring |
|
A dialog for configuring vector layer renderers. |
|
A dialog for editing the details of a rule based renderer rule. |
|
A widget for editing the details of a rule based renderer rule. |
|
Base class for renderer settings widgets. |
|
Tree model for a rule-based renderer’s rules. |
|
A widget for configuring a |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
A widget for controlling the properties of a |
|
A widget for configuring |
|
A widget for configuring the conditions attached to a style smart group. |
|
A dialog for configuring a style smart group. |
|
A dialog allowing importing and exporting of entities from a |
|
A dialog which presents available groups from a |
|
A dialog allowing users to customize and populate a |
|
A dialog for setting properties of a newly saved style. |
|
A widget for controlling the properties of a |
|
A dialog for selection of an SVG file. |
|
A model for displaying SVG files with a preview icon which can be filtered by file name. |
|
A model for displaying SVG search paths. |
|
A model for displaying SVG files with a preview icon. |
|
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. |
|
Abstract base class for widgets used to configure |
|
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. |
|
A widget which presents symbol-level properties (such as size), and allows selection of symbols from stored styles. |
|
A widget for configuring a |
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 |
|
A registry for objects which track user history (i.e. operations performed through the GUI). |
|
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 that provides calculation of new fields using existing fields, values and a set of operators. |
|
Layer properties dialog for vector layers. |
Vector Tile Layers¶
Layer properties dialog for vector tile layers. |