Skip to content
Permalink
Browse files

run sipify

  • Loading branch information
3nids committed Jan 13, 2018
1 parent ba95189 commit 6d94ac9c6cdb76d3836f33a02782da499aaa7520
Showing with 259 additions and 259 deletions.
  1. +2 −2 python/core/auth/qgsauthmanager.sip
  2. +2 −2 python/core/auth/qgsauthmethod.sip
  3. +1 −1 python/core/effects/qgsimageoperation.sip
  4. +2 −2 python/core/effects/qgspainteffectregistry.sip
  5. +3 −3 python/core/expression/qgsexpression.sip
  6. +4 −4 python/core/geocms/geonode/qgsgeonoderequest.sip
  7. +3 −3 python/core/geometry/qgsgeometry.sip
  8. +2 −2 python/core/geometry/qgspoint.sip
  9. +2 −2 python/core/layout/qgsabstractreportsection.sip
  10. +2 −2 python/core/layout/qgslayoutatlas.sip
  11. +1 −1 python/core/layout/qgslayoutguidecollection.sip
  12. +2 −2 python/core/layout/qgslayoutitem.sip
  13. +4 −4 python/core/layout/qgslayoutitemmapgrid.sip
  14. +4 −4 python/core/layout/qgslayoutitemmapitem.sip
  15. +4 −4 python/core/layout/qgslayoutitemmapoverview.sip
  16. +3 −3 python/core/layout/qgslayoutitempicture.sip
  17. +2 −2 python/core/layout/qgslayoutitemtexttable.sip
  18. +2 −2 python/core/layout/qgslayoutobject.sip
  19. +3 −3 python/core/layout/qgslayoutpagecollection.sip
  20. +4 −4 python/core/layout/qgslayoutpoint.sip
  21. +4 −4 python/core/layout/qgslayoutsize.sip
  22. +1 −1 python/core/layout/qgsreport.sip
  23. +1 −1 python/core/layout/qgsreportsectionfieldgroup.sip
  24. +1 −1 python/core/layout/qgsreportsectionlayout.sip
  25. +1 −1 python/core/locator/qgslocator.sip
  26. +3 −3 python/core/locator/qgslocatorfilter.sip
  27. +7 −7 python/core/processing/qgsprocessingalgorithm.sip
  28. +1 −1 python/core/processing/qgsprocessingparameters.sip
  29. +3 −3 python/core/processing/qgsprocessingutils.sip
  30. +3 −3 python/core/qgsapplication.sip
  31. +11 −11 python/core/qgscoordinatereferencesystem.sip
  32. +5 −5 python/core/qgscoordinatetransform.sip
  33. +3 −3 python/core/qgscoordinatetransformcontext.sip
  34. +2 −2 python/core/qgsdataprovider.sip
  35. +2 −2 python/core/qgsdatetimestatisticalsummary.sip
  36. +2 −2 python/core/qgsdiagramrenderer.sip
  37. +5 −5 python/core/qgsdistancearea.sip
  38. +1 −1 python/core/qgsfeaturerequest.sip
  39. +2 −2 python/core/qgsjsonutils.sip
  40. +1 −1 python/core/qgsmaplayerstore.sip
  41. +2 −2 python/core/qgsmapthemecollection.sip
  42. +5 −5 python/core/qgsproject.sip
  43. +2 −2 python/core/qgsprojectproperty.sip
  44. +4 −4 python/core/qgsstatisticalsummary.sip
  45. +4 −4 python/core/qgsstringstatisticalsummary.sip
  46. +5 −5 python/core/qgstaskmanager.sip
  47. +77 −77 python/core/qgsvectorlayer.sip
  48. +1 −1 python/core/qgsvectorlayercache.sip
  49. +2 −2 python/core/raster/qgsrasterdataprovider.sip
  50. +4 −4 python/core/symbology/qgsrenderer.sip
  51. +1 −1 python/core/symbology/qgsrendererregistry.sip
  52. +1 −1 python/core/symbology/qgssymbollayerregistry.sip
  53. +2 −2 python/gui/attributetable/qgsattributetabledelegate.sip
  54. +2 −2 python/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.sip
  55. +3 −3 python/gui/editorwidgets/qgsdatetimeedit.sip
  56. +2 −2 python/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.sip
  57. +5 −5 python/gui/qgisinterface.sip
  58. +3 −3 python/gui/qgsattributeformwidget.sip
  59. +3 −3 python/gui/qgscollapsiblegroupbox.sip
  60. +5 −5 python/gui/qgscolorbutton.sip
  61. +1 −1 python/gui/qgscolorwidgets.sip
  62. +1 −1 python/gui/qgsdetaileditemdata.sip
  63. +1 −1 python/gui/qgsmaplayerconfigwidget.sip
  64. +1 −1 python/gui/qgsmaplayerconfigwidgetfactory.sip
  65. +5 −5 python/gui/qgspanelwidget.sip
  66. +2 −2 python/gui/qgspanelwidgetstack.sip
  67. +2 −2 python/gui/qgssourceselectproviderregistry.sip
  68. +1 −1 python/gui/raster/qgsrasterminmaxwidget.sip
  69. +1 −1 python/gui/symbology/qgsrendererpropertiesdialog.sip
