#include <qgsofflineediting.h>

Inheritance diagram for QgsOfflineEditing:

Public Types
enum	ProgressMode { CopyFeatures = 0, ProcessFeatures, AddFields, AddFeatures, RemoveFeatures, UpdateFeatures, UpdateGeometries }

Signals
void	layerProgressUpdated (int layer, int numLayers)
	Emit a signal that the next layer of numLayers has started processing. More...

void	progressModeSet (QgsOfflineEditing::ProgressMode mode, int maximum)
	Emit a signal that sets the mode for the progress of the current operation. More...

void	progressStarted ()
	Emit a signal that processing has started. More...

void	progressStopped ()
	Emit a signal that processing of all layers has finished. More...

void	progressUpdated (int progress)
	Emit a signal with the progress of the current mode. More...

void	warning (const QString &title, const QString &message)
	Emitted when a warning needs to be displayed. More...

Public Member Functions
	QgsOfflineEditing ()

	~QgsOfflineEditing ()

bool	convertToOfflineProject (const QString &offlineDataPath, const QString &offlineDbFile, const QStringList &layerIds, bool onlySelected=false)
	Convert current project for offline editing. More...

bool	isOfflineProject () const
	Return true if current project is offline. More...

void	synchronize ()
	Synchronize to remote layers. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

Definition at line 34 of file qgsofflineediting.h.

Member Enumeration Documentation

◆ ProgressMode

enum QgsOfflineEditing::ProgressMode

Enumerator
CopyFeatures
ProcessFeatures
AddFields
AddFeatures
RemoveFeatures
UpdateFeatures
UpdateGeometries

Definition at line 39 of file qgsofflineediting.h.

Constructor & Destructor Documentation

◆ QgsOfflineEditing()

QgsOfflineEditing::QgsOfflineEditing ( )

Definition at line 57 of file qgsofflineediting.cpp.

◆ ~QgsOfflineEditing()

QgsOfflineEditing::~QgsOfflineEditing ( )

Definition at line 63 of file qgsofflineediting.cpp.

Member Function Documentation

◆ convertToOfflineProject()

bool QgsOfflineEditing::convertToOfflineProject	(	const QString &	offlineDataPath,
		const QString &	offlineDbFile,
		const QStringList &	layerIds,
		bool	onlySelected = `false`
	)

Convert current project for offline editing.

convert current project to offline project returns offline project file path

Parameters

offlineDataPath	Path to offline db file
offlineDbFile	Offline db file name
layerIds	List of layer names to convert
onlySelected	Only copy selected features from layers where a selection is present

Workflow:

copy layers to spatialite
create spatialite db at offlineDataPath
create table for each layer
add new spatialite layer
copy features
save as offline project
mark offline layers
remove remote layers
mark as offline project

Definition at line 82 of file qgsofflineediting.cpp.

◆ isOfflineProject()

bool QgsOfflineEditing::isOfflineProject ( ) const

Return true if current project is offline.

Definition at line 200 of file qgsofflineediting.cpp.

◆ layerProgressUpdated

void QgsOfflineEditing::layerProgressUpdated	(	int	layer,
		int	numLayers
	)

signal

Emit a signal that the next layer of numLayers has started processing.

Parameters

layer	current layer index
numLayers	total number of layers

◆ progressModeSet

void QgsOfflineEditing::progressModeSet	(	QgsOfflineEditing::ProgressMode	mode,
		int	maximum
	)

signal

Emit a signal that sets the mode for the progress of the current operation.

Parameters

mode	progress mode
maximum	total number of entities to process in the current operation

◆ progressStarted

void QgsOfflineEditing::progressStarted ( )

signal

Emit a signal that processing has started.

◆ progressStopped

void QgsOfflineEditing::progressStopped ( )

signal

Emit a signal that processing of all layers has finished.

◆ progressUpdated

void QgsOfflineEditing::progressUpdated ( int progress )

signal

Emit a signal with the progress of the current mode.

Parameters

progress current index of processed entities

◆ synchronize()

void QgsOfflineEditing::synchronize ( )

Synchronize to remote layers.

Definition at line 205 of file qgsofflineediting.cpp.

◆ warning

void QgsOfflineEditing::warning	(	const QString &	title,
		const QString &	message
	)

signal

Emitted when a warning needs to be displayed.

Parameters

title	title string for message
message	A descriptive message for the warning

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsofflineediting.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsofflineediting.cpp

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ProgressMode

Constructor & Destructor Documentation

◆ QgsOfflineEditing()

◆ ~QgsOfflineEditing()

Member Function Documentation

◆ convertToOfflineProject()

◆ isOfflineProject()

◆ layerProgressUpdated

◆ progressModeSet

◆ progressStarted

◆ progressStopped

◆ progressUpdated

◆ synchronize()

◆ warning