QGIS/python/gui/auto_generated/qgsadvanceddigitizingfloater.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

118 lines
3.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsadvanceddigitizingfloater.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsAdvancedDigitizingFloater : QWidget
{
%Docstring(signature="appended")
A widget that floats next to the mouse pointer, and allows interaction
with the AdvancedDigitizing feature.
It proxies display and actions to
:py:class:`QgsMapToolAdvancedDigitizingDockWidget`.
.. note::
This class is a technology preview and unstable API.
.. versionadded:: 3.8
%End
%TypeHeaderCode
#include "qgsadvanceddigitizingfloater.h"
%End
public:
enum class FloaterItem
{
XCoordinate,
YCoordinate,
MCoordinate,
ZCoordinate,
Angle,
CommonAngleSnapping,
Distance,
Bearing,
};
typedef QFlags<QgsAdvancedDigitizingFloater::FloaterItem> FloaterItems;
explicit QgsAdvancedDigitizingFloater( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget );
%Docstring
Create an advanced digitizing floater widget
:param canvas: The map canvas on which the widget operates
:param cadDockWidget: The cadDockWidget to which the floater belongs
.. versionadded:: 3.8
%End
bool active();
%Docstring
Whether the floater is active or not. Note that the floater may be
active but not visible (e.g. if the mouse is not over the canvas).
.. versionadded:: 3.8
%End
bool itemVisibility( const QgsAdvancedDigitizingFloater::FloaterItem &item ) const;
%Docstring
Returns ``True`` if the floater ``item`` visibility setting is enabled.
:param item: floater item
.. versionadded:: 3.32
%End
public slots:
void setActive( bool active );
%Docstring
Set whether the floater should be active or not. Note that the floater
may be active but not visible (e.g. if the mouse is not over the
canvas).
:param active:
.. versionadded:: 3.8
%End
void setItemVisibility( const QgsAdvancedDigitizingFloater::FloaterItem &item, bool visible );
%Docstring
Set whether the floater ``item`` should be visible or not.
:param item: floater item
:param visible:
.. versionadded:: 3.32
%End
private:
virtual bool eventFilter( QObject *obj, QEvent *event );
%Docstring
event filter to track mouse position
.. note::
defined as private in Python bindings
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsadvanceddigitizingfloater.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/