QGIS/python/core/auto_generated/qgsprojecttimesettings.sip.in
Samweli Mwakisambwe 0facf5450d
QGIS Project temporal settings
Adds the ability to set a temporal range for a project
2020-03-07 07:43:13 +10:00

85 lines
2.3 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsprojecttimesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProjectTimeSettings : QObject
{
%Docstring
Contains temporal settings and properties for the project,
this will be used in animating/showing temporal layers.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsprojecttimesettings.h"
%End
public:
QgsProjectTimeSettings( QObject *parent = 0 );
%Docstring
Constructor for QgsProjectTimeSettings with the specified ``parent`` object.
%End
void reset();
%Docstring
Resets the settings to a default state.
%End
QgsDateTimeRange temporalRange() const;
%Docstring
Returns the project temporal range.
.. seealso:: :py:func:`setTemporalRange`
%End
void setTemporalRange( const QgsDateTimeRange &extent );
%Docstring
Sets the project temporal range
.. seealso:: :py:func:`temporalRange`
%End
bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
%Docstring
Reads the settings's state from a DOM element.
.. seealso:: :py:func:`writeXml`
%End
QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const;
%Docstring
Returns a DOM element representing the settings.
.. seealso:: :py:func:`readXml`
%End
signals:
void temporalRangeChanged();
%Docstring
Emitted when temporal range changes.
.. seealso:: :py:func:`temporalRange`
.. seealso:: :py:func:`setTemporalRange`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsprojecttimesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/