QGIS/python/core/auto_generated/qgsmaplayerdependency.sip.in

78 lines
2.2 KiB
Plaintext
Raw Normal View History

2017-05-14 09:48:41 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmaplayerdependency.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsMapLayerDependency
{
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
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:
- PresenceDependency && FromProvider: virtual layers for instance which may depend on other layers already loaded to work
- DataDependency && FromUser: dependencies given by the user, mainly to represent database triggers
2017-05-14 09:48:41 +02:00
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsmaplayerdependency.h"
%End
2017-05-14 09:48:41 +02:00
public:
enum Type
{
PresenceDependency,
DataDependency
};
2017-05-14 09:48:41 +02:00
enum Origin
{
FromProvider,
FromUser
};
2017-05-14 09:48:41 +02:00
QgsMapLayerDependency( const QString &layerId, Type type = DataDependency, Origin origin = FromUser );
%Docstring
Standard constructor
%End
2017-05-14 09:48:41 +02:00
Type type() const;
%Docstring
Returns the dependency type
2017-05-14 09:48:41 +02:00
%End
2017-05-14 09:48:41 +02:00
Origin origin() const;
%Docstring
Returns the dependency origin
2017-05-14 09:48:41 +02:00
%End
2017-05-14 09:48:41 +02:00
QString layerId() const;
%Docstring
Returns the ID of the layer this dependency depends on
2017-05-14 09:48:41 +02:00
%End
2017-05-14 09:48:41 +02:00
bool operator==( const QgsMapLayerDependency &other ) const;
2016-09-02 15:50:31 +02:00
2017-05-14 09:48:41 +02:00
//! hash operator
long __hash__() const;
2016-09-02 15:50:31 +02:00
%MethodCode
2017-05-14 09:48:41 +02:00
sipRes = qHash( *sipCpp );
2016-09-02 15:50:31 +02:00
%End
};
2017-05-14 09:48:41 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmaplayerdependency.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/