QGIS/python/core/auto_generated/qgslocalizeddatapathregistry.sip.in
2023-02-03 09:05:37 +01:00

77 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgslocalizeddatapathregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl 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.pl again *
************************************************************************/