@@ -161,8 +161,8 @@ Re-emit a signal to schedule an optional erase of authentication database.
.. note::

This can be called from the slot connected to a previously emitted scheduling signal,
so that the slot can ask for another emit later, if the slot noticies the current GUI
processing state is not ready for interacting with the user, e.g. project is still loading
so that the slot can ask for another emit later, if the slot noticies the current GUI
processing state is not ready for interacting with the user, e.g. project is still loading

:param emitted: Setting to false will cause signal to be emitted by the schedule timer.
Setting to true will stop any emitting, but will not stop the schedule timer.
@@ -129,8 +129,8 @@ Clear any cached configuration. Called when the QgsAuthManager deletes an authen
.. note::

It is highly recommended that a cache of authentication components (per requested authcfg)
be implemented, to avoid excessive queries on the auth database. Such a cache could be as
simple as a QHash or QMap of authcfg -> QgsAuthMethodConfig. See 'Basic' auth method plugin for example.
be implemented, to avoid excessive queries on the auth database. Such a cache could be as
simple as a QHash or QMap of authcfg -> QgsAuthMethodConfig. See 'Basic' auth method plugin for example.
%End

virtual void updateMethodConfig( QgsAuthMethodConfig &mconfig ) = 0;
@@ -130,7 +130,7 @@ speed and blur quality.
.. note::

for fastest operation, ensure the source image is ARGB32_Premultiplied if
alphaOnly is set to false, or ARGB32 if alphaOnly is true
alphaOnly is set to false, or ARGB32 if alphaOnly is true
%End

static QImage *gaussianBlur( QImage &image, const int radius ) /Factory/;
@@ -18,8 +18,8 @@ class QgsPaintEffectAbstractMetadata
.. note::

It's necessary to implement the createPaintEffect() function.
In C++ you can use the QgsPaintEffectMetadata convenience class to
simplify creation of the metadata.
In C++ you can use the QgsPaintEffectMetadata convenience class to
simplify creation of the metadata.

.. versionadded:: 2.9
%End
@@ -132,8 +132,8 @@ Get list of columns referenced by the expression.
.. note::

If the returned list contains the QgsFeatureRequest.AllAttributes constant then
all attributes from the layer are required for evaluation of the expression.
QgsFeatureRequest.setSubsetOfAttributes automatically handles this case.
all attributes from the layer are required for evaluation of the expression.
QgsFeatureRequest.setSubsetOfAttributes automatically handles this case.

.. seealso:: :py:func:`referencedAttributeIndexes`
%End
@@ -355,7 +355,7 @@ value.
.. note::

this method is inefficient for bulk evaluation of expressions, it is intended
for one-off evaluations only.
for one-off evaluations only.
%End

enum SpatialOperator
@@ -70,8 +70,8 @@ Calling this method does not block while waiting for a result.
.. warning::

