Skip to content
Permalink
Browse files

run sipify

  • Loading branch information
3nids committed Dec 6, 2017
1 parent 53a8693 commit e48cf98edb2149f230b3f8c6f0b3babef9b9d5e0
Showing 364 changed files with 5,725 additions and 5,725 deletions.
@@ -35,7 +35,7 @@ class QgsIDWInterpolator: QgsInterpolator

Point values are weighted by 1 / ( distance ^ coefficient ).

.. seealso:: distanceCoefficient()
.. seealso:: :py:func:`distanceCoefficient()`
.. versionadded:: 3.0
%End

@@ -47,7 +47,7 @@ class QgsIDWInterpolator: QgsInterpolator

Point values are weighted by 1 / ( distance ^ coefficient ).

.. seealso:: setDistanceCoefficient()
.. seealso:: :py:func:`setDistanceCoefficient()`
.. versionadded:: 3.0
:rtype: float
%End
@@ -44,7 +44,7 @@ class QgsTinInterpolator: QgsInterpolator
Returns the fields output by features when saving the triangulation.
These fields should be used when creating
a suitable feature sink for setTriangulationSink()
.. seealso:: setTriangulationSink()
.. seealso:: :py:func:`setTriangulationSink()`
.. versionadded:: 3.0
:rtype: QgsFields
%End
@@ -56,7 +56,7 @@ class QgsTinInterpolator: QgsInterpolator
The sink must be setup to accept LineString features, with fields matching
those returned by triangulationFields().

.. seealso:: triangulationFields()
.. seealso:: :py:func:`triangulationFields()`
.. versionadded:: 3.0
%End

@@ -44,14 +44,14 @@ class QgsGraphEdge
int toVertex() const;
%Docstring
Returns the index of the vertex at the end of this edge.
.. seealso:: fromVertex()
.. seealso:: :py:func:`fromVertex()`
:rtype: int
%End

int fromVertex() const;
%Docstring
Returns the index of the vertex at the start of this edge.
.. seealso:: toVertex()
.. seealso:: :py:func:`toVertex()`
:rtype: int
%End

@@ -86,14 +86,14 @@ class QgsGraphVertex
QgsGraphEdgeIds incomingEdges() const;
%Docstring
Returns the incoming edge ids, i.e. edges which end at this node.
.. seealso:: outgoingEdges()
.. seealso:: :py:func:`outgoingEdges()`
:rtype: QgsGraphEdgeIds
%End

QgsGraphEdgeIds outgoingEdges() const;
%Docstring
Returns outgoing edge ids, i.e. edges which start at this node.
.. seealso:: incomingEdges()
.. seealso:: :py:func:`incomingEdges()`
:rtype: QgsGraphEdgeIds
%End

@@ -108,24 +108,24 @@ Type of output value
%Docstring
Prepares the output file for writing and setups up the surface calculation. This must be called
before adding features via addFeature().
.. seealso:: addFeature()
.. seealso:: finalise()
.. seealso:: :py:func:`addFeature()`
.. seealso:: :py:func:`finalise()`
:rtype: Result
%End

Result addFeature( const QgsFeature &feature );
%Docstring
Adds a single feature to the KDE surface. prepare() must be called before adding features.
.. seealso:: prepare()
.. seealso:: finalise()
.. seealso:: :py:func:`prepare()`
.. seealso:: :py:func:`finalise()`
:rtype: Result
%End

Result finalise();
%Docstring
Finalises the output file. Must be called after adding all features via addFeature().
.. seealso:: prepare()
.. seealso:: addFeature()
.. seealso:: :py:func:`prepare()`
.. seealso:: :py:func:`addFeature()`
:rtype: Result
%End

@@ -57,71 +57,71 @@ class QgsAnnotation : QObject
bool isVisible() const;
%Docstring
Returns true if the annotation is visible and should be rendered.
.. seealso:: setVisible()
.. seealso:: :py:func:`setVisible()`
:rtype: bool
%End

