QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Setting options for loading vector layers. More...
#include <qgsvectorlayer.h>
Public Member Functions | |
LayerOptions (bool loadDefaultStyle=true, bool readExtentFromXml=false) | |
Constructor for LayerOptions. | |
LayerOptions (const QgsCoordinateTransformContext &transformContext, bool loadDefaultStyle=true, bool readExtentFromXml=false) | |
Constructor for LayerOptions. | |
Public Attributes | |
QgsCoordinateReferenceSystem | fallbackCrs |
Fallback layer coordinate reference system. | |
Qgis::WkbType | fallbackWkbType = Qgis::WkbType::Unknown |
Fallback geometry type. | |
bool | forceReadOnly = false |
Controls whether the layer is forced to be load as Read Only. | |
bool | loadAllStoredStyles = false |
Controls whether the stored styles will be all loaded. | |
bool | loadDefaultStyle = true |
Set to true if the default layer style should be loaded. | |
bool | readExtentFromXml = false |
If true , the layer extent will be read from XML (i.e. | |
bool | skipCrsValidation = false |
Controls whether the layer is allowed to have an invalid/unknown CRS. | |
QgsCoordinateTransformContext | transformContext = QgsCoordinateTransformContext() |
Coordinate transform context. | |
Setting options for loading vector layers.
Definition at line 423 of file qgsvectorlayer.h.
|
inlineexplicit |
Constructor for LayerOptions.
Definition at line 429 of file qgsvectorlayer.h.
|
inlineexplicit |
QgsCoordinateReferenceSystem QgsVectorLayer::LayerOptions::fallbackCrs |
Fallback layer coordinate reference system.
This may be set for layers where the coordinate reference system is known in advance, and where the layer path may not be initially resolvable. (E.g. layers with a URI pointing to a non-existent file). It is only ever used if the layer cannot be resolved, otherwise the actual layer CRS will be detected and used for the layer.
Definition at line 487 of file qgsvectorlayer.h.
Qgis::WkbType QgsVectorLayer::LayerOptions::fallbackWkbType = Qgis::WkbType::Unknown |
Fallback geometry type.
This may be set for layers where the geometry type is known in advance, and where the layer path may not be initially resolvable. (E.g. layers with a URI pointing to a non-existent file). It is only ever used if the layer cannot be resolved, otherwise the actual layer geometry type will be detected and used for the layer.
Definition at line 474 of file qgsvectorlayer.h.
bool QgsVectorLayer::LayerOptions::forceReadOnly = false |
Controls whether the layer is forced to be load as Read Only.
If true
, then the layer's provider will only check read capabilities. Write capabilities will be skipped.
If false
(the default), the layer's provider will check the edition capabilities based on user rights or file rights or others.
Definition at line 515 of file qgsvectorlayer.h.
bool QgsVectorLayer::LayerOptions::loadAllStoredStyles = false |
Controls whether the stored styles will be all loaded.
If true
and the layer's provider supports style stored in the data source all the available styles will be loaded in addition to the default one.
If false
(the default), the layer's provider will only load the default style.
Definition at line 529 of file qgsvectorlayer.h.
bool QgsVectorLayer::LayerOptions::loadDefaultStyle = true |
Set to true
if the default layer style should be loaded.
Definition at line 449 of file qgsvectorlayer.h.
bool QgsVectorLayer::LayerOptions::readExtentFromXml = false |
If true
, the layer extent will be read from XML (i.e.
stored in the project file). If false
, the extent will be determined by the provider on layer load.
Definition at line 455 of file qgsvectorlayer.h.
bool QgsVectorLayer::LayerOptions::skipCrsValidation = false |
Controls whether the layer is allowed to have an invalid/unknown CRS.
If true
, then no validation will be performed on the layer's CRS and the layer layer's crs() may be invalid() (i.e. the layer will have no georeferencing available and will be treated as having purely numerical coordinates).
If false
(the default), the layer's CRS will be validated using QgsCoordinateReferenceSystem::validate(), which may cause a blocking, user-facing dialog asking users to manually select the correct CRS for the layer.
Definition at line 502 of file qgsvectorlayer.h.
QgsCoordinateTransformContext QgsVectorLayer::LayerOptions::transformContext = QgsCoordinateTransformContext() |