QGIS/python/core/auto_generated/providers/qgsproviderutils.sip.in

70 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/providers/qgsproviderutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProviderUtils
{
%Docstring(signature="appended")
Contains utility functions for working with data providers.
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsproviderutils.h"
%End
public:
enum class SublayerCompletenessFlag
{
IgnoreUnknownFeatureCount,
IgnoreUnknownGeometryType,
};
typedef QFlags<QgsProviderUtils::SublayerCompletenessFlag> SublayerCompletenessFlags;
static bool sublayerDetailsAreIncomplete( const QList< QgsProviderSublayerDetails > &details, QgsProviderUtils::SublayerCompletenessFlags flags = QgsProviderUtils::SublayerCompletenessFlags() );
%Docstring
Returns ``True`` if the sublayer ``details`` are incomplete, and require a more in-depth
scan.
For instance, if the details contain any vector sublayers with unknown geometry types
then a query with the :py:class:`Qgis`.SublayerQueryFlag.ResolveGeometryType flag is required.
The ``flags`` argument can be used to control the level of completeness required during the test.
%End
static QString suggestLayerNameFromFilePath( const QString &path );
%Docstring
Suggests a suitable layer name given only a file ``path``.
Usually this corresponds to the base file name of ``path`` (e.g.
"rivers" for a path of "c:/my data/water/rivers.shp"). However
some data formats which use fixed file paths (such as aigrid files)
will instead return the parent directory name (e.g. "rivers" for
a path of "c:/my data/water/rivers/hdr.adf").
%End
};
QFlags<QgsProviderUtils::SublayerCompletenessFlag> operator|(QgsProviderUtils::SublayerCompletenessFlag f1, QFlags<QgsProviderUtils::SublayerCompletenessFlag> f2);
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/providers/qgsproviderutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/