QGIS/python/gui/qgsmaptip.sip
Juergen E. Fischer f3cb57b1eb SIP bindings update:
- update methods of existing classes
- add comment to methods missing in the sip bindings
- split up collective sip files into single files and use
  same directory structure in python/ as in src/
- add a lot of missing classes (some might not make sense because of
  missing python methods in those classes)
- remove some non-existing methods from the header files
- add scripts/sipdiff
- replace some usages of std::vector and std::set with QVector/QSet
2012-09-24 02:42:57 +02:00

37 lines
1.1 KiB
Plaintext

/** \ingroup gui
* A maptip is a class to display a tip on a map canvas
* when a mouse is hovered over a feature.
*/
class QgsMapTip
{
%TypeHeaderCode
#include <qgsmaptip.h>
%End
public:
/** Default constructor
*/
QgsMapTip();
/** Destructor
*/
virtual ~QgsMapTip();
/** Show a maptip at a given point on the map canvas
* @param thepLayer a qgis vector map layer pointer that will
* be used to provide the attribute data for the map tip.
* @param theMapPosition a reference to the position of the cursor
* in map coordinatess.
* @param thePixelPosition a reference to the position of the cursor
* in pixel coordinates.
* @param mpMapCanvas a map canvas on which the tip is drawn
*/
void showMapTip( QgsMapLayer * thepLayer,
QgsPoint & theMapPosition,
QPoint & thePixelPosition,
QgsMapCanvas *mpMapCanvas );
/** Clear the current maptip if it exists
* @param mpMapCanvas the canvas from which the tip should be cleared.
*/
void clear( QgsMapCanvas *mpMapCanvas );
};