QGIS API Documentation  3.23.0-Master (eb871beae0)
qgsmaplayerfactory.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmaplayerfactory.h
3  --------------------------------------
4  Date : March 2021
5  Copyright : (C) 2021 by Nyall Dawson
6  Email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSMAPLAYERFACTORY_H
19 #define QGSMAPLAYERFACTORY_H
20 
21 #include "qgis_core.h"
22 #include "qgis.h"
24 
25 #include <QString>
26 
33 class CORE_EXPORT QgsMapLayerFactory
34 {
35  public:
36 
47  static QgsMapLayerType typeFromString( const QString &string, bool &ok SIP_OUT );
48 
54  static QString typeToString( QgsMapLayerType type );
55 
61  struct LayerOptions
62  {
63 
67  explicit LayerOptions( const QgsCoordinateTransformContext &transformContext )
68  : transformContext( transformContext )
69  {}
70 
73 
75  bool loadDefaultStyle = true;
76  };
77 
85  static QgsMapLayer *createLayer( const QString &uri, const QString &name, QgsMapLayerType type, const LayerOptions &options,
86  const QString &provider = QString() ) SIP_FACTORY;
87 
88 };
89 
90 #endif // QGSMAPLAYERFACTORY_H
Contains information about the context in which a coordinate transform is executed.
Contains utility functions for creating map layers.
Base class for all map layer types.
Definition: qgsmaplayer.h:73
QgsMapLayerType
Types of layers that can be added to a map.
Definition: qgis.h:47
#define SIP_OUT
Definition: qgis_sip.h:58
#define SIP_FACTORY
Definition: qgis_sip.h:76
Setting options for loading layers.
LayerOptions(const QgsCoordinateTransformContext &transformContext)
Constructor for LayerOptions with transformContext.
QgsCoordinateTransformContext transformContext
Transform context.