QGIS API Documentation  2.99.0-Master (19b062c)
Public Slots | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QgsMapOverviewCanvas Class Reference

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

#include <qgsmapoverviewcanvas.h>

Inheritance diagram for QgsMapOverviewCanvas:
Inheritance graph
[legend]

Public Slots

void destinationCrsChanged ()
 Should be called when the canvas destination CRS is changed. More...
 
void drawExtentRect ()
 used for overview canvas to reflect changed extent in main map canvas More...
 

Public Member Functions

 QgsMapOverviewCanvas (QWidget *parent=nullptr, QgsMapCanvas *mapCanvas=nullptr)
 
void enableAntiAliasing (bool flag)
 
QList< QgsMapLayer * > layers () const
 Returns list of layers visible in the overview. More...
 
void refresh ()
 renders overview and updates panning widget More...
 
void setBackgroundColor (const QColor &color)
 changes background color More...
 
void setLayers (const QList< QgsMapLayer *> &layers)
 updates layer set for overview More...
 
void updateFullExtent ()
 

Protected Slots

void layerRepaintRequested (bool deferred=false)
 Triggered when a layer in the overview requests a repaint. More...
 
void mapRenderingFinished ()
 

Protected Member Functions

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 paintEvent (QPaintEvent *pe) override
 Overridden paint event. More...
 
void resizeEvent (QResizeEvent *e) override
 Overridden resize event. More...
 
void showEvent (QShowEvent *e) override
 Overridden show event. More...
 
void updatePanningWidget (QPoint pos)
 called when panning to reflect mouse movement More...
 

Protected Attributes

QgsMapRendererQImageJobmJob = nullptr
 for rendering overview More...
 
QgsMapCanvasmMapCanvas = nullptr
 main map canvas - used to get/set extent More...
 
QPoint mPanningCursorOffset
 position of cursor inside panning widget More...
 
QgsPanningWidget * mPanningWidget = nullptr
 widget for panning map in overview More...
 
QPixmap mPixmap
 pixmap where the map is stored More...
 
QgsMapSettings mSettings
 map settings used for rendering of the overview map More...
 

Detailed Description

A widget that displays an overview map.

Definition at line 41 of file qgsmapoverviewcanvas.h.

Constructor & Destructor Documentation

◆ QgsMapOverviewCanvas()

QgsMapOverviewCanvas::QgsMapOverviewCanvas ( QWidget *  parent = nullptr,
QgsMapCanvas mapCanvas = nullptr 
)

Definition at line 34 of file qgsmapoverviewcanvas.cpp.

Member Function Documentation

◆ destinationCrsChanged

void QgsMapOverviewCanvas::destinationCrsChanged ( )
slot

Should be called when the canvas destination CRS is changed.

Definition at line 260 of file qgsmapoverviewcanvas.cpp.

◆ drawExtentRect

void QgsMapOverviewCanvas::drawExtentRect ( )
slot

used for overview canvas to reflect changed extent in main map canvas

Definition at line 78 of file qgsmapoverviewcanvas.cpp.

◆ enableAntiAliasing()

void QgsMapOverviewCanvas::enableAntiAliasing ( bool  flag)
inline

Definition at line 60 of file qgsmapoverviewcanvas.h.

◆ layerRepaintRequested

void QgsMapOverviewCanvas::layerRepaintRequested ( bool  deferred = false)
protectedslot

Triggered when a layer in the overview requests a repaint.

Definition at line 209 of file qgsmapoverviewcanvas.cpp.

◆ layers()

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

Returns list of layers visible in the overview.

Definition at line 265 of file qgsmapoverviewcanvas.cpp.

◆ mapRenderingFinished

void QgsMapOverviewCanvas::mapRenderingFinished ( )
protectedslot

Definition at line 197 of file qgsmapoverviewcanvas.cpp.

◆ mouseMoveEvent()

void QgsMapOverviewCanvas::mouseMoveEvent ( QMouseEvent *  e)
overrideprotected

Overridden mouse move event.

Definition at line 142 of file qgsmapoverviewcanvas.cpp.

◆ mousePressEvent()

void QgsMapOverviewCanvas::mousePressEvent ( QMouseEvent *  e)
overrideprotected

Overridden mouse press event.

Definition at line 103 of file qgsmapoverviewcanvas.cpp.

◆ mouseReleaseEvent()

void QgsMapOverviewCanvas::mouseReleaseEvent ( QMouseEvent *  e)
overrideprotected

Overridden mouse release event.

Definition at line 124 of file qgsmapoverviewcanvas.cpp.

◆ paintEvent()

void QgsMapOverviewCanvas::paintEvent ( QPaintEvent *  pe)
overrideprotected

Overridden paint event.

Definition at line 68 of file qgsmapoverviewcanvas.cpp.

◆ refresh()

void QgsMapOverviewCanvas::refresh ( )

renders overview and updates panning widget

Definition at line 159 of file qgsmapoverviewcanvas.cpp.

◆ resizeEvent()

void QgsMapOverviewCanvas::resizeEvent ( QResizeEvent *  e)
overrideprotected

Overridden resize event.

Definition at line 49 of file qgsmapoverviewcanvas.cpp.

◆ setBackgroundColor()

void QgsMapOverviewCanvas::setBackgroundColor ( const QColor &  color)

changes background color

Definition at line 216 of file qgsmapoverviewcanvas.cpp.

◆ setLayers()

void QgsMapOverviewCanvas::setLayers ( const QList< QgsMapLayer *> &  layers)

updates layer set for overview

Definition at line 226 of file qgsmapoverviewcanvas.cpp.

◆ showEvent()

void QgsMapOverviewCanvas::showEvent ( QShowEvent *  e)
overrideprotected

Overridden show event.

Definition at line 62 of file qgsmapoverviewcanvas.cpp.

◆ updateFullExtent()

void QgsMapOverviewCanvas::updateFullExtent ( )

Definition at line 245 of file qgsmapoverviewcanvas.cpp.

◆ updatePanningWidget()

void QgsMapOverviewCanvas::updatePanningWidget ( QPoint  pos)
protected

called when panning to reflect mouse movement

Definition at line 152 of file qgsmapoverviewcanvas.cpp.

Member Data Documentation

◆ mJob

QgsMapRendererQImageJob* QgsMapOverviewCanvas::mJob = nullptr
protected

for rendering overview

Definition at line 121 of file qgsmapoverviewcanvas.h.

◆ mMapCanvas

QgsMapCanvas* QgsMapOverviewCanvas::mMapCanvas = nullptr
protected

main map canvas - used to get/set extent

Definition at line 112 of file qgsmapoverviewcanvas.h.

◆ mPanningCursorOffset

QPoint QgsMapOverviewCanvas::mPanningCursorOffset
protected

position of cursor inside panning widget

Definition at line 109 of file qgsmapoverviewcanvas.h.

◆ mPanningWidget

QgsPanningWidget* QgsMapOverviewCanvas::mPanningWidget = nullptr
protected

widget for panning map in overview

Definition at line 106 of file qgsmapoverviewcanvas.h.

◆ mPixmap

QPixmap QgsMapOverviewCanvas::mPixmap
protected

pixmap where the map is stored

Definition at line 115 of file qgsmapoverviewcanvas.h.

◆ mSettings

QgsMapSettings QgsMapOverviewCanvas::mSettings
protected

map settings used for rendering of the overview map

Definition at line 118 of file qgsmapoverviewcanvas.h.


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