Skip to content
Permalink
Browse files

Doxygen

  • Loading branch information
nyalldawson committed Dec 11, 2018
1 parent d8eac47 commit cd762da817bc3d4994afba7904582ec7153e4bc6
@@ -590,22 +590,22 @@ The geometry is specified using the map's destinationCrs().
%Docstring
Sets a list of ``regions`` to avoid placing labels within.

.. versionadded:: 3.6

.. seealso:: :py:func:`labelBlockingRegions`

.. seealso:: :py:func:`setLabelBoundaryGeometry`

.. versionadded:: 3.6
%End

QList< QgsLabelBlockingRegion > labelBlockingRegions() const;
%Docstring
Returns the list of regions to avoid placing labels within.

.. versionadded:: 3.6

.. seealso:: :py:func:`setLabelBlockingRegions`

.. seealso:: :py:func:`labelBoundaryGeometry`

.. versionadded:: 3.6
%End

protected:
@@ -248,7 +248,7 @@ void QgsLabelingEngine::run( QgsRenderContext &context )
// get map label boundary geometry - if one hasn't been explicitly set, we use the whole of the map's visible polygon
QgsGeometry mapBoundaryGeom = !mMapSettings.labelBoundaryGeometry().isNull() ? mMapSettings.labelBoundaryGeometry() : QgsGeometry::fromQPolygonF( visiblePoly );

// label blocking regions work by "chopping away" those regions from the permissible labelling area
// label blocking regions work by "chopping away" those regions from the permissible labeling area
const QList< QgsLabelBlockingRegion > blockingRegions = mMapSettings.labelBlockingRegions();
for ( const QgsLabelBlockingRegion &region : blockingRegions )
{
@@ -518,17 +518,17 @@ class CORE_EXPORT QgsMapSettings

/**
* Sets a list of \a regions to avoid placing labels within.
* \since QGIS 3.6
* \see labelBlockingRegions()
* \see setLabelBoundaryGeometry()
* \since QGIS 3.6
*/
void setLabelBlockingRegions( const QList< QgsLabelBlockingRegion > &regions ) { mLabelBlockingRegions = regions; }

/**
* Returns the list of regions to avoid placing labels within.
* \since QGIS 3.6
* \see setLabelBlockingRegions()
* \see labelBoundaryGeometry()
* \since QGIS 3.6
*/
QList< QgsLabelBlockingRegion > labelBlockingRegions() const { return mLabelBlockingRegions; }

0 comments on commit cd762da

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