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

use more semantic argument name

Browse Source
This commit is contained in:
Alexander Bruy 2025-04-03 10:50:48 +01:00
parent 598233d881
commit d7fd6fd619
27 changed files with 58 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/PyQt6/analysis/auto_generated/interpolation/qgsgridfilewriter.sip.in
View File

@ -42,7 +42,7 @@ cancellation support
:return: 0 in case of success
%End
void setCreationOptions( const QStringList &list );
void setCreationOptions( const QStringList &options );
%Docstring
Sets a list of data source creation options to use when creating the
output raster file.

2
python/PyQt6/analysis/auto_generated/raster/qgsninecellfilter.sip.in
View File

@ -71,7 +71,7 @@ mOutputFile
double outputNodataValue() const;
void setOutputNodataValue( double value );
void setCreationOptions( const QStringList &list );
void setCreationOptions( const QStringList &options );
%Docstring
Sets a list of data source creation options to use when creating the
output raster file.

2
python/PyQt6/analysis/auto_generated/raster/qgsrastercalculator.sip.in
View File

@ -155,7 +155,7 @@ Returns a description of the last error encountered.
.. versionadded:: 3.4
%End
void setCreationOptions( const QStringList &list );
void setCreationOptions( const QStringList &options );
%Docstring
Sets a list of data source creation options to use when creating the
output raster file.

3
python/PyQt6/core/auto_generated/providers/qgsprovidermetadata.sip.in
View File

@ -465,6 +465,7 @@ create new empty GeoPackage or FileGeodatabase databases.
.. versionadded:: 3.28
%End
virtual QgsRasterDataProvider *createRasterDataProvider(
const QString &uri,
const QString &format,
@ -474,7 +475,7 @@ create new empty GeoPackage or FileGeodatabase databases.
int height,
double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() ) /Factory/;
const QStringList &createOptions = QStringList() ) /Factory/;
%Docstring
Creates a new instance of the raster data provider.

3
python/PyQt6/core/auto_generated/providers/qgsproviderregistry.sip.in
View File

@ -109,6 +109,7 @@ Returns the provider capabilities
%End
QgsRasterDataProvider *createRasterDataProvider(
const QString &providerKey,
const QString &uri,
@ -118,7 +119,7 @@ Returns the provider capabilities
int width, int height,
double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() ) /Factory/;
const QStringList &createOptions = QStringList() ) /Factory/;
%Docstring
Creates new instance of raster data provider

6
python/PyQt6/core/auto_generated/raster/qgsrasterdataprovider.sip.in
View File

@ -452,13 +452,14 @@ editing mode in order to allow write operations.
:return: ``True`` on success
%End
static QgsRasterDataProvider *create( const QString &providerKey,
const QString &uri,
const QString &format, int nBands,
Qgis::DataType type,
int width, int height, double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() );
const QStringList &createOptions = QStringList() );
%Docstring
Creates a new dataset with mDataSourceURI
%End
@ -527,7 +528,8 @@ Encodes the URI starting from the struct .
since QGIS 3.22
%End
virtual QString validateCreationOptions( const QStringList &creationOptions, const QString &format );
virtual QString validateCreationOptions( const QStringList &createOptions, const QString &format );
%Docstring
Validates creation options for a specific dataset and destination
format.

8
python/PyQt6/core/auto_generated/raster/qgsrasterfilewriter.sip.in
View File

@ -258,6 +258,7 @@ Returns the maximum tile height (in pixels) for tiled outputs.
.. seealso:: :py:func:`tiledMode`
%End
void setCreateOptions( const QStringList &list );
%Docstring
Sets a list of data source creation options to use when creating the
@ -292,16 +293,17 @@ creating the output raster file.
.. versionadded:: 3.44
%End
void setCreationOptions( const QStringList &list );
void setCreationOptions( const QStringList &options );
%Docstring
Sets a list of data source creation options to use when
creating the output raster file.
Sets a list of data source creation options to use when creating the
output raster file.
.. seealso:: :py:func:`creationOptions`
.. versionadded:: 3.44
%End
void setPyramidsConfigOptions( const QStringList &list );
%Docstring
Sets a ``list`` of configuration options to use when creating the

