sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-06 00:03:16 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix another documentation build warning

Browse Source
This commit is contained in:
Nyall Dawson 2025-04-09 06:55:51 +10:00
parent fc76784e09
commit fb645f0e04
5 changed files with 35 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/PyQt6/core/auto_additions/qgsvectorfilewriter.py
View File

@ -49,7 +49,7 @@ try:
except (NameError, AttributeError): except (NameError, AttributeError):
pass pass
try: try:
QgsVectorFileWriter.SaveVectorOptions.__attribute_docs__ = {'driverName': 'OGR driver to use', 'layerName': 'Layer name. If let empty, it will be derived from the filename', 'actionOnExistingFile': 'Action on existing file', 'fileEncoding': 'Encoding to use', 'ct': 'Transform to reproject exported geometries with, or invalid transform\nfor no transformation', 'onlySelectedFeatures': 'Write only selected features of layer', 'datasourceOptions': 'List of OGR data source creation options', 'layerOptions': 'List of OGR layer creation options', 'skipAttributeCreation': 'Only write geometries', 'attributes': 'Attributes to export (empty means all unless skipAttributeCreation is set)', 'attributesExportNames': 'Attributes export names', 'symbologyExport': 'Symbology to export', 'symbologyScale': 'Scale of symbology', 'filterExtent': 'If not empty, only features intersecting the extent will be saved', 'overrideGeometryType': 'Set to a valid geometry type to override the default geometry type for the layer. This parameter\nallows for conversion of geometryless tables to null geometries, etc.', 'forceMulti': 'Sets to ``True`` to force creation of multi* geometries', 'includeZ': 'Sets to ``True`` to include z dimension in output. This option is only valid if overrideGeometryType is set', 'fieldValueConverter': 'Field value converter.\n\nOwnership is not transferred and callers must ensure that the lifetime of fieldValueConverter\nexceeds the lifetime of the :py:class:`QgsVectorFileWriter` object.', 'feedback': 'Optional feedback object allowing cancellation of layer save', 'fieldNameSource': 'Source for exported field names.\n\n.. versionadded:: 3.18', 'saveMetadata': 'Set to ``True`` to save layer metadata for the exported vector file.\n\n.. seealso:: :py:func:`layerMetadata`\n\n.. versionadded:: 3.20', 'layerMetadata': 'Layer metadata to save for the exported vector file. This will only be used if saveMetadata is ``True``.\n\n.. seealso:: :py:func:`saveMetadata`\n\n.. versionadded:: 3.20', 'includeConstraints': 'Set to ``True`` to transfer field constraints to the exported vector file.\n\nSupport for field constraints depends on the output file format.\n\n.. versionadded:: 3.34', 'setFieldDomains': 'Set to ``True`` to transfer field domains to the exported vector file.\n\nSupport for field domains depends on the output file format.\n\n.. note::\n\n Only available in builds based on GDAL 3.5 or later\n\n.. versionadded:: 3.36', 'sourceDatabaseProviderConnection': 'Source database provider connection, for field domains.\n\nOwnership is not transferred and callers must ensure that the lifetime of sourceDatabaseProviderConnection\nexceeds the lifetime of the :py:class:`QgsVectorFileWriter` object.\n\n.. versionadded:: 3.36'} QgsVectorFileWriter.SaveVectorOptions.__attribute_docs__ = {'driverName': 'OGR driver to use', 'layerName': 'Layer name. If let empty, it will be derived from the filename', 'actionOnExistingFile': 'Action on existing file', 'fileEncoding': 'Encoding to use', 'ct': 'Transform to reproject exported geometries with, or invalid transform\nfor no transformation', 'onlySelectedFeatures': 'Write only selected features of layer', 'datasourceOptions': 'List of OGR data source creation options', 'layerOptions': 'List of OGR layer creation options', 'skipAttributeCreation': 'Only write geometries', 'attributes': 'Attributes to export (empty means all unless skipAttributeCreation is set)', 'attributesExportNames': 'Attributes export names', 'symbologyExport': 'Symbology to export', 'symbologyScale': 'Scale of symbology', 'filterExtent': 'If not empty, only features intersecting the extent will be saved', 'overrideGeometryType': 'Set to a valid geometry type to override the default geometry type for the layer. This parameter\nallows for conversion of geometryless tables to null geometries, etc.', 'forceMulti': 'Sets to ``True`` to force creation of multipart geometries', 'includeZ': 'Sets to ``True`` to include z dimension in output. This option is only valid if overrideGeometryType is set', 'fieldValueConverter': 'Field value converter.\n\nOwnership is not transferred and callers must ensure that the lifetime of fieldValueConverter\nexceeds the lifetime of the :py:class:`QgsVectorFileWriter` object.', 'feedback': 'Optional feedback object allowing cancellation of layer save', 'fieldNameSource': 'Source for exported field names.\n\n.. versionadded:: 3.18', 'saveMetadata': 'Set to ``True`` to save layer metadata for the exported vector file.\n\n.. seealso:: :py:func:`layerMetadata`\n\n.. versionadded:: 3.20', 'layerMetadata': 'Layer metadata to save for the exported vector file. This will only be used if saveMetadata is ``True``.\n\n.. seealso:: :py:func:`saveMetadata`\n\n.. versionadded:: 3.20', 'includeConstraints': 'Set to ``True`` to transfer field constraints to the exported vector file.\n\nSupport for field constraints depends on the output file format.\n\n.. versionadded:: 3.34', 'setFieldDomains': 'Set to ``True`` to transfer field domains to the exported vector file.\n\nSupport for field domains depends on the output file format.\n\n.. note::\n\n Only available in builds based on GDAL 3.5 or later\n\n.. versionadded:: 3.36', 'sourceDatabaseProviderConnection': 'Source database provider connection, for field domains.\n\nOwnership is not transferred and callers must ensure that the lifetime of sourceDatabaseProviderConnection\nexceeds the lifetime of the :py:class:`QgsVectorFileWriter` object.\n\n.. versionadded:: 3.36'}
QgsVectorFileWriter.SaveVectorOptions.__annotations__ = {'driverName': str, 'layerName': str, 'actionOnExistingFile': 'QgsVectorFileWriter.ActionOnExistingFile', 'fileEncoding': str, 'ct': 'QgsCoordinateTransform', 'onlySelectedFeatures': bool, 'datasourceOptions': 'List[str]', 'layerOptions': 'List[str]', 'skipAttributeCreation': bool, 'attributes': 'QgsAttributeList', 'attributesExportNames': 'List[str]', 'symbologyExport': 'Qgis.FeatureSymbologyExport', 'symbologyScale': float, 'filterExtent': 'QgsRectangle', 'overrideGeometryType': 'Qgis.WkbType', 'forceMulti': bool, 'includeZ': bool, 'fieldValueConverter': 'QgsVectorFileWriter.FieldValueConverter', 'feedback': 'QgsFeedback', 'fieldNameSource': 'QgsVectorFileWriter.FieldNameSource', 'saveMetadata': bool, 'layerMetadata': 'QgsLayerMetadata', 'includeConstraints': bool, 'setFieldDomains': bool, 'sourceDatabaseProviderConnection': 'QgsAbstractDatabaseProviderConnection'} QgsVectorFileWriter.SaveVectorOptions.__annotations__ = {'driverName': str, 'layerName': str, 'actionOnExistingFile': 'QgsVectorFileWriter.ActionOnExistingFile', 'fileEncoding': str, 'ct': 'QgsCoordinateTransform', 'onlySelectedFeatures': bool, 'datasourceOptions': 'List[str]', 'layerOptions': 'List[str]', 'skipAttributeCreation': bool, 'attributes': 'QgsAttributeList', 'attributesExportNames': 'List[str]', 'symbologyExport': 'Qgis.FeatureSymbologyExport', 'symbologyScale': float, 'filterExtent': 'QgsRectangle', 'overrideGeometryType': 'Qgis.WkbType', 'forceMulti': bool, 'includeZ': bool, 'fieldValueConverter': 'QgsVectorFileWriter.FieldValueConverter', 'feedback': 'QgsFeedback', 'fieldNameSource': 'QgsVectorFileWriter.FieldNameSource', 'saveMetadata': bool, 'layerMetadata': 'QgsLayerMetadata', 'includeConstraints': bool, 'setFieldDomains': bool, 'sourceDatabaseProviderConnection': 'QgsAbstractDatabaseProviderConnection'}
except (NameError, AttributeError): except (NameError, AttributeError):
pass pass