When using the non-blocking methods in this class, sending
overlapping requests results in undefined behavior. Use separate instances
of QgsGeoNodeRequest instead to avoid this.
overlapping requests results in undefined behavior. Use separate instances
of QgsGeoNodeRequest instead to avoid this.

.. seealso:: :py:func:`requestBlocking`
%End
@@ -98,8 +98,8 @@ This method is non-blocking and returns immediately.
.. warning::

When using the non-blocking methods in this class, sending
overlapping requests results in undefined behavior. Use separate instances
of QgsGeoNodeRequest instead to avoid this.
overlapping requests results in undefined behavior. Use separate instances
of QgsGeoNodeRequest instead to avoid this.

.. seealso:: :py:func:`layersFetched`

@@ -305,7 +305,7 @@ Uses GEOS library for the test.
.. note::

This is useful mainly for linestrings and linear rings. Polygons are simple by definition,
for checking anomalies in polygon geometries one can use isGeosValid().
for checking anomalies in polygon geometries one can use isGeosValid().

.. versionadded:: 3.0
%End
@@ -939,7 +939,7 @@ by calling `error()` on the returned geometry.
.. note::

for line based geometries, the center point of the line is returned,
and for point based geometries, the point itself is returned
and for point based geometries, the point itself is returned

.. seealso:: :py:func:`pointOnSurface`

@@ -1368,7 +1368,7 @@ The ``method`` argument dictates which validator to utilize.
.. note::

Available in Python bindings since QGIS 1.6
*
*
%End

static QgsGeometry unaryUnion( const QVector<QgsGeometry> &geometries );
@@ -155,7 +155,7 @@ Sets the point's z-coordinate.
.. note::

calling this will have no effect if the point does not contain a z-dimension. Use addZValue() to
add a z value and force the point to have a z dimension.
add a z value and force the point to have a z dimension.

.. seealso:: z

@@ -169,7 +169,7 @@ Sets the point's m-value.
.. note::

calling this will have no effect if the point does not contain a m-dimension. Use addMValue() to
add a m value and force the point to have an m dimension.
add a m value and force the point to have an m dimension.

.. seealso:: m

@@ -18,7 +18,7 @@ class QgsReportSectionContext
.. warning::

This is not considered stable API, and may change in future QGIS releases. It is
exposed to the Python bindings for unit testing purposes only.
exposed to the Python bindings for unit testing purposes only.

.. versionadded:: 3.0
%End
@@ -42,7 +42,7 @@ class QgsAbstractReportSection : QgsAbstractLayoutIterator
.. warning::

This is not considered stable API, and may change in future QGIS releases. It is
exposed to the Python bindings for unit testing purposes only.
exposed to the Python bindings for unit testing purposes only.

.. versionadded:: 3.0
%End
@@ -18,8 +18,8 @@ This class is used for printing, exporting to PDF and images.
.. note::

This class should not be created directly. For the atlas to function correctly
the atlasComposition() property for QgsComposition should be used to retrieve a
QgsLayoutAtlas which is automatically created and attached to the composition.
the atlasComposition() property for QgsComposition should be used to retrieve a
QgsLayoutAtlas which is automatically created and attached to the composition.

.. versionadded:: 3.0
%End
@@ -47,7 +47,7 @@ Sets the ``layout`` the guide belongs to.
.. note::

Adding the guide to a QgsLayoutGuideCollection will automatically set
the corresponding layout for you.
the corresponding layout for you.

.. seealso:: :py:func:`layout`
%End
@@ -273,8 +273,8 @@ Sets whether the item is ``visible``.
.. note::

QGraphicsItem.setVisible should not be called directly
on a QgsLayoutItem, as some item types (e.g., groups) need to override
the visibility toggle.
on a QgsLayoutItem, as some item types (e.g., groups) need to override
the visibility toggle.
%End

void setLocked( const bool locked );
@@ -41,7 +41,7 @@ above any existing map grids already present in the stack.
.. note::

After adding a grid to the stack, updateBoundingRect() and update()
should be called for the QgsLayoutItemMap to prevent rendering artifacts.
should be called for the QgsLayoutItemMap to prevent rendering artifacts.

