Class: QgsProcessingParameterDateTime¶

A datetime (or pure date or time) parameter for processing algorithms.

QgsProcessingParameterDateTime should be evaluated by calling QgsProcessingAlgorithm.parameterAsDateTime(), which will return a date time value.

Added in version 3.14.

Class Hierarchy¶

Base classes¶

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

Enums

Type

alias of ProcessingDateTimeParameterDataType

Methods

`dataType`	Returns the acceptable data type for the parameter.
`maximum`	Returns the maximum value acceptable by the parameter.
`minimum`	Returns the minimum value acceptable by the parameter.
`setDataType`	Sets the acceptable data type for the parameter.
`setMaximum`	Sets the maximum value acceptable by the parameter.
`setMinimum`	Sets the minimum value acceptable by the parameter.

Static Methods

`fromScriptCode`	Creates a new parameter using the definition from a script code.
`typeName`	Returns the type name for the parameter class.

class qgis.core.QgsProcessingParameterDateTime[source]¶

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', type: Qgis.ProcessingDateTimeParameterDataType = Qgis.ProcessingDateTimeParameterDataType.DateTime, defaultValue: Any = None, optional: bool = False, minValue: QDateTime | datetime.datetime = QDateTime(), maxValue: QDateTime | datetime.datetime = QDateTime())

Constructor for QgsProcessingParameterDateTime.

Parameters:

name (Optional[str])
description (Optional[str] = '')
type (Qgis.ProcessingDateTimeParameterDataType = Qgis.ProcessingDateTimeParameterDataType.DateTime)
defaultValue (Any = None)
optional (bool = False)
minValue (Union[QDateTime, datetime.datetime] = QDateTime())
maxValue (Union[QDateTime, datetime.datetime] = QDateTime())

__init__(a0: QgsProcessingParameterDateTime)

Parameters:: a0 (QgsProcessingParameterDateTime)

Type¶: alias of ProcessingDateTimeParameterDataType

dataType(self) → Qgis.ProcessingDateTimeParameterDataType[source]¶

Returns the acceptable data type for the parameter.

See also

setDataType()

Return type:: Qgis.ProcessingDateTimeParameterDataType

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterDateTime | None[source]¶

Creates a new parameter using the definition from a script code.

Parameters:

name (Optional[str])
description (Optional[str])
isOptional (bool)
definition (Optional[str])

Return type:

Optional[QgsProcessingParameterDateTime]

maximum(self) → QDateTime[source]¶

Returns the maximum value acceptable by the parameter.

An invalid QDateTime value indicates no maximum value.

See also

setMaximum()

Return type:: QDateTime

minimum(self) → QDateTime[source]¶

Returns the minimum value acceptable by the parameter.

An invalid QDateTime value indicates no minimum value.

See also

setMinimum()

Return type:: QDateTime

setDataType(self, type: Qgis.ProcessingDateTimeParameterDataType)[source]¶

Sets the acceptable data type for the parameter.

See also

dataType()

Parameters:: type (Qgis.ProcessingDateTimeParameterDataType)

setMaximum(self, maximum: QDateTime | datetime.datetime)[source]¶

Sets the maximum value acceptable by the parameter.

An invalid QDateTime value indicates no maximum value.

If the dataType() is QgsProcessingParameterDateTime.Time, then the date component of maximum must be set to any valid date (but this date will not actually be considered when comparing parameter values to the specified maximum value, only the time component will be considered).

See also

maximum()

Parameters:: maximum (Union[QDateTime, datetime.datetime])

setMinimum(self, minimum: QDateTime | datetime.datetime)[source]¶

Sets the minimum value acceptable by the parameter.

An invalid QDateTime value indicates no minimum value.

If the dataType() is QgsProcessingParameterDateTime.Time, then the date component of minimum must be set to any valid date (but this date will not actually be considered when comparing parameter values to the specified minimum value, only the time component will be considered).

See also

minimum()

Parameters:: minimum (Union[QDateTime, datetime.datetime])

static typeName() → str[source]¶

Returns the type name for the parameter class.

Return type:: str