void setVisible( bool visible );
%Docstring
Sets whether the annotation is visible and should be rendered.
.. seealso:: isVisible()
.. seealso:: :py:func:`isVisible()`
%End

bool hasFixedMapPosition() const;
%Docstring
Returns true if the annotation is attached to a fixed map position, or
false if the annotation uses a position relative to the current map
extent.
.. seealso:: setHasFixedMapPosition()
.. seealso:: mapPosition()
.. seealso:: relativePosition()
.. seealso:: :py:func:`setHasFixedMapPosition()`
.. seealso:: :py:func:`mapPosition()`
.. seealso:: :py:func:`relativePosition()`
:rtype: bool
%End

void setHasFixedMapPosition( bool fixed );
%Docstring
Sets whether the annotation is attached to a fixed map position, or
uses a position relative to the current map extent.
.. seealso:: hasFixedMapPosition()
.. seealso:: :py:func:`hasFixedMapPosition()`
%End

QgsPointXY mapPosition() const;
%Docstring
Returns the map position of the annotation, if it is attached to a fixed map
position.
.. seealso:: setMapPosition()
.. seealso:: hasFixedMapPosition()
.. seealso:: mapPositionCrs()
.. seealso:: :py:func:`setMapPosition()`
.. seealso:: :py:func:`hasFixedMapPosition()`
.. seealso:: :py:func:`mapPositionCrs()`
:rtype: QgsPointXY
%End

void setMapPosition( const QgsPointXY &position );
%Docstring
Sets the map position of the annotation, if it is attached to a fixed map
position.
.. seealso:: mapPosition()
.. seealso:: :py:func:`mapPosition()`
%End

QgsCoordinateReferenceSystem mapPositionCrs() const;
%Docstring
Returns the CRS of the map position, or an invalid CRS if the annotation does
not have a fixed map position.
.. seealso:: setMapPositionCrs()
.. seealso:: :py:func:`setMapPositionCrs()`
:rtype: QgsCoordinateReferenceSystem
%End

void setMapPositionCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the CRS of the map position.
.. seealso:: mapPositionCrs()
.. seealso:: :py:func:`mapPositionCrs()`
%End

QPointF relativePosition() const;
%Docstring
Returns the relative position of the annotation, if it is not attached to a fixed map
position. The coordinates in the return point should be between 0 and 1, and represent
the relative percentage for the position compared to the map width and height.
.. seealso:: setRelativePosition()
.. seealso:: :py:func:`setRelativePosition()`
:rtype: QPointF
%End

@@ -130,63 +130,63 @@ class QgsAnnotation : QObject
Sets the relative position of the annotation, if it is not attached to a fixed map
position. The coordinates in the return point should be between 0 and 1, and represent
the relative percentage for the position compared to the map width and height.
.. seealso:: relativePosition()
.. seealso:: :py:func:`relativePosition()`
%End

void setFrameOffsetFromReferencePoint( QPointF offset );
%Docstring
Sets the annotation's frame's offset from the mapPosition() reference point.
.. seealso:: frameOffsetFromReferencePoint()
.. seealso:: :py:func:`frameOffsetFromReferencePoint()`
%End

QPointF frameOffsetFromReferencePoint() const;
%Docstring
Returns the annotation's frame's offset from the mapPosition() reference point.
.. seealso:: setFrameOffsetFromReferencePoint()
.. seealso:: :py:func:`setFrameOffsetFromReferencePoint()`
:rtype: QPointF
%End

void setFrameSize( QSizeF size );
%Docstring
Sets the size of the annotation's frame (the main area in which
the annotation's content is drawn).
.. seealso:: frameSize()
.. seealso:: :py:func:`frameSize()`
%End

QSizeF frameSize() const;
%Docstring
Returns the size of the annotation's frame (the main area in which
the annotation's content is drawn).
.. seealso:: setFrameSize()
.. seealso:: :py:func:`setFrameSize()`
:rtype: QSizeF
%End

void setContentsMargin( const QgsMargins &margins );
%Docstring
Sets the margins (in millimeters) between the outside of the frame and the annotation
content.
.. seealso:: contentsMargin()
.. seealso:: :py:func:`contentsMargin()`
%End

QgsMargins contentsMargin() const;
%Docstring
Returns the margins (in millimeters) between the outside of the frame and the annotation
content.
.. seealso:: setContentsMargin()
.. seealso:: :py:func:`setContentsMargin()`
:rtype: QgsMargins
%End

void setFillSymbol( QgsFillSymbol *symbol /Transfer/ );
%Docstring
Sets the fill symbol used for rendering the annotation frame. Ownership
of the symbol is transferred to the annotation.
.. seealso:: fillSymbol()
.. seealso:: :py:func:`fillSymbol()`
%End

QgsFillSymbol *fillSymbol() const;
%Docstring
Returns the symbol that is used for rendering the annotation frame.
.. seealso:: setFillSymbol()
.. seealso:: :py:func:`setFillSymbol()`
:rtype: QgsFillSymbol
%End

@@ -199,29 +199,29 @@ class QgsAnnotation : QObject
%Docstring
Writes the annotation state to a DOM element. Derived classes should
call _writeXml() within their implementation of this method.
.. seealso:: readXml()
.. seealso:: :py:func:`readXml()`
.. seealso:: _writeXml()
%End

virtual void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context ) = 0;
%Docstring
Restores the annotation's state from a DOM element. Derived classes should
call _readXml() within their implementation of this method.
.. seealso:: writeXml()
.. seealso:: :py:func:`writeXml()`
.. seealso:: _readXml()
%End

void setMarkerSymbol( QgsMarkerSymbol *symbol /Transfer/ );
%Docstring
Sets the symbol that is drawn at the annotation's map position. Ownership
of the symbol is transferred to the annotation.
.. seealso:: markerSymbol()
.. seealso:: :py:func:`markerSymbol()`
%End

QgsMarkerSymbol *markerSymbol() const;
%Docstring
Returns the symbol that is drawn at the annotation's map position.
.. seealso:: setMarkerSymbol()
.. seealso:: :py:func:`setMarkerSymbol()`
:rtype: QgsMarkerSymbol
%End

@@ -230,7 +230,7 @@ class QgsAnnotation : QObject
Returns the map layer associated with the annotation. Annotations can be
associated with a map layer if their visibility should be synchronized
with the layer's visibility.
.. seealso:: setMapLayer()
.. seealso:: :py:func:`setMapLayer()`
:rtype: QgsMapLayer
%End

@@ -239,21 +239,21 @@ class QgsAnnotation : QObject
Sets the map layer associated with the annotation. Annotations can be
associated with a map layer if their visibility should be synchronized
with the layer's visibility.
.. seealso:: mapLayer()
.. seealso:: :py:func:`mapLayer()`
%End

QgsFeature associatedFeature() const;
%Docstring
Returns the feature associated with the annotation, or an invalid
feature if none has been set.
.. seealso:: setAssociatedFeature()
.. seealso:: :py:func:`setAssociatedFeature()`
:rtype: QgsFeature
%End

virtual void setAssociatedFeature( const QgsFeature &feature );
%Docstring
Sets the feature associated with the annotation.
.. seealso:: associatedFeature()
.. seealso:: :py:func:`associatedFeature()`
%End

signals:
@@ -293,15 +293,15 @@ Emitted whenever the annotation's appearance changes
%Docstring
Writes common annotation properties to a DOM element.
This method should be called from subclasses in their writeXml method.
.. seealso:: writeXml()
.. seealso:: :py:func:`writeXml()`
.. seealso:: _readXml()
%End

void _readXml( const QDomElement &annotationElem, const QgsReadWriteContext &context );
%Docstring
Reads common annotation properties from a DOM element.
This method should be called from subclasses in their readXml method.
.. seealso:: readXml()
.. seealso:: :py:func:`readXml()`
.. seealso:: _writeXml()
%End

0 comments on commit e48cf98

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