16
python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in
View File

@ -296,7 +296,7 @@ Write contents of vector layer to an (OGR supported) vector format
This parameter allows for conversion of This parameter allows for conversion of
geometryless tables to null geometries, etc geometryless tables to null geometries, etc
(added in QGIS 2.14) (added in QGIS 2.14)
:param forceMulti: set to ``True`` to force creation of multi* :param forceMulti: set to ``True`` to force creation of multipart
geometries (added in QGIS 2.14) geometries (added in QGIS 2.14)
:param includeZ: set to ``True`` to include z dimension in output. This :param includeZ: set to ``True`` to include z dimension in output. This
option is only valid if overrideGeometryType is set. option is only valid if overrideGeometryType is set.
@ -305,7 +305,9 @@ Write contents of vector layer to an (OGR supported) vector format
skipAttributeCreation is set) skipAttributeCreation is set)
:param fieldValueConverter: field value converter (added in QGIS 2.16) :param fieldValueConverter: field value converter (added in QGIS 2.16)
:return: - errorMessage: the error message text, if an error occurs :return: - QgsVectorFileWriter.WriterError.NoError in case of success,
or error code in case of error
- errorMessage: the error message text, if an error occurs
while writing the layer while writing the layer
.. deprecated:: 3.40 .. deprecated:: 3.40
@ -358,7 +360,7 @@ Writes a layer out to a vector file.
This parameter allows for conversion of This parameter allows for conversion of
geometryless tables to null geometries, etc geometryless tables to null geometries, etc
(added in QGIS 2.14) (added in QGIS 2.14)
:param forceMulti: set to ``True`` to force creation of multi* :param forceMulti: set to ``True`` to force creation of multipart
geometries (added in QGIS 2.14) geometries (added in QGIS 2.14)
:param includeZ: set to ``True`` to include z dimension in output. This :param includeZ: set to ``True`` to include z dimension in output. This
option is only valid if overrideGeometryType is set. option is only valid if overrideGeometryType is set.
@ -367,7 +369,9 @@ Writes a layer out to a vector file.
skipAttributeCreation is set) skipAttributeCreation is set)
:param fieldValueConverter: field value converter (added in QGIS 2.16) :param fieldValueConverter: field value converter (added in QGIS 2.16)
:return: - errorMessage: the error message text, if an error occurs :return: - QgsVectorFileWriter.WriterError.NoError in case of success,
or error code in case of error
- errorMessage: the error message text, if an error occurs
while writing the layer while writing the layer
.. deprecated:: 3.40 .. deprecated:: 3.40
@ -457,7 +461,9 @@ Writes a layer out to a vector file.
:param newFilename: QString pointer which will contain the new file name :param newFilename: QString pointer which will contain the new file name
created (in case it is different to fileName). created (in case it is different to fileName).
:return: - errorMessage: the error message text, if an error occurs :return: - QgsVectorFileWriter.WriterError.NoError in case of success,
or error code in case of error
- errorMessage: the error message text, if an error occurs
while writing the layer while writing the layer
.. deprecated:: 3.40 .. deprecated:: 3.40

