QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Signals | Public Member Functions | List of all members
QgsOfflineEditing Class Reference

#include <qgsofflineediting.h>

Inheritance diagram for QgsOfflineEditing:
Inheritance graph
[legend]

Public Types

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

Signals

void progressStarted ()
 emit a signal that processing has started More...
 
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 progressUpdated (int progress)
 emit a signal with the progress of the current mode More...
 
void progressStopped ()
 emit a signal that processing of all layers has finished More...
 

Public Member Functions

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

Member Enumeration Documentation

Enumerator
CopyFeatures 
ProcessFeatures 
AddFields 
AddFeatures 
RemoveFeatures 
UpdateFeatures 
UpdateGeometries 

Constructor & Destructor Documentation

QgsOfflineEditing::QgsOfflineEditing ( )
QgsOfflineEditing::~QgsOfflineEditing ( )

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
offlineDataPathpath to offline db file
offlineDbFileoffline db file name
layerIdslist of layer names to convert
bool QgsOfflineEditing::isOfflineProject ( )

return true if current project is offline

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

emit a signal that the next layer of numLayers has started processing

Parameters
layercurrent layer index
numLayerstotal 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
modeprogress mode
maximumtotal 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
progresscurrent index of processed entities
void QgsOfflineEditing::synchronize ( )

synchronize to remote layers


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