QGIS API Documentation  2.11.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Classes | Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsMapCanvas Class Reference

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

#include <qgsmapcanvas.h>

Inheritance diagram for QgsMapCanvas:
Inheritance graph
[legend]

Classes

class  CanvasProperties
 

Public Types

enum  WheelAction { WheelZoom, WheelZoomAndRecenter, WheelZoomToMouseCursor, WheelNothing }
 

Public Slots

void layerCrsChange ()
 This slot is connected to the layer's CRS change. More...
 
void layerStateChange ()
 This slot is connected to the visibility change of one or more layers. More...
 
void refresh ()
 Repaints the canvas map. More...
 
bool renderFlag ()
 State of render suppression flag. More...
 
void saveAsImage (QString theFileName, QPixmap *QPixmap=0, QString="PNG")
 Save the convtents of the map canvas to disk as an image. More...
 
void selectionChangedSlot ()
 Receives signal about selection change, and pass it on with layer info. More...
 
void setRenderFlag (bool theFlag)
 Whether to suppress rendering or not. More...
 

Signals

void currentLayerChanged (QgsMapLayer *layer)
 Emitted when the current layer is changed. More...
 
void destinationCrsChanged ()
 Emitted when map CRS has changed. More...
 
void extentsChanged ()
 Emitted when the extents of the map change. More...
 
void hasCrsTransformEnabledChanged (bool flag)
 Emitted when on-the-fly projection has been turned on/off. More...
 
void keyPressed (QKeyEvent *e)
 Emit key press event. More...
 
void keyReleased (QKeyEvent *e)
 Emit key release event. More...
 
void layersChanged ()
 Emitted when a new set of layers has been received. More...
 
void layerStyleOverridesChanged ()
 Emitted when the configuration of overridden layer styles changes. More...
 
void mapCanvasRefreshed ()
 Emitted when canvas finished a refresh request. More...
 
void mapToolSet (QgsMapTool *tool)
 Emit map tool changed event. More...
 
void mapToolSet (QgsMapTool *newTool, QgsMapTool *oldTool)
 Emit map tool changed with the old tool. More...
 
void mapUnitsChanged ()
 Emmitted when map units are changed. More...
 
void renderComplete (QPainter *)
 Emitted when the canvas has rendered. More...
 
void renderStarting ()
 Emitted when the canvas is about to be rendered. More...
 
void rotationChanged (double)
 Emitted when the rotation of the map changes. More...
 
void scaleChanged (double)
 Emitted when the scale of the map changes. More...
 
void selectionChanged (QgsMapLayer *layer)
 Emitted when selection in any layer gets changed. More...
 
Q_DECL_DEPRECATED void setProgress (int, int)
 Let the owner know how far we are with render operations. More...
 
void xyCoordinates (const QgsPoint &p)
 Emits current mouse position. More...
 
void zoomLastStatusChanged (bool)
 Emitted when zoom last status changed. More...
 
void zoomNextStatusChanged (bool)
 Emitted when zoom next status changed. More...
 

Public Member Functions

 QgsMapCanvas (QWidget *parent=0, const char *name=0)
 Constructor. More...
 
 ~QgsMapCanvas ()
 Destructor. More...
 
bool antiAliasingEnabled () const
 true if antialising is enabled More...
 
virtual QColor canvasColor () const
 Read property of QColor bgColor. More...
 
Q_DECL_DEPRECATED QPaintDevicecanvasPaintDevice ()
 Accessor for the canvas paint device. More...
 
QgsPoint center () const
 Get map center, in geographical coordinates. More...
 
Q_DECL_DEPRECATED void clear ()
 Clear the map canvas. More...
 
void clearCache ()
 Make sure to remove any rendered images from cache (does nothing if cache is not enabled) More...
 
void clearExtentHistory ()
 
QgsMapLayercurrentLayer ()
 returns current layer (set by legend widget) More...
 
void enableAntiAliasing (bool theFlag)
 used to determine if anti-aliasing is enabled or not More...
 
void enableOverviewMode (QgsMapOverviewCanvas *overview)
 
QgsRectangle extent () const
 Returns the current zoom exent of the map canvas. More...
 
void freeze (bool frz=true)
 Freeze/thaw the map canvas. More...
 
QgsRectangle fullExtent () const
 Returns the combined exent for all layers on the map canvas. More...
 
const QgsMapToPixelgetCoordinateTransform ()
 Get the current coordinate transform. More...
 
void getDatumTransformInfo (const QgsMapLayer *ml, const QString &srcAuthId, const QString &destAuthId)
 ask user about datum transformation More...
 
bool hasCrsTransformEnabled ()
 A simple helper method to find out if on the fly projections are enabled or not. More...
 
bool isCachingEnabled () const
 Check whether images of rendered layers are curerently being cached. More...
 
Q_DECL_DEPRECATED bool isDirty () const
 Return the state of the canvas (dirty or not) More...
 
bool isDrawing ()
 Find out whether rendering is in progress. More...
 
bool isFrozen ()
 Accessor for frozen status of canvas. More...
 
bool isParallelRenderingEnabled () const
 Check whether the layers are rendered in parallel or sequentially. More...
 
const QgsLabelingResultslabelingResults () const
 Get access to the labeling results (may be null) More...
 
QgsMapLayerlayer (int index)
 return the map layer at position index in the layer stack More...
 
int layerCount () const
 return number of layers on the map More...
 
QList< QgsMapLayer * > layers () const
 return list of layers within map canvas. More...
 
QMap< QString, QStringlayerStyleOverrides () const
 Getter for stored overrides of styles for layers. More...
 
QgsMapCanvasMapmap ()
 
Q_DECL_DEPRECATED QgsMapRenderermapRenderer ()
 
const QgsMapSettingsmapSettings () const
 Get access to properties used for map rendering. More...
 
QgsMapToolmapTool ()
 Returns the currently active tool. More...
 
QGis::UnitType mapUnits () const
 Get the current canvas map units. More...
 
double mapUnitsPerPixel () const
 Returns the mapUnitsPerPixel (map units per pixel) for the canvas. More...
 
int mapUpdateInterval () const
 Find out how often map preview should be updated while it is being rendered (in milliseconds) More...
 
QPoint mouseLastXY ()
 returns last position of mouse cursor More...
 
void panAction (QMouseEvent *event)
 Called when mouse is moving and pan is activated. More...
 
void panActionEnd (QPoint releasePoint)
 Ends pan action and redraws the canvas. More...
 
void panToSelected (QgsVectorLayer *layer=NULL)
 Pan to the selected features of current (vector) layer keeping same extent. More...
 
QgsPreviewEffect::PreviewMode previewMode () const
 Returns the current preview mode for the map canvas. More...
 
bool previewModeEnabled () const
 Returns whether a preview mode is enabled for the map canvas. More...
 
void readProject (const QDomDocument &)
 called to read map canvas settings from project More...
 
