QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
QgsMapLayerDependency Class Reference

This class models dependencies with or between map layers. More...

#include <qgsmaplayerdependency.h>

Public Types

enum  Origin { FromProvider = 0 , FromUser = 1 }
 Origin of the dependency. More...
 
enum  Type { PresenceDependency = 1 , DataDependency = 2 }
 Type of dependency. More...
 

Public Member Functions

 QgsMapLayerDependency (const QString &layerId, Type type=DataDependency, Origin origin=FromUser)
 Standard constructor.
 
QString layerId () const
 Returns the ID of the layer this dependency depends on.
 
bool operator== (const QgsMapLayerDependency &other) const
 Comparison operator.
 
Origin origin () const
 Returns the dependency origin.
 
Type type () const
 Returns the dependency type.
 

Detailed Description

This class models dependencies with or between map layers.

A dependency is defined by a layer ID, a type and an origin. The two combinations of type/origin that are currently supported are:

Definition at line 36 of file qgsmaplayerdependency.h.

Member Enumeration Documentation

◆ Origin

Origin of the dependency.

Enumerator
FromProvider 
FromUser 

Definition at line 47 of file qgsmaplayerdependency.h.

◆ Type

Type of dependency.

Enumerator
PresenceDependency 
DataDependency 

Definition at line 40 of file qgsmaplayerdependency.h.

Constructor & Destructor Documentation

◆ QgsMapLayerDependency()

QgsMapLayerDependency::QgsMapLayerDependency ( const QString &  layerId,
Type  type = DataDependency,
Origin  origin = FromUser 
)
inline

Standard constructor.

Definition at line 54 of file qgsmaplayerdependency.h.

Member Function Documentation

◆ layerId()

QString QgsMapLayerDependency::layerId ( ) const
inline

Returns the ID of the layer this dependency depends on.

Definition at line 67 of file qgsmaplayerdependency.h.

◆ operator==()

bool QgsMapLayerDependency::operator== ( const QgsMapLayerDependency other) const
inline

Comparison operator.

Definition at line 72 of file qgsmaplayerdependency.h.

◆ origin()

Origin QgsMapLayerDependency::origin ( ) const
inline

Returns the dependency origin.

Definition at line 64 of file qgsmaplayerdependency.h.

◆ type()

Type QgsMapLayerDependency::type ( ) const
inline

Returns the dependency type.

Definition at line 61 of file qgsmaplayerdependency.h.


The documentation for this class was generated from the following file: