QGIS/python/core/auto_additions/qgsdataprovider.py
Nyall Dawson 989e62a80f Handle docstrings for c++ structs
sip doesn't support the docstring directive for structs (only classes),
so patch these back in via sipify magic
2024-08-16 07:28:29 +10:00

14 lines
1.3 KiB
Python

# The following has been generated automatically from src/core/providers/qgsdataprovider.h
try:
QgsDataProvider.__attribute_docs__ = {'transformContext': 'Coordinate transform context', 'fullExtentCalculated': 'Emitted whenever a deferred extent calculation is completed by the provider.\n\nLayers should connect to this signal and update their cached extents whenever\nit is emitted.\n', 'dataChanged': "Emitted whenever a change is made to the data provider which may have\ncaused changes in the provider's data OUTSIDE of QGIS.\n\nWhen emitted from a :py:class:`QgsVectorDataProvider`, any cached information such as\nfeature ids should be invalidated.\n\n.. warning::\n\n This signal is NOT emitted when changes are made to a provider\n from INSIDE QGIS -- e.g. when adding features to a vector layer, deleting features\n or modifying existing features. Instead, the specific :py:class:`QgsVectorLayer` signals\n should be used to detect these operations.\n", 'notify': 'Emitted when the datasource issues a notification.\n\n.. seealso:: :py:func:`setListening`\n'}
except NameError:
pass
QgsDataProvider.sublayerSeparator = staticmethod(QgsDataProvider.sublayerSeparator)
QgsDataProvider.ProviderOptions.__doc__ = """Setting options for creating vector data providers.
.. note::
coordinateTransformContext was added in QGIS 3.8
.. versionadded:: 3.2"""