void refreshAllLayers ()
 Reload all layers, clear the cache and refresh the canvas. More...
 
double rotation () const
 Get the current map canvas rotation in clockwise degrees. More...
 
double scale ()
 Get the last reported scale of the canvas. More...
 
void setCachingEnabled (bool enabled)
 Set whether to cache images of rendered layers. More...
 
virtual void setCanvasColor (const QColor &_newVal)
 Write property of QColor bgColor. More...
 
void setCenter (const QgsPoint &center)
 Set the center of the map canvas, in geographical coordinates. More...
 
void setCrsTransformEnabled (bool enabled)
 sets whether to use projections for this layer set More...
 
void setCurrentLayer (QgsMapLayer *layer)
 
void setDestinationCrs (const QgsCoordinateReferenceSystem &crs)
 sets destination coordinate reference system More...
 
Q_DECL_DEPRECATED void setDirty (bool _dirty)
 Flag the canvas as dirty and needed a refresh. More...
 
void setExtent (const QgsRectangle &r)
 Set the extent of the map canvas. More...
 
void setLayerSet (QList< QgsMapCanvasLayer > &layers)
 
void setLayerStyleOverrides (const QMap< QString, QString > &overrides)
 Setter for stored overrides of styles for layers. More...
 
void setMapTool (QgsMapTool *mapTool)
 Sets the map tool currently being used on the canvas. More...
 
void setMapUnits (QGis::UnitType mapUnits)
 Set map units (needed by project properties dialog) More...
 
void setMapUpdateInterval (int timeMiliseconds)
 Set how often map preview should be updated while it is being rendered (in milliseconds) More...
 
void setParallelRenderingEnabled (bool enabled)
 Set whether the layers are rendered in parallel or sequentially. More...
 
void setPreviewMode (QgsPreviewEffect::PreviewMode mode)
 Sets a preview mode for the map canvas. More...
 
void setPreviewModeEnabled (bool previewEnabled)
 Enables a preview mode for the map canvas. More...
 
void setRotation (double degrees)
 Set the rotation of the map canvas in clockwise degrees. More...
 
void setSelectionColor (const QColor &color)
 Set color of selected vector features. More...
 
void setSnappingUtils (QgsSnappingUtils *utils)
 Assign an instance of snapping utils to the map canvas. More...
 
void setWheelAction (WheelAction action, double factor=2)
 set wheel action and zoom factor (should be greater than 1) More...
 
Q_DECL_DEPRECATED void showError (QgsMapLayer *mapLayer)
 
QgsSnappingUtilssnappingUtils () const
 Return snapping utility class that is associated with map canvas. More...
 
void stopRendering ()
 stop rendering (if there is any right now) More...
 
void unsetMapTool (QgsMapTool *mapTool)
 Unset the current map tool or last non zoom tool. More...
 
Q_DECL_DEPRECATED void updateFullExtent ()
 Updates the full extent. More...
 
Q_DECL_DEPRECATED void updateMap ()
 
void updateOverview ()
 
void updateScale ()
 Emits signal scaleChanged to update scale in main window. More...
 
Q_DECL_DEPRECATED void useImageToRender (bool theFlag)
 Select which Qt class to render with. More...
 
void writeProject (QDomDocument &)
 called to write map canvas settings to project More...
 
void zoomByFactor (double scaleFactor, const QgsPoint *center=0)
 Zoom with the factor supplied. More...
 
void zoomIn ()
 Zoom in with fixed factor. More...
 
void zoomOut ()
 Zoom out with fixed factor. More...
 
void zoomScale (double scale)
 Zoom to a specific scale. More...
 
void zoomToFullExtent ()
 Zoom to the full extent of all layers. More...
 
void zoomToNextExtent ()
 Zoom to the next extent (view) More...
 
void zoomToPreviousExtent ()
 Zoom to the previous extent (view) More...
 
void zoomToSelected (QgsVectorLayer *layer=NULL)
 Zoom to the extent of the selected features of current (vector) layer. More...
 
void zoomWithCenter (int x, int y, bool zoomIn)
 Zooms in/out with a given center. More...
 
- Public Member Functions inherited from QGraphicsView
 QGraphicsView (QWidget *parent)
 
 QGraphicsView (QGraphicsScene *scene, QWidget *parent)
 
 ~QGraphicsView ()
 
Qt::Alignment alignment () const
 
QBrush backgroundBrush () const
 
CacheMode cacheMode () const
 
void centerOn (const QPointF &pos)
 
void centerOn (qreal x, qreal y)
 
void centerOn (const QGraphicsItem *item)
 
DragMode dragMode () const
 
void ensureVisible (const QRectF &rect, int xmargin, int ymargin)
 
void ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin)
 
void ensureVisible (const QGraphicsItem *item, int xmargin, int ymargin)
 
void fitInView (const QRectF &rect, Qt::AspectRatioMode aspectRatioMode)
 
void fitInView (qreal x, qreal y, qreal w, qreal h, Qt::AspectRatioMode aspectRatioMode)
 
void fitInView (const QGraphicsItem *item, Qt::AspectRatioMode aspectRatioMode)
 
QBrush foregroundBrush () const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const
 
void invalidateScene (const QRectF &rect, QFlags< QGraphicsScene::SceneLayer > layers)
 
bool isInteractive () const
 
bool isTransformed () const
 
QGraphicsItemitemAt (const QPoint &pos) const
 
QGraphicsItemitemAt (int x, int y) const
 
QList< QGraphicsItem * > items () const
 
QList< QGraphicsItem * > items (const QPolygon &polygon, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > items (int x, int y) const
 
QList< QGraphicsItem * > items (const QRect &rect, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > items (int x, int y, int w, int h, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > items (const QPainterPath &path, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > items (const QPoint &pos) const
 
QPoint mapFromScene (const QPointF &point) const
 
QPolygon mapFromScene (const QRectF &rect) const
 
QPolygon mapFromScene (const QPolygonF &polygon) const
 
QPoint mapFromScene (qreal x, qreal y) const
 
QPolygon mapFromScene (qreal x, qreal y, qreal w, qreal h) const
 
QPainterPath mapFromScene (const QPainterPath &path) const
 
QPolygonF mapToScene (const QRect &rect) const
 
QPolygonF mapToScene (const QPolygon &polygon) const
 
QPointF mapToScene (const QPoint &point) const
 
QPolygonF mapToScene (int x, int y, int w, int h) const
 
QPointF mapToScene (int x, int y) const
 
QPainterPath mapToScene (const QPainterPath &path) const
 
QMatrix matrix () const
 
OptimizationFlags optimizationFlags () const
 
void render (QPainter *painter, const QRectF &target, const QRect &source, Qt::AspectRatioMode aspectRatioMode)
 
QPainter::RenderHints renderHints () const
 
void resetCachedContent ()
 
void resetMatrix ()
 
void resetTransform ()
 
ViewportAnchor resizeAnchor () const
 
void rotate (qreal angle)
 
Qt::ItemSelectionMode rubberBandSelectionMode () const
 
void scale (qreal sx, qreal sy)
 
QGraphicsScenescene () const
 
QRectF sceneRect () const
 
void setAlignment (QFlags< Qt::AlignmentFlag > alignment)
 
void setBackgroundBrush (const QBrush &brush)
 
void setCacheMode (QFlags< QGraphicsView::CacheModeFlag > mode)
 
void setDragMode (DragMode mode)
 
void setForegroundBrush (const QBrush &brush)
 
void setInteractive (bool allowed)
 
void setMatrix (const QMatrix &matrix, bool combine)
 
void setOptimizationFlag (OptimizationFlag flag, bool enabled)
 
void setOptimizationFlags (QFlags< QGraphicsView::OptimizationFlag > flags)
 
void setRenderHint (QPainter::RenderHint hint, bool enabled)
 
void setRenderHints (QFlags< QPainter::RenderHint > hints)
 
void setResizeAnchor (ViewportAnchor anchor)
 
void setRubberBandSelectionMode (Qt::ItemSelectionMode mode)
 
void setScene (QGraphicsScene *scene)
 
void setSceneRect (qreal x, qreal y, qreal w, qreal h)
 
void setSceneRect (const QRectF &rect)
 
void setTransform (const QTransform &matrix, bool combine)
 
void setTransformationAnchor (ViewportAnchor anchor)
 
void setViewportUpdateMode (ViewportUpdateMode mode)
 
void shear (qreal sh, qreal sv)
 
virtual QSize sizeHint () const
 
QTransform transform () const
 
ViewportAnchor transformationAnchor () const
 
void translate (qreal dx, qreal dy)
 
void updateScene (const QList< QRectF > &rects)
 
void updateSceneRect (const QRectF &rect)
 
QTransform viewportTransform () const
 
ViewportUpdateMode viewportUpdateMode () const
 
- Public Member Functions inherited from QAbstractScrollArea
 QAbstractScrollArea (QWidget *parent)
 
 ~QAbstractScrollArea ()
 
void addScrollBarWidget (QWidget *widget, QFlags< Qt::AlignmentFlag > alignment)
 
QWidgetcornerWidget () const
 
QScrollBarhorizontalScrollBar () const
 
Qt::ScrollBarPolicy horizontalScrollBarPolicy () const
 
QSize maximumViewportSize () const
 
virtual QSize minimumSizeHint () const
 
QWidgetList scrollBarWidgets (QFlags< Qt::AlignmentFlag > alignment)
 
void setCornerWidget (QWidget *widget)
 
void setHorizontalScrollBar (QScrollBar *scrollBar)
 
void setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setVerticalScrollBar (QScrollBar *scrollBar)
 
void setVerticalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setViewport (QWidget *widget)
 
QScrollBarverticalScrollBar () const
 
Qt::ScrollBarPolicy verticalScrollBarPolicy () const
 
QWidgetviewport () const
 
- Public Member Functions inherited from QFrame
 QFrame (QWidget *parent, QFlags< Qt::WindowType > f)
 
 QFrame (QWidget *parent, const char *name, QFlags< Qt::WindowType > f)
 
 ~QFrame ()
 
QRect frameRect () const
 
Shadow frameShadow () const
 
Shape frameShape () const
 
int frameStyle () const
 
int frameWidth () const
 
int lineWidth () const
 
int midLineWidth () const
 
void setFrameRect (const QRect &)
 
void setFrameShadow (Shadow)
 
void setFrameShape (Shape)
 
void setFrameStyle (int style)
 
void setLineWidth (int)
 
void setMidLineWidth (int)
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, QFlags< Qt::WindowType > f)
 
 QWidget (QWidget *parent, const char *name, QFlags< Qt::WindowType > f)
 
 ~QWidget ()
 
bool acceptDrops () const
 
QString accessibleDescription () const
 
QString accessibleName () const
 
QList< QAction * > actions () const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const
 
Qt::BackgroundMode backgroundMode () const
 
QPoint backgroundOffset () const
 
BackgroundOrigin backgroundOrigin () const
 
QPalette::ColorRole backgroundRole () const
 
QSize baseSize () const
 
QString caption () const
 
QWidgetchildAt (int x, int y, bool includeThis) const
 
QWidgetchildAt (const QPoint &p, bool includeThis) const
 
QWidgetchildAt (int x, int y) const
 
QWidgetchildAt (const QPoint &p) const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
void clearFocus ()
 
void clearMask ()
 
bool close (bool alsoDelete)
 
bool close ()
 
QColorGroup colorGroup () const
 
void constPolish () const
 
QMargins contentsMargins () const
 
QRect contentsRect () const
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
QCursor cursor () const
 
void customContextMenuRequested (const QPoint &pos)
 
void drawText (const QPoint &p, const QString &s)
 
void drawText (int x, int y, const QString &s)
 
WId effectiveWinId () const
 
void ensurePolished () const
 
void erase ()
 
void erase (const QRect &rect)
 
void erase (const QRegion &rgn)
 
void erase (int x, int y, int w, int h)
 
Qt::FocusPolicy focusPolicy () const
 
QWidgetfocusProxy () const
 
QWidgetfocusWidget () const
 
const QFontfont () const
 
QFontInfo fontInfo () const
 
QFontMetrics fontMetrics () const
 
QPalette::ColorRole foregroundRole () const
 
QRect frameGeometry () const
 
QSize frameSize () const
 
const QRectgeometry () const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 
virtual HDC getDC () const
 
void grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const
 
bool hasEditFocus () const
 
bool hasFocus () const
 
bool hasMouse () const
 
bool hasMouseTracking () const
 
int height () const
 
virtual int heightForWidth (int w) const
 
void hide ()
 
const QPixmapicon () const
 
void iconify ()
 
QString iconText () const
 
QInputContextinputContext ()
 
Qt::InputMethodHints inputMethodHints () const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const
 
bool isAncestorOf (const QWidget *child) const
 
bool isDesktop () const
 
bool isDialog () const
 
bool isEnabled () const
 
bool isEnabledTo (QWidget *ancestor) const
 
bool isEnabledToTLW () const
 
bool isFullScreen () const
 
bool isHidden () const
 
bool isInputMethodEnabled () const
 
bool isMaximized () const
 
bool isMinimized () const
 
bool isModal () const
 
bool isPopup () const
 
bool isShown () const
 
bool isTopLevel () const
 
bool isUpdatesEnabled () const
 
bool isVisible () const
 
bool isVisibleTo (QWidget *ancestor) const
 
bool isVisibleToTLW () const
 
bool isWindow () const
 
bool isWindowModified () const
 
QLayoutlayout () const
 
Qt::LayoutDirection layoutDirection () const
 
QLocale locale () const
 
void lower ()
 
Qt::HANDLE macCGHandle () const
 
Qt::HANDLE macQDHandle () const
 
QPoint mapFrom (QWidget *parent, const QPoint &pos) const
 
QPoint mapFromGlobal (const QPoint &pos) const
 
QPoint mapFromParent (const QPoint &pos) const
 
QPoint mapTo (QWidget *parent, const QPoint &pos) const
 
QPoint mapToGlobal (const QPoint &pos) const
 
QPoint mapToParent (const QPoint &pos) const
 
QRegion mask () const
 
int maximumHeight () const
 
QSize maximumSize () const
 
int maximumWidth () const
 
int minimumHeight () const
 
QSize minimumSize () const
 
int minimumWidth () const
 
void move (int x, int y)
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const
 
QWidgetnextInFocusChain () const
 
QRect normalGeometry () const
 
void overrideWindowFlags (QFlags< Qt::WindowType > flags)
 
bool ownCursor () const
 
bool ownFont () const
 
bool ownPalette () const
 
virtual QPaintEnginepaintEngine () const
 
const QPalettepalette () const
 
QWidgetparentWidget (bool sameWindow) const
 
QWidgetparentWidget () const
 
QPlatformWindow * platformWindow () const
 
QPlatformWindowFormat platformWindowFormat () const
 
void polish ()
 
QPoint pos () const
 
QWidgetpreviousInFocusChain () const
 
void raise ()
 
void recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)
 
QRect rect () const
 
virtual void releaseDC (HDC hdc) const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)
 
void repaint (int x, int y, int w, int h, bool b)
 
void repaint (const QRegion &rgn, bool b)
 
void repaint ()
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRegion &rgn)
 