2
python/core/auto_additions/qgsvectorfilewriter.py
View File

@ -5,7 +5,7 @@ try:
except (NameError, AttributeError): except (NameError, AttributeError):
pass pass
try: try:
QgsVectorFileWriter.SaveVectorOptions.__attribute_docs__ = {'driverName': 'OGR driver to use', 'layerName': 'Layer name. If let empty, it will be derived from the filename', 'actionOnExistingFile': 'Action on existing file', 'fileEncoding': 'Encoding to use', 'ct': 'Transform to reproject exported geometries with, or invalid transform\nfor no transformation', 'onlySelectedFeatures': 'Write only selected features of layer', 'datasourceOptions': 'List of OGR data source creation options', 'layerOptions': 'List of OGR layer creation options', 'skipAttributeCreation': 'Only write geometries', 'attributes': 'Attributes to export (empty means all unless skipAttributeCreation is set)', 'attributesExportNames': 'Attributes export names', 'symbologyExport': 'Symbology to export', 'symbologyScale': 'Scale of symbology', 'filterExtent': 'If not empty, only features intersecting the extent will be saved', 'overrideGeometryType': 'Set to a valid geometry type to override the default geometry type for the layer. This parameter\nallows for conversion of geometryless tables to null geometries, etc.', 'forceMulti': 'Sets to ``True`` to force creation of multi* geometries', 'includeZ': 'Sets to ``True`` to include z dimension in output. This option is only valid if overrideGeometryType is set', 'fieldValueConverter': 'Field value converter.\n\nOwnership is not transferred and callers must ensure that the lifetime of fieldValueConverter\nexceeds the lifetime of the :py:class:`QgsVectorFileWriter` object.', 'feedback': 'Optional feedback object allowing cancellation of layer save', 'fieldNameSource': 'Source for exported field names.\n\n.. versionadded:: 3.18', 'saveMetadata': 'Set to ``True`` to save layer metadata for the exported vector file.\n\n.. seealso:: :py:func:`layerMetadata`\n\n.. versionadded:: 3.20', 'layerMetadata': 'Layer metadata to save for the exported vector file. This will only be used if saveMetadata is ``True``.\n\n.. seealso:: :py:func:`saveMetadata`\n\n.. versionadded:: 3.20', 'includeConstraints': 'Set to ``True`` to transfer field constraints to the exported vector file.\n\nSupport for field constraints depends on the output file format.\n\n.. versionadded:: 3.34', 'setFieldDomains': 'Set to ``True`` to transfer field domains to the exported vector file.\n\nSupport for field domains depends on the output file format.\n\n.. note::\n\n Only available in builds based on GDAL 3.5 or later\n\n.. versionadded:: 3.36', 'sourceDatabaseProviderConnection': 'Source database provider connection, for field domains.\n\nOwnership is not transferred and callers must ensure that the lifetime of sourceDatabaseProviderConnection\nexceeds the lifetime of the :py:class:`QgsVectorFileWriter` object.\n\n.. versionadded:: 3.36'} QgsVectorFileWriter.SaveVectorOptions.__attribute_docs__ = {'driverName': 'OGR driver to use', 'layerName': 'Layer name. If let empty, it will be derived from the filename', 'actionOnExistingFile': 'Action on existing file', 'fileEncoding': 'Encoding to use', 'ct': 'Transform to reproject exported geometries with, or invalid transform\nfor no transformation', 'onlySelectedFeatures': 'Write only selected features of layer', 'datasourceOptions': 'List of OGR data source creation options', 'layerOptions': 'List of OGR layer creation options', 'skipAttributeCreation': 'Only write geometries', 'attributes': 'Attributes to export (empty means all unless skipAttributeCreation is set)', 'attributesExportNames': 'Attributes export names', 'symbologyExport': 'Symbology to export', 'symbologyScale': 'Scale of symbology', 'filterExtent': 'If not empty, only features intersecting the extent will be saved', 'overrideGeometryType': 'Set to a valid geometry type to override the default geometry type for the layer. This parameter\nallows for conversion of geometryless tables to null geometries, etc.', 'forceMulti': 'Sets to ``True`` to force creation of multipart geometries', 'includeZ': 'Sets to ``True`` to include z dimension in output. This option is only valid if overrideGeometryType is set', 'fieldValueConverter': 'Field value converter.\n\nOwnership is not transferred and callers must ensure that the lifetime of fieldValueConverter\nexceeds the lifetime of the :py:class:`QgsVectorFileWriter` object.', 'feedback': 'Optional feedback object allowing cancellation of layer save', 'fieldNameSource': 'Source for exported field names.\n\n.. versionadded:: 3.18', 'saveMetadata': 'Set to ``True`` to save layer metadata for the exported vector file.\n\n.. seealso:: :py:func:`layerMetadata`\n\n.. versionadded:: 3.20', 'layerMetadata': 'Layer metadata to save for the exported vector file. This will only be used if saveMetadata is ``True``.\n\n.. seealso:: :py:func:`saveMetadata`\n\n.. versionadded:: 3.20', 'includeConstraints': 'Set to ``True`` to transfer field constraints to the exported vector file.\n\nSupport for field constraints depends on the output file format.\n\n.. versionadded:: 3.34', 'setFieldDomains': 'Set to ``True`` to transfer field domains to the exported vector file.\n\nSupport for field domains depends on the output file format.\n\n.. note::\n\n Only available in builds based on GDAL 3.5 or later\n\n.. versionadded:: 3.36', 'sourceDatabaseProviderConnection': 'Source database provider connection, for field domains.\n\nOwnership is not transferred and callers must ensure that the lifetime of sourceDatabaseProviderConnection\nexceeds the lifetime of the :py:class:`QgsVectorFileWriter` object.\n\n.. versionadded:: 3.36'}
QgsVectorFileWriter.SaveVectorOptions.__annotations__ = {'driverName': str, 'layerName': str, 'actionOnExistingFile': 'QgsVectorFileWriter.ActionOnExistingFile', 'fileEncoding': str, 'ct': 'QgsCoordinateTransform', 'onlySelectedFeatures': bool, 'datasourceOptions': 'List[str]', 'layerOptions': 'List[str]', 'skipAttributeCreation': bool, 'attributes': 'QgsAttributeList', 'attributesExportNames': 'List[str]', 'symbologyExport': 'Qgis.FeatureSymbologyExport', 'symbologyScale': float, 'filterExtent': 'QgsRectangle', 'overrideGeometryType': 'Qgis.WkbType', 'forceMulti': bool, 'includeZ': bool, 'fieldValueConverter': 'QgsVectorFileWriter.FieldValueConverter', 'feedback': 'QgsFeedback', 'fieldNameSource': 'QgsVectorFileWriter.FieldNameSource', 'saveMetadata': bool, 'layerMetadata': 'QgsLayerMetadata', 'includeConstraints': bool, 'setFieldDomains': bool, 'sourceDatabaseProviderConnection': 'QgsAbstractDatabaseProviderConnection'} QgsVectorFileWriter.SaveVectorOptions.__annotations__ = {'driverName': str, 'layerName': str, 'actionOnExistingFile': 'QgsVectorFileWriter.ActionOnExistingFile', 'fileEncoding': str, 'ct': 'QgsCoordinateTransform', 'onlySelectedFeatures': bool, 'datasourceOptions': 'List[str]', 'layerOptions': 'List[str]', 'skipAttributeCreation': bool, 'attributes': 'QgsAttributeList', 'attributesExportNames': 'List[str]', 'symbologyExport': 'Qgis.FeatureSymbologyExport', 'symbologyScale': float, 'filterExtent': 'QgsRectangle', 'overrideGeometryType': 'Qgis.WkbType', 'forceMulti': bool, 'includeZ': bool, 'fieldValueConverter': 'QgsVectorFileWriter.FieldValueConverter', 'feedback': 'QgsFeedback', 'fieldNameSource': 'QgsVectorFileWriter.FieldNameSource', 'saveMetadata': bool, 'layerMetadata': 'QgsLayerMetadata', 'includeConstraints': bool, 'setFieldDomains': bool, 'sourceDatabaseProviderConnection': 'QgsAbstractDatabaseProviderConnection'}
except (NameError, AttributeError): except (NameError, AttributeError):
pass pass

