QGIS/python/PyQt6/core/auto_generated/qgsidentifycontext.sip.in
2024-08-13 20:28:55 +10:00

80 lines
2.3 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsidentifycontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsIdentifyContext
{
%Docstring(signature="appended")
Identify contexts are used to encapsulate the settings to be used to perform
an identify action.
.. versionadded:: 3.16.1
%End
%TypeHeaderCode
#include "qgsidentifycontext.h"
%End
public:
QgsIdentifyContext();
void setTemporalRange( const QgsDateTimeRange &range );
%Docstring
Set datetime ``range`` to be used with the identify action.
.. seealso:: :py:func:`temporalRange`
.. seealso:: :py:func:`isTemporal`
%End
const QgsDateTimeRange &temporalRange() const;
%Docstring
Returns the datetime range to be used with the identify action.
.. seealso:: :py:func:`setTemporalRange`
.. seealso:: :py:func:`isTemporal`
%End
bool isTemporal() const;
%Docstring
Returns ``True`` if the temporal range setting is enabled.
%End
QgsDoubleRange zRange() const;
%Docstring
Returns the range of z-values to identify within, or an infinite range if no filtering by
z should be applied.
.. seealso:: :py:func:`setZRange`
.. versionadded:: 3.38
%End
void setZRange( const QgsDoubleRange &range );
%Docstring
Sets the ``range`` of z-values to identify within.
Set to an infinite range if no filtering by z should be applied.
.. seealso:: :py:func:`zRange`
.. versionadded:: 3.38
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsidentifycontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/