Skip to content

Commit

Permalink
[rotated_ticks] add missing since 3.16 doctags
Browse files Browse the repository at this point in the history
  • Loading branch information
olivierdalang committed Sep 1, 2020
1 parent 426c869 commit 498e7fc
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 5 deletions.
32 changes: 32 additions & 0 deletions python/core/auto_generated/layout/qgslayoutitemmapgrid.sip.in
Expand Up @@ -864,111 +864,143 @@ framePenSize method.
Enable/disable ticks rotation for rotated or reprojected grids.

.. seealso:: :py:func:`rotatedTicksEnabled`

.. versionadded:: 3.16
%End

double rotatedTicksEnabled() const;
%Docstring
Gets whether ticks rotation for rotated or reprojected grids is enabled.

.. seealso:: :py:func:`setRotatedTicksEnabled`

.. versionadded:: 3.16
%End

void setRotatedTicksLengthMode( const TickLengthMode mode );
%Docstring
Sets the tick length calculation mode.

.. seealso:: :py:func:`rotatedTicksLengthMode`

.. versionadded:: 3.16
%End

TickLengthMode rotatedTicksLengthMode() const;
%Docstring
Returns the grid frame style.

.. seealso:: :py:func:`setRotatedTicksLengthMode`

.. versionadded:: 3.16
%End

void setRotatedTicksMinimumAngle( const double angle );
%Docstring
Sets the ``minimum`` angle (in degrees) below which ticks are not drawn.

.. seealso:: :py:func:`rotatedTicksMinimumAngle`

.. versionadded:: 3.16
%End

double rotatedTicksMinimumAngle() const;
%Docstring
Gets the ``minimum`` angle (in degrees) below which ticks are not drawn.

.. seealso:: :py:func:`setRotatedTicksMinimumAngle`

.. versionadded:: 3.16
%End

void setRotatedTicksMarginToCorner( const double margin );
%Docstring
Sets the ``margin`` to corners (in canvas units) below which outwards facing ticks are not drawn.

.. seealso:: :py:func:`rotatedTicksMarginToCorner`

.. versionadded:: 3.16
%End

double rotatedTicksMarginToCorner() const;
%Docstring
Gets the ``margin`` to corners (in canvas units) below which outwards facing ticks are not drawn.

.. seealso:: :py:func:`setRotatedTicksMarginToCorner`

.. versionadded:: 3.16
%End

void setRotatedAnnotationsEnabled( const bool state );
%Docstring
Enable/disable annotations rotation for rotated or reprojected grids.

.. seealso:: :py:func:`rotatedAnnotationsEnabled`

.. versionadded:: 3.16
%End

double rotatedAnnotationsEnabled() const;
%Docstring
Gets whether annotations rotation for rotated or reprojected grids is enabled.

.. seealso:: :py:func:`setRotatedAnnotationsEnabled`

.. versionadded:: 3.16
%End

void setRotatedAnnotationsLengthMode( const TickLengthMode mode );
%Docstring
Sets the annotation length calculation mode.

.. seealso:: :py:func:`rotatedAnnotationsLengthMode`

.. versionadded:: 3.16
%End

TickLengthMode rotatedAnnotationsLengthMode() const;
%Docstring
Returns the grid frame style.

.. seealso:: :py:func:`setRotatedAnnotationsLengthMode`

.. versionadded:: 3.16
%End

void setRotatedAnnotationsMinimumAngle( const double angle );
%Docstring
Sets the ``minimum`` angle (in degrees) below which annotated are not drawn.

.. seealso:: :py:func:`rotatedAnnotationsMinimumAngle`

.. versionadded:: 3.16
%End

double rotatedAnnotationsMinimumAngle() const;
%Docstring
Gets the ``minimum`` angle (in degrees) below which annotated are not drawn.

.. seealso:: :py:func:`setRotatedAnnotationsMinimumAngle`

.. versionadded:: 3.16
%End

void setRotatedAnnotationsMarginToCorner( const double margin );
%Docstring
Sets the ``margin`` to corners (in canvas units) below which outwards facing ticks are not drawn.

.. seealso:: :py:func:`rotatedAnnotationsMarginToCorner`

.. versionadded:: 3.16
%End

double rotatedAnnotationsMarginToCorner() const;
%Docstring
Gets the ``margin`` to corners (in canvas units) below which outwards facing ticks are not drawn.

.. seealso:: :py:func:`setRotatedAnnotationsMarginToCorner`

.. versionadded:: 3.16
%End

void setFrameMargin( const double margin );
Expand Down
26 changes: 21 additions & 5 deletions src/core/layout/qgslayoutitemmapgrid.h
Expand Up @@ -813,96 +813,112 @@ class CORE_EXPORT QgsLayoutItemMapGrid : public QgsLayoutItemMapItem
/**
* Enable/disable ticks rotation for rotated or reprojected grids.
* \see rotatedTicksEnabled()
* \since QGIS 3.16
*/
void setRotatedTicksEnabled( const bool state ) { mRotatedTicksEnabled = state; }

/**
* Gets whether ticks rotation for rotated or reprojected grids is enabled.
* \see setRotatedTicksEnabled()
* \since QGIS 3.16
*/
double rotatedTicksEnabled() const { return mRotatedTicksEnabled; }

/**
* Sets the tick length calculation mode.
* \see rotatedTicksLengthMode()
*/
* Sets the tick length calculation mode.
* \see rotatedTicksLengthMode()
* \since QGIS 3.16
*/
void setRotatedTicksLengthMode( const TickLengthMode mode ) { mRotatedTicksLengthMode = mode; }

/**
* Returns the grid frame style.
* \see setRotatedTicksLengthMode()
* \since QGIS 3.16
*/
TickLengthMode rotatedTicksLengthMode() const { return mRotatedTicksLengthMode; }

/**
* Sets the \a minimum angle (in degrees) below which ticks are not drawn.
* \see rotatedTicksMinimumAngle()
* \since QGIS 3.16
*/
void setRotatedTicksMinimumAngle( const double angle ) { mRotatedTicksMinimumAngle = angle; }

/**
* Gets the \a minimum angle (in degrees) below which ticks are not drawn.
* \see setRotatedTicksMinimumAngle()
* \since QGIS 3.16
*/
double rotatedTicksMinimumAngle() const { return mRotatedTicksMinimumAngle; }

/**
* Sets the \a margin to corners (in canvas units) below which outwards facing ticks are not drawn.
* \see rotatedTicksMarginToCorner()
* \since QGIS 3.16
*/
void setRotatedTicksMarginToCorner( const double margin ) { mRotatedTicksMarginToCorner = margin; }

/**
* Gets the \a margin to corners (in canvas units) below which outwards facing ticks are not drawn.
* \see setRotatedTicksMarginToCorner()
* \since QGIS 3.16
*/
double rotatedTicksMarginToCorner() const { return mRotatedTicksMarginToCorner; }

/**
* Enable/disable annotations rotation for rotated or reprojected grids.
* \see rotatedAnnotationsEnabled()
* \since QGIS 3.16
*/
void setRotatedAnnotationsEnabled( const bool state ) { mRotatedAnnotationsEnabled = state; }

/**
* Gets whether annotations rotation for rotated or reprojected grids is enabled.
* \see setRotatedAnnotationsEnabled()
* \since QGIS 3.16
*/
double rotatedAnnotationsEnabled() const { return mRotatedAnnotationsEnabled; }

/**
* Sets the annotation length calculation mode.
* \see rotatedAnnotationsLengthMode()
* Sets the annotation length calculation mode.
* \see rotatedAnnotationsLengthMode()
* \since QGIS 3.16
*/
void setRotatedAnnotationsLengthMode( const TickLengthMode mode ) { mRotatedAnnotationsLengthMode = mode; }

/**
* Returns the grid frame style.
* \see setRotatedAnnotationsLengthMode()
* \since QGIS 3.16
*/
TickLengthMode rotatedAnnotationsLengthMode() const { return mRotatedAnnotationsLengthMode; }

/**
* Sets the \a minimum angle (in degrees) below which annotated are not drawn.
* \see rotatedAnnotationsMinimumAngle()
* \since QGIS 3.16
*/
void setRotatedAnnotationsMinimumAngle( const double angle ) { mRotatedAnnotationsMinimumAngle = angle; }

/**
* Gets the \a minimum angle (in degrees) below which annotated are not drawn.
* \see setRotatedAnnotationsMinimumAngle()
* \since QGIS 3.16
*/
double rotatedAnnotationsMinimumAngle() const { return mRotatedAnnotationsMinimumAngle; }

/**
* Sets the \a margin to corners (in canvas units) below which outwards facing ticks are not drawn.
* \see rotatedAnnotationsMarginToCorner()
* \since QGIS 3.16
*/
void setRotatedAnnotationsMarginToCorner( const double margin ) { mRotatedAnnotationsMarginToCorner = margin; }

/**
* Gets the \a margin to corners (in canvas units) below which outwards facing ticks are not drawn.
* \see setRotatedAnnotationsMarginToCorner()
* \since QGIS 3.16
*/
double rotatedAnnotationsMarginToCorner() const { return mRotatedAnnotationsMarginToCorner; }

Expand Down

0 comments on commit 498e7fc

Please sign in to comment.