QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | List of all members
QgsHighlight Class Reference

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

#include <qgshighlight.h>

Inheritance diagram for QgsHighlight:
Inheritance graph
[legend]

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

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from QgsMapCanvasItem
QgsMapCanvasmMapCanvas
 pointer to map canvas More...
 
QgsRectangle mRect
 canvas item rectangle (in map coordinates) More...
 
QPoint mPanningOffset
 offset from normal position due current panning operation, used when converting map coordinates to move map canvas items More...
 
QSizeF mItemSize
 cached size of the item (to return in boundingRect()) More...
 

Detailed Description

A class for highlight features on the map.

The QgsHighlight class provides a transparent overlay widget for highlightng features on the map.

Constructor & Destructor Documentation

QgsHighlight::QgsHighlight ( QgsMapCanvas mapCanvas,
QgsGeometry geom,
QgsMapLayer layer 
)
QgsHighlight::QgsHighlight ( QgsMapCanvas mapCanvas,
QgsGeometry geom,
QgsVectorLayer layer 
)
QgsHighlight::QgsHighlight ( QgsMapCanvas mapCanvas,
const QgsFeature feature,
QgsVectorLayer layer 
)

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

Parameters
mapCanvasmap canvas
feature
layervector layer
QgsHighlight::~QgsHighlight ( )

Member Function Documentation

const QgsMapLayer* QgsHighlight::layer ( ) const
inline
void QgsHighlight::paint ( QPainter *  p)
protectedvirtual

Draw the shape in response to an update event.

Implements QgsMapCanvasItem.

void QgsHighlight::setBuffer ( double  buffer)
inline

Set line / outline buffer in millimeters.

Note
: added in version 2.3
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.

void QgsHighlight::setFillColor ( const QColor &  fillColor)

Set polygons fill color.

Note
: added in version 2.3
void QgsHighlight::setMinWidth ( double  width)
inline

Set minimum line / outline width in millimeters.

Note
: added in version 2.3
void QgsHighlight::setWidth ( int  width)

Set width.

Ignored in feature mode.

Set the outline width.

void QgsHighlight::updateRect ( )
protected

recalculates needed rectangle


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