QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
Public Types | Public Slots | Public Member Functions | List of all members
QgsAdvancedDigitizingFloater Class Reference

The QgsAdvancedDigitizingFloater class is widget that floats next to the mouse pointer, and allow interaction with the AdvancedDigitizing feature. More...

#include <qgsadvanceddigitizingfloater.h>

Inheritance diagram for QgsAdvancedDigitizingFloater:
Inheritance graph
[legend]

Public Types

enum class  FloaterItem : int {
  XCoordinate = 1 << 1 , YCoordinate = 1 << 2 , MCoordinate = 1 << 3 , ZCoordinate = 1 << 4 ,
  Angle = 1 << 5 , CommonAngleSnapping = 1 << 6 , Distance = 1 << 7 , Bearing = 1 << 8
}
 Available floater items. More...
 
typedef QFlags< FloaterItemFloaterItems
 

Public Slots

void setActive (bool active)
 Set whether the floater should be active or not.
 
void setItemVisibility (const QgsAdvancedDigitizingFloater::FloaterItem &item, bool visible)
 Set whether the floater item should be visible or not.
 

Public Member Functions

 QgsAdvancedDigitizingFloater (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
 Create an advanced digitizing floater widget.
 
bool active ()
 Whether the floater is active or not.
 
bool itemVisibility (const QgsAdvancedDigitizingFloater::FloaterItem &item) const
 Returns true if the floater item visibility setting is enabled.
 

Detailed Description

The QgsAdvancedDigitizingFloater class is widget that floats next to the mouse pointer, and allow interaction with the AdvancedDigitizing feature.

It proxies display and actions to QgsMapToolAdvancedDigitizingDockWidget.

Note
This class is a technology preview and unstable API.
Since
QGIS 3.8

Definition at line 40 of file qgsadvanceddigitizingfloater.h.

Member Typedef Documentation

◆ FloaterItems

Definition at line 58 of file qgsadvanceddigitizingfloater.h.

Member Enumeration Documentation

◆ FloaterItem

Available floater items.

Enumerator
XCoordinate 
YCoordinate 
MCoordinate 
ZCoordinate 
Angle 
CommonAngleSnapping 
Distance 
Bearing 

Definition at line 47 of file qgsadvanceddigitizingfloater.h.

Constructor & Destructor Documentation

◆ QgsAdvancedDigitizingFloater()

QgsAdvancedDigitizingFloater::QgsAdvancedDigitizingFloater ( QgsMapCanvas canvas,
QgsAdvancedDigitizingDockWidget cadDockWidget 
)
explicit

Create an advanced digitizing floater widget.

Parameters
canvasThe map canvas on which the widget operates
cadDockWidgetThe cadDockWidget to which the floater belongs
Since
QGIS 3.8

Definition at line 26 of file qgsadvanceddigitizingfloater.cpp.

Member Function Documentation

◆ active()

bool QgsAdvancedDigitizingFloater::active ( )

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).

Since
QGIS 3.8

Definition at line 186 of file qgsadvanceddigitizingfloater.cpp.

◆ itemVisibility()

bool QgsAdvancedDigitizingFloater::itemVisibility ( const QgsAdvancedDigitizingFloater::FloaterItem item) const

Returns true if the floater item visibility setting is enabled.

Parameters
itemfloater item
Since
QGIS 3.32

Definition at line 191 of file qgsadvanceddigitizingfloater.cpp.

◆ setActive

void QgsAdvancedDigitizingFloater::setActive ( bool  active)
slot

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).

Parameters
active
Since
QGIS 3.8

Definition at line 196 of file qgsadvanceddigitizingfloater.cpp.

◆ setItemVisibility

void QgsAdvancedDigitizingFloater::setItemVisibility ( const QgsAdvancedDigitizingFloater::FloaterItem item,
bool  visible 
)
slot

Set whether the floater item should be visible or not.

Parameters
itemfloater item
visible
Since
QGIS 3.32

Definition at line 205 of file qgsadvanceddigitizingfloater.cpp.


The documentation for this class was generated from the following files: