QGIS API Documentation  3.13.0-Master (740be229cb)
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 QgsPointXY;
23 class QgsVectorLayer;
24 class QgsWebView;
25 
26 #include <QWidget>
27 #include <QUrl>
28 #include "qgsfeature.h"
29 #include "qgis_gui.h"
30 
51 class GUI_EXPORT QgsMapTip : public QWidget
52 {
53  Q_OBJECT
54  public:
55 
59  QgsMapTip();
60 
71  void showMapTip( QgsMapLayer *thepLayer,
72  QgsPointXY &mapPosition,
73  QPoint &pixelPosition,
74  QgsMapCanvas *mpMapCanvas );
75 
80  void clear( QgsMapCanvas *mpMapCanvas = nullptr );
81 
85  void applyFontSettings();
86 
87  private slots:
88  void onLinkClicked( const QUrl &url );
89  void resizeContent();
90 
91  private:
92  // Fetch the feature to use for the maptip text.
93  // Only the first feature in the search radius is used
94  QString fetchFeature( QgsMapLayer *thepLayer,
95  QgsPointXY &mapPosition,
96  QgsMapCanvas *mapCanvas );
97 
98  QString replaceText(
99  QString displayText, QgsVectorLayer *layer, QgsFeature &feat );
100 
101  // Flag to indicate if a maptip is currently being displayed
102  bool mMapTipVisible;
103 
104  QWidget *mWidget = nullptr;
105  QgsWebView *mWebView = nullptr;
106 
107  QString mFontFamily;
108  int mFontSize = 8;
109 
110  const int MARGIN_VALUE = 5;
111 };
112 #endif // QGSMAPTIP_H
Base class for all map layer types.
Definition: qgsmaplayer.h:80
A class to represent a 2D point.
Definition: qgspointxy.h:43
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:78
The QgsWebView class is a collection of stubs to mimic the API of QWebView on systems where the real ...
Definition: qgswebview.h:65
A maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature...
Definition: qgsmaptip.h:51
Represents a vector layer which manages a vector based data sets.