void repaint (bool b)
 
void repaint (const QRect &rect)
 
void repaint (const QRect &r, bool b)
 
void reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)
 
void reparent (QWidget *parent, const QPoint &p, bool showIt)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setActiveWindow ()
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundColor (const QColor &color)
 
void setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)
 
void setBackgroundOrigin (BackgroundOrigin background)
 
void setBackgroundPixmap (const QPixmap &pixmap)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 
void setCaption (const QString &c)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContentsMargins (const QMargins &margins)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setEraseColor (const QColor &color)
 
void setErasePixmap (const QPixmap &pixmap)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus (Qt::FocusReason reason)
 
void setFocus ()
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setFont (const QFont &f, bool b)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (int x, int y, int w, int h)
 
void setGeometry (const QRect &)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setIcon (const QPixmap &i)
 
void setIconText (const QString &it)
 
void setInputContext (QInputContext *context)
 
void setInputMethodEnabled (bool enabled)
 
void setInputMethodHints (QFlags< Qt::InputMethodHint > hints)
 
void setKeyCompression (bool b)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setPalette (const QPalette &p, bool b)
 
void setPaletteBackgroundColor (const QColor &color)
 
void setPaletteBackgroundPixmap (const QPixmap &pixmap)
 
void setPaletteForegroundColor (const QColor &color)
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, QFlags< Qt::WindowType > f)
 
void setPlatformWindow (QPlatformWindow *window)
 
void setPlatformWindowFormat (const QPlatformWindowFormat &format)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setShown (bool shown)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setSizePolicy (QSizePolicy)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
QStylesetStyle (const QString &style)
 
void setStyleSheet (const QString &styleSheet)
 
