QgsMapTip Class Reference

A maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature. More...

#include <qgsmaptip.h>

List of all members.

Public Member Functions
	QgsMapTip ()
	Default constructor.
virtual	~QgsMapTip ()
	Destructor.
void	clear (QgsMapCanvas *mpMapCanvas)
	Clear the current maptip if it exists.
void	showMapTip (QgsMapLayer *thepLayer, QgsPoint &theMapPosition, QPoint &thePixelPosition, QgsMapCanvas *mpMapCanvas)
	Show a maptip at a given point on the map canvas.
Private Member Functions
QString	fetchFeature (QgsMapLayer *thepLayer, QgsPoint &theMapPosition, QgsMapCanvas *thepMapCanvas)
QString	replaceText (QString displayText, QgsVectorLayer *layer, QgsFeature &feat)
Private Attributes
QPoint	mLastPosition
bool	mMapTipVisible

---

Detailed Description

A maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature.

Definition at line 29 of file qgsmaptip.h.

---

Constructor & Destructor Documentation

QgsMapTip::QgsMapTip

(

)

Default constructor.

Definition at line 28 of file qgsmaptip.cpp.

References mMapTipVisible.

QgsMapTip::~QgsMapTip

(

)

[virtual]

Destructor.

Definition at line 34 of file qgsmaptip.cpp.

---

Member Function Documentation

void QgsMapTip::clear

(

QgsMapCanvas *

mpMapCanvas

)

Clear the current maptip if it exists.

Parameters:

mpMapCanvas

the canvas from which the tip should be cleared.

Definition at line 64 of file qgsmaptip.cpp.

References mLastPosition, and mMapTipVisible.

QString QgsMapTip::fetchFeature	(	QgsMapLayer *	thepLayer,
		QgsPoint &	theMapPosition,
		QgsMapCanvas *	thepMapCanvas
	)		[private]

Definition at line 75 of file qgsmaptip.cpp.

References QgsFeature::attribute(), QGis::DEFAULT_IDENTIFY_RADIUS, QgsVectorLayer::displayField(), QgsFeatureRequest::ExactIntersect, QgsMapCanvas::extent(), QgsVectorLayer::fieldNameIndex(), QgsVectorLayer::getFeatures(), QgsMapCanvas::mapRenderer(), QgsMapRenderer::mapToLayerCoordinates(), QgsFeatureIterator::nextFeature(), QgsExpression::replaceExpressionText(), QgsRectangle::setXMaximum(), QgsRectangle::setXMinimum(), QgsRectangle::setYMaximum(), QgsRectangle::setYMinimum(), QgsRectangle::width(), QgsPoint::x(), and QgsPoint::y().

Referenced by showMapTip().

QString QgsMapTip::replaceText	(	QString	displayText,
		QgsVectorLayer *	layer,
		QgsFeature &	feat
	)		[private]

void QgsMapTip::showMapTip	(	QgsMapLayer *	thepLayer,
		QgsPoint &	theMapPosition,
		QPoint &	thePixelPosition,
		QgsMapCanvas *	mpMapCanvas
	)

Show a maptip at a given point on the map canvas.

Parameters:

thepLayer	a qgis vector map layer pointer that will be used to provide the attribute data for the map tip.
theMapPosition	a reference to the position of the cursor in map coordinatess.
thePixelPosition	a reference to the position of the cursor in pixel coordinates.
mpMapCanvas	a map canvas on which the tip is drawn

Definition at line 39 of file qgsmaptip.cpp.

References fetchFeature(), mLastPosition, and mMapTipVisible.

---

Member Data Documentation

QPoint QgsMapTip::mLastPosition [private]

Definition at line 68 of file qgsmaptip.h.

Referenced by clear(), and showMapTip().

bool QgsMapTip::mMapTipVisible [private]

Definition at line 65 of file qgsmaptip.h.

Referenced by clear(), QgsMapTip(), and showMapTip().

---

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

• src/gui/qgsmaptip.h
• src/gui/qgsmaptip.cpp