QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Namespaces | Classes | Enumerations | Variables
QGIS gui library.

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  QgsBlendModeComboBox
 A combobox which lets the user select blend modes from a predefined list. 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  QgsCredentialDialog
 A generic dialog for requesting credentials. More...
 
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  QgsEncodingFileDialog
 A file dialog which lets the user select the preferred encoding type for a data provider. 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  QgsLegendInterface
 QgsLegendInterface Abstract base class to make QgsLegend available to plugins. More...
 
class  QgsMapCanvasLayer
 A class that stores visibility and presence in overview flags together with pointer to the layer. 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  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  QgsMessageBar
 A bar for displaying non-blocking messages to the user. More...
 
class  QgsMessageLogViewer
 A generic message for displaying QGIS log messages. More...
 
class  QgsMessageViewer
 A generic message view for displaying QGIS messages. 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  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  QgsVertexMarker
 A class for marking vertices of features using e.g. More...
 
class  QgsBusyIndicatorDialog
 A simple dialog to show an indeterminate busy progress indicator. More...
 
class  QgsCollapsibleGroupBoxBasic
 A groupbox that collapses/expands when toggled. More...
 
class  QgsCollapsibleGroupBox
 A groupbox that collapses/expands when toggled and can save its collapsed and checked states. 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  QgsColorSwatchDelegate
 A delegate for showing a color swatch in a list. More...
 
class  QgsColorSchemeModel
 A model for colors in a color scheme. More...
 
class  QgsColorSchemeList
 An editable list of color swatches, taken from an associated QgsColorScheme. More...
 
class  QgsColorSwatchGrid
 A grid of color swatches, which allows for user selection. More...
 
class  QgsColorGridAction
 A color swatch grid which can be embedded into a menu. More...
 
class  QgsColorWidget
 A base class for interactive color widgets. More...
 
class  QgsColorWheel
 A color wheel widget. More...
 
class  QgsColorBox
 A color box widget. More...
 
class  QgsColorRampWidget
 A color ramp widget. More...
 
class  QgsColorSliderWidget
 A composite horizontal color ramp widget and associated spinbox for manual value entry. More...
 
class  QgsColorTextWidget
 A line edit widget which displays colors as text and accepts string representations of colors. More...
 
class  QgsColorPreviewWidget
 A preview box which displays one or two colors as swatches. More...
 
class  QgsDataDefinedButton
 A button for defining data source field mappings or expressions. More...
 
class  QgsOptionsDialogBase
 A base dialog for options and properties dialogs that offers vertical tabs. More...
 

Enumerations

enum  QgsMapCanvas::WheelAction { QgsMapCanvas::WheelZoom, QgsMapCanvas::WheelZoomAndRecenter, QgsMapCanvas::WheelZoomToMouseCursor, QgsMapCanvas::WheelNothing }
 
enum  QgsMessageBar::MessageLevel { QgsMessageBar::INFO = 0, QgsMessageBar::WARNING = 1, QgsMessageBar::CRITICAL = 2 }
 
enum  QgsPreviewEffect::PreviewMode { QgsPreviewEffect::PreviewGrayscale, QgsPreviewEffect::PreviewMono, QgsPreviewEffect::PreviewProtanope, QgsPreviewEffect::PreviewDeuteranope }
 
enum  QgsProjectBadLayerGuiHandler::DataType { QgsProjectBadLayerGuiHandler::IS_VECTOR, QgsProjectBadLayerGuiHandler::IS_RASTER, QgsProjectBadLayerGuiHandler::IS_BOGUS }
 file data representation More...
 
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  QgsRubberBand::IconType {
  QgsRubberBand::ICON_NONE, QgsRubberBand::ICON_CROSS, QgsRubberBand::ICON_X, QgsRubberBand::ICON_BOX,
  QgsRubberBand::ICON_CIRCLE, QgsRubberBand::ICON_FULL_BOX
}
 Icons Added in 1.9. More...
 
enum  QgsVertexMarker::IconType { QgsVertexMarker::ICON_NONE, QgsVertexMarker::ICON_CROSS, QgsVertexMarker::ICON_X, QgsVertexMarker::ICON_BOX }
 Icons. More...
 

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

file data representation

Enumerator
IS_VECTOR 
IS_RASTER 
IS_BOGUS 

Icons.

Enumerator
ICON_NONE 
ICON_CROSS 
ICON_X 
ICON_BOX 

Icons Added in 1.9.

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 (■)

Enumerator
INFO 
WARNING 
CRITICAL 
Enumerator
PreviewGrayscale 
PreviewMono 
PreviewProtanope 
PreviewDeuteranope 

the three flavors for data

Enumerator
IS_FILE 
IS_DATABASE 
IS_URL 
IS_Unknown 
Enumerator
Default 
Full 
Table 
LineEdit 
ProfileLineEdit 
Enumerator
WheelZoom 
WheelZoomAndRecenter 
WheelZoomToMouseCursor 
WheelNothing 

Variable Documentation

GUI_EXPORT const char* zoom_in[]

Bitmap cursors for map operations.