QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
Public Types | Signals | Public Member Functions | List of all members
QgsTemporalProperty Class Reference

Base class for temporal property. More...

#include <qgstemporalproperty.h>

Inheritance diagram for QgsTemporalProperty:
Inheritance graph
[legend]

Public Types

enum  Flag { FlagDontInvalidateCachedRendersWhenRangeChanges = 1 }
 Flags attached to the temporal property. More...
 

Signals

void changed ()
 Emitted when the temporal properties have changed. More...
 

Public Member Functions

 QgsTemporalProperty (QObject *parent=nullptr, bool enabled=false)
 Constructor for QgsTemporalProperty, with the specified parent object. More...
 
virtual QgsTemporalProperty::Flags flags () const
 Returns flags associated to the temporal property. More...
 
bool isActive () const
 Returns true if the temporal property is active. More...
 
void setIsActive (bool active)
 Sets whether the temporal property is active. More...
 

Detailed Description

Base class for temporal property.

Since
QGIS 3.14

Definition at line 35 of file qgstemporalproperty.h.

Member Enumeration Documentation

◆ Flag

Flags attached to the temporal property.

Enumerator
FlagDontInvalidateCachedRendersWhenRangeChanges 

Any cached rendering will not be invalidated when temporal range context is modified.

Definition at line 44 of file qgstemporalproperty.h.

Constructor & Destructor Documentation

◆ QgsTemporalProperty()

QgsTemporalProperty::QgsTemporalProperty ( QObject *  parent = nullptr,
bool  enabled = false 
)

Constructor for QgsTemporalProperty, with the specified parent object.

The active argument specifies whether the property is initially active (see isActive()).

Definition at line 21 of file qgstemporalproperty.cpp.

Member Function Documentation

◆ changed

void QgsTemporalProperty::changed ( )
signal

Emitted when the temporal properties have changed.

◆ flags()

virtual QgsTemporalProperty::Flags QgsTemporalProperty::flags ( ) const
inlinevirtual

Returns flags associated to the temporal property.

Reimplemented in QgsRasterLayerTemporalProperties, and QgsVectorLayerTemporalProperties.

Definition at line 74 of file qgstemporalproperty.h.

◆ isActive()

bool QgsTemporalProperty::isActive ( ) const

Returns true if the temporal property is active.

See also
setIsActive()

Definition at line 36 of file qgstemporalproperty.cpp.

◆ setIsActive()

void QgsTemporalProperty::setIsActive ( bool  active)

Sets whether the temporal property is active.

See also
isActive()

Definition at line 27 of file qgstemporalproperty.cpp.


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