QgsHighlight Class Reference

A class for highlight features on the map. More...

#include <qgshighlight.h>

Inheritance diagram for QgsHighlight:

Public Member Functions
	QgsHighlight (QgsMapCanvas *mapCanvas, const QgsGeometry &geom, QgsMapLayer *layer)
	Constructor for QgsHighlight. More...
	QgsHighlight (QgsMapCanvas *mapCanvas, const QgsFeature &feature, QgsVectorLayer *layer)
	Constructor for highlighting true feature shape using feature attributes and renderer. More...
	~QgsHighlight () override
QgsMapLayer *	layer () const
	Return the layer for which this highlight has been created. More...
void	setBuffer (double buffer)
	Set line / stroke buffer in millimeters. More...
void	setColor (const QColor &color)
	Set line/stroke to color, polygon fill to color with alpha = 63. More...
void	setFillColor (const QColor &fillColor)
	Fill color for the highlight. More...
void	setMinWidth (double width)
	Set minimum line / stroke width in millimeters. More...
void	setWidth (int width)
	Set stroke width. More...
void	updatePosition () override
	called on changed extent or resize event to update position of the item More...
Public Member Functions inherited from QgsMapCanvasItem
QRectF	boundingRect () const override
QgsRectangle	rect () const
	returns canvas item rectangle in map units More...
void	setRect (const QgsRectangle &r, bool resetRotation=true)
	sets canvas item rectangle in map units More...
QPointF	toCanvasCoordinates (const QgsPointXY &point) const
	transformation from map coordinates to screen coordinates More...
QgsPointXY	toMapCoordinates (QPoint point) const
	transformation from screen coordinates to map coordinates More...

Protected Member Functions
void	paint (QPainter *p) override
	function to be implemented by derived classes More...
void	updateRect ()
	recalculates needed rectangle More...
Protected Member Functions inherited from QgsMapCanvasItem
	QgsMapCanvasItem (QgsMapCanvas *mapCanvas)
	protected constructor: cannot be constructed directly More...
	~QgsMapCanvasItem () override
void	paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=nullptr) override
bool	setRenderContextVariables (QPainter *p, QgsRenderContext &context) const
	Sets render context parameters. More...
void	updateCanvas ()
	schedules map canvas for repaint More...

Additional Inherited Members
Protected Attributes inherited from QgsMapCanvasItem
QSizeF	mItemSize
	cached size of the item (to return in boundingRect()) More...
QgsMapCanvas *	mMapCanvas = nullptr
	pointer to map canvas More...
QgsRectangle	mRect
	cached canvas item rectangle in map coordinates encodes position (xmin,ymax) and size (width/height) used to re-position and re-size the item on zoom/pan while waiting for the renderer to complete. More...
double	mRectRotation

Detailed Description

A class for highlight features on the map.

The QgsHighlight class provides a transparent overlay canvas item for highlighting features or geometries on a map canvas.

color = QColor(Qt.red)
highlight = QgsHighlight(mapCanvas, feature, layer)
highlight.setColor(color)
color.setAlpha(50)
highlight.setFillColor(color)
highlight.show()

Definition at line 49 of file qgshighlight.h.

Constructor & Destructor Documentation

QgsHighlight() [1/2]

QgsHighlight::QgsHighlight	(	QgsMapCanvas *	mapCanvas,
		const QgsGeometry &	geom,
		QgsMapLayer *	layer
	)

Constructor for QgsHighlight.

Parameters

mapCanvas	associated map canvas
geom	initial geometry of highlight
layer	associated map layer

Definition at line 49 of file qgshighlight.cpp.

QgsHighlight() [2/2]

QgsHighlight::QgsHighlight	(	QgsMapCanvas *	mapCanvas,
		const QgsFeature &	feature,
		QgsVectorLayer *	layer
	)

Constructor for highlighting true feature shape using feature attributes and renderer.

Parameters

mapCanvas	map canvas
feature
layer	vector layer

Definition at line 57 of file qgshighlight.cpp.

~QgsHighlight()

QgsHighlight::~QgsHighlight ( )

override

Definition at line 87 of file qgshighlight.cpp.

Member Function Documentation

layer()

QgsMapLayer* QgsHighlight::layer ( ) const

inline

Return the layer for which this highlight has been created.

Definition at line 108 of file qgshighlight.h.

paint()

void QgsHighlight::paint ( QPainter *  painter )

overrideprotectedvirtual

function to be implemented by derived classes

Implements QgsMapCanvasItem.

Definition at line 251 of file qgshighlight.cpp.

setBuffer()

void QgsHighlight::setBuffer ( double  buffer )

inline

Set line / stroke buffer in millimeters.

Since

QGIS 2.4

Definition at line 96 of file qgshighlight.h.

setColor()

void QgsHighlight::setColor

(

const QColor &

color

)

Set line/stroke to color, polygon fill to color with alpha = 63.

This is legacy function, use setFillColor() after setColor() if different fill color is required.

Definition at line 92 of file qgshighlight.cpp.

setFillColor()

void QgsHighlight::setFillColor

(

const QColor &

fillColor

)

Fill color for the highlight.

Will be used for polygons and points.

Since

QGIS 2.4

Definition at line 100 of file qgshighlight.cpp.

setMinWidth()

void QgsHighlight::setMinWidth ( double  width )

inline

Set minimum line / stroke width in millimeters.

Since

QGIS 2.4

Definition at line 103 of file qgshighlight.h.

setWidth()

void QgsHighlight::setWidth

(

int

width

)

Set stroke width.

Note

Ignored in feature mode.

Definition at line 179 of file qgshighlight.cpp.

updatePosition()

void QgsHighlight::updatePosition ( )

overridevirtual

called on changed extent or resize event to update position of the item

Reimplemented from QgsMapCanvasItem.

Definition at line 246 of file qgshighlight.cpp.

updateRect()

void QgsHighlight::updateRect ( )

protected

recalculates needed rectangle

Definition at line 378 of file qgshighlight.cpp.

---

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

• /tmp/buildd/qgis-3.0.2+14stretch/src/gui/qgshighlight.h
• /tmp/buildd/qgis-3.0.2+14stretch/src/gui/qgshighlight.cpp