Doxymentation for QgsTransaction

qgis · May 5, 2017 · 931bf32 · 931bf32 · m-kuhn · May 5, 2017
1 parent fd25288
commit 931bf32
Show file tree

Hide file tree

Showing 3 changed files with 113 additions and 49 deletions.
diff --git a/python/core/qgstransaction.sip b/python/core/qgstransaction.sip
@@ -1,72 +1,131 @@
-/**
- * This class allows to include 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.
- */
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/qgstransaction.h                                            *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
 class QgsTransaction : QObject /Abstract/
 {
+%Docstring
+ 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.
+%End
+
 %TypeHeaderCode
-#include <qgstransaction.h>
+#include "qgstransaction.h"
 %End
   public:
-    /** Creates a transaction for the specified connection string and provider */
+
     static QgsTransaction *create( const QString &connString, const QString &providerKey ) /Factory/;
+%Docstring
+ Create a transaction for the specified connection string ``connString``
+ and provider with ``providerKey``.
+ :rtype: QgsTransaction
+%End
 
-    /** 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 ) /Factory/;
+%Docstring
+ Create a transaction which includes the layers specified with
+ ``layerIds``.
+ All layers are expected to have the same connection string and data
+ provider.
+ :rtype: QgsTransaction
+%End
 
     virtual ~QgsTransaction();
 
-    /** Add layer to the transaction. The layer must not be in edit mode.*/
     bool addLayer( const QString &layerId );
+%Docstring
+ Add the layer with ``layerId`` to the transaction. The layer must not be
+ in edit mode and the connection string must match.
+ :rtype: bool
+%End
 
-    /** Add layer to the transaction. The layer must not be in edit mode.*/
     bool addLayer( QgsVectorLayer *layer );
+%Docstring
+ Add the ``layer`` to the transaction. The layer must not be
+ in edit mode and the connection string must match.
+ :rtype: bool
+%End
 
-    /** 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 /Out/, int statementTimeout = 20 );
+%Docstring
+ Begin transaction
+ The ``statementTimeout`` (in seconds) specifies how long an sql statement
+ is allowed to block QGIS before it is aborted.
+ Statements can block, 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.
+ :rtype: bool
+%End
 
-    /** Commit transaction. All layers need to be in read-only mode. */
     bool commit( QString &errorMsg /Out/ );
+%Docstring
+ Commit transaction.
+ :rtype: bool
+%End
 
-    /** Roll back transaction. All layers need to be in read-only mode. */
     bool rollback( QString &errorMsg /Out/ );
+%Docstring
+ Roll back transaction.
+ :rtype: bool
+%End
 
-    /** Executes sql */
     virtual bool executeSql( const QString &sql, QString &error /Out/ ) = 0;
+%Docstring
+ Execute the ``sql`` string. The result must not be a tuple, so running a
+ ``SELECT`` query will return an error.
+ :rtype: bool
+%End
 
-    /**
-     * Checks if a the provider of a give layer supports transactions.
-     */
     static bool supportsTransaction( const QgsVectorLayer *layer );
+%Docstring
+ Checks if a the provider of a given ``layer`` supports transactions.
+ :rtype: bool
+%End
 
   signals:
-    /**
-     * Emitted after a rollback
-     */
+
     void afterRollback();
+%Docstring
+ Emitted after a rollback
+%End
+
+  protected:
+
+
 };
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/qgstransaction.h                                            *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,4 @@
+psycopg2
+numpy
+pyyaml
+future
diff --git a/src/core/qgstransaction.h b/src/core/qgstransaction.h
@@ -24,6 +24,7 @@
 #include <QObject>
 
 #include "qgis_core.h"
+#include "qgis_sip.h"
 
 class QgsVectorDataProvider;
 class QgsVectorLayer;
@@ -49,7 +50,7 @@ class QgsVectorLayer;
  *
  * Edits on features can get rejected if another conflicting transaction is active.
  */
-class CORE_EXPORT QgsTransaction : public QObject
+class CORE_EXPORT QgsTransaction : public QObject SIP_ABSTRACT
 {
     Q_OBJECT
 
@@ -123,14 +124,14 @@ class CORE_EXPORT QgsTransaction : public QObject
      */
     void afterRollback();
 
-  private slots:
-    void onLayersDeleted( const QStringList &layerids );
-
   protected:
-    QgsTransaction( const QString &connString );
+    QgsTransaction( const QString &connString ) SIP_SKIP;
 
     QString mConnString;
 
+  private slots:
+    void onLayersDeleted( const QStringList &layerids );
+
   private:
 
     bool mTransactionActive;