|
QGIS API Documentation 4.3.0-Master (91d4a333d5d)
|
Contains utility functions for working with map layers. More...
#include <qgsmaplayerutils.h>
Static Public Member Functions | |
| static QgsRectangle | combinedExtent (const QList< QgsMapLayer * > &layers, const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &transformContext) |
| Returns the combined extent of a list of layers. | |
| static QgsAbstractDatabaseProviderConnection * | databaseConnection (const QgsMapLayer *layer) |
Creates and returns the (possibly nullptr) database connection for a layer. | |
| static bool | isOpenStreetMapLayer (QgsMapLayer *layer) |
Returns true if the layer is served by OpenStreetMap server. | |
| static bool | isOpenStreetMapUri (const QString &uri, const QString &providerType) |
Returns true if the uri for a given provider is served by OpenStreetMap server. | |
| static QString | launderLayerName (const QString &name) |
| Launders a layer's name, converting it into a format which is general suitable for file names or database layer names. | |
| static bool | layerRefersToUri (const QgsMapLayer *layer, const QString &uri, Qgis::SourceHierarchyLevel level=Qgis::SourceHierarchyLevel::Object) |
Returns true if a layer and uri point to the same resource at the specified hierarchy level. | |
| static bool | layerSourceMatchesPath (const QgsMapLayer *layer, const QString &path) |
Returns true if the source of the specified layer matches the given path. | |
| static QString | layerToolTip (const QgsMapLayer *layer) |
| Returns the consistent tooltip for the given layer. | |
| static QString | layerTypeToString (Qgis::LayerType type) |
| Returns the translated name of the type for a given layer type. | |
| static QgsSaveStyleResult | saveLayerStyleToDatabase (QgsMapLayer *layer, const QString &providerKey, const QString &targetDataSource, const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, const Qgis::SaveStyleFormats formats=Qgis::SaveStyleFormats(Qgis::SaveStyleFormat::QML|Qgis::SaveStyleFormat::SLD), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
| Saves QML and SLD representations of layer's style to a table in the database identified by providerKey and associates it with targetDataSource which can be different from the layer's own data source. | |
| static QList< QgsMapLayer * > | sortLayersByType (const QList< QgsMapLayer * > &layers, const QList< Qgis::LayerType > &order) |
| Sorts a list of map layers by their layer type, respecting the order of types specified. | |
| static bool | updateLayerSourcePath (QgsMapLayer *layer, const QString &newPath) |
| Updates a layer's data source, replacing its data source with a path referring to newPath. | |
Contains utility functions for working with map layers.
Definition at line 38 of file qgsmaplayerutils.h.
|
static |
Returns the combined extent of a list of layers.
The crs argument specifies the desired coordinate reference system for the combined extent.
Definition at line 40 of file qgsmaplayerutils.cpp.
|
static |
Creates and returns the (possibly nullptr) database connection for a layer.
Ownership is transferred to the caller.
Definition at line 101 of file qgsmaplayerutils.cpp.
|
static |
Returns true if the layer is served by OpenStreetMap server.
Definition at line 200 of file qgsmaplayerutils.cpp.
|
static |
Returns true if the uri for a given provider is served by OpenStreetMap server.
Definition at line 210 of file qgsmaplayerutils.cpp.
|
static |
Launders a layer's name, converting it into a format which is general suitable for file names or database layer names.
Specifically this method:
Definition at line 188 of file qgsmaplayerutils.cpp.
|
static |
Returns true if a layer and uri point to the same resource at the specified hierarchy level.
This method parses the underlying connection parameters of the layer and uri to check if they share the same scope defined by level.
| QgsNotSupportedException | if the layer's provider does not implement the QgsProviderMetadata::ProviderMetadataCapability::UrisReferToSame capability. |
Definition at line 138 of file qgsmaplayerutils.cpp.
|
static |
Returns true if the source of the specified layer matches the given path.
This method can be used to test whether a layer is associated with a file path.
Definition at line 129 of file qgsmaplayerutils.cpp.
|
static |
Returns the consistent tooltip for the given layer.
Definition at line 259 of file qgsmaplayerutils.cpp.
|
static |
Returns the translated name of the type for a given layer type.
Definition at line 232 of file qgsmaplayerutils.cpp.
|
static |
Saves QML and SLD representations of layer's style to a table in the database identified by providerKey and associates it with targetDataSource which can be different from the layer's own data source.
Unlike QgsMapLayer::saveStyleToDatabaseV2(), this method allows saving the style from one layer to a different layer in a database. The target layer is identified by the targetDataSource argument, which is a URI that specifies the layer in the database to which the style should be associated.
| layer | Source layer whose style will be exported. |
| providerKey | Provider key for the target database. |
| targetDataSource | URI of the target layer in the database. |
| name | Style name. |
| description | A description of the style. |
| useAsDefault | Set to true if style should be used as the default style for the layer. |
| uiFileContent | Optional UI file content associated with the style. |
| formats | Flag specifying which style formats to save. |
| categories | The style categories to be saved. |
Definition at line 296 of file qgsmaplayerutils.cpp.
|
static |
Sorts a list of map layers by their layer type, respecting the order of types specified.
Layer types which appear earlier in the order list will result in matching layers appearing earlier in the result list.
Definition at line 172 of file qgsmaplayerutils.cpp.
|
static |
Updates a layer's data source, replacing its data source with a path referring to newPath.
Returns true if the layer was updated, or false if the layer was not updated (e.g. it uses a data provider which does not specify paths in a layer URI.
Definition at line 157 of file qgsmaplayerutils.cpp.