Skip to content

Commit

Permalink
Dox++
Browse files Browse the repository at this point in the history
(cherry picked from commit 5a24660)
  • Loading branch information
nyalldawson committed Dec 2, 2018
1 parent 50cbb29 commit a5db9af
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
19 changes: 19 additions & 0 deletions python/core/auto_generated/symbology/qgslinesymbollayer.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,26 @@ Returns the units for lengths used in the custom dash pattern.
void setCustomDashVector( const QVector<qreal> &vector );

bool drawInsidePolygon() const;
%Docstring
Returns true if the line should only be drawn inside polygons, and any portion
of the line which falls outside the polygon should be clipped away.

This setting only has an effect when the line symbol is being
used to render polygon rings.

.. seealso:: :py:func:`setDrawInsidePolygon`
%End

void setDrawInsidePolygon( bool drawInsidePolygon );
%Docstring
Sets whether the line should only be drawn inside polygons, and any portion
of the line which falls outside the polygon should be clipped away.

This setting only has an effect when the line symbol is being
used to render polygon rings.

.. seealso:: :py:func:`drawInsidePolygon`
%End

virtual QVector<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const;

Expand Down
21 changes: 19 additions & 2 deletions src/core/symbology/qgslinesymbollayer.h
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,26 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer
QVector<qreal> customDashVector() const { return mCustomDashVector; }
void setCustomDashVector( const QVector<qreal> &vector ) { mCustomDashVector = vector; }

//Returns true if the line should only be drawn inside the polygon
/**
* Returns true if the line should only be drawn inside polygons, and any portion
* of the line which falls outside the polygon should be clipped away.
*
* This setting only has an effect when the line symbol is being
* used to render polygon rings.
*
* \see setDrawInsidePolygon()
*/
bool drawInsidePolygon() const { return mDrawInsidePolygon; }
//Set to true if the line should only be drawn inside the polygon

/**
* Sets whether the line should only be drawn inside polygons, and any portion
* of the line which falls outside the polygon should be clipped away.
*
* This setting only has an effect when the line symbol is being
* used to render polygon rings.
*
* \see drawInsidePolygon()
*/
void setDrawInsidePolygon( bool drawInsidePolygon ) { mDrawInsidePolygon = drawInsidePolygon; }

QVector<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const override;
Expand Down

0 comments on commit a5db9af

Please sign in to comment.