1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgstemporalrangeobject.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsTemporalRangeObject
{
%Docstring(signature="appended")
Base class for objects with an associated (optional) temporal range.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgstemporalrangeobject.h"
%End
public:
QgsTemporalRangeObject( bool enabled = false );
%Docstring
Constructor QgsTemporalRangeObject.
The ``enabled`` argument specifies whether the temporal range is
initially enabled or not (see
:py:func:`~QgsTemporalRangeObject.isTemporal`).
%End
virtual ~QgsTemporalRangeObject();
void setIsTemporal( bool enabled );
%Docstring
Sets whether the temporal range is ``enabled`` (i.e. whether the object
has a temporal range which will be considered when rendering maps with a
specific time range set.)
.. seealso:: :py:func:`isTemporal`
%End
bool isTemporal() const;
%Docstring
Returns ``True`` if the object's temporal range is enabled, and the
object will be filtered when rendering maps with a specific time range
set.
For map settings, if ``False`` is returned, then any other temporal
settings relating to the map will be ignored during rendering.
.. seealso:: :py:func:`setIsTemporal`
%End
void setTemporalRange( const QgsDateTimeRange &range );
%Docstring
Sets the temporal ``range`` for the object.
Calling :py:func:`~QgsTemporalRangeObject.setTemporalRange`
automatically enables temporal properties on the object (see
:py:func:`~QgsTemporalRangeObject.isTemporal`), regardless of its
existing state.
When a temporal ``range`` is set it can be used to filter and request
time base objects.
.. seealso:: :py:func:`temporalRange`
%End
const QgsDateTimeRange &temporalRange() const;
%Docstring
Returns the datetime range for the object.
This should only be considered when
:py:func:`~QgsTemporalRangeObject.isTemporal` returns ``True``.
.. seealso:: :py:func:`setTemporalRange`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgstemporalrangeobject.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
