mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
79 lines
2.9 KiB
Plaintext
79 lines
2.9 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsmaptip.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
class QgsMapTip : QWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
A maptip is a class to display a tip on a map canvas
|
|
when a mouse is hovered over a feature.
|
|
|
|
Since QGIS 2.16 a maptip can show full html.
|
|
:py:class:`QgsMapTip` is a :py:class:`QgsWebView`, so you can load full HTML/JS/CSS in it.
|
|
|
|
The code found in the map tips tab is inserted in a inline-block div
|
|
so the frame can be resized based on the content size.
|
|
|
|
If no element in the html has a width attribute, the frame will squeeze down
|
|
to the widest word. To avoid this you can wrap your HTML in a
|
|
div style="width:300px" or similar.
|
|
|
|
JS can be included using the script tag as usual, while CSS files must be
|
|
linked using link rel="stylesheet" href="URL.css" the html specs
|
|
discourages link rel="stylesheet" in the body, but all browsers allow it.
|
|
see https://jakearchibald.com/2016/link-in-body
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmaptip.h"
|
|
%End
|
|
public:
|
|
|
|
QgsMapTip();
|
|
%Docstring
|
|
Default constructor
|
|
%End
|
|
|
|
void showMapTip( QgsMapLayer *thepLayer,
|
|
QgsPointXY &mapPosition,
|
|
QPoint &pixelPosition,
|
|
QgsMapCanvas *mpMapCanvas );
|
|
%Docstring
|
|
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 mapPosition: a reference to the position of the cursor
|
|
in map coordinatess.
|
|
:param pixelPosition: a reference to the position of the cursor
|
|
in pixel coordinates.
|
|
:param mpMapCanvas: a map canvas on which the tip is drawn
|
|
%End
|
|
|
|
void clear( QgsMapCanvas *mpMapCanvas = 0 );
|
|
%Docstring
|
|
Clear the current maptip if it exists
|
|
|
|
:param mpMapCanvas: the canvas from which the tip should be cleared.
|
|
%End
|
|
|
|
void applyFontSettings();
|
|
%Docstring
|
|
Apply font family and size to match user settings
|
|
%End
|
|
|
|
};
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsmaptip.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|