.. seealso:: :py:func:`removeGrid`
%End
@@ -53,7 +53,7 @@ Removes a grid with matching ``gridId`` from the stack and deletes the correspon
.. note::

After removing a grid from the stack, updateBoundingRect() and update()
should be called for the QgsLayoutItemMap to prevent rendering artifacts.
should be called for the QgsLayoutItemMap to prevent rendering artifacts.

.. seealso:: :py:func:`addGrid`
%End
@@ -65,7 +65,7 @@ Moves a grid with matching ``gridId`` up the stack, causing it to be rendered ab
.. note::

After moving a grid within the stack, update() should be
called for the QgsLayoutItemMap to redraw the map with the new grid stack order.
called for the QgsLayoutItemMap to redraw the map with the new grid stack order.

.. seealso:: :py:func:`moveGridDown`
%End
@@ -77,7 +77,7 @@ Moves a grid with matching ``gridId`` down the stack, causing it to be rendered
.. note::

After moving a grid within the stack, update() should be
called for the QgsLayoutItemMap to redraw the map with the new grid stack order.
called for the QgsLayoutItemMap to redraw the map with the new grid stack order.

.. seealso:: :py:func:`moveGridUp`
%End
@@ -180,7 +180,7 @@ above any existing map items already present in the stack.
.. note::

After adding an item to the stack update()
should be called for the QgsLayoutItemMap to prevent rendering artifacts.
should be called for the QgsLayoutItemMap to prevent rendering artifacts.

.. seealso:: :py:func:`removeItem`
%End
@@ -192,7 +192,7 @@ Removes an item which matching ``itemId`` from the stack and deletes the corresp
.. note::

After removing an item from the stack, update()
should be called for the QgsLayoutItemMap to prevent rendering artifacts.
should be called for the QgsLayoutItemMap to prevent rendering artifacts.

.. seealso:: :py:func:`addItem`
%End
@@ -204,7 +204,7 @@ Moves an item which matching ``itemId`` up the stack, causing it to be rendered
.. note::

After moving an item within the stack, update() should be
called for the QgsLayoutItemMap to redraw the map with the new item stack order.
called for the QgsLayoutItemMap to redraw the map with the new item stack order.

.. seealso:: :py:func:`moveItemDown`
%End
@@ -216,7 +216,7 @@ Moves an item which matching ``itemId`` up the stack, causing it to be rendered
.. note::

After moving an item within the stack, update() should be
called for the QgsLayoutItemMap to redraw the map with the new item stack order.
called for the QgsLayoutItemMap to redraw the map with the new item stack order.

.. seealso:: :py:func:`moveItemUp`
%End
@@ -42,7 +42,7 @@ above any existing map overviews already present in the stack.
.. note::

After adding a overview to the stack, update()
should be called for the QgsLayoutItemMap to prevent rendering artifacts.
should be called for the QgsLayoutItemMap to prevent rendering artifacts.

.. seealso:: :py:func:`removeOverview`
%End
@@ -54,7 +54,7 @@ Removes an overview with matching overviewId from the stack and deletes the corr
.. note::

After removing an overview from the stack, update()
should be called for the QgsLayoutItemMap to prevent rendering artifacts.
should be called for the QgsLayoutItemMap to prevent rendering artifacts.

.. seealso:: :py:func:`addOverview`
%End
@@ -66,7 +66,7 @@ Moves an overview with matching overviewId up the stack, causing it to be render
.. note::

After moving an overview within the stack, update() should be
called for the QgsLayoutItemMap to redraw the map with the new overview stack order.
called for the QgsLayoutItemMap to redraw the map with the new overview stack order.

.. seealso:: :py:func:`moveOverviewDown`
%End
@@ -78,7 +78,7 @@ Moves an overview with matching overviewId down the stack, causing it to be rend
.. note::

After moving an overview within the stack, update() should be
called for the QgsLayoutItemMap to redraw the map with the new overview stack order.
called for the QgsLayoutItemMap to redraw the map with the new overview stack order.

.. seealso:: :py:func:`moveOverviewUp`
%End
@@ -191,7 +191,7 @@ Sets the fill ``color`` used for parametrized SVG files.
.. note::

