QGIS API Documentation  2.10.1-Pisa
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups 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 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)
 convert current project for offline editing More...
 
bool isOfflineProject ()
 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)
 
QObjectchild (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< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () 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
 
QObjectsender () 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 32 of file qgsofflineediting.h.

Member Enumeration Documentation

Enumerator
CopyFeatures 
ProcessFeatures 
AddFields 
AddFeatures 
RemoveFeatures 
UpdateFeatures 
UpdateGeometries 

Definition at line 37 of file qgsofflineediting.h.

Constructor & Destructor Documentation

QgsOfflineEditing::QgsOfflineEditing ( )

Definition at line 56 of file qgsofflineediting.cpp.

QgsOfflineEditing::~QgsOfflineEditing ( )

Definition at line 61 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
offlineDataPathpath to offline db file
offlineDbFileoffline db file name
layerIdslist of layer names to convert

Definition at line 69 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
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

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
titletitle string for message
messageA descriptive message for the warning

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