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, QgsGeometry *geom, QgsMapLayer *layer)
	QgsHighlight (QgsMapCanvas *mapCanvas, QgsGeometry *geom, QgsVectorLayer *layer)
	QgsHighlight (QgsMapCanvas *mapCanvas, const QgsFeature &feature, QgsVectorLayer *layer)
	Constructor for highlighting true feature shape using feature attributes and renderer.
	~QgsHighlight ()
const QgsMapLayer *	layer () const
void	setBuffer (double buffer)
	Set line / outline buffer in millimeters.
void	setColor (const QColor &color)
	Set line/outline to color, polygon fill to color with alpha = 63.
void	setFillColor (const QColor &fillColor)
	Set polygons fill color.
void	setMinWidth (double width)
	Set minimum line / outline width in millimeters.
void	setWidth (int width)
	Set width.
virtual void	updatePosition () override
	called on changed extent or resize event to update position of the item
Public Member Functions inherited from QgsMapCanvasItem
virtual QRectF	boundingRect () const override
	default implementation for canvas items
QgsRectangle	rect () const
	returns canvas item rectangle in map units
Q_DECL_DEPRECATED void	setPanningOffset (const QPoint &point)
	sets current offset, to be called from QgsMapCanvas
void	setRect (const QgsRectangle &r, bool resetRotation=true)
	sets canvas item rectangle in map units
QPointF	toCanvasCoordinates (const QgsPoint &point) const
	transformation from map coordinates to screen coordinates
QgsPoint	toMapCoordinates (const QPoint &point) const
	transformation from screen coordinates to map coordinates

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

Additional Inherited Members
Protected Attributes inherited from QgsMapCanvasItem
QSizeF	mItemSize
	cached size of the item (to return in boundingRect())
QgsMapCanvas *	mMapCanvas
	pointer to map canvas
QPoint	mPanningOffset
	offset from normal position due current panning operation, used when converting map coordinates to move map canvas items
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 widget for highlighting features on the map.

Definition at line 36 of file qgshighlight.h.

Constructor & Destructor Documentation

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

Definition at line 56 of file qgshighlight.cpp.

QgsHighlight::QgsHighlight	(	QgsMapCanvas *	mapCanvas,
		QgsGeometry *	geom,
		QgsVectorLayer *	layer
	)

Definition at line 66 of file qgshighlight.cpp.

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

QgsHighlight::~QgsHighlight

(

)

Definition at line 109 of file qgshighlight.cpp.

Member Function Documentation

const QgsMapLayer* QgsHighlight::layer ( ) const

inline

Definition at line 69 of file qgshighlight.h.

void QgsHighlight::paint ( QPainter *  p )

overrideprotectedvirtual

Draw the shape in response to an update event.

Implements QgsMapCanvasItem.

Definition at line 279 of file qgshighlight.cpp.

void QgsHighlight::setBuffer ( double  buffer )

inline

Set line / outline buffer in millimeters.

Note

: added in version 2.3

Definition at line 63 of file qgshighlight.h.

void QgsHighlight::setColor

(

const QColor &

color

)

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

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

Set the outline and fill color.

Definition at line 117 of file qgshighlight.cpp.

void QgsHighlight::setFillColor

(

const QColor &

fillColor

)

Set polygons fill color.

Note

: added in version 2.3

Definition at line 125 of file qgshighlight.cpp.

void QgsHighlight::setMinWidth ( double  width )

inline

Set minimum line / outline width in millimeters.

Note

: added in version 2.3

Definition at line 67 of file qgshighlight.h.

void QgsHighlight::setWidth

(

int

width

)

Set width.

Ignored in feature mode.

Set the outline width.

Definition at line 207 of file qgshighlight.cpp.

void QgsHighlight::updatePosition ( )

overridevirtual

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

Reimplemented from QgsMapCanvasItem.

Definition at line 271 of file qgshighlight.cpp.

void QgsHighlight::updateRect ( )

protected

recalculates needed rectangle

Definition at line 407 of file qgshighlight.cpp.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgshighlight.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgshighlight.cpp