QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
qgsmaptip.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmaptip.h - Query a layer and show a maptip on the canvas
3  ---------------------
4  begin : October 2007
5  copyright : (C) 2007 by Gary Sherman
6  email : sherman @ mrcc dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 #ifndef QGSMAPTIP_H
16 #define QGSMAPTIP_H
17 
18 class QgsMapLayer;
19 class QgsMapCanvas;
20 class QPoint;
21 class QString;
22 class QgsPoint;
23 class QgsVectorLayer;
24 class QgsWebView;
25 
26 #include <QWidget>
27 #include <QUrl>
28 #include "qgsfeature.h"
29 
49 class GUI_EXPORT QgsMapTip: public QWidget
50 {
51  Q_OBJECT
52  public:
55  QgsMapTip();
58  virtual ~QgsMapTip();
68  void showMapTip( QgsMapLayer * thepLayer,
69  QgsPoint & theMapPosition,
70  QPoint & thePixelPosition,
71  QgsMapCanvas *mpMapCanvas );
75  void clear( QgsMapCanvas *mpMapCanvas = nullptr );
76  private:
77  // Fetch the feature to use for the maptip text.
78  // Only the first feature in the search radius is used
79  QString fetchFeature( QgsMapLayer * thepLayer,
80  QgsPoint & theMapPosition,
81  QgsMapCanvas *thepMapCanvas );
82 
83  QString replaceText(
84  QString displayText, QgsVectorLayer *layer, QgsFeature &feat );
85 
86  // Flag to indicate if a maptip is currently being displayed
87  bool mMapTipVisible;
88 
89  QWidget* mWidget;
90  QgsWebView* mWebView;
91 
92  private slots:
93  void onLinkClicked( const QUrl& url );
94 };
95 #endif // QGSMAPTIP_H
Base class for all map layer types.
Definition: qgsmaplayer.h:49
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:187
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:109
The QgsWebView class is a collection of stubs to mimic the API of QWebView on systems where the real ...
Definition: qgswebview.h:57
A maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature...
Definition: qgsmaptip.h:49
A class to represent a point.
Definition: qgspoint.h:117
Represents a vector layer which manages a vector based data sets.