QgsOfflineEditing Class Reference

#include <qgsofflineediting.h>

Classes
struct	AttributeValueChange
struct	GeometryChange

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
void	progressModeSet (QgsOfflineEditing::ProgressMode mode, int maximum)
	emit a signal that sets the mode for the progress of the current operation
void	progressStarted ()
	emit a signal that processing has started
void	progressStopped ()
	emit a signal that processing of all layers has finished
void	progressUpdated (int progress)
	emit a signal with the progress of the current mode
void	warning (const QString &title, const QString &message)
	Emitted when a warning needs to be displayed.

Public Member Functions
	QgsOfflineEditing ()
	~QgsOfflineEditing ()
bool	convertToOfflineProject (const QString &offlineDataPath, const QString &offlineDbFile, const QStringList &layerIds)
	convert current project for offline editing
bool	isOfflineProject ()
	return true if current project is offline
void	synchronize ()
	synchronize to remote layers

Detailed Description

Definition at line 32 of file qgsofflineediting.h.

Member Enumeration Documentation

enum QgsOfflineEditing::ProgressMode

Enumerator:

CopyFeatures
ProcessFeatures
AddFields
AddFeatures
RemoveFeatures
UpdateFeatures
UpdateGeometries

Definition at line 37 of file qgsofflineediting.h.

Constructor & Destructor Documentation

QgsOfflineEditing::QgsOfflineEditing

(

)

Definition at line 55 of file qgsofflineediting.cpp.

QgsOfflineEditing::~QgsOfflineEditing

(

)

Definition at line 60 of file qgsofflineediting.cpp.

Member Function Documentation

bool QgsOfflineEditing::convertToOfflineProject	(	const QString &	offlineDataPath,
		const QString &	offlineDbFile,
		const QStringList &	layerIds
	)

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

Definition at line 68 of file qgsofflineediting.cpp.

bool QgsOfflineEditing::isOfflineProject

(

)

return true if current project is offline

Definition at line 190 of file qgsofflineediting.cpp.

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

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

void QgsOfflineEditing::progressStarted ( )

signal

emit a signal that processing has started

void QgsOfflineEditing::progressStopped ( )

signal

emit a signal that processing of all layers has finished

void QgsOfflineEditing::progressUpdated ( int  progress )

signal

emit a signal with the progress of the current mode

Parameters

progress

current index of processed entities

void QgsOfflineEditing::synchronize

(

)

synchronize to remote layers

Definition at line 195 of file qgsofflineediting.cpp.

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.8.2+12wheezy/src/core/qgsofflineediting.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsofflineediting.cpp