File: qgslocalizeddatapathregistry.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 (82 lines) | stat: -rw-r--r-- 2,681 bytes parent folder | download | duplicates (12)
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
71
72
73
74
75
76
77
78
79
80
81
82
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgslocalizeddatapathregistry.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/








class QgsLocalizedDataPathRegistry
{
%Docstring(signature="appended")
A registry class to hold localized data paths which can be used for
basemaps, logos, etc.

Paths are meant to be absolute paths and are stored by order of
preference.

If a layer from one of the paths is loaded, it will be saved as
localized in the project file. For instance, if you have `C:/my_maps` in
your localized paths, `C:/my_maps/my_country/ortho.tif` will be save in
your project as `localized:my_country/ortho.tif`.

The resolving of the file paths happens in :py:class:`QgsPathResolver`.

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgslocalizeddatapathregistry.h"
%End
  public:
    QgsLocalizedDataPathRegistry();

    QString globalPath( const QString &localizedPath ) const;
%Docstring
Returns the global path if the file has been found in one of the paths,
an empty string otherwise
%End

    QString localizedPath( const QString &globalPath ) const;
%Docstring
Returns the localized path if the file has been found in one of the
path, an empty string otherwise
%End

    QStringList paths() const;
%Docstring
Returns a list of registered localized paths
%End


    void registerPath( const QString &path, int position = -1 );
%Docstring
Registers a localized path If ``position`` is given, the path is
inserted at the given position in the list Since the paths are stored by
order of preference, lower positions in the list take precedence.
%End

    void unregisterPath( const QString &path );
%Docstring
Unregisters a localized path
%End


  private:
    QgsLocalizedDataPathRegistry( const QgsLocalizedDataPathRegistry &other );
};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgslocalizeddatapathregistry.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/