16
python/core/auto_generated/qgsvectorfilewriter.sip.in
View File

@ -296,7 +296,7 @@ Write contents of vector layer to an (OGR supported) vector format
This parameter allows for conversion of This parameter allows for conversion of
geometryless tables to null geometries, etc geometryless tables to null geometries, etc
(added in QGIS 2.14) (added in QGIS 2.14)
:param forceMulti: set to ``True`` to force creation of multi* :param forceMulti: set to ``True`` to force creation of multipart
geometries (added in QGIS 2.14) geometries (added in QGIS 2.14)
:param includeZ: set to ``True`` to include z dimension in output. This :param includeZ: set to ``True`` to include z dimension in output. This
option is only valid if overrideGeometryType is set. option is only valid if overrideGeometryType is set.
@ -305,7 +305,9 @@ Write contents of vector layer to an (OGR supported) vector format
skipAttributeCreation is set) skipAttributeCreation is set)
:param fieldValueConverter: field value converter (added in QGIS 2.16) :param fieldValueConverter: field value converter (added in QGIS 2.16)
:return: - errorMessage: the error message text, if an error occurs :return: - QgsVectorFileWriter.WriterError.NoError in case of success,
or error code in case of error
- errorMessage: the error message text, if an error occurs
while writing the layer while writing the layer
.. deprecated:: 3.40 .. deprecated:: 3.40
@ -358,7 +360,7 @@ Writes a layer out to a vector file.
This parameter allows for conversion of This parameter allows for conversion of
geometryless tables to null geometries, etc geometryless tables to null geometries, etc
(added in QGIS 2.14) (added in QGIS 2.14)
:param forceMulti: set to ``True`` to force creation of multi* :param forceMulti: set to ``True`` to force creation of multipart
geometries (added in QGIS 2.14) geometries (added in QGIS 2.14)
:param includeZ: set to ``True`` to include z dimension in output. This :param includeZ: set to ``True`` to include z dimension in output. This
option is only valid if overrideGeometryType is set. option is only valid if overrideGeometryType is set.
@ -367,7 +369,9 @@ Writes a layer out to a vector file.
skipAttributeCreation is set) skipAttributeCreation is set)
:param fieldValueConverter: field value converter (added in QGIS 2.16) :param fieldValueConverter: field value converter (added in QGIS 2.16)
:return: - errorMessage: the error message text, if an error occurs :return: - QgsVectorFileWriter.WriterError.NoError in case of success,
or error code in case of error
- errorMessage: the error message text, if an error occurs
while writing the layer while writing the layer
.. deprecated:: 3.40 .. deprecated:: 3.40
@ -457,7 +461,9 @@ Writes a layer out to a vector file.
:param newFilename: QString pointer which will contain the new file name :param newFilename: QString pointer which will contain the new file name
created (in case it is different to fileName). created (in case it is different to fileName).
:return: - errorMessage: the error message text, if an error occurs :return: - QgsVectorFileWriter.WriterError.NoError in case of success,
or error code in case of error
- errorMessage: the error message text, if an error occurs
while writing the layer while writing the layer
.. deprecated:: 3.40 .. deprecated:: 3.40