void setToolTip (const QString &)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlags (QFlags< Qt::WindowType > type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (QFlags< Qt::WindowState > windowState)
 
void setWindowSurface (QWindowSurface *surface)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const
 
QSize sizeIncrement () const
 
QSizePolicy sizePolicy () const
 
void stackUnder (QWidget *w)
 
QString statusTip () const
 
QStylestyle () const
 
QString styleSheet () const
 
bool testAttribute (Qt::WidgetAttribute attribute) const
 
QString toolTip () const
 
QWidgettopLevelWidget () const
 
bool underMouse () const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetFont ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void unsetPalette ()
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update (int x, int y, int w, int h)
 
void update ()
 
void updateGeometry ()
 
bool updatesEnabled () const
 
QRect visibleRect () const
 
QRegion visibleRegion () const
 
QString whatsThis () const
 
int width () const
 
QWidgetwindow () const
 
QString windowFilePath () const
 
Qt::WindowFlags windowFlags () const
 
QIcon windowIcon () const
 
QString windowIconText () const
 
Qt::WindowModality windowModality () const
 
qreal windowOpacity () const
 
QString windowRole () const
 
Qt::WindowStates windowState () const
 
QWindowSurface * windowSurface () const
 
QString windowTitle () const
 
Qt::WindowType windowType () const
 
WId winId () const
 
int x () const
 
const QX11Infox11Info () const
 
Qt::HANDLE x11PictureHandle () const
 
int y () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 
- Public Member Functions inherited from QPaintDevice
virtual  ~QPaintDevice ()
 
int colorCount () const
 
int depth () const
 
int height () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
int numColors () const
 
virtual QPaintEnginepaintEngine () const =0
 
bool paintingActive () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
int width () const
 
int widthMM () const
 
int x11Cells () const
 
Qt::HANDLE x11Colormap () const
 
bool x11DefaultColormap () const
 
bool x11DefaultVisual () const
 
int x11Depth () const
 
Display * x11Display () const
 
int x11Screen () const
 
void * x11Visual () const
 

Static Public Member Functions

static void enableRotation (bool enabled)
 change canvas rotation support More...
 
static bool rotationEnabled ()
 return if canvas rotation is enabled More...
 
- Static Public Member Functions inherited from QWidget
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
QWidgetMapper * wmapper ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Public Member Functions inherited from QPaintDevice
int x11AppCells (int screen)
 
Qt::HANDLE x11AppColormap (int screen)
 
bool x11AppDefaultColormap (int screen)
 
bool x11AppDefaultVisual (int screen)
 
int x11AppDepth (int screen)
 
Display * x11AppDisplay ()
 
int x11AppDpiX (int screen)
 
int x11AppDpiY (int screen)
 
Qt::HANDLE x11AppRootWindow (int screen)
 
int x11AppScreen ()
 
void * x11AppVisual (int screen)
 
void x11SetAppDpiX (int dpi, int screen)
 
void x11SetAppDpiY (int dpi, int screen)
 

Protected Member Functions

void dragEnterEvent (QDragEnterEvent *e) override
 Overridden drag enter event. More...
 
void keyPressEvent (QKeyEvent *e) override
 Overridden key press event. More...
 
void keyReleaseEvent (QKeyEvent *e) override
 Overridden key release event. More...
 
void mouseDoubleClickEvent (QMouseEvent *e) override
 Overridden mouse double click event. More...
 
void mouseMoveEvent (QMouseEvent *e) override
 Overridden mouse move event. More...
 
void mousePressEvent (QMouseEvent *e) override
 Overridden mouse press event. More...
 
void mouseReleaseEvent (QMouseEvent *e) override
 Overridden mouse release event. More...
 
void moveCanvasContents (bool reset=false)
 called when panning is in action, reset indicates end of panning More...
 
void paintEvent (QPaintEvent *e) override
 Overridden paint event. More...
 
void resizeEvent (QResizeEvent *e) override
 Overridden resize event. More...
 
void updateCanvasItemPositions ()
 called on resize or changed extent to notify canvas items to change their rectangle More...
 
void updateDatumTransformEntries ()
 Make sure the datum transform store is properly populated. More...
 
void wheelEvent (QWheelEvent *e) override
 Overridden mouse wheel event. More...
 
- Protected Member Functions inherited from QGraphicsView
virtual void contextMenuEvent (QContextMenuEvent *event)
 
virtual void dragLeaveEvent (QDragLeaveEvent *event)
 
virtual void dragMoveEvent (QDragMoveEvent *event)
 
virtual void drawBackground (QPainter *painter, const QRectF &rect)
 
virtual void drawForeground (QPainter *painter, const QRectF &rect)
 
virtual void drawItems (QPainter *painter, int numItems, QGraphicsItem *[] items, const QStyleOptionGraphicsItem[] options)
 
virtual void dropEvent (QDropEvent *event)
 
virtual bool event (QEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
virtual bool focusNextPrevChild (bool next)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual void scrollContentsBy (int dx, int dy)
 
void setupViewport (QWidget *widget)
 
virtual void showEvent (QShowEvent *event)
 
virtual bool viewportEvent (QEvent *event)
 
- Protected Member Functions inherited from QAbstractScrollArea
void setupViewport (QWidget *viewport)
 
void setViewportMargins (const QMargins &margins)
 
void setViewportMargins (int left, int top, int right, int bottom)
 
- Protected Member Functions inherited from QFrame
virtual void changeEvent (QEvent *ev)
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void enterEvent (QEvent *event)
 
bool focusNextChild ()
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
virtual void languageChange ()
 
virtual void leaveEvent (QEvent *event)
 
virtual bool macEvent (EventHandlerCallRef caller, EventRef event)
 
virtual int metric (PaintDeviceMetric m) const
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool qwsEvent (QWSEvent *event)
 
void resetInputContext ()
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual bool winEvent (MSG *message, long *result)
 
virtual bool x11Event (XEvent *event)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice ()
 

Protected Attributes

QScopedPointer< CanvasPropertiesmCanvasProperties
 Handle pattern for implementation object. More...
 

Additional Inherited Members

- Public Attributes inherited from QGraphicsView
typedef CacheMode
 
typedef OptimizationFlags
 
- Public Attributes inherited from QWidget
typedef RenderFlags
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QGraphicsView
 alignment
 
 backgroundBrush
 
 cacheMode
 
 dragMode
 
 foregroundBrush
 
 interactive
 
 optimizationFlags
 
 renderHints
 
 resizeAnchor
 
 rubberBandSelectionMode
 
 sceneRect
 
 transformationAnchor
 
 viewportUpdateMode
 
- Properties inherited from QAbstractScrollArea
 horizontalScrollBarPolicy
 
 verticalScrollBarPolicy
 
- Properties inherited from QFrame
 frameRect
 
 frameShadow
 
 frameShape
 
 frameWidth
 
 lineWidth
 
 midLineWidth
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 toolTip
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 

Detailed Description

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

Definition at line 105 of file qgsmapcanvas.h.

Constructor & Destructor Documentation

QgsMapCanvas::QgsMapCanvas ( QWidget parent = 0,
const char *  name = 0 
)

Constructor.

Definition at line 184 of file qgsmapcanvas.cpp.

QgsMapCanvas::~QgsMapCanvas ( )

Destructor.

Definition at line 268 of file qgsmapcanvas.cpp.

Member Function Documentation

bool QgsMapCanvas::antiAliasingEnabled ( ) const
inline

true if antialising is enabled

Definition at line 347 of file qgsmapcanvas.h.

QColor QgsMapCanvas::canvasColor ( ) const
virtual

Read property of QColor bgColor.

Definition at line 1558 of file qgsmapcanvas.cpp.

QPaintDevice & QgsMapCanvas::canvasPaintDevice ( )

Accessor for the canvas paint device.

Deprecated:
since 2.4

Definition at line 1617 of file qgsmapcanvas.cpp.

QgsPoint QgsMapCanvas::center ( ) const

Get map center, in geographical coordinates.

Note
added in 2.8

Definition at line 924 of file qgsmapcanvas.cpp.

void QgsMapCanvas::clear ( )

Clear the map canvas.

Deprecated:
since 2.4 - use refresh() - clear does the same thing

Definition at line 962 of file qgsmapcanvas.cpp.

void QgsMapCanvas::clearCache ( )

Make sure to remove any rendered images from cache (does nothing if cache is not enabled)

Note
added in 2.4

Definition at line 579 of file qgsmapcanvas.cpp.

void QgsMapCanvas::clearExtentHistory ( )

Definition at line 1020 of file qgsmapcanvas.cpp.

QgsMapLayer * QgsMapCanvas::currentLayer ( )

returns current layer (set by legend widget)

Definition at line 616 of file qgsmapcanvas.cpp.

void QgsMapCanvas::currentLayerChanged ( QgsMapLayer layer)
signal

Emitted when the current layer is changed.

Note
added in 2.8
void QgsMapCanvas::destinationCrsChanged ( )
signal

Emitted when map CRS has changed.

Note
added in 2.4
void QgsMapCanvas::dragEnterEvent ( QDragEnterEvent e)
overrideprotectedvirtual

Overridden drag enter event.

Reimplemented from QGraphicsView.

Definition at line 1945 of file qgsmapcanvas.cpp.

void QgsMapCanvas::enableAntiAliasing ( bool  theFlag)

used to determine if anti-aliasing is enabled or not

Definition at line 307 of file qgsmapcanvas.cpp.

void QgsMapCanvas::enableOverviewMode ( QgsMapOverviewCanvas overview)

Definition at line 466 of file qgsmapcanvas.cpp.

void QgsMapCanvas::enableRotation ( bool  enabled)
static

change canvas rotation support

Note
added in 2.8

Definition at line 1985 of file qgsmapcanvas.cpp.

QgsRectangle QgsMapCanvas::extent ( ) const

Returns the current zoom exent of the map canvas.

Definition at line 846 of file qgsmapcanvas.cpp.

void QgsMapCanvas::extentsChanged ( )
signal

Emitted when the extents of the map change.

void QgsMapCanvas::freeze ( bool  frz = true)

Freeze/thaw the map canvas.

This is used to prevent the canvas from responding to events while layers are being added/removed etc.

Parameters
frzBoolean specifying if the canvas should be frozen (true) or thawed (false). Default is true.

Definition at line 1606 of file qgsmapcanvas.cpp.

QgsRectangle QgsMapCanvas::fullExtent ( ) const

Returns the combined exent for all layers on the map canvas.

Definition at line 851 of file qgsmapcanvas.cpp.

const QgsMapToPixel * QgsMapCanvas::getCoordinateTransform ( )

Get the current coordinate transform.

Definition at line 373 of file qgsmapcanvas.cpp.

void QgsMapCanvas::getDatumTransformInfo ( const QgsMapLayer ml,
const QString srcAuthId,
const QString destAuthId 
)

ask user about datum transformation

Ask user which datum transform to use.

Definition at line 1861 of file qgsmapcanvas.cpp.

bool QgsMapCanvas::hasCrsTransformEnabled ( )

A simple helper method to find out if on the fly projections are enabled or not.

Definition at line 1031 of file qgsmapcanvas.cpp.

void QgsMapCanvas::hasCrsTransformEnabledChanged ( bool  flag)
signal

Emitted when on-the-fly projection has been turned on/off.

Note
added in 2.4
bool QgsMapCanvas::isCachingEnabled ( ) const

Check whether images of rendered layers are curerently being cached.

Note
added in 2.4

Definition at line 574 of file qgsmapcanvas.cpp.

bool QgsMapCanvas::isDirty ( ) const

Return the state of the canvas (dirty or not)

Deprecated:
since 2.4 - dirty flag is not kept anymore - always returns false

Definition at line 358 of file qgsmapcanvas.cpp.

bool QgsMapCanvas::isDrawing ( )

Find out whether rendering is in progress.

Definition at line 365 of file qgsmapcanvas.cpp.

bool QgsMapCanvas::isFrozen ( )

Accessor for frozen status of canvas.

Definition at line 1611 of file qgsmapcanvas.cpp.

bool QgsMapCanvas::isParallelRenderingEnabled ( ) const

Check whether the layers are rendered in parallel or sequentially.

Note
added in 2.4

Definition at line 590 of file qgsmapcanvas.cpp.

void QgsMapCanvas::keyPressed ( QKeyEvent e)
signal

Emit key press event.

void QgsMapCanvas::keyPressEvent ( QKeyEvent e)
overrideprotectedvirtual

Overridden key press event.

Reimplemented from QGraphicsView.

Definition at line 1101 of file qgsmapcanvas.cpp.

void QgsMapCanvas::keyReleased ( QKeyEvent e)
signal

Emit key release event.

void QgsMapCanvas::keyReleaseEvent ( QKeyEvent e)
overrideprotectedvirtual

Overridden key release event.

Reimplemented from QGraphicsView.

Definition at line 1210 of file qgsmapcanvas.cpp.

const QgsLabelingResults * QgsMapCanvas::labelingResults ( ) const

Get access to the labeling results (may be null)

Note
added in 2.4

Definition at line 547 of file qgsmapcanvas.cpp.

QgsMapLayer * QgsMapCanvas::layer ( int  index)

return the map layer at position index in the layer stack

Definition at line 331 of file qgsmapcanvas.cpp.

int QgsMapCanvas::layerCount ( ) const

return number of layers on the map

Definition at line 1568 of file qgsmapcanvas.cpp.

void QgsMapCanvas::layerCrsChange ( )
slot

This slot is connected to the layer's CRS change.

Definition at line 1595 of file qgsmapcanvas.cpp.

QList< QgsMapLayer * > QgsMapCanvas::layers ( ) const

return list of layers within map canvas.

Definition at line 1574 of file qgsmapcanvas.cpp.

void QgsMapCanvas::layersChanged ( )
signal

Emitted when a new set of layers has been received.

void QgsMapCanvas::layerStateChange ( )
slot

This slot is connected to the visibility change of one or more layers.

Definition at line 1587 of file qgsmapcanvas.cpp.

QMap< QString, QString > QgsMapCanvas::layerStyleOverrides ( ) const

Getter for stored overrides of styles for layers.

Note
added in 2.12

Definition at line 1651 of file qgsmapcanvas.cpp.

void QgsMapCanvas::layerStyleOverridesChanged ( )
signal

Emitted when the configuration of overridden layer styles changes.

Note
added in 2.12
QgsMapCanvasMap * QgsMapCanvas::map ( )
Deprecated:
since 2.4 - there could be more than just one "map" items

Definition at line 320 of file qgsmapcanvas.cpp.

void QgsMapCanvas::mapCanvasRefreshed ( )
signal

Emitted when canvas finished a refresh request.

QgsMapRenderer * QgsMapCanvas::mapRenderer ( )
Deprecated:
since 2.4 - use mapSettings() for anything related to current renderer settings / SIP: removed /Transfer/ because it crashes after few calls to iface.mapCanvas().mapRenderer().hasCrsTransformEnabled() / and in fact there is no transfer of ownership from c++ to python! / Actually the problem comes from the fact that "hasCrsTransformEnabled" is both a signal and a normal method / /KeepReference/ is necessary because otherwise mapRenderer().hasCrsTransformEnabled() was crashing

Definition at line 325 of file qgsmapcanvas.cpp.

const QgsMapSettings & QgsMapCanvas::mapSettings ( ) const

Get access to properties used for map rendering.

Note
added in 2.4

Definition at line 491 of file qgsmapcanvas.cpp.

QgsMapTool * QgsMapCanvas::mapTool ( )

Returns the currently active tool.

Definition at line 1710 of file qgsmapcanvas.cpp.

void QgsMapCanvas::mapToolSet ( QgsMapTool tool)
signal

Emit map tool changed event.

void QgsMapCanvas::mapToolSet ( QgsMapTool newTool,
QgsMapTool oldTool 
)
signal

Emit map tool changed with the old tool.

Note
added in 2.3
QGis::UnitType QgsMapCanvas::mapUnits ( ) const

Get the current canvas map units.

Definition at line 1646 of file qgsmapcanvas.cpp.

void QgsMapCanvas::mapUnitsChanged ( )
signal

Emmitted when map units are changed.

Note
added in 2.4
double QgsMapCanvas::mapUnitsPerPixel ( ) const

Returns the mapUnitsPerPixel (map units per pixel) for the canvas.

Definition at line 1624 of file qgsmapcanvas.cpp.

int QgsMapCanvas::mapUpdateInterval ( ) const

Find out how often map preview should be updated while it is being rendered (in milliseconds)

Note
added in 2.4

Definition at line 600 of file qgsmapcanvas.cpp.

void QgsMapCanvas::mouseDoubleClickEvent ( QMouseEvent e)
overrideprotectedvirtual

Overridden mouse double click event.

Reimplemented from QGraphicsView.

Definition at line 1242 of file qgsmapcanvas.cpp.

QPoint QgsMapCanvas::mouseLastXY ( )

returns last position of mouse cursor

Definition at line 1756 of file qgsmapcanvas.cpp.

void QgsMapCanvas::mouseMoveEvent ( QMouseEvent e)
overrideprotectedvirtual

Overridden mouse move event.

Reimplemented from QGraphicsView.

Definition at line 1459 of file qgsmapcanvas.cpp.

void QgsMapCanvas::mousePressEvent ( QMouseEvent e)
overrideprotectedvirtual

Overridden mouse press event.

Reimplemented from QGraphicsView.

Definition at line 1252 of file qgsmapcanvas.cpp.

void QgsMapCanvas::mouseReleaseEvent ( QMouseEvent e)
overrideprotectedvirtual

Overridden mouse release event.

Reimplemented from QGraphicsView.

Definition at line 1281 of file qgsmapcanvas.cpp.

void QgsMapCanvas::moveCanvasContents ( bool  reset = false)
protected

called when panning is in action, reset indicates end of panning

Definition at line 1742 of file qgsmapcanvas.cpp.

void QgsMapCanvas::paintEvent ( QPaintEvent e)
overrideprotectedvirtual

Overridden paint event.

Reimplemented from QGraphicsView.

Definition at line 1348 of file qgsmapcanvas.cpp.

void QgsMapCanvas::panAction ( QMouseEvent event)

Called when mouse is moving and pan is activated.

Definition at line 1734 of file qgsmapcanvas.cpp.

void QgsMapCanvas::panActionEnd ( QPoint  releasePoint)

Ends pan action and redraws the canvas.

Definition at line 1715 of file qgsmapcanvas.cpp.

void QgsMapCanvas::panToSelected ( QgsVectorLayer layer = NULL)

Pan to the selected features of current (vector) layer keeping same extent.

Definition at line 1078 of file qgsmapcanvas.cpp.

QgsPreviewEffect::PreviewMode QgsMapCanvas::previewMode ( ) const

Returns the current preview mode for the map canvas.

This setting only has an effect if previewModeEnabled is true.

Returns
preview mode for map canvas
See also
setPreviewMode
previewModeEnabled
Note
added in 2.3

Definition at line 1791 of file qgsmapcanvas.cpp.

bool QgsMapCanvas::previewModeEnabled ( ) const

Returns whether a preview mode is enabled for the map canvas.

Returns
true if a preview mode is currently enabled
See also
setPreviewModeEnabled
previewMode
Note
added in 2.3

Definition at line 1771 of file qgsmapcanvas.cpp.

void QgsMapCanvas::readProject ( const QDomDocument doc)

called to read map canvas settings from project

Definition at line 1817 of file qgsmapcanvas.cpp.

void QgsMapCanvas::refresh ( )
slot

Repaints the canvas map.

Definition at line 622 of file qgsmapcanvas.cpp.

void QgsMapCanvas::refreshAllLayers ( )

Reload all layers, clear the cache and refresh the canvas.

Note
added in 2.9

Definition at line 1990 of file qgsmapcanvas.cpp.

void QgsMapCanvas::renderComplete ( QPainter )
signal

Emitted when the canvas has rendered.

Passes a pointer to the painter on which the map was drawn. This is useful for plugins that wish to draw on the map after it has been rendered. Passing the painter allows plugins to work when the map is being rendered onto a pixmap other than the mapCanvas own pixmap member.TODO: deprecate when decorations are reimplemented as map canvas items

  • anything related to rendering progress is not visible outside of map canvas
  • additional drawing shall be done directly within the renderer job or independently as a map canvas item
bool QgsMapCanvas::renderFlag ( )
inlineslot

State of render suppression flag.

Definition at line 431 of file qgsmapcanvas.h.

void QgsMapCanvas::renderStarting ( )
signal

Emitted when the canvas is about to be rendered.

void QgsMapCanvas::resizeEvent ( QResizeEvent e)
overrideprotectedvirtual

Overridden resize event.

Reimplemented from QGraphicsView.

Definition at line 1324 of file qgsmapcanvas.cpp.

double QgsMapCanvas::rotation ( ) const

Get the current map canvas rotation in clockwise degrees.

Note
added in 2.8

Definition at line 931 of file qgsmapcanvas.cpp.

void QgsMapCanvas::rotationChanged ( double  )
signal

Emitted when the rotation of the map changes.

Note
added in 2.8
bool QgsMapCanvas::rotationEnabled ( )
static

return if canvas rotation is enabled

Note
added in 2.8

Definition at line 1980 of file qgsmapcanvas.cpp.

void QgsMapCanvas::saveAsImage ( QString  theFileName,
QPixmap QPixmap = 0,
QString  theFormat = "PNG" 
)
slot

Save the convtents of the map canvas to disk as an image.

Definition at line 793 of file qgsmapcanvas.cpp.

double QgsMapCanvas::scale ( )

Get the last reported scale of the canvas.

Definition at line 347 of file qgsmapcanvas.cpp.

void QgsMapCanvas::scaleChanged ( double  )
signal

Emitted when the scale of the map changes.

void QgsMapCanvas::selectionChanged ( QgsMapLayer layer)
signal

Emitted when selection in any layer gets changed.

void QgsMapCanvas::selectionChangedSlot ( )
slot

Receives signal about selection change, and pass it on with layer info.

Definition at line 1937 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setCachingEnabled ( bool  enabled)

Set whether to cache images of rendered layers.

Note
added in 2.4

Definition at line 552 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setCanvasColor ( const QColor theColor)
virtual

Write property of QColor bgColor.

Definition at line 1540 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setCenter ( const QgsPoint center)

Set the center of the map canvas, in geographical coordinates.

Note
added in 2.8

Definition at line 911 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setCrsTransformEnabled ( bool  enabled)

sets whether to use projections for this layer set

Note
added in 2.4

Definition at line 496 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setCurrentLayer ( QgsMapLayer layer)

Definition at line 341 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setDestinationCrs ( const QgsCoordinateReferenceSystem crs)

sets destination coordinate reference system

Note
added in 2.4

Definition at line 510 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setDirty ( bool  _dirty)

Flag the canvas as dirty and needed a refresh.

Deprecated:
since 2.4 - use refresh() to trigger a refresh (clients should not decide explicitly whether canvas is dirty or not)

Definition at line 352 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setExtent ( const QgsRectangle r)

Set the extent of the map canvas.

Definition at line 857 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setLayerSet ( QList< QgsMapCanvasLayer > &  layers)

Definition at line 378 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setLayerStyleOverrides ( const QMap< QString, QString > &  overrides)

Setter for stored overrides of styles for layers.

Note
added in 2.12

Definition at line 1656 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setMapTool ( QgsMapTool mapTool)

Sets the map tool currently being used on the canvas.

Definition at line 1485 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setMapUnits ( QGis::UnitType  mapUnits)

Set map units (needed by project properties dialog)

Definition at line 1630 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setMapUpdateInterval ( int  timeMiliseconds)

Set how often map preview should be updated while it is being rendered (in milliseconds)

Note
added in 2.4

Definition at line 595 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setParallelRenderingEnabled ( bool  enabled)

Set whether the layers are rendered in parallel or sequentially.

Note
added in 2.4

Definition at line 585 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setPreviewMode ( QgsPreviewEffect::PreviewMode  mode)

Sets a preview mode for the map canvas.

This setting only has an effect if previewModeEnabled is true.

Parameters
modepreview mode for the canvas
See also
previewMode
setPreviewModeEnabled
previewModeEnabled
Note
added in 2.3

Definition at line 1781 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setPreviewModeEnabled ( bool  previewEnabled)

Enables a preview mode for the map canvas.

Parameters
previewEnabledset to true to enable a preview mode
See also
setPreviewMode
Note
added in 2.3

Definition at line 1761 of file qgsmapcanvas.cpp.

Q_DECL_DEPRECATED void QgsMapCanvas::setProgress ( int  ,
int   
)
signal

Let the owner know how far we are with render operations.

Deprecated:
since 2.4 - already unused in 2.0 anyway
void QgsMapCanvas::setRenderFlag ( bool  theFlag)
slot

Whether to suppress rendering or not.

Definition at line 1666 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setRotation ( double  degrees)

Set the rotation of the map canvas in clockwise degrees.

Note
added in 2.8

Definition at line 936 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setSelectionColor ( const QColor color)

Set color of selected vector features.

Note
added in 2.4

Definition at line 1563 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setSnappingUtils ( QgsSnappingUtils utils)

Assign an instance of snapping utils to the map canvas.

The instance is not owned by the canvas, so it is possible to use one instance in multiple canvases.

For main canvas in QGIS, do not associate a different instance from the existing one (it is updated from the project's snapping configuration).

Note
added in 2.8

Definition at line 1812 of file qgsmapcanvas.cpp.

void QgsMapCanvas::setWheelAction ( WheelAction  action,
double  factor = 2 
)

set wheel action and zoom factor (should be greater than 1)

Definition at line 1426 of file qgsmapcanvas.cpp.

void QgsMapCanvas::showError ( QgsMapLayer mapLayer)
Deprecated:
since 2.4 - does nothing - errors are reported by different means

Definition at line 1751 of file qgsmapcanvas.cpp.

QgsSnappingUtils * QgsMapCanvas::snappingUtils ( ) const

Return snapping utility class that is associated with map canvas.

If no snapping utils instance has been associated previously, an internal will be created for convenience (so map tools do not need to test for existence of the instance).

Main canvas in QGIS returns an instance which is always up-to-date with the project's snapping configuration.

Note
added in 2.8

Definition at line 1801 of file qgsmapcanvas.cpp.

void QgsMapCanvas::stopRendering ( )

stop rendering (if there is any right now)

Note
added in 2.4

Definition at line 777 of file qgsmapcanvas.cpp.

void QgsMapCanvas::unsetMapTool ( QgsMapTool mapTool)

Unset the current map tool or last non zoom tool.

This is called from destructor of map tools to make sure that this map tool won't be used any more. You don't have to call it manualy, QgsMapTool takes care of it.

Definition at line 1522 of file qgsmapcanvas.cpp.

void QgsMapCanvas::updateCanvasItemPositions ( )
protected

called on resize or changed extent to notify canvas items to change their rectangle

Definition at line 1355 of file qgsmapcanvas.cpp.

void QgsMapCanvas::updateDatumTransformEntries ( )
protected

Make sure the datum transform store is properly populated.

Definition at line 1686 of file qgsmapcanvas.cpp.

Q_DECL_DEPRECATED void QgsMapCanvas::updateFullExtent ( )
inline

Updates the full extent.

Deprecated:
since v2.4 - does nothing

Definition at line 272 of file qgsmapcanvas.h.

void QgsMapCanvas::updateMap ( )
Deprecated:
in 2.4 - does nothing - kept for API compatibility

Definition at line 788 of file qgsmapcanvas.cpp.

void QgsMapCanvas::updateOverview ( )

Definition at line 606 of file qgsmapcanvas.cpp.

void QgsMapCanvas::updateScale ( )

Emits signal scaleChanged to update scale in main window.

Definition at line 956 of file qgsmapcanvas.cpp.

void QgsMapCanvas::useImageToRender ( bool  theFlag)

Select which Qt class to render with.

Deprecated:
since 2.4 - does nothing because now we always render to QImage

Definition at line 315 of file qgsmapcanvas.cpp.

void QgsMapCanvas::wheelEvent ( QWheelEvent e)
overrideprotectedvirtual

Overridden mouse wheel event.

Reimplemented from QGraphicsView.

Definition at line 1373 of file qgsmapcanvas.cpp.

void QgsMapCanvas::writeProject ( QDomDocument doc)

called to write map canvas settings to project

Definition at line 1841 of file qgsmapcanvas.cpp.

void QgsMapCanvas::xyCoordinates ( const QgsPoint p)
signal

Emits current mouse position.

Note
changed in 1.3
void QgsMapCanvas::zoomByFactor ( double  scaleFactor,
const QgsPoint center = 0 
)

Zoom with the factor supplied.

Factor > 1 zooms out, interval (0,1) zooms in If point is given, re-center on it

Definition at line 1929 of file qgsmapcanvas.cpp.

void QgsMapCanvas::zoomIn ( )

Zoom in with fixed factor.

Definition at line 1432 of file qgsmapcanvas.cpp.

void QgsMapCanvas::zoomLastStatusChanged ( bool  )
signal

Emitted when zoom last status changed.

void QgsMapCanvas::zoomNextStatusChanged ( bool  )
signal

Emitted when zoom next status changed.

void QgsMapCanvas::zoomOut ( )

Zoom out with fixed factor.

Definition at line 1437 of file qgsmapcanvas.cpp.

void QgsMapCanvas::zoomScale ( double  scale)

Zoom to a specific scale.

Definition at line 1442 of file qgsmapcanvas.cpp.

void QgsMapCanvas::zoomToFullExtent ( )

Zoom to the full extent of all layers.

Definition at line 969 of file qgsmapcanvas.cpp.

void QgsMapCanvas::zoomToNextExtent ( )

Zoom to the next extent (view)

Definition at line 1003 of file qgsmapcanvas.cpp.

void QgsMapCanvas::zoomToPreviousExtent ( )

Zoom to the previous extent (view)

Definition at line 985 of file qgsmapcanvas.cpp.

void QgsMapCanvas::zoomToSelected ( QgsVectorLayer layer = NULL)

Zoom to the extent of the selected features of current (vector) layer.

Parameters
layeroptionally specify different than current layer

Definition at line 1036 of file qgsmapcanvas.cpp.

void QgsMapCanvas::zoomWithCenter ( int  x,
int  y,
bool  zoomIn 
)

Zooms in/out with a given center.

Definition at line 1447 of file qgsmapcanvas.cpp.

Member Data Documentation

QScopedPointer<CanvasProperties> QgsMapCanvas::mCanvasProperties
protected

Handle pattern for implementation object.

Definition at line 604 of file qgsmapcanvas.h.


The documentation for this class was generated from the following files: