QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
QgsTransactionGroup Class Reference

Represents a transaction group. More...

#include <qgstransactiongroup.h>

Inheritance diagram for QgsTransactionGroup:

Signals

void commitError (const QString &msg)
 Will be emitted whenever there is a commit error.

Public Member Functions

 QgsTransactionGroup (QObject *parent=nullptr)
 Constructor for QgsTransactionGroup.
bool addLayer (QgsVectorLayer *layer)
 Add a layer to this transaction group.
QString connString () const
 Returns the connection string used by this transaction group.
bool isEmpty () const
 Returns true if there are no layers in this transaction group.
QSet< QgsVectorLayer * > layers () const
 Gets the set of layers currently managed by this transaction group.
bool modified () const
 Returns true if any of the layers in this group reports a modification.
QString providerKey () const
 Returns the provider key used by this transaction group.

Detailed Description

Represents a transaction group.

Definition at line 34 of file qgstransactiongroup.h.

Constructor & Destructor Documentation

◆ QgsTransactionGroup()

QgsTransactionGroup::QgsTransactionGroup ( QObject * parent = nullptr)
explicit

Constructor for QgsTransactionGroup.

Definition at line 28 of file qgstransactiongroup.cpp.

Member Function Documentation

◆ addLayer()

bool QgsTransactionGroup::addLayer ( QgsVectorLayer * layer)

Add a layer to this transaction group.

Will return true if it is compatible and has been added.

Definition at line 34 of file qgstransactiongroup.cpp.

◆ commitError

void QgsTransactionGroup::commitError ( const QString & msg)
signal

Will be emitted whenever there is a commit error.

◆ connString()

QString QgsTransactionGroup::connString ( ) const

Returns the connection string used by this transaction group.

Layers need be compatible when added.

Definition at line 207 of file qgstransactiongroup.cpp.

◆ isEmpty()

bool QgsTransactionGroup::isEmpty ( ) const

Returns true if there are no layers in this transaction group.

Definition at line 202 of file qgstransactiongroup.cpp.

◆ layers()

QSet< QgsVectorLayer * > QgsTransactionGroup::layers ( ) const

Gets the set of layers currently managed by this transaction group.

Returns
Layer set

Definition at line 58 of file qgstransactiongroup.cpp.

◆ modified()

bool QgsTransactionGroup::modified ( ) const

Returns true if any of the layers in this group reports a modification.

Definition at line 63 of file qgstransactiongroup.cpp.

◆ providerKey()

QString QgsTransactionGroup::providerKey ( ) const

Returns the provider key used by this transaction group.

Layers need be compatible when added.

Definition at line 197 of file qgstransactiongroup.cpp.


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