QgsOfflineEditing Class Reference

Handles logic relating to synchronizing online and offline copies of layer data. More...

#include <qgsofflineediting.h>

Inheritance diagram for QgsOfflineEditing:

Public Types
enum	ContainerType { SpatiaLite , GPKG }
	Type of offline database container file. More...
enum	ProgressMode {   CopyFeatures = 0 , ProcessFeatures , AddFields , AddFeatures ,   RemoveFeatures , UpdateFeatures , UpdateGeometries }

Signals
void	layerProgressUpdated (int layer, int numLayers)
	Emitted whenever a new layer is being processed.
void	progressModeSet (QgsOfflineEditing::ProgressMode mode, long long maximum)
	Emitted when the mode for the progress of the current operation is set.
void	progressStarted ()
	Emitted when the process has started.
void	progressStopped ()
	Emitted when the processing of all layers has finished.
void	progressUpdated (long long progress)
	Emitted 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 ()
bool	convertToOfflineProject (const QString &offlineDataPath, const QString &offlineDbFile, const QStringList &layerIds, bool onlySelected=false, ContainerType containerType=SpatiaLite, const QString &layerNameSuffix=QStringLiteral(" (offline)"))
	Convert current project for offline editing.
bool	isOfflineProject () const
	Returns true if current project is offline.
void	synchronize (bool useTransaction=false)
	Synchronize to remote layers.

Detailed Description

Handles logic relating to synchronizing online and offline copies of layer data.

Definition at line 36 of file qgsofflineediting.h.

Member Enumeration Documentation

ContainerType

enum QgsOfflineEditing::ContainerType

Type of offline database container file.

Enumerator
SpatiaLite
GPKG

Definition at line 53 of file qgsofflineediting.h.

ProgressMode

enum QgsOfflineEditing::ProgressMode

Enumerator
CopyFeatures
ProcessFeatures
AddFields
AddFeatures
RemoveFeatures
UpdateFeatures
UpdateGeometries

Definition at line 41 of file qgsofflineediting.h.

Constructor & Destructor Documentation

QgsOfflineEditing()

QgsOfflineEditing::QgsOfflineEditing

(

)

Definition at line 67 of file qgsofflineediting.cpp.

Member Function Documentation

convertToOfflineProject()

bool QgsOfflineEditing::convertToOfflineProject	(	const QString &	offlineDataPath,
		const QString &	offlineDbFile,
		const QStringList &	layerIds,
		bool	onlySelected = false,
		ContainerType	containerType = SpatiaLite,
		const QString &	layerNameSuffix = QStringLiteral( " (offline)" )
	)

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
containerType	defines the SQLite file container type like SpatiaLite or GPKG
layerNameSuffix	Suffix string added to the offline layer name

Workflow:

• create a sqlite database at offlineDataPath
• copy layers to Geopackage or SpatiaLite offline layers in the above-created database
• replace remote layers' data source with offline layers from the database
• mark those layers as offline
• mark project as offline

Definition at line 84 of file qgsofflineediting.cpp.

isOfflineProject()

bool QgsOfflineEditing::isOfflineProject

(

)

const

Returns true if current project is offline.

Definition at line 139 of file qgsofflineediting.cpp.

layerProgressUpdated

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

signal

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.

progressModeSet

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

signal

Emitted when the mode for the progress of the current operation is set.

Parameters

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

progressStarted

void QgsOfflineEditing::progressStarted ( )

signal

Emitted when the process has started.

progressStopped

void QgsOfflineEditing::progressStopped ( )

signal

Emitted when the processing of all layers has finished.

progressUpdated

void QgsOfflineEditing::progressUpdated ( long long  progress )

signal

Emitted with the progress of the current mode.

Parameters

progress

current index of processed entities

synchronize()

void QgsOfflineEditing::synchronize

(

bool

useTransaction = false

)

Synchronize to remote layers.

Parameters

useTransaction

enforce the remote layer modifications with the same source to be in a transaction group

Definition at line 144 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:

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/qgsofflineediting.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/qgsofflineediting.cpp