File: qgsproviderutils.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (70 lines) | stat: -rw-r--r-- 2,702 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/providers/qgsproviderutils.h                                *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py 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 /BaseType=IntFlag/
    {
      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.py again   *
 ************************************************************************/