QGIS/python/core/qgstransactiongroup.sip

69 lines
2.1 KiB
Plaintext
Raw Normal View History

2016-01-15 09:31:19 +01:00
/***************************************************************************
qgstransactiongroup.h - QgsTransactionGroup
---------------------
begin : 15.1.2016
copyright : (C) 2016 by Matthias Kuhn
email : mmatthias@opengis.ch
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
class QgsTransactionGroup : QObject
{
%TypeHeaderCode
#include "qgstransactiongroup.h"
%End
public:
explicit QgsTransactionGroup( QObject *parent = 0 );
~QgsTransactionGroup();
/**
* Add a layer to this transaction group.
*
* Will return true if it is compatible and has been added.
*/
bool addLayer( QgsVectorLayer* layer );
2016-01-18 13:11:02 +01:00
/**
* Get the set of layers currently managed by this transaction group.
*
* @return Layer set
*/
QSet<QgsVectorLayer*> layers() const;
/**
* Returns true if any of the layers in this group reports a modification.
*/
bool modified() const;
2016-01-15 09:31:19 +01:00
/**
* Return the connection string used by this transaction group.
* Layers need be compatible when added.
*/
QString connString() const;
/**
* Return the provider key used by this transaction group.
* Layers need be compatible when added.
*/
QString providerKey() const;
/**
* Returns true if there are no layers in this transaction group.
*/
bool isEmpty() const;
signals:
/**
* Will be emitted whenever there is a commit error
*/
void commitError( const QString& msg );
};