File: qgsadvanceddigitizingfloater.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (116 lines) | stat: -rw-r--r-- 3,254 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/************************************************************************
 * 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")
The :py:class:`QgsAdvancedDigitizingFloater` class is widget that floats
next to the mouse pointer, and allow 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 /BaseType=IntFlag/
    {
      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   *
 ************************************************************************/