QGIS API Documentation 3.37.0-Master (614ebf5f6b2)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsIdentifyContext Class Reference

Identify contexts are used to encapsulate the settings to be used to perform an identify action. More...

#include <qgsidentifycontext.h>

Public Member Functions

 QgsIdentifyContext ()=default
 Constructor for QgsIdentifyContext.
 
bool isTemporal () const
 Returns true if the temporal range setting is enabled.
 
void setTemporalRange (const QgsDateTimeRange &range)
 Set datetime range to be used with the identify action.
 
void setZRange (const QgsDoubleRange &range)
 Sets the range of z-values to identify within.
 
const QgsDateTimeRangetemporalRange () const
 Returns the datetime range to be used with the identify action.
 
QgsDoubleRange zRange () const
 Returns the range of z-values to identify within, or an infinite range if no filtering by z should be applied.
 

Detailed Description

Identify contexts are used to encapsulate the settings to be used to perform an identify action.

Since
QGIS 3.16.1

Definition at line 31 of file qgsidentifycontext.h.

Constructor & Destructor Documentation

◆ QgsIdentifyContext()

QgsIdentifyContext::QgsIdentifyContext ( )
default

Constructor for QgsIdentifyContext.

Member Function Documentation

◆ isTemporal()

bool QgsIdentifyContext::isTemporal ( ) const

Returns true if the temporal range setting is enabled.

Definition at line 29 of file qgsidentifycontext.cpp.

◆ setTemporalRange()

void QgsIdentifyContext::setTemporalRange ( const QgsDateTimeRange range)

Set datetime range to be used with the identify action.

See also
temporalRange()
isTemporal()

Definition at line 19 of file qgsidentifycontext.cpp.

◆ setZRange()

void QgsIdentifyContext::setZRange ( const QgsDoubleRange range)

Sets the range of z-values to identify within.

Set to an infinite range if no filtering by z should be applied.

See also
zRange()
Since
QGIS 3.38

Definition at line 39 of file qgsidentifycontext.cpp.

◆ temporalRange()

const QgsDateTimeRange & QgsIdentifyContext::temporalRange ( ) const

Returns the datetime range to be used with the identify action.

See also
setTemporalRange()
isTemporal()

Definition at line 24 of file qgsidentifycontext.cpp.

◆ zRange()

QgsDoubleRange QgsIdentifyContext::zRange ( ) const

Returns the range of z-values to identify within, or an infinite range if no filtering by z should be applied.

See also
setZRange()
Since
QGIS 3.38

Definition at line 34 of file qgsidentifycontext.cpp.


The documentation for this class was generated from the following files: