Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Dox++
  • Loading branch information
nyalldawson committed Mar 6, 2020
1 parent 326f583 commit 266d920
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
10 changes: 7 additions & 3 deletions python/gui/auto_generated/qgsmapcanvas.sip.in
Expand Up @@ -732,11 +732,15 @@ for the canvas.
%End


void setTemporalRange( const QgsDateTimeRange &dateTimeRange );
void setTemporalRange( const QgsDateTimeRange &range );
%Docstring
Set datetime range for the map canvas.
Set datetime ``range`` for the map canvas.

Emits temporalRangeChanged(), after a successful update.
The temporalRangeChanged() signal will be emitted if the temporal range has been changed.

.. note::

Calling setTemporalRange() does not automatically trigger a map refresh.

.. seealso:: :py:func:`temporalRange`

Expand Down
8 changes: 5 additions & 3 deletions src/gui/qgsmapcanvas.h
Expand Up @@ -670,14 +670,16 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView
void setCustomDropHandlers( const QVector<QPointer<QgsCustomDropHandler >> &handlers ) SIP_SKIP;

/**
* Set datetime range for the map canvas.
* Set datetime \a range for the map canvas.
*
* Emits temporalRangeChanged(), after a successful update.
* The temporalRangeChanged() signal will be emitted if the temporal range has been changed.
*
* \note Calling setTemporalRange() does not automatically trigger a map refresh.
*
* \see temporalRange()
* \since QGIS 3.14
*/
void setTemporalRange( const QgsDateTimeRange &dateTimeRange );
void setTemporalRange( const QgsDateTimeRange &range );

/**
* Returns map canvas datetime range.
Expand Down

0 comments on commit 266d920

Please sign in to comment.