QGIS API Documentation  2.99.0-Master (e077efd)
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...
 
void hasCrsTransformEnabled (bool flag)
 

Public Member Functions

 QgsMapOverviewCanvas (QWidget *parent=nullptr, QgsMapCanvas *mapCanvas=nullptr)
 
 ~QgsMapOverviewCanvas ()
 
void enableAntiAliasing (bool flag)
 
QStringList layerSet () const
 
void refresh ()
 renders overview and updates panning widget More...
 
void setBackgroundColor (const QColor &color)
 changes background color More...
 
void setLayerSet (const QStringList &layerSet)
 updates layer set for overview More...
 
void updateFullExtent ()
 

Protected Slots

void layerRepaintRequested ()
 
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
 for rendering overview More...
 
QgsMapCanvasmMapCanvas
 main map canvas - used to get/set extent More...
 
QPoint mPanningCursorOffset
 position of cursor inside panning widget More...
 
QgsPanningWidget * mPanningWidget
 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 39 of file qgsmapoverviewcanvas.h.

Constructor & Destructor Documentation

§ QgsMapOverviewCanvas()

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

Definition at line 34 of file qgsmapoverviewcanvas.cpp.

§ ~QgsMapOverviewCanvas()

QgsMapOverviewCanvas::~QgsMapOverviewCanvas ( )

Definition at line 48 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 269 of file qgsmapoverviewcanvas.cpp.

§ drawExtentRect

void QgsMapOverviewCanvas::drawExtentRect ( )
slot

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

Definition at line 81 of file qgsmapoverviewcanvas.cpp.

§ enableAntiAliasing()

void QgsMapOverviewCanvas::enableAntiAliasing ( bool  flag)
inline

Definition at line 59 of file qgsmapoverviewcanvas.h.

§ hasCrsTransformEnabled

void QgsMapOverviewCanvas::hasCrsTransformEnabled ( bool  flag)
slot

Definition at line 264 of file qgsmapoverviewcanvas.cpp.

§ layerRepaintRequested

void QgsMapOverviewCanvas::layerRepaintRequested ( )
protectedslot

Definition at line 212 of file qgsmapoverviewcanvas.cpp.

§ layerSet()

QStringList QgsMapOverviewCanvas::layerSet ( ) const

Definition at line 274 of file qgsmapoverviewcanvas.cpp.

§ mapRenderingFinished

void QgsMapOverviewCanvas::mapRenderingFinished ( )
protectedslot

Definition at line 200 of file qgsmapoverviewcanvas.cpp.

§ mouseMoveEvent()

void QgsMapOverviewCanvas::mouseMoveEvent ( QMouseEvent *  e)
overrideprotected

Overridden mouse move event.

Definition at line 145 of file qgsmapoverviewcanvas.cpp.

§ mousePressEvent()

void QgsMapOverviewCanvas::mousePressEvent ( QMouseEvent *  e)
overrideprotected

Overridden mouse press event.

Definition at line 106 of file qgsmapoverviewcanvas.cpp.

§ mouseReleaseEvent()

void QgsMapOverviewCanvas::mouseReleaseEvent ( QMouseEvent *  e)
overrideprotected

Overridden mouse release event.

Definition at line 127 of file qgsmapoverviewcanvas.cpp.

§ paintEvent()

void QgsMapOverviewCanvas::paintEvent ( QPaintEvent *  pe)
overrideprotected

Overridden paint event.

Definition at line 71 of file qgsmapoverviewcanvas.cpp.

§ refresh()

void QgsMapOverviewCanvas::refresh ( )

renders overview and updates panning widget

Definition at line 162 of file qgsmapoverviewcanvas.cpp.

§ resizeEvent()

void QgsMapOverviewCanvas::resizeEvent ( QResizeEvent *  e)
overrideprotected

Overridden resize event.

Definition at line 52 of file qgsmapoverviewcanvas.cpp.

§ setBackgroundColor()

void QgsMapOverviewCanvas::setBackgroundColor ( const QColor &  color)

changes background color

Definition at line 218 of file qgsmapoverviewcanvas.cpp.

§ setLayerSet()

void QgsMapOverviewCanvas::setLayerSet ( const QStringList &  layerSet)

updates layer set for overview

Definition at line 228 of file qgsmapoverviewcanvas.cpp.

§ showEvent()

void QgsMapOverviewCanvas::showEvent ( QShowEvent *  e)
overrideprotected

Overridden show event.

Definition at line 65 of file qgsmapoverviewcanvas.cpp.

§ updateFullExtent()

void QgsMapOverviewCanvas::updateFullExtent ( )

Definition at line 249 of file qgsmapoverviewcanvas.cpp.

§ updatePanningWidget()

void QgsMapOverviewCanvas::updatePanningWidget ( QPoint  pos)
protected

called when panning to reflect mouse movement

Definition at line 155 of file qgsmapoverviewcanvas.cpp.

Member Data Documentation

§ mJob

QgsMapRendererQImageJob* QgsMapOverviewCanvas::mJob
protected

for rendering overview

Definition at line 119 of file qgsmapoverviewcanvas.h.

§ mMapCanvas

QgsMapCanvas* QgsMapOverviewCanvas::mMapCanvas
protected

main map canvas - used to get/set extent

Definition at line 110 of file qgsmapoverviewcanvas.h.

§ mPanningCursorOffset

QPoint QgsMapOverviewCanvas::mPanningCursorOffset
protected

position of cursor inside panning widget

Definition at line 107 of file qgsmapoverviewcanvas.h.

§ mPanningWidget

QgsPanningWidget* QgsMapOverviewCanvas::mPanningWidget
protected

widget for panning map in overview

Definition at line 104 of file qgsmapoverviewcanvas.h.

§ mPixmap

QPixmap QgsMapOverviewCanvas::mPixmap
protected

pixmap where the map is stored

Definition at line 113 of file qgsmapoverviewcanvas.h.

§ mSettings

QgsMapSettings QgsMapOverviewCanvas::mSettings
protected

map settings used for rendering of the overview map

Definition at line 116 of file qgsmapoverviewcanvas.h.


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