Skip to content
Permalink
Browse files

Standardise dox for signals

  • Loading branch information
nyalldawson committed Feb 25, 2019
1 parent cab2dcf commit 519a30f10c712acd4d82c29e3d94f17fe7837e37
Showing with 139 additions and 167 deletions.
  1. +2 −2 python/core/auto_generated/layout/qgslayout.sip.in
  2. +2 −2 python/core/auto_generated/layout/qgslayoutatlas.sip.in
  3. +3 −3 python/core/auto_generated/layout/qgslayoutitemmap.sip.in
  4. +1 −1 python/core/auto_generated/layout/qgslayoutitempicture.sip.in
  5. +1 −1 python/core/auto_generated/qgsnetworkaccessmanager.sip.in
  6. +3 −3 python/core/auto_generated/qgsofflineediting.sip.in
  7. +1 −1 python/core/auto_generated/qgsrelationmanager.sip.in
  8. +18 −18 python/core/auto_generated/qgsvectorlayer.sip.in
  9. +2 −2 python/core/auto_generated/qgsvectorlayercache.sip.in
  10. +1 −1 python/core/auto_generated/qgsvectorlayereditbuffer.sip.in
  11. +1 −1 python/core/auto_generated/symbology/qgsstyle.sip.in
  12. +1 −1 python/gui/auto_generated/attributetable/qgsattributetabledelegate.sip.in
  13. +1 −1 python/gui/auto_generated/attributetable/qgsattributetablefiltermodel.sip.in
  14. +1 −1 python/gui/auto_generated/attributetable/qgsattributetableview.sip.in
  15. +3 −3 python/gui/auto_generated/attributetable/qgsdualview.sip.in
  16. +3 −3 python/gui/auto_generated/attributetable/qgsfeaturelistview.sip.in
  17. +1 −1 python/gui/auto_generated/attributetable/qgsifeatureselectionmanager.sip.in
  18. +1 −1 python/gui/auto_generated/layertree/qgslayertreeviewindicator.sip.in
  19. +1 −1 python/gui/auto_generated/layout/qgslayoutruler.sip.in
  20. +2 −2 python/gui/auto_generated/layout/qgslayoutview.sip.in
  21. +6 −6 python/gui/auto_generated/qgisinterface.sip.in
  22. +2 −2 python/gui/auto_generated/qgsattributeform.sip.in
  23. +1 −1 python/gui/auto_generated/qgscheckablecombobox.sip.in
  24. +1 −1 python/gui/auto_generated/qgscolorbutton.sip.in
  25. +1 −1 python/gui/auto_generated/qgsfieldcombobox.sip.in
  26. +1 −1 python/gui/auto_generated/qgsfieldexpressionwidget.sip.in
  27. +1 −1 python/gui/auto_generated/qgsmaplayercombobox.sip.in
  28. +1 −1 python/gui/auto_generated/qgstreewidgetitem.sip.in
  29. +1 −1 python/gui/auto_generated/raster/qgsrasterbandcombobox.sip.in
  30. +1 −1 src/app/layout/qgslayoutpagepropertieswidget.h
  31. +5 −5 src/app/qgisapp.h
  32. +1 −1 src/app/qgslayertreeviewbadlayerindicator.h
  33. +2 −2 src/core/layout/qgslayout.h
  34. +2 −2 src/core/layout/qgslayoutatlas.h
  35. +3 −3 src/core/layout/qgslayoutitemmap.h
  36. +1 −1 src/core/layout/qgslayoutitempicture.h
  37. +1 −1 src/core/qgsnetworkaccessmanager.h
  38. +3 −3 src/core/qgsofflineediting.h
  39. +1 −1 src/core/qgsrelationmanager.h
  40. +18 −18 src/core/qgsvectorlayer.h
  41. +3 −3 src/core/qgsvectorlayercache.h
  42. +1 −1 src/core/qgsvectorlayereditbuffer.h
  43. +1 −1 src/core/symbology/qgsstyle.h
  44. +1 −1 src/gui/attributetable/qgsattributetabledelegate.h
  45. +1 −1 src/gui/attributetable/qgsattributetablefiltermodel.h
  46. +1 −1 src/gui/attributetable/qgsattributetableview.h
  47. +3 −3 src/gui/attributetable/qgsdualview.h
  48. +3 −3 src/gui/attributetable/qgsfeaturelistview.h
  49. +1 −1 src/gui/attributetable/qgsifeatureselectionmanager.h
  50. +1 −1 src/gui/layertree/qgslayertreeviewindicator.h
  51. +1 −1 src/gui/layout/qgslayoutruler.h
  52. +2 −2 src/gui/layout/qgslayoutview.h
  53. +6 −6 src/gui/qgisinterface.h
  54. +2 −2 src/gui/qgsattributeform.h
  55. +2 −2 src/gui/qgscheckablecombobox.h
  56. +1 −1 src/gui/qgscolorbutton.h
  57. +1 −1 src/gui/qgsfieldcombobox.h
  58. +1 −1 src/gui/qgsfieldexpressionwidget.h
  59. +1 −1 src/gui/qgsmaplayercombobox.h
  60. +1 −1 src/gui/qgstreewidgetitem.h
  61. +1 −1 src/gui/raster/qgsrasterbandcombobox.h
  62. +0 −14 src/providers/postgres/qgspostgresprovider.h
  63. +0 −14 src/providers/spatialite/qgsspatialiteprovider.h
  64. +2 −2 src/quickgui/qgsquickmapcanvasmap.h