This setting only has an effect on parametrized SVG files, and is ignored for
non-parametrized SVG files.
non-parametrized SVG files.

.. seealso:: :py:func:`svgFillColor`

@@ -216,7 +216,7 @@ Sets the stroke ``color`` used for parametrized SVG files.
.. note::

This setting only has an effect on parametrized SVG files, and is ignored for
non-parametrized SVG files.
non-parametrized SVG files.

.. seealso:: :py:func:`svgStrokelColor`

@@ -239,7 +239,7 @@ Sets the stroke ``width`` (in layout units) used for parametrized SVG files.
.. note::

This setting only has an effect on parametrized SVG files, and is ignored for
non-parametrized SVG files.
non-parametrized SVG files.

.. seealso:: :py:func:`svgStrokeWidth`

@@ -48,8 +48,8 @@ Adds a row to the table
.. note::

If row is shorter than the number of columns in the table than blank cells
will be inserted at the end of the row. If row contains more strings then the number
of columns in the table then these extra strings will be ignored.
will be inserted at the end of the row. If row contains more strings then the number
of columns in the table then these extra strings will be ignored.

.. note::

@@ -91,8 +91,8 @@ Constructor for QgsLayoutObject, with the specified parent ``layout``.
.. note::

While ownership of a QgsLayoutObject is not passed to the layout,
classes which are derived from QgsLayoutObject (such as QgsLayoutItem)
may transfer their ownership to a layout upon construction.
classes which are derived from QgsLayoutObject (such as QgsLayoutItem)
may transfer their ownership to a layout upon construction.
%End


@@ -255,8 +255,8 @@ first page.
.. note::

This is a relaxed check, which will always return a page number. For instance,
it does not consider x coordinates and vertical coordinates before the first page or
after the last page will still return the nearest page.
it does not consider x coordinates and vertical coordinates before the first page or
after the last page will still return the nearest page.

.. seealso:: :py:func:`predicatePageNumberForPoint`

@@ -293,7 +293,7 @@ If no page exists at ``point``, None will be returned.
.. note::

Unlike pageNumberForPoint(), this method only returns pages which
directly intersect with the specified point.
directly intersect with the specified point.

.. seealso:: :py:func:`pageNumberForPoint`
%End
@@ -22,10 +22,10 @@ for use in QGIS layouts. Measurement units are stored alongside the position.
.. note::

This class does not inherit from QPointF since QPointF includes methods which should not apply
to positions with with units. For instance, the + and - operators would mislead users of this class
to believe that addition of two QgsLayoutPoints with different unit types would automatically convert
units. Instead, all unit conversion must be handled by a QgsLayoutMeasurementConverter so that
conversion between paper and screen units can be correctly performed.
to positions with with units. For instance, the + and - operators would mislead users of this class
to believe that addition of two QgsLayoutPoints with different unit types would automatically convert
units. Instead, all unit conversion must be handled by a QgsLayoutMeasurementConverter so that
conversion between paper and screen units can be correctly performed.
%End

%TypeHeaderCode
@@ -23,10 +23,10 @@ for use in QGIS layouts. Measurement units are stored alongside the size.
.. note::

This class does not inherit from QSizeF since QSizeF includes methods which should not apply to sizes
with units. For instance, the + and - operators would mislead users of this class to believe that
addition of two QgsLayoutSize with different unit types would automatically convert units. Instead,
all unit conversion must be handled by a QgsLayoutMeasurementConverter so that conversion between
paper and screen units can be correctly performed.
with units. For instance, the + and - operators would mislead users of this class to believe that
addition of two QgsLayoutSize with different unit types would automatically convert units. Instead,
all unit conversion must be handled by a QgsLayoutMeasurementConverter so that conversion between
paper and screen units can be correctly performed.
%End

%TypeHeaderCode
@@ -20,7 +20,7 @@ subclasses.
.. warning::

This is not considered stable API, and may change in future QGIS releases. It is
exposed to the Python bindings for unit testing purposes only.
exposed to the Python bindings for unit testing purposes only.

.. versionadded:: 3.0
%End

0 comments on commit 6d94ac9

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