/usr/include/qgis/qgstransaction.h is in libqgis-dev 2.14.11+dfsg-3+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | /***************************************************************************
qgstransaction.h
----------------
begin : May 5, 2014
copyright : (C) 2014 by Marco Hugentobler
email : marco dot hugentobler at sourcepole dot 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. *
* *
***************************************************************************/
#ifndef QGSTRANSACTION_H
#define QGSTRANSACTION_H
#include <QSet>
#include <QString>
#include <QObject>
class QgsVectorDataProvider;
class QgsVectorLayer;
/**
* This class allows including a set of layers in a database-side transaction,
* provided the layer data providers support transactions and are compatible
* with each other.
*
* Only layers which are not in edit mode can be included in a transaction,
* and all layers need to be in read-only mode for a transaction to be committed
* or rolled back.
*
* Layers cannot only be included in one transaction at a time.
*
* When editing layers which are part of a transaction group, all changes are
* sent directly to the data provider (bypassing the undo/redo stack), and the
* changes can either be committed or rolled back on the database side via the
* QgsTransaction::commit and QgsTransaction::rollback methods.
*
* As long as the transaction is active, the state of all layer features reflects
* the current state in the transaction.
*
* Edits on features can get rejected if another conflicting transaction is active.
*/
class CORE_EXPORT QgsTransaction : public QObject
{
Q_OBJECT
public:
/** Creates a transaction for the specified connection string and provider */
static QgsTransaction* create( const QString& connString, const QString& providerKey );
/** Creates a transaction which includes the specified layers. Connection string
* and data provider are taken from the first layer */
static QgsTransaction* create( const QStringList& layerIds );
virtual ~QgsTransaction();
/** Add layer to the transaction. The layer must not be in edit mode.*/
bool addLayer( const QString& layerId );
/** Add layer to the transaction. The layer must not be in edit mode.*/
bool addLayer( QgsVectorLayer* layer );
/** Begin transaction
* The statement timeout, in seconds, specifies how long an sql statement
* is allowed to block QGIS before it is aborted. Statements can block,
* depending on the provider, if multiple transactions are active and a
* statement would produce a conflicting state. In these cases, the
* statements block until the conflicting transaction is committed or
* rolled back.
* Some providers might not honour the statement timeout. */
bool begin( QString& errorMsg, int statementTimeout = 20 );
/** Commit transaction. */
bool commit( QString& errorMsg );
/** Roll back transaction. */
bool rollback( QString& errorMsg );
/** Executes sql */
virtual bool executeSql( const QString& sql, QString& error ) = 0;
/**
* Checks if a the provider of a give layer supports transactions.
*/
static bool supportsTransaction( const QgsVectorLayer* layer );
signals:
/**
* Emitted after a rollback
*/
void afterRollback();
private slots:
void onLayersDeleted( const QStringList& layerids );
protected:
QgsTransaction( const QString& connString );
QString mConnString;
private:
QgsTransaction( const QgsTransaction& other );
const QgsTransaction& operator=( const QgsTransaction& other );
bool mTransactionActive;
QSet<QgsVectorLayer*> mLayers;
void setLayerTransactionIds( QgsTransaction *transaction );
virtual bool beginTransaction( QString& error, int statementTimeout ) = 0;
virtual bool commitTransaction( QString& error ) = 0;
virtual bool rollbackTransaction( QString& error ) = 0;
};
#endif // QGSTRANSACTION_H
|