Class: QgsGeometryWidget¶

A widget for storing and interacting with a QgsGeometry object.

This widget can be used in places where an dialog needs to expose a geometry value to users, and allow them to safely interact with it (such as changing the stored geometry value).

Added in version 3.30.

Class Hierarchy¶

Base classes¶

QWidget
QObject
QPaintDevice

class qgis.gui.QgsGeometryWidget[source]¶

Bases: QWidget

__init__(parent: QWidget | None = None)

Constructor for QgsGeometryWidget, with the specified parent widget.

Parameters:: parent (Optional[QWidget] = None)

acceptedWkbTypes(self) → List[Qgis.WkbType]¶

Returns the list of WKB geometry types which are permitted for the widget.

See also

setAcceptedWkbTypes()

Return type:: List[Qgis.WkbType]

clearGeometry(self)[source]¶: Clears the current geometry value stored in the widget.

copyAsGeoJson(self)[source]¶: Copies the current geometry value to the clipboard, as a GeoJSON string.

See also

copyAsWkt()

copyAsWkt(self)[source]¶: Copies the current geometry value to the clipboard, as a WKT string.

See also

copyAsGeoJson()

geometryValue(self) → QgsReferencedGeometry[source]¶

Returns the current geometry value for the widget.

Warning

This should not be confused with QWidget.geometry(), which returns the placement and size of the widget itself.

See also

setGeometryValue()

See also

geometryValueChanged()

Return type:: QgsReferencedGeometry

signal geometryValueChanged[source]¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

isReadOnly(self) → bool[source]¶

Returns whether the widget is in a read-only state.

See also

setReadOnly()