It's built on top of core library and adds reusable GUI widgets. More...

Namespaces
	QgisGui
	/namespace QgisGui The QgisGui namespace contains constants and helper functions used throughout the QGIS GUI.

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

class	QgsAuthAuthoritiesEditor
	Widget for viewing and editing authentication identities database. More...

class	QgsAuthCertEditors
	Wrapper widget to manage available certificate editors. More...

class	QgsAuthCertInfo
	Widget for viewing detailed info on a certificate and its hierarchical trust chain. More...

class	QgsAuthCertInfoDialog
	Dialog wrapper for widget displaying detailed info on a certificate and its hierarchical trust chain. More...

class	QgsAuthCertManager
	Dialog wrapper for widget to manage available certificate editors. More...

class	QgsAuthCertTrustPolicyComboBox
	Widget for editing the trust policy associated with a Certificate (Intermediate) Authority. More...

class	QgsAuthConfigEdit
	Widget for editing an authentication configuration. More...

class	QgsAuthConfigEditor
	Widget for editing authentication configuration database. More...

class	QgsAuthConfigIdEdit
	Custom widget for editing an authentication configuration ID. More...

class	QgsAuthConfigSelect
	Selector widget for authentication configs. More...

class	QgsAuthConfigUriEdit
	Dialog wrapper of select widget to edit an authcfg in a data source URI. More...

class	QgsAuthEditorWidgets
	Wrapper widget for available authentication editors. More...

class	QgsAuthGuiUtils
	Utility functions for use by authentication GUI widgets or standalone apps. More...

class	QgsAuthIdentitiesEditor
	Widget for viewing and editing authentication identities database. More...

class	QgsAuthImportCertDialog
	Widget for importing a certificate into the authentication database. More...

class	QgsAuthImportIdentityDialog
	Widget for importing an identity certificate/key bundle into the authentication database. More...

class	QgsAuthMethodEdit
	Abstract base class for the edit widget of authentication method plugins. More...

class	QgsAuthMethodPlugins
	Dialog for viewing available authentication method plugins. More...

class	QgsAuthServersEditor
	Widget for viewing and editing servers in authentication database. More...

class	QgsAuthSslConfigDialog
	Dialog wrapper of widget for editing an SSL server configuration. More...

class	QgsAuthSslConfigWidget
	Widget for editing an SSL server configuration. More...

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

class	QgsAuthSslImportDialog
	Widget for importing an SSL server certificate exception into the authentication database. More...

class	QgsAuthTrustedCAsDialog
	Widget for listing trusted Certificate (Intermediate) Authorities used in secure connections. More...

class	QgsBlendModeComboBox
	A combobox which lets the user select blend modes from a predefined list. More...

class	QgsBusyIndicatorDialog
	A simple dialog to show an indeterminate busy progress indicator. More...

class	QgsCodeEditor
	A text editor based on QScintilla2. More...

class	QgsCodeEditorCSS
	A CSS editor based on QScintilla2. More...

class	QgsCodeEditorHTML
	A HTML editor based on QScintilla2. More...

class	QgsCodeEditorPython
	A Python editor based on QScintilla2. More...

class	QgsCodeEditorSQL
	A SQL editor based on QScintilla2. More...

class	QgsCollapsibleGroupBox
	A groupbox that collapses/expands when toggled and can save its collapsed and checked states. More...

class	QgsCollapsibleGroupBoxBasic
	A groupbox that collapses/expands when toggled. More...

class	QgsColorBox
	A color box widget. More...

class	QgsColorButton
	A cross platform button subclass for selecting colors. Will open a color chooser dialog when clicked. Offers live updates to button from color chooser dialog. More...

class	QgsColorButtonV2
	A cross platform button subclass for selecting colors. More...

class	QgsColorDialog
	A native operating system dialog for selecting a color. More...

class	QgsColorDialogV2
	A custom QGIS dialog for selecting a color. More...

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

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

class	QgsColorRampWidget
	A color ramp widget. More...

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

class	QgsColorSchemeModel
	A model for colors in a color scheme. More...

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

class	QgsColorSwatchDelegate
	A delegate for showing a color swatch in a list. More...

class	QgsColorSwatchGrid
	A grid of color swatches, which allows for user selection. More...

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

class	QgsColorWheel
	A color wheel widget. More...

class	QgsColorWidget
	A base class for interactive color widgets. More...

class	QgsCredentialDialog
	A generic dialog for requesting credentials. More...

class	QgsDataDefinedAssistant
	An assistant (wizard) dialog, accessible from a QgsDataDefinedButton. More...

class	QgsDataDefinedButton
	A button for defining data source field mappings or expressions. More...

class	QgsDataDefinedSymbolDialog

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

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

class	QgsDetailedItemWidget
	A widget renderer for detailed item views. More...

class	QgsDialog
	A generic dialog with layout and button box. More...

class	QgsEffectDrawModeComboBox
	A combo box allowing selection of paint effect draw modes. More...

class	QgsEffectStackCompactWidget
	A small widget consisting of a check box for enabling/disabling an effect stack and a button for opening an effect stack customisation dialog. More...

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

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

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

class	QgsFieldConditionalFormatWidget
	A widget for customising conditional formatting options. More...

class	QgsFileDropEdit
	A line edit for capturing file names that can have files dropped onto it via drag & drop. More...

class	QgsFilterLineEdit
	Lineedit with builtin clear button. More...

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

class	QgsGraduatedHistogramWidget
	Graphical histogram for displaying distribution of field values and editing range breaks for a QgsGraduatedSymbolRendererV2 renderer. More...

class	QgsHistogramWidget
	Graphical histogram for displaying distributions of field values. More...

class	QgsLegendInterface
	QgsLegendInterface Abstract base class to make QgsLegend available to plugins. More...

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

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

class	QgsMapCanvasLayer
	A class that stores visibility and presence in overview flags together with pointer to the layer. More...

class	QgsMapCanvasMap
	A rectangular graphics item representing the map on the canvas. More...

class	QgsMapCanvasSnapper
	This class reads the snapping properties from the current project and configures a QgsSnapper to perform the snapping. More...

class	QgsMapOverviewCanvas
	A widget that displays an overview map. More...

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

class	QgsMapTool
	Abstract base class for all map tools. More...

class	QgsMapToolEmitPoint
	A map tool that simply emits a point when clicking on the map. More...

class	QgsMapToolPan
	A map tool for panning the map. More...

class	QgsMapToolTouch
	A map tool for panning the map. More...

class	QgsMapToolZoom
	A map tool for zooming into the map. More...

class	QgsMasterPasswordResetDialog
	Dialog to verify current master password and initiate reset of authentication database with a new password. More...

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

class	QgsMessageLogViewer
	A generic dialog widget for displaying QGIS log messages. More...

class	QgsMessageViewer
	A generic message view for displaying QGIS messages. More...

class	QgsNewNameDialog
	New name, for example new layer name dialog. More...

class	QgsOptionsDialogBase
	A base dialog for options and properties dialogs that offers vertical tabs. More...

class	QgsPaintEffectPropertiesWidget
	A widget which modifies the properties of a QgsPaintEffect. More...

class	QgsPaintEffectWidget
	Base class for effect properties widgets. More...

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

class	QgsProjectBadLayerGuiHandler
	Handler for missing layers within project. More...

class	QgsProjectionSelectionWidget
	A widget for selecting a projection. More...

class	QgsProjectionSelector
	A widget for selecting a Coordinate reference system from a tree. More...

class	QgsRasterFormatSaveOptionsWidget
	A widget to select format-specific raster saving options. More...

class	QgsRasterPyramidsOptionsWidget
	A widget to select format-specific raster saving options. More...

class	QgsRubberBand
	A class for drawing transient features (e.g. More...

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

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

class	QgsVariableEditorWidget
	A tree based widget for editing expression context scope variables. More...

class	QgsVertexMarker
	A class for marking vertices of features using e.g. More...

Enumerations
enum	QgsAuthImportIdentityDialog::BundleTypes { QgsAuthImportIdentityDialog::PkiPaths = 0, QgsAuthImportIdentityDialog::PkiPkcs12 = 1 }
	Type of bundles supported. More...

enum	QgsAuthImportCertDialog::CertFilter { QgsAuthImportCertDialog::NoFilter = 1, QgsAuthImportCertDialog::CaFilter = 2 }
	Type of filter to apply to dialog. More...

enum	QgsAuthImportCertDialog::CertInput { QgsAuthImportCertDialog::AllInputs = 1, QgsAuthImportCertDialog::FileInput = 2, QgsAuthImportCertDialog::TextInput = 3 }
	Type of inputs for certificates. More...

enum	QgsProjectBadLayerGuiHandler::DataType { QgsProjectBadLayerGuiHandler::IS_VECTOR, QgsProjectBadLayerGuiHandler::IS_RASTER, QgsProjectBadLayerGuiHandler::IS_BOGUS }
	file data representation More...

enum	QgsVertexMarker::IconType { QgsVertexMarker::ICON_NONE, QgsVertexMarker::ICON_CROSS, QgsVertexMarker::ICON_X, QgsVertexMarker::ICON_BOX, QgsVertexMarker::ICON_CIRCLE }
	Icons. More...

enum	QgsRubberBand::IconType { QgsRubberBand::ICON_NONE, QgsRubberBand::ICON_CROSS, QgsRubberBand::ICON_X, QgsRubberBand::ICON_BOX, QgsRubberBand::ICON_CIRCLE, QgsRubberBand::ICON_FULL_BOX }
	Icons. More...

enum	QgsAuthImportIdentityDialog::IdentityType { QgsAuthImportIdentityDialog::CertIdentity = 0 }
	Type of identity being imported. More...

enum	QgsMessageBar::MessageLevel { QgsMessageBar::INFO = 0, QgsMessageBar::WARNING = 1, QgsMessageBar::CRITICAL = 2, QgsMessageBar::SUCCESS = 3 }

enum	QgsPreviewEffect::PreviewMode { QgsPreviewEffect::PreviewGrayscale, QgsPreviewEffect::PreviewMono, QgsPreviewEffect::PreviewProtanope, QgsPreviewEffect::PreviewDeuteranope }

enum	QgsProjectBadLayerGuiHandler::ProviderType { QgsProjectBadLayerGuiHandler::IS_FILE, QgsProjectBadLayerGuiHandler::IS_DATABASE, QgsProjectBadLayerGuiHandler::IS_URL, QgsProjectBadLayerGuiHandler::IS_Unknown }
	the three flavors for data More...

enum	QgsRasterFormatSaveOptionsWidget::Type { QgsRasterFormatSaveOptionsWidget::Default, QgsRasterFormatSaveOptionsWidget::Full, QgsRasterFormatSaveOptionsWidget::Table, QgsRasterFormatSaveOptionsWidget::LineEdit, QgsRasterFormatSaveOptionsWidget::ProfileLineEdit }

enum	QgsAuthConfigEdit::Validity { QgsAuthConfigEdit::Valid, QgsAuthConfigEdit::Invalid, QgsAuthConfigEdit::Unknown }
	Type of configuration validity. More...

enum	QgsAuthImportIdentityDialog::Validity { QgsAuthImportIdentityDialog::Valid, QgsAuthImportIdentityDialog::Invalid, QgsAuthImportIdentityDialog::Unknown }
	Type of certificate/bundle validity output. More...

enum	QgsMapCanvas::WheelAction { QgsMapCanvas::WheelZoom, QgsMapCanvas::WheelZoomAndRecenter, QgsMapCanvas::WheelZoomToMouseCursor, QgsMapCanvas::WheelNothing }

Variables
GUI_EXPORT const char *	zoom_in []
	Bitmap cursors for map operations. More...

Detailed Description

It's built on top of core library and adds reusable GUI widgets.

Enumeration Type Documentation

enum QgsAuthImportIdentityDialog::BundleTypes

Type of bundles supported.

Enumerator
PkiPaths
PkiPkcs12

Definition at line 43 of file qgsauthimportidentitydialog.h.

enum QgsAuthImportCertDialog::CertFilter

Type of filter to apply to dialog.

Enumerator
NoFilter
CaFilter

Definition at line 37 of file qgsauthimportcertdialog.h.

enum QgsAuthImportCertDialog::CertInput

Type of inputs for certificates.

Enumerator
AllInputs
FileInput
TextInput

Definition at line 44 of file qgsauthimportcertdialog.h.

enum QgsProjectBadLayerGuiHandler::DataType

protected

file data representation

Enumerator
IS_VECTOR
IS_RASTER
IS_BOGUS

Definition at line 41 of file qgsprojectbadlayerguihandler.h.

enum QgsVertexMarker::IconType

Icons.

Enumerator
ICON_NONE
ICON_CROSS
ICON_X
ICON_BOX
ICON_CIRCLE

Definition at line 32 of file qgsvertexmarker.h.

enum QgsRubberBand::IconType

Icons.

Enumerator
ICON_NONE	No icon is used.
ICON_CROSS	A cross is used to highlight points (+)
ICON_X	A cross is used to highlight points (x)
ICON_BOX	A box is used to highlight points (□)
ICON_CIRCLE	A circle is used to highlight points (○)
ICON_FULL_BOX	A full box is used to highlight points (■)

Definition at line 37 of file qgsrubberband.h.

enum QgsAuthImportIdentityDialog::IdentityType

Type of identity being imported.

Enumerator
CertIdentity

Definition at line 37 of file qgsauthimportidentitydialog.h.

enum QgsMessageBar::MessageLevel

Enumerator
INFO
WARNING
CRITICAL
SUCCESS

Definition at line 47 of file qgsmessagebar.h.

enum QgsPreviewEffect::PreviewMode

Enumerator
PreviewGrayscale
PreviewMono
PreviewProtanope
PreviewDeuteranope

Definition at line 33 of file qgsprevieweffect.h.

enum QgsProjectBadLayerGuiHandler::ProviderType

protected

the three flavors for data

Enumerator
IS_FILE
IS_DATABASE
IS_URL
IS_Unknown

Definition at line 44 of file qgsprojectbadlayerguihandler.h.

enum QgsRasterFormatSaveOptionsWidget::Type

Enumerator
Default
Full
Table
LineEdit
ProfileLineEdit

Definition at line 37 of file qgsrasterformatsaveoptionswidget.h.

enum QgsAuthConfigEdit::Validity

Type of configuration validity.

Enumerator
Valid
Invalid
Unknown

Definition at line 38 of file qgsauthconfigedit.h.

enum QgsAuthImportIdentityDialog::Validity

Type of certificate/bundle validity output.

Enumerator
Valid
Invalid
Unknown

Definition at line 50 of file qgsauthimportidentitydialog.h.

enum QgsMapCanvas::WheelAction

Enumerator
WheelZoom
WheelZoomAndRecenter
WheelZoomToMouseCursor
WheelNothing

Definition at line 113 of file qgsmapcanvas.h.

Variable Documentation

GUI_EXPORT const char* zoom_in[]

Bitmap cursors for map operations.

Definition at line 21 of file qgscursors.cpp.

Namespaces

Classes

Enumerations

Variables

Detailed Description

Enumeration Type Documentation

Variable Documentation