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

#include <qgshighlight.h>

Inheritance diagram for QgsHighlight:

Public Member Functions
	QgsHighlight (QgsMapCanvas mapCanvas, const QgsFeature &feature, QgsVectorLayer layer)
	Constructor for highlighting `true` feature shape using feature attributes and renderer.

	QgsHighlight (QgsMapCanvas mapCanvas, const QgsGeometry &geom, QgsMapLayer layer)
	Constructor for QgsHighlight.

	~QgsHighlight () override

void	applyDefaultStyle ()
	Applies the default style from the user settings to the highlight.

double	buffer () const
	Returns the buffer.

QColor	color () const
	Returns the line/stroke color.

QColor	fillColor () const
	Returns the fill color.

QgsMapLayer *	layer () const
	Returns the layer for which this highlight has been created.

void	setBuffer (double buffer)
	Set line / stroke buffer in millimeters.

void	setColor (const QColor &color)
	Set line/stroke to color, polygon fill to color with alpha = 63.

void	setFillColor (const QColor &fillColor)
	Fill color for the highlight.

void	setMinWidth (double width)
	Set minimum line / stroke width in millimeters.

void	setWidth (int width)
	Set stroke width.

void	updatePosition () override
	called on changed extent or resize event to update position of the item

int	width () const
	Returns the stroke width.

Public Member Functions inherited from QgsMapCanvasItem
QRectF	boundingRect () const override

QgsRectangle	rect () const
	returns canvas item rectangle in map units

void	setRect (const QgsRectangle &r, bool resetRotation=true)
	sets canvas item rectangle in map units

QPointF	toCanvasCoordinates (const QgsPointXY &point) const
	transformation from map coordinates to screen coordinates

QgsPointXY	toMapCoordinates (QPoint point) const
	transformation from screen coordinates to map coordinates

Protected Member Functions
void	paint (QPainter *p) override
	function to be implemented by derived classes

void	updateRect ()
	recalculates needed rectangle

Protected Member Functions inherited from QgsMapCanvasItem
	QgsMapCanvasItem (QgsMapCanvas *mapCanvas)
	protected constructor: cannot be constructed directly

	~QgsMapCanvasItem () override

void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget=nullptr) override

bool	setRenderContextVariables (QPainter *p, QgsRenderContext &context) const
	Sets render context parameters.

void	updateCanvas ()
	schedules map canvas for repaint

Properties
int	buffer

QColor	color

QColor	fillColor

int	width

Friends
class	QgsMapToolAddFeature

class	QgsUpdateGpsDetailsAction

Additional Inherited Members
Protected Attributes inherited from QgsMapCanvasItem
QSizeF	mItemSize
	cached size of the item (to return in boundingRect())

QgsMapCanvas *	mMapCanvas = nullptr
	pointer to map canvas

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.

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 61 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 52 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 61 of file qgshighlight.cpp.

◆ ~QgsHighlight()

QgsHighlight::~QgsHighlight ( )

overridedefault

Member Function Documentation

◆ applyDefaultStyle()

void QgsHighlight::applyDefaultStyle ( )

Applies the default style from the user settings to the highlight.

Since: QGIS 3.30

Definition at line 308 of file qgshighlight.cpp.

◆ buffer()

double QgsHighlight::buffer ( ) const

inline

Returns the buffer.

Since: QGIS 3.4

Definition at line 152 of file qgshighlight.h.

◆ color()

QColor QgsHighlight::color ( ) const

inline

Returns the line/stroke color.

Since: QGIS 3.4

Definition at line 113 of file qgshighlight.h.

◆ fillColor()

QColor QgsHighlight::fillColor ( ) const

inline

Returns the fill color.

Since: QGIS 3.4

Definition at line 125 of file qgshighlight.h.

◆ layer()

QgsMapLayer * QgsHighlight::layer ( ) const

inline

Returns the layer for which this highlight has been created.

Definition at line 171 of file qgshighlight.h.

◆ paint()

void QgsHighlight::paint ( QPainter * painter )

overrideprotectedvirtual

function to be implemented by derived classes

Implements QgsMapCanvasItem.

Definition at line 323 of file qgshighlight.cpp.

◆ setBuffer()

void QgsHighlight::setBuffer ( double buffer )

inline

Set line / stroke buffer in millimeters.

Since: QGIS 2.4

Definition at line 159 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 108 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 117 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 166 of file qgshighlight.h.

◆ setWidth()

void QgsHighlight::setWidth ( int width )

Set stroke width.

Note: Ignored in feature mode.

Definition at line 200 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 295 of file qgshighlight.cpp.

◆ updateRect()

void QgsHighlight::updateRect ( )

protected

recalculates needed rectangle

Definition at line 488 of file qgshighlight.cpp.

◆ width()

int QgsHighlight::width ( ) const

inline

Returns the stroke width.

Since: QGIS 3.4

Definition at line 139 of file qgshighlight.h.

Friends And Related Symbol Documentation

◆ QgsMapToolAddFeature

friend class QgsMapToolAddFeature

friend

Definition at line 222 of file qgshighlight.h.

◆ QgsUpdateGpsDetailsAction

friend class QgsUpdateGpsDetailsAction

friend

Definition at line 223 of file qgshighlight.h.

Property Documentation

◆ buffer

int QgsHighlight::buffer

readwrite

Definition at line 89 of file qgshighlight.h.

◆ color

QColor QgsHighlight::color

readwrite

Definition at line 86 of file qgshighlight.h.

◆ fillColor

QColor QgsHighlight::fillColor

readwrite

Definition at line 87 of file qgshighlight.h.

◆ width

int QgsHighlight::width

readwrite

Definition at line 88 of file qgshighlight.h.

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

/build/qgis-3.34.0+99sid/src/gui/qgshighlight.h
/build/qgis-3.34.0+99sid/src/gui/qgshighlight.cpp

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsHighlight() [1/2]

◆ QgsHighlight() [2/2]

◆ ~QgsHighlight()

Member Function Documentation

◆ applyDefaultStyle()

◆ buffer()

◆ color()

◆ fillColor()

◆ layer()

◆ paint()

◆ setBuffer()

◆ setColor()

◆ setFillColor()

◆ setMinWidth()

◆ setWidth()

◆ updatePosition()

◆ updateRect()

◆ width()

Friends And Related Symbol Documentation

◆ QgsMapToolAddFeature

◆ QgsUpdateGpsDetailsAction

Property Documentation

◆ buffer

◆ color

◆ fillColor

◆ width