QGIS/python/core/qgsofflineediting.sip
Denis Rouzaud 45266cd03e [sipify] improvements
* add In annotation
 * remove struct forward declarations
 * fix members initialization list in header
 * merge removal code for function bodies and constructor definition
2017-04-26 10:25:50 +02:00

104 lines
3.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsofflineediting.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsOfflineEditing : QObject
{
%TypeHeaderCode
#include "qgsofflineediting.h"
%End
public:
enum ProgressMode
{
CopyFeatures,
ProcessFeatures,
AddFields,
AddFeatures,
RemoveFeatures,
UpdateFeatures,
UpdateGeometries
};
QgsOfflineEditing();
bool convertToOfflineProject( const QString &offlineDataPath, const QString &offlineDbFile, const QStringList &layerIds, bool onlySelected = false );
%Docstring
Convert current project for offline editing
\param offlineDataPath Path to offline db file
\param offlineDbFile Offline db file name
\param layerIds List of layer names to convert
\param onlySelected Only copy selected features from layers where a selection is present
:rtype: bool
%End
bool isOfflineProject() const;
%Docstring
Return true if current project is offline
:rtype: bool
%End
void synchronize();
%Docstring
Synchronize to remote layers
%End
signals:
void progressStarted();
%Docstring
The signal is emitted when the process has started.
%End
void layerProgressUpdated( int layer, int numLayers );
%Docstring
Is emitted whenever a new layer is being processed.
It is possible to estimate the progress of the complete operation by
comparing the index of the current ``layer`` to the total amount
``numLayers``.
%End
void progressModeSet( QgsOfflineEditing::ProgressMode mode, int maximum );
%Docstring
Is emitted when the mode for the progress of the current operation is
set.
\param mode progress mode
\param maximum total number of entities to process in the current operation
%End
void progressUpdated( int progress );
%Docstring
Emitted with the progress of the current mode
\param progress current index of processed entities
%End
void progressStopped();
%Docstring
Emitted when the processing of all layers has finished
%End
void warning( const QString &title, const QString &message );
%Docstring
Emitted when a warning needs to be displayed.
\param title title string for message
\param message A descriptive message for the warning
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsofflineediting.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/