Skip to content

Commit

Permalink
Doxygen for QgsRubberband
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn authored and nyalldawson committed Sep 29, 2018
1 parent fc7df32 commit 8fdf34b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
10 changes: 7 additions & 3 deletions python/gui/auto_generated/qgsrubberband.sip.in
Expand Up @@ -46,13 +46,17 @@ for tracking the mouse while drawing polylines or polygons.
%Docstring
Creates a new RubberBand.

:param mapCanvas: The map canvas to draw onto. It's CRS will be used map points onto screen coordinates.
:param geometryType: Defines how the data should be drawn onto the screen. (Use Qgis.Line, Qgis.Polygon or Qgis.Point)
:param mapCanvas: The map canvas to draw onto.
Its CRS will be used map points onto screen coordinates.
The ownership is transferred to this canvas.
:param geometryType: Defines how the data should be drawn onto the screen.
QgsWkbTypes.LineGeometry, QgsWkbTypes.PolygonGeometry or QgsWkbTypes.PointGeometry
%End

void setColor( const QColor &color );
%Docstring
Sets the color for the rubberband
Sets the color for the rubberband.
Shorthand method to set fill and stroke color with a single call.

:param color: The color used to render this rubberband
%End
Expand Down
10 changes: 7 additions & 3 deletions src/gui/qgsrubberband.h
Expand Up @@ -87,13 +87,17 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem

/**
* Creates a new RubberBand.
* \param mapCanvas The map canvas to draw onto. It's CRS will be used map points onto screen coordinates.
* \param geometryType Defines how the data should be drawn onto the screen. (Use Qgis::Line, Qgis::Polygon or Qgis::Point)
* \param mapCanvas The map canvas to draw onto.
* Its CRS will be used map points onto screen coordinates.
* The ownership is transferred to this canvas.
* \param geometryType Defines how the data should be drawn onto the screen.
* QgsWkbTypes::LineGeometry, QgsWkbTypes::PolygonGeometry or QgsWkbTypes::PointGeometry
*/
QgsRubberBand( QgsMapCanvas *mapCanvas SIP_TRANSFERTHIS, QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry );

/**
* Sets the color for the rubberband
* Sets the color for the rubberband.
* Shorthand method to set fill and stroke color with a single call.
* \param color The color used to render this rubberband
*/
void setColor( const QColor &color );
Expand Down

0 comments on commit 8fdf34b

Please sign in to comment.