Skip to content
Permalink
Browse files

Improve docs

  • Loading branch information
nyalldawson committed Nov 4, 2020
1 parent e59bab7 commit 7771417a2d88875502973550f4e84764eb8af82e
Showing with 33 additions and 36 deletions.
  1. +19 −17 python/core/auto_generated/qgsproviderregistry.sip.in
  2. +14 −19 src/core/qgsproviderregistry.h
@@ -283,59 +283,61 @@ Returns metadata of the provider or ``None`` if not found

QString fileVectorFilters() const;
%Docstring
Returns vector file filter string
Returns a file filter string for supported vector files.

Returns a string suitable for a QFileDialog of vector file formats
supported by all data providers.

This walks through all data providers appending calls to their
fileVectorFilters to a string, which is then returned.
.. seealso:: :py:func:`fileRasterFilters`

\note
.. seealso:: :py:func:`fileMeshFilters`

It'd be nice to eventually be raster/vector neutral.
.. seealso:: :py:func:`filePointCloudFilters`
%End

QString fileRasterFilters() const;
%Docstring
Returns raster file filter string
Returns a file filter string for supported raster files.

Returns a string suitable for a QFileDialog of raster file formats
supported by all data providers.

This walks through all data providers appending calls to their
buildSupportedRasterFileFilter to a string, which is then returned.

.. note::

This replaces :py:func:`QgsRasterLayer.buildSupportedRasterFileFilter()`

.. seealso:: :py:func:`fileVectorFilters`

.. seealso:: :py:func:`fileMeshFilters`

.. seealso:: :py:func:`filePointCloudFilters`
%End

QString fileMeshFilters() const;
%Docstring
Returns mesh file filter string
Returns a file filter string for supported mesh files.

Returns a string suitable for a QFileDialog of mesh file formats
supported by all data providers.

This walks through all data providers appending calls to their
fileMeshFilters to a string, which is then returned.

.. seealso:: :py:func:`fileMeshDatasetFilters`

.. seealso:: :py:func:`fileRasterFilters`

.. seealso:: :py:func:`fileVectorFilters`

.. seealso:: :py:func:`filePointCloudFilters`

.. versionadded:: 3.6
%End

QString fileMeshDatasetFilters() const;
%Docstring
Returns mesh's dataset file filter string
Returns a file filter string for supported mesh dataset files.

Returns a string suitable for a QFileDialog of mesh datasets file formats
supported by all data providers.

This walks through all data providers appending calls to their
fileMeshFilters to a string, which is then returned.

.. seealso:: :py:func:`fileMeshFilters`

.. versionadded:: 3.6
@@ -283,57 +283,52 @@ class CORE_EXPORT QgsProviderRegistry
QgsProviderMetadata *providerMetadata( const QString &providerKey ) const;

/**
* Returns vector file filter string
* Returns a file filter string for supported vector files.
*
* Returns a string suitable for a QFileDialog of vector file formats
* supported by all data providers.
*
* This walks through all data providers appending calls to their
* fileVectorFilters to a string, which is then returned.
*
* \note
*
* It'd be nice to eventually be raster/vector neutral.
* \see fileRasterFilters()
* \see fileMeshFilters()
* \see filePointCloudFilters()
*/
QString fileVectorFilters() const;

/**
* Returns raster file filter string
* Returns a file filter string for supported raster files.
*
* Returns a string suitable for a QFileDialog of raster file formats
* supported by all data providers.
*
* This walks through all data providers appending calls to their
* buildSupportedRasterFileFilter to a string, which is then returned.
*
* \note This replaces QgsRasterLayer::buildSupportedRasterFileFilter()
*
* \see fileVectorFilters()
* \see fileMeshFilters()
* \see filePointCloudFilters()
*/
QString fileRasterFilters() const;

/**
* Returns mesh file filter string
* Returns a file filter string for supported mesh files.
*
* Returns a string suitable for a QFileDialog of mesh file formats
* supported by all data providers.
*
* This walks through all data providers appending calls to their
* fileMeshFilters to a string, which is then returned.
*
* \see fileMeshDatasetFilters()
* \see fileRasterFilters()
* \see fileVectorFilters()
* \see filePointCloudFilters()
*
* \since QGIS 3.6
*/
QString fileMeshFilters() const;

/**
* Returns mesh's dataset file filter string
* Returns a file filter string for supported mesh dataset files.
*
* Returns a string suitable for a QFileDialog of mesh datasets file formats
* supported by all data providers.
*
* This walks through all data providers appending calls to their
* fileMeshFilters to a string, which is then returned.
*
* \see fileMeshFilters()
*
* \since QGIS 3.6

0 comments on commit 7771417

Please sign in to comment.
You can’t perform that action at this time.