Skip to content
Permalink
Browse files

Dox++

  • Loading branch information
nyalldawson committed Dec 20, 2018
1 parent 82ebf8a commit 9df3eb3e5cae9ce1df4dd3e0554989c38f9ead2c
Showing with 28 additions and 32 deletions.
  1. +14 −15 python/core/auto_generated/qgsdataprovider.sip.in
  2. +14 −17 src/core/qgsdataprovider.h
@@ -11,19 +11,10 @@





class QgsDataProvider : QObject
{
%Docstring
Abstract base class for spatial data provider implementations.

This object needs to inherit from QObject to enable event
processing in the Postgres/PostGIS provider (QgsPostgresProvider).
It is called *here* so that this vtable and the vtable for
QgsPostgresProvider don't get misaligned -
the QgsVectorLayer class factory (which refers
to generic QgsVectorDataProvider's) depends on it.
%End

%TypeHeaderCode
@@ -401,23 +392,31 @@ Returns true if metadata was successfully written to the data provider.

void fullExtentCalculated();
%Docstring
This is emitted whenever the worker thread has fully calculated the
PostGIS extents for this layer, and its event has been received by this
provider.
Emitted whenever a deffered extent calculation is completed by the provider.

Layers should connect to this signal and update their cached extents whenever
it is emitted.
%End

void dataChanged();
%Docstring
This is emitted whenever an asynchronous operation has finished
and the data should be redrawn
Emitted whenever a change is made to the data provider which may have
caused changes in the provider's data OUTSIDE of QGIS.

When emitted from a :py:class:`QgsVectorDataProvider`, any cached information such as
feature ids should be invalidated.

.. warning::

This signal is NOT emitted when changes are made to a provider
from INSIDE QGIS -- e.g. when adding features to a vector layer, deleting features
or modifying existing features. Instead, the specific QgsVectorLayer signals
should be used to detect these operations.
%End

void notify( const QString &msg );
%Docstring
Emitted when datasource issues a notification
Emitted when the datasource issues a notification.

.. seealso:: :py:func:`setListening`

@@ -36,16 +36,7 @@ class QgsCoordinateReferenceSystem;
/**
* \ingroup core
* Abstract base class for spatial data provider implementations.
*
* This object needs to inherit from QObject to enable event
* processing in the Postgres/PostGIS provider (QgsPostgresProvider).
* It is called *here* so that this vtable and the vtable for
* QgsPostgresProvider don't get misaligned -
* the QgsVectorLayer class factory (which refers
* to generic QgsVectorDataProvider's) depends on it.
*/


class CORE_EXPORT QgsDataProvider : public QObject
{

@@ -534,23 +525,29 @@ class CORE_EXPORT QgsDataProvider : public QObject
signals:

/**
* This is emitted whenever the worker thread has fully calculated the
* PostGIS extents for this layer, and its event has been received by this
* provider.
* Emitted whenever a deffered extent calculation is completed by the provider.
*
* Layers should connect to this signal and update their cached extents whenever
* it is emitted.
*/
void fullExtentCalculated();

/**
* This is emitted whenever an asynchronous operation has finished
* and the data should be redrawn
* Emitted whenever a change is made to the data provider which may have
* caused changes in the provider's data OUTSIDE of QGIS.
*
* When emitted from a QgsVectorDataProvider, any cached information such as
* feature ids should be invalidated.
*
* When emitted from a QgsVectorDataProvider, any cached information such as
* feature ids should be invalidated.
* \warning This signal is NOT emitted when changes are made to a provider
* from INSIDE QGIS -- e.g. when adding features to a vector layer, deleting features
* or modifying existing features. Instead, the specific QgsVectorLayer signals
* should be used to detect these operations.
*/
void dataChanged();

/**
* Emitted when datasource issues a notification
* Emitted when the datasource issues a notification.
*
* \see setListening
*

0 comments on commit 9df3eb3

Please sign in to comment.
You can’t perform that action at this time.