16
src/core/qgsvectorfilewriter.h
View File

@ -303,11 +303,12 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink
* \param filterExtent if not NULLPTR, only features intersecting the extent will be saved (added in QGIS 2.4) * \param filterExtent if not NULLPTR, only features intersecting the extent will be saved (added in QGIS 2.4)
* \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter * \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter
* allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14) * allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14)
* \param forceMulti set to TRUE to force creation of multi* geometries (added in QGIS 2.14) * \param forceMulti set to TRUE to force creation of multipart geometries (added in QGIS 2.14)
* \param includeZ set to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14) * \param includeZ set to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14)
* \param attributes attributes to export (empty means all unless skipAttributeCreation is set) * \param attributes attributes to export (empty means all unless skipAttributeCreation is set)
* \param fieldValueConverter field value converter (added in QGIS 2.16) * \param fieldValueConverter field value converter (added in QGIS 2.16)
* \param newLayer QString pointer which will contain the new layer name created (in case it is different to the provided layer name) (added in QGIS 3.4, not available in python) * \param newLayer QString pointer which will contain the new layer name created (in case it is different to the provided layer name) (added in QGIS 3.4, not available in python)
* \returns QgsVectorFileWriter::WriterError::NoError in case of success, or error code in case of error
* \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead. * \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead.
*/ */
#else #else
@ -330,10 +331,11 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink
* \param filterExtent if not NULLPTR, only features intersecting the extent will be saved (added in QGIS 2.4) * \param filterExtent if not NULLPTR, only features intersecting the extent will be saved (added in QGIS 2.4)
* \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter * \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter
* allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14) * allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14)
* \param forceMulti set to TRUE to force creation of multi* geometries (added in QGIS 2.14) * \param forceMulti set to TRUE to force creation of multipart geometries (added in QGIS 2.14)
* \param includeZ set to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14) * \param includeZ set to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14)
* \param attributes attributes to export (empty means all unless skipAttributeCreation is set) * \param attributes attributes to export (empty means all unless skipAttributeCreation is set)
* \param fieldValueConverter field value converter (added in QGIS 2.16) * \param fieldValueConverter field value converter (added in QGIS 2.16)
* \returns QgsVectorFileWriter::WriterError::NoError in case of success, or error code in case of error
* \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead. * \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead.
*/ */
#endif #endif
@ -383,11 +385,12 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink
* \param filterExtent if not NULLPTR, only features intersecting the extent will be saved (added in QGIS 2.4) * \param filterExtent if not NULLPTR, only features intersecting the extent will be saved (added in QGIS 2.4)
* \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter * \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter
* allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14) * allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14)
* \param forceMulti set to TRUE to force creation of multi* geometries (added in QGIS 2.14) * \param forceMulti set to TRUE to force creation of multipart geometries (added in QGIS 2.14)
* \param includeZ set to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14) * \param includeZ set to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14)
* \param attributes attributes to export (empty means all unless skipAttributeCreation is set) * \param attributes attributes to export (empty means all unless skipAttributeCreation is set)
* \param fieldValueConverter field value converter (added in QGIS 2.16) * \param fieldValueConverter field value converter (added in QGIS 2.16)
* \param newLayer QString pointer which will contain the new layer name created (in case it is different to the provided layer name) (added in QGIS 3.4, not available in python) * \param newLayer QString pointer which will contain the new layer name created (in case it is different to the provided layer name) (added in QGIS 3.4, not available in python)
* \returns QgsVectorFileWriter::WriterError::NoError in case of success, or error code in case of error
* \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead. * \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead.
*/ */
#else #else
@ -411,10 +414,11 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink
* \param filterExtent if not NULLPTR, only features intersecting the extent will be saved (added in QGIS 2.4) * \param filterExtent if not NULLPTR, only features intersecting the extent will be saved (added in QGIS 2.4)
* \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter * \param overrideGeometryType set to a valid geometry type to override the default geometry type for the layer. This parameter
* allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14) * allows for conversion of geometryless tables to null geometries, etc (added in QGIS 2.14)
* \param forceMulti set to TRUE to force creation of multi* geometries (added in QGIS 2.14) * \param forceMulti set to TRUE to force creation of multipart geometries (added in QGIS 2.14)
* \param includeZ set to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14) * \param includeZ set to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set. (added in QGIS 2.14)
* \param attributes attributes to export (empty means all unless skipAttributeCreation is set) * \param attributes attributes to export (empty means all unless skipAttributeCreation is set)
* \param fieldValueConverter field value converter (added in QGIS 2.16) * \param fieldValueConverter field value converter (added in QGIS 2.16)
* \returns QgsVectorFileWriter::WriterError::NoError in case of success, or error code in case of error
* \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead. * \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead.
*/ */
#endif #endif
@ -506,7 +510,7 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink
*/ */
Qgis::WkbType overrideGeometryType = Qgis::WkbType::Unknown; Qgis::WkbType overrideGeometryType = Qgis::WkbType::Unknown;
//! Sets to TRUE to force creation of multi* geometries //! Sets to TRUE to force creation of multipart geometries
bool forceMulti = false; bool forceMulti = false;
//! Sets to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set //! Sets to TRUE to include z dimension in output. This option is only valid if overrideGeometryType is set
@ -586,6 +590,7 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink
* \param newFilename QString pointer which will contain the new file name created (in case it is different to fileName). * \param newFilename QString pointer which will contain the new file name created (in case it is different to fileName).
* \param errorMessage will be set to the error message text, if an error occurs while writing the layer * \param errorMessage will be set to the error message text, if an error occurs while writing the layer
* \param newLayer QString pointer which will contain the new layer name created (in case it is different to the provided layer name) (added in QGIS 3.4, not available in python) * \param newLayer QString pointer which will contain the new layer name created (in case it is different to the provided layer name) (added in QGIS 3.4, not available in python)
* \returns QgsVectorFileWriter::WriterError::NoError in case of success, or error code in case of error
* \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead. * \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead.
*/ */
#else #else
@ -597,6 +602,7 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink
* \param options options. * \param options options.
* \param newFilename QString pointer which will contain the new file name created (in case it is different to fileName). * \param newFilename QString pointer which will contain the new file name created (in case it is different to fileName).
* \param errorMessage will be set to the error message text, if an error occurs while writing the layer * \param errorMessage will be set to the error message text, if an error occurs while writing the layer
* \returns QgsVectorFileWriter::WriterError::NoError in case of success, or error code in case of error
* \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead. * \deprecated QGIS 3.40. Use writeAsVectorFormatV2() instead.
*/ */
#endif #endif