# need to set EXTENSION_MAPPING for the extension otherwise the files are not

# properly processed by doxygen.

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern

# basis. Doxygen will compare the file name with each pattern and apply the

%Docstring

Removes a vector layer join

%End

QgsVectorLayerJoinBuffer *joinBuffer();

:param layers: set of :py:class:`QgsMapLayerDependency`. Only user-defined dependencies will be added

.. versionadded:: 3.0

%End

%Docstring

Returns whether the layer contains labels which are enabled and should be drawn.

.. seealso:: :py:func:`setLabelsEnabled`

.. note::

object is returned by labeling().

.. seealso:: :py:func:`labelsEnabled`

%Docstring

Returns whether the layer contains diagrams which are enabled and should be drawn.

.. versionadded:: 2.9

%End

:param styleId: the provider's layer_styles table id of the style to delete

- msgError: reference to string that will be updated with any error messages

.. versionadded:: 3.0

Load a named style from file/local db/datasource db

:param theURI: the URI of the style or the URI of the layer

:param categories: the style categories to be loaded.

%End

virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag /Out/,

QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) ${SIP_FINAL};

%Docstring

Retained for backward compatibility

%End

bool loadAuxiliaryLayer( const QgsAuxiliaryStorage &storage, const QString &key = QString() );

%Docstring

Loads the auxiliary layer for this vector layer. If there's no

returned. The key is optional because if this layer has been read from

a XML document, then the key read in this document is used by default.

:param storage: The auxiliary storage where to look for the table

:param key: The key to use for joining.

.. versionadded:: 3.0

:param context: reading context (used for transform from relative to absolute paths)

:param categories: the style categories to be read

%End

virtual bool readStyle( const QDomNode &node, QString &errorMessage,

:param context: reading context (used for transform from relative to absolute paths)

:param categories: the style categories to be read

%End

virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage,

:param context: writing context (used for transform from absolute to relative paths)

:param categories: the style categories to be written

%End

virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,

:param context: writing context (used for transform from absolute to relative paths)

:param categories: the style categories to be written

%End

bool writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsStringMap &props = QgsStringMap() ) const;

:param errorMessage: reference to string that will be updated with any error messages

:param props: a open ended set of properties that can drive/inform the SLD encoding

%End

virtual bool readSld( const QDomNode &node, QString &errorMessage ) ${SIP_FINAL};

:param dataSource: new layer data source

:param baseName: base name of the layer

:param provider: provider string

data source

.. versionadded:: 2.10

:param baseName: base name of the layer

:param provider: provider string

:param options: provider options

data source

.. seealso:: :py:func:`dataSourceChanged`

or other definition string specific to the underlying dataprovider

and data store.

%End

virtual QString subsetString() const;

with matching QgsFeature.id() with the attributes and geometry from ``feature``.

Changes are not immediately committed to the layer.

be updated. This can be used to override default field value expressions.

.. note::

%Docstring

Deletes the selected features

%End

QgsGeometry::OperationResult addRing( const QVector<QgsPointXY> &ring, QgsFeatureId *featureId = 0 );

Splits parts cut by the given line

:param splitLine: line that splits the layer features

:return: QgsGeometry.OperationResult

- Success

Splits features cut by the given line

:param splitLine: line that splits the layer features

:return: QgsGeometry.OperationResult

- Success

.. note::

.. seealso:: :py:func:`labelsEnabled`

virtual bool isEditable() const ${SIP_FINAL};

%Docstring

%End

virtual bool isSpatial() const ${SIP_FINAL};

%Docstring

%End

virtual bool isModified() const;

%Docstring

%End

bool isAuxiliaryField( int index, int &srcIndex ) const;

%Docstring

.. versionadded:: 3.0

%End

%Docstring

Make layer read-only (editing disabled) or not

%End

bool changeGeometry( QgsFeatureId fid, QgsGeometry &geometry, bool skipDefaultValue = false );

(but does not immediately commit the changes). The ``fid`` argument

specifies the ID of the feature to be changed.

be updated. This can be used to override default field value expressions.

.. note::

retrieved and used. Note that this involves a feature request to the underlying data provider,

so it is more efficient to explicitly pass an ``oldValue`` if it is already available.

be updated. This can be used to override default field value expressions.

.. note::

request to the underlying data provider, so it is more efficient to

explicitly pass an oldValue if it is already available.

be updated. This can be used to override default field value

expressions.

.. note::

bool addAttribute( const QgsField &field );

%Docstring

Add an attribute field (but does not commit it)

.. note::

:param attrs: the indices of the attributes to delete

%End

virtual bool addFeatures( QgsFeatureList &features, QgsFeatureSink::Flags flags = 0 ) ${SIP_FINAL};

:param fids: The feature ids to delete

in case of an active transaction depends on the provider implementation

.. note::

Attempts to commit to the underlying data provider any buffered changes made since the

last to call to startEditing().

in-memory changes are left untouched and are not discarded. This allows editing to

continue if the commit failed on e.g. a disallowed value in a Postgres

database - the user can re-edit and try again.

%Docstring

Stops a current editing operation and discards any uncommitted edits.

behavior).

.. seealso:: :py:func:`startEditing`

:param fieldOrExpression: source field or expression to use as basis for aggregated values.

:param parameters: parameters controlling aggregate calculation

:param context: expression context for expressions and filters

:return: calculated aggregate value

bool readExtentFromXml() const;

%Docstring

it.

.. versionadded:: 3.0

Update the extents for the layer. This is necessary if features are

added/deleted or the layer has been subsetted.

%End

bool startEditing();

be made persistent until commitChanges() is called, and can be reverted by calling

rollBack().

failed (e.g. due to an underlying read-only data source, or lack of edit support

by the backend data provider).

:param selected: Newly selected feature ids

:param deselected: Ids of all features which have previously been selected but are not any more

%End

void layerModified();

$IS_OVERRIDE,

$ACTUAL_CLASS,

$#CLASSNAME)." :: ".$new_line."\n";

}

sub write_output {

return $line;

}

sub detect_comment_block{

, readExtentFromXml( readExtentFromXml )

{}

bool loadDefaultStyle = true;

/**

bool readExtentFromXml = false;

/**

bool removeJoin( const QString &joinLayerId );

bool setDependencies( const QSet<QgsMapLayerDependency> &layers ) FINAL;

/**

/**

/**

bool diagramsEnabled() const;

virtual bool deleteStyleFromDatabase( const QString &styleId, QString &msgError SIP_OUT );

/**

virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag SIP_OUT, bool loadFromLocalDb,

QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories );

/**

QString loadNamedStyle( const QString &theURI, bool &resultFlag SIP_OUT,

QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) FINAL;

/**

bool readSymbology( const QDomNode &layerNode, QString &errorMessage,

QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) FINAL;

bool readStyle( const QDomNode &node, QString &errorMessage,

QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) FINAL;

bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage,

const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) const FINAL;

bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,

const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) const FINAL;

bool writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsStringMap &props = QgsStringMap() ) const;

virtual bool setSubsetString( const QString &subset );

/**

bool deleteSelectedFeatures( int *deletedCount = nullptr );

/**

/**

/**

const QgsAbstractVectorLayerLabeling *labeling() const SIP_SKIP { return mLabeling; }

/**

void setLabeling( QgsAbstractVectorLayerLabeling *labeling SIP_TRANSFER );

bool isEditable() const FINAL;

bool isSpatial() const FINAL;

virtual bool isModified() const;

/**

/**

bool setReadOnly( bool readonly = true );

/**

bool deleteAttributes( const QList<int> &attrs );

/**

void setReadExtentFromXml( bool readExtentFromXml );

/**