2
python/PyQt6/gui/auto_generated/qgsrasterformatsaveoptionswidget.sip.in
View File

@ -127,7 +127,7 @@ Emitted when the options configured in the widget are changed.
void deleteCreationOptions( const QString &profile );
void setCreationOptions();
void setCreationOptions( const QString &profile, const QString &options );
void setCreationOptions( const QString &profile, const QStringList &list );
void setCreationOptions( const QString &profile, const QStringList &options );
QStringList profiles() const;
virtual bool eventFilter( QObject *obj, QEvent *event );

1
python/PyQt6/gui/auto_generated/qgsrasterlayersaveasdialog.sip.in
View File

@ -78,7 +78,6 @@ Name of the output layer within GeoPackage file
QStringList createOptions() const;
%Docstring
.. deprecated:: 3.44
Use :py:func:`~QgsRasterLayerSaveAsDialog.creationOptions` instead.

2
python/analysis/auto_generated/interpolation/qgsgridfilewriter.sip.in
View File

@ -42,7 +42,7 @@ cancellation support
:return: 0 in case of success
%End
void setCreationOptions( const QStringList &list );
void setCreationOptions( const QStringList &options );
%Docstring
Sets a list of data source creation options to use when creating the
output raster file.

2
python/analysis/auto_generated/raster/qgsninecellfilter.sip.in
View File

@ -71,7 +71,7 @@ mOutputFile
double outputNodataValue() const;
void setOutputNodataValue( double value );
void setCreationOptions( const QStringList &list );
void setCreationOptions( const QStringList &options );
%Docstring
Sets a list of data source creation options to use when creating the
output raster file.

2
python/analysis/auto_generated/raster/qgsrastercalculator.sip.in
View File

@ -155,7 +155,7 @@ Returns a description of the last error encountered.
.. versionadded:: 3.4
%End
void setCreationOptions( const QStringList &list );
void setCreationOptions( const QStringList &options );
%Docstring
Sets a list of data source creation options to use when creating the
output raster file.

3
python/core/auto_generated/providers/qgsprovidermetadata.sip.in
View File

@ -465,6 +465,7 @@ create new empty GeoPackage or FileGeodatabase databases.
.. versionadded:: 3.28
%End
virtual QgsRasterDataProvider *createRasterDataProvider(
const QString &uri,
const QString &format,
@ -474,7 +475,7 @@ create new empty GeoPackage or FileGeodatabase databases.
int height,
double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() ) /Factory/;
const QStringList &createOptions = QStringList() ) /Factory/;
%Docstring
Creates a new instance of the raster data provider.

3
python/core/auto_generated/providers/qgsproviderregistry.sip.in
View File

@ -109,6 +109,7 @@ Returns the provider capabilities
%End
QgsRasterDataProvider *createRasterDataProvider(
const QString &providerKey,
const QString &uri,
@ -118,7 +119,7 @@ Returns the provider capabilities
int width, int height,
double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() ) /Factory/;
const QStringList &createOptions = QStringList() ) /Factory/;
%Docstring
Creates new instance of raster data provider

6
python/core/auto_generated/raster/qgsrasterdataprovider.sip.in
View File

@ -452,13 +452,14 @@ editing mode in order to allow write operations.
:return: ``True`` on success
%End
static QgsRasterDataProvider *create( const QString &providerKey,
const QString &uri,
const QString &format, int nBands,
Qgis::DataType type,
int width, int height, double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() );
const QStringList &createOptions = QStringList() );
%Docstring
Creates a new dataset with mDataSourceURI
%End
@ -527,7 +528,8 @@ Encodes the URI starting from the struct .
since QGIS 3.22
%End
virtual QString validateCreationOptions( const QStringList &creationOptions, const QString &format );
virtual QString validateCreationOptions( const QStringList &createOptions, const QString &format );
%Docstring
Validates creation options for a specific dataset and destination
format.

8
python/core/auto_generated/raster/qgsrasterfilewriter.sip.in
View File

@ -258,6 +258,7 @@ Returns the maximum tile height (in pixels) for tiled outputs.
.. seealso:: :py:func:`tiledMode`
%End
void setCreateOptions( const QStringList &list );
%Docstring
Sets a list of data source creation options to use when creating the
@ -292,16 +293,17 @@ creating the output raster file.
.. versionadded:: 3.44
%End
void setCreationOptions( const QStringList &list );
void setCreationOptions( const QStringList &options );
%Docstring
Sets a list of data source creation options to use when
creating the output raster file.
Sets a list of data source creation options to use when creating the
output raster file.
.. seealso:: :py:func:`creationOptions`
.. versionadded:: 3.44
%End
void setPyramidsConfigOptions( const QStringList &list );
%Docstring
Sets a ``list`` of configuration options to use when creating the

2
python/gui/auto_generated/qgsrasterformatsaveoptionswidget.sip.in
View File

@ -127,7 +127,7 @@ Emitted when the options configured in the widget are changed.
void deleteCreationOptions( const QString &profile );
void setCreationOptions();
void setCreationOptions( const QString &profile, const QString &options );
void setCreationOptions( const QString &profile, const QStringList &list );
void setCreationOptions( const QString &profile, const QStringList &options );
QStringList profiles() const;
virtual bool eventFilter( QObject *obj, QEvent *event );

1
python/gui/auto_generated/qgsrasterlayersaveasdialog.sip.in
View File

@ -78,7 +78,6 @@ Name of the output layer within GeoPackage file
QStringList createOptions() const;
%Docstring
.. deprecated:: 3.44
Use :py:func:`~QgsRasterLayerSaveAsDialog.creationOptions` instead.

2
src/analysis/interpolation/qgsgridfilewriter.h
View File

@ -59,7 +59,7 @@ class ANALYSIS_EXPORT QgsGridFileWriter
* \see creationOptions()
* \since QGIS 3.44t
*/
void setCreationOptions( const QStringList &list ) { mCreationOptions = list; }
void setCreationOptions( const QStringList &options ) { mCreationOptions = options; }
/**
* Returns the list of data source creation options which will be used when creating the output raster file.

2
src/analysis/raster/qgsninecellfilter.h
View File

@ -80,7 +80,7 @@ class ANALYSIS_EXPORT QgsNineCellFilter
* \see creationOptions()
* \since QGIS 3.44
*/
void setCreationOptions( const QStringList &list ) { mCreationOptions = list; }
void setCreationOptions( const QStringList &options ) { mCreationOptions = options; }
/**
* Returns the list of data source creation options which will be used when creating the output raster file.

2
src/analysis/raster/qgsrastercalculator.h
View File

@ -166,7 +166,7 @@ class ANALYSIS_EXPORT QgsRasterCalculator
* \see creationOptions()
* \since QGIS 3.44
*/
void setCreationOptions( const QStringList &list ) { mCreationOptions = list; }
void setCreationOptions( const QStringList &options ) { mCreationOptions = options; }
/**
* Returns the list of data source creation options which will be used when creating the output raster file.

4
src/core/providers/qgsprovidermetadata.h
View File

@ -519,6 +519,8 @@ class CORE_EXPORT QgsProviderMetadata : public QObject
*/
virtual bool createDatabase( const QString &uri, QString &errorMessage SIP_OUT );
// TODO QGIS 4.0: rename createOptions to creationOptions for consistency with GDAL
/**
* Creates a new instance of the raster data provider.
* \since QGIS 3.10
@ -532,7 +534,7 @@ class CORE_EXPORT QgsProviderMetadata : public QObject
int height,
double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() ) SIP_FACTORY;
const QStringList &createOptions = QStringList() ) SIP_FACTORY;
/**
* Creates mesh data source from a file name \a fileName and a driver \a driverName, that is the mesh frame stored in file, memory or with other way (depending of the provider)

4
src/core/providers/qgsproviderregistry.h
View File

@ -160,6 +160,8 @@ class CORE_EXPORT QgsProviderRegistry
*/
SIP_SKIP Qgis::VectorExportResult createEmptyLayer( const QString &providerKey, const QString &uri, const QgsFields &fields, Qgis::WkbType wkbType, const QgsCoordinateReferenceSystem &srs, bool overwrite, QMap<int, int> &oldToNewAttrIdxMap, QString &errorMessage, const QMap<QString, QVariant> *options, QString &createdLayerName );
// TODO QGIS 4.0: rename createOptions to creationOptions for consistency with GDAL
/**
* Creates new instance of raster data provider
*
@ -175,7 +177,7 @@ class CORE_EXPORT QgsProviderRegistry
int width, int height,
double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() ) SIP_FACTORY;
const QStringList &createOptions = QStringList() ) SIP_FACTORY;
/**
* Returns list of raster pyramid resampling methods

10
src/core/raster/qgsrasterdataprovider.h
View File

@ -439,6 +439,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast
*/
bool writeBlock( QgsRasterBlock *block, int band, int xOffset = 0, int yOffset = 0 );
// TODO QGIS 4.0: rename createOptions to creationOptions for consistency with GDAL
//! Creates a new dataset with mDataSourceURI
static QgsRasterDataProvider *create( const QString &providerKey,
const QString &uri,
@ -446,7 +448,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast
Qgis::DataType type,
int width, int height, double *geoTransform,
const QgsCoordinateReferenceSystem &crs,
const QStringList &creationOptions = QStringList() );
const QStringList &createOptions = QStringList() );
/**
* Set no data value on created dataset
@ -506,13 +508,15 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast
*/
static QString encodeVirtualRasterProviderUri( const VirtualRasterParameters &parts );
// TODO QGIS 4.0: rename createOptions to creationOptions for consistency with GDAL
/**
* Validates creation options for a specific dataset and destination format.
* \note used by GDAL provider only
* \note see also validateCreationOptionsFormat() in gdal provider for validating options based on format only
*/
virtual QString validateCreationOptions( const QStringList &creationOptions, const QString &format )
{ Q_UNUSED( creationOptions ) Q_UNUSED( format ); return QString(); }
virtual QString validateCreationOptions( const QStringList &createOptions, const QString &format )
{ Q_UNUSED( createOptions ) Q_UNUSED( format ); return QString(); }
/**
* Validates pyramid creation options for a specific dataset and destination format

6
src/core/raster/qgsrasterfilewriter.h
View File

@ -247,6 +247,8 @@ class CORE_EXPORT QgsRasterFileWriter
*/
int maxTileHeight() const { return mMaxTileHeight; }
// TODO QGIS 4.0: rename list to options to have more semantic argument name
/**
* Sets a list of data source creation options to use when
* creating the output raster file.
@ -281,7 +283,9 @@ class CORE_EXPORT QgsRasterFileWriter
* \see creationOptions()
* \since QGIS 3.44
*/
void setCreationOptions( const QStringList &list ) { mCreationOptions = list; }
void setCreationOptions( const QStringList &options ) { mCreationOptions = options; }
// TODO QGIS 4.0: rename list to options to have more semantic argument name
/**
* Sets a \a list of configuration options to use when

4
src/gui/qgsrasterformatsaveoptionswidget.cpp
View File

@ -507,9 +507,9 @@ void QgsRasterFormatSaveOptionsWidget::setCreationOptions( const QString &profil
mySettings.setValue( settingsKey( profileName ), options.trimmed() );
}
void QgsRasterFormatSaveOptionsWidget::setCreationOptions( const QString &profileName, const QStringList &list )
void QgsRasterFormatSaveOptionsWidget::setCreationOptions( const QString &profileName, const QStringList &options )
{
setCreationOptions( profileName, list.join( QLatin1Char( ' ' ) ) );
setCreationOptions( profileName, options.join( QLatin1Char( ' ' ) ) );
}
QStringList QgsRasterFormatSaveOptionsWidget::profiles() const

2
src/gui/qgsrasterformatsaveoptionswidget.h
View File

@ -162,7 +162,7 @@ class GUI_EXPORT QgsRasterFormatSaveOptionsWidget : public QWidget, private Ui::
void deleteCreationOptions( const QString &profile ) SIP_FORCE;
void setCreationOptions() SIP_FORCE;
void setCreationOptions( const QString &profile, const QString &options ) SIP_FORCE;
void setCreationOptions( const QString &profile, const QStringList &list ) SIP_FORCE;
void setCreationOptions( const QString &profile, const QStringList &options ) SIP_FORCE;
QStringList profiles() const SIP_FORCE;
bool eventFilter( QObject *obj, QEvent *event ) override SIP_FORCE;
QString pseudoFormat() const SIP_FORCE;