@@ -624,7 +624,7 @@ Updates the scene bounds of the layout.

void changed();
%Docstring
Is emitted when properties of the layout change. This signal is only
Emitted when properties of the layout change. This signal is only
emitted for settings directly managed by the layout, and is not emitted
when child items change.
%End
@@ -642,7 +642,7 @@ If None, no item is selected.

void refreshed();
%Docstring
Is emitted when the layout has been refreshed and items should also be refreshed
Emitted when the layout has been refreshed and items should also be refreshed
and updated.
%End

@@ -371,7 +371,7 @@ Emitted when the coverage layer for the atlas changes.

void messagePushed( const QString &message );
%Docstring
Is emitted when the atlas has an updated status bar ``message``.
Emitted when the atlas has an updated status bar ``message``.
%End

void numberFeaturesChanged( int numFeatures );
@@ -381,7 +381,7 @@ Emitted when the number of features for the atlas changes.

void featureChanged( const QgsFeature &feature );
%Docstring
Is emitted when the current atlas ``feature`` changes.
Emitted when the current atlas ``feature`` changes.
%End

void renderBegun();
@@ -612,7 +612,7 @@ Calculates the extent to request and the yShift of the top-left point in case of

void extentChanged();
%Docstring
Is emitted when the map's extent changes.
Emitted when the map's extent changes.

.. seealso:: :py:func:`setExtent`

@@ -621,7 +621,7 @@ Is emitted when the map's extent changes.

void mapRotationChanged( double newRotation );
%Docstring
Is emitted when the map's rotation changes.
Emitted when the map's rotation changes.

.. seealso:: :py:func:`setMapRotation`

@@ -630,7 +630,7 @@ Is emitted when the map's rotation changes.

void preparedForAtlas();
%Docstring
Is emitted when the map has been prepared for atlas rendering, just before actual rendering
Emitted when the map has been prepared for atlas rendering, just before actual rendering
%End

void layerStyleOverridesChanged();
@@ -310,7 +310,7 @@ Forces a recalculation of the picture's frame size
signals:
void pictureRotationChanged( double newRotation );
%Docstring
Is emitted on picture rotation change
Emitted on picture rotation change
%End

protected:
@@ -326,7 +326,7 @@ created in any thread.

void finished( QgsNetworkReplyContent reply );
%Docstring
This signal is emitted whenever a pending network reply is finished.
Emitted whenever a pending network reply is finished.

The ``reply`` parameter will contain a QgsNetworkReplyContent object, containing all the useful
information relating to the reply, including headers and reply content.
@@ -61,20 +61,20 @@ Synchronize to remote layers

void progressStarted();
%Docstring
The signal is emitted when the process has started.
Emitted when the process has started.
%End

void layerProgressUpdated( int layer, int numLayers );
%Docstring
Is emitted whenever a new layer is being processed.
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``.
%End

void progressModeSet( QgsOfflineEditing::ProgressMode mode, int maximum );
%Docstring
Is emitted when the mode for the progress of the current operation is
Emitted when the mode for the progress of the current operation is
set.

:param mode: progress mode
@@ -128,7 +128,7 @@ Discover all the relations available from the current layers.
signals:
void relationsLoaded();
%Docstring
This signal is emitted when the relations were loaded after reading a project
Emitted when the relations were loaded after reading a project
%End

void changed();
@@ -2329,7 +2329,7 @@ by the backend data provider).

void selectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect );
%Docstring
This signal is emitted when selection was changed
Emitted when selection was changed

:param selected: Newly selected feature ids
:param deselected: Ids of all features which have previously been selected but are not any more
@@ -2338,7 +2338,7 @@ This signal is emitted when selection was changed

void layerModified();
%Docstring
This signal is emitted when modifications has been done on layer
Emitted when modifications has been done on layer
%End

void allowCommitChanged();
@@ -2350,37 +2350,37 @@ Emitted whenever the allowCommitChanged() property of this layer changes.

void beforeModifiedCheck() const;
%Docstring
Is emitted, when layer is checked for modifications. Use for last-minute additions
Emitted when the layer is checked for modifications. Use for last-minute additions.
%End

void beforeEditingStarted();
%Docstring
Is emitted, before editing on this layer is started
Emitted before editing on this layer is started.
%End

void editingStarted();
%Docstring
Is emitted, when editing on this layer has started
Emitted when editing on this layer has started.
%End

void editingStopped();
%Docstring
Is emitted, when edited changes successfully have been written to the data provider
Emitted when edited changes have been successfully written to the data provider.
%End

void beforeCommitChanges();
%Docstring
Is emitted, before changes are committed to the data provider
Emitted before changes are committed to the data provider.
%End

void beforeRollBack();
%Docstring
Is emitted, before changes are rolled back
Emitted before changes are rolled back.
%End

void afterRollBack();
%Docstring
Is emitted, after changes are rolled back
Emitted after changes are rolled back.

.. versionadded:: 3.4
%End
@@ -2451,7 +2451,7 @@ If features are deleted outside of an edit command, this signal will be emitted

void updatedFields();
%Docstring
Is emitted, whenever the fields available from this layer have been changed.
Emitted whenever the fields available from this layer have been changed.
This can be due to manually adding attributes or due to a join.
%End

@@ -2464,7 +2464,7 @@ Emitted when the layer's subset string has changed.

void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value );
%Docstring
Is emitted whenever an attribute value change is done in the edit buffer.
Emitted whenever an attribute value change is done in the edit buffer.
Note that at this point the attribute change is not yet saved to the provider.

:param fid: The id of the changed feature
@@ -2474,7 +2474,7 @@ Note that at this point the attribute change is not yet saved to the provider.

void geometryChanged( QgsFeatureId fid, const QgsGeometry &geometry );
%Docstring
Is emitted whenever a geometry change is done in the edit buffer.
Emitted whenever a geometry change is done in the edit buffer.
Note that at this point the geometry change is not yet saved to the provider.

:param fid: The id of the changed feature
@@ -2483,27 +2483,27 @@ Note that at this point the geometry change is not yet saved to the provider.

void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes );
%Docstring
This signal is emitted, when attributes are deleted from the provider
Emitted when attributes are deleted from the provider
%End
void committedAttributesAdded( const QString &layerId, const QList<QgsField> &addedAttributes );
%Docstring
This signal is emitted, when attributes are added to the provider
Emitted when attributes are added to the provider
%End
void committedFeaturesAdded( const QString &layerId, const QgsFeatureList &addedFeatures );
%Docstring
This signal is emitted, when features are added to the provider
Emitted when features are added to the provider
%End
void committedFeaturesRemoved( const QString &layerId, const QgsFeatureIds &deletedFeatureIds );
%Docstring
This signal is emitted, when features are deleted from the provider
Emitted when features are deleted from the provider
%End
void committedAttributeValuesChanges( const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues );
%Docstring
This signal is emitted, when attribute value changes are saved to the provider
Emitted when attribute value changes are saved to the provider
%End
void committedGeometriesChanges( const QString &layerId, const QgsGeometryMap &changedGeometries );
%Docstring
This signal is emitted, when geometry changes are saved to the provider
Emitted when geometry changes are saved to the provider
%End

void labelingFontNotFound( QgsVectorLayer *layer, const QString &fontfamily );
@@ -281,13 +281,13 @@ layer() will still return a valid pointer for cleanup purpose.

void attributeValueChanged( QgsFeatureId fid, int field, const QVariant &value );
%Docstring
Is emitted when an attribute is changed. Is re-emitted after the layer itself emits this signal.
Emitted when an attribute is changed. Is re-emitted after the layer itself emits this signal.
You should connect to this signal, to be sure, to not get a cached value if querying the cache.
%End

void featureAdded( QgsFeatureId fid );
%Docstring
Is emitted, when a new feature has been added to the layer and this cache.
Emitted when a new feature has been added to the layer and this cache.
You should connect to this signal instead of the layers', if you want to be sure
that this cache has updated information for the new feature

@@ -214,7 +214,7 @@ Returns true if the specified feature ID has been deleted but not committed.
signals:
void layerModified();
%Docstring
This signal is emitted when modifications has been done on layer
Emitted when modifications has been done on layer
%End

void featureAdded( QgsFeatureId fid );
@@ -498,7 +498,7 @@ name or tag changes.

void groupsModified();
%Docstring
Is emitted every time a tag or smartgroup has been added, removed, or renamed
Emitted every time a tag or smartgroup has been added, removed, or renamed
%End

void entityTagsChanged( QgsStyle::StyleEntity entity, const QString &name, const QStringList &newTags );
@@ -67,7 +67,7 @@ Sets data from model into the editor. Overloads default method

void actionColumnItemPainted( const QModelIndex &index ) const;
%Docstring
Is emitted when an action column item is painted.
Emitted when an action column item is painted.
The consumer of this signal can initialize the index widget.

.. note::
@@ -202,7 +202,7 @@ is shown.

void sortColumnChanged( int column, Qt::SortOrder order );
%Docstring
Is emitted whenever the sort column is changed
Emitted whenever the sort column is changed

:param column: The sort column
:param order: The sort order
@@ -128,7 +128,7 @@ Saves geometry to the settings on close

void willShowContextMenu( QMenu *menu, const QModelIndex &atIndex );
%Docstring
Is emitted, in order to provide a hook to add additional* menu entries to the context menu.
Emitted in order to provide a hook to add additional* menu entries to the context menu.

:param menu: If additional QMenuItems are added, they will show up in the context menu.
:param atIndex: The QModelIndex, to which the context menu belongs. Relative to the source model.
@@ -227,19 +227,19 @@ Cancel the progress dialog (if any)

void displayExpressionChanged( const QString &expression );
%Docstring
Is emitted, whenever the display expression is successfully changed
Emitted whenever the display expression is successfully changed

:param expression: The expression that was applied
%End

void filterChanged();
%Docstring
Is emitted, whenever the filter changes
Emitted whenever the filter changes
%End

void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type );
%Docstring
Is emitted when a filter expression is set using the view.
Emitted when a filter expression is set using the view.

:param expression: filter expression
:param type: filter type
@@ -115,22 +115,22 @@ setFeatureSelectionManager

void currentEditSelectionChanged( QgsFeature &feat );
%Docstring
Is emitted, whenever the current edit selection has been changed.
Emitted whenever the current edit selection has been changed.

:param feat: the feature, which will be edited.
%End

void displayExpressionChanged( const QString &expression );
%Docstring
Is emitted, whenever the display expression is successfully changed
Emitted whenever the display expression is successfully changed

:param expression: The expression that was applied
%End


void willShowContextMenu( QgsActionMenu *menu, const QModelIndex &atIndex );
%Docstring
Is emitted, when the context menu is created to add the specific actions to it
Emitted when the context menu is created to add the specific actions to it

:param menu: is the already created context menu
:param atIndex: is the position of the current feature in the model
@@ -61,7 +61,7 @@ Returns reference to identifiers of selected features

void selectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect );
%Docstring
This signal is emitted when selection was changed
Emitted when selection was changed.

:param selected: Newly selected feature ids
:param deselected: Ids of all features which have previously been selected but are not any more
@@ -51,7 +51,7 @@ Sets tool tip text
signals:
void clicked( const QModelIndex &index );
%Docstring
Signal that is emitted when user clicks on the indicator
Emitted when user clicks on the indicator
%End

};
@@ -76,7 +76,7 @@ the view.
signals:
void cursorPosChanged( QPointF );
%Docstring
Is emitted when mouse cursor coordinates change
Emitted when mouse cursor coordinates change
%End

protected:
@@ -517,12 +517,12 @@ Emitted when the current ``tool`` is changed.

void zoomLevelChanged();
%Docstring
Is emitted whenever the zoom level of the view is changed.
Emitted whenever the zoom level of the view is changed.
%End

void cursorPosChanged( QPointF layoutPoint );
%Docstring
Is emitted when the mouse cursor coordinates change within the view.
Emitted when the mouse cursor coordinates change within the view.
The ``layoutPoint`` argument indicates the cursor position within
the layout coordinate system.
%End

0 comments on commit 519a30f

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