QTimeZone Class
QTimeZone identifies how a time representation relates to UTC. More...
| Header: | #include <QTimeZone> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Core)target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
This class is equality-comparable.
Note: All functions in this class are thread-safe.
Public Types
| struct | OffsetData |
(since 6.5) enum | Initialization { LocalTime, UTC } |
| enum | NameType { DefaultName, LongName, ShortName, OffsetName } |
| OffsetDataList | |
| enum | TimeType { StandardTime, DaylightTime, GenericTime } |
Public Functions
| QTimeZone() | |
(since 6.5) | QTimeZone(QTimeZone::Initialization spec) |
| QTimeZone(const QByteArray &ianaId) | |
| QTimeZone(int offsetSeconds) | |
| QTimeZone(const QByteArray &zoneId, int offsetSeconds, const QString &name, const QString &abbreviation, QLocale::Territory territory = QLocale::AnyTerritory, const QString &comment = QString()) | |
| QTimeZone(const QTimeZone &other) | |
| QTimeZone(QTimeZone &&other) | |
| ~QTimeZone() | |
| QString | abbreviation(const QDateTime &atDateTime) const |
(since 6.5) QTimeZone | asBackendZone() const |
| QString | comment() const |
| int | daylightTimeOffset(const QDateTime &atDateTime) const |
| QString | displayName(QTimeZone::TimeType timeType, QTimeZone::NameType nameType = DefaultName, const QLocale &locale = QLocale()) const |
| QString | displayName(const QDateTime &atDateTime, QTimeZone::NameType nameType = DefaultName, const QLocale &locale = QLocale()) const |
(since 6.5) int | fixedSecondsAheadOfUtc() const |
(since 6.8) bool | hasAlternativeName(QByteArrayView alias) const |
| bool | hasDaylightTime() const |
| bool | hasTransitions() const |
| QByteArray | id() const |
| bool | isDaylightTime(const QDateTime &atDateTime) const |
(since 6.5) bool | isUtcOrFixedOffset() const |
| bool | isValid() const |
| QTimeZone::OffsetData | nextTransition(const QDateTime &afterDateTime) const |
| QTimeZone::OffsetData | offsetData(const QDateTime &forDateTime) const |
| int | offsetFromUtc(const QDateTime &atDateTime) const |
| QTimeZone::OffsetData | previousTransition(const QDateTime &beforeDateTime) const |
| int | standardTimeOffset(const QDateTime &atDateTime) const |
| void | swap(QTimeZone &other) |
(since 6.2) QLocale::Territory | territory() const |
(since 6.5) Qt::TimeSpec | timeSpec() const |
| CFTimeZoneRef | toCFTimeZone() const |
| NSTimeZone * | toNSTimeZone() const |
| QTimeZone::OffsetDataList | transitions(const QDateTime &fromDateTime, const QDateTime &toDateTime) const |
| QTimeZone & | operator=(QTimeZone &&other) |
| QTimeZone & | operator=(const QTimeZone &other) |
Static Public Members
| const int | MaxUtcOffsetSecs |
| const int | MinUtcOffsetSecs |
| QList<QByteArray> | availableTimeZoneIds() |
| QList<QByteArray> | availableTimeZoneIds(QLocale::Territory territory) |
| QList<QByteArray> | availableTimeZoneIds(int offsetSeconds) |
| QTimeZone | fromCFTimeZone(CFTimeZoneRef timeZone) |
(since 6.5) QTimeZone | fromDurationAheadOfUtc(std::chrono::seconds offset) |
| QTimeZone | fromNSTimeZone(const NSTimeZone *timeZone) |
(since 6.5) QTimeZone | fromSecondsAheadOfUtc(int offset) |
(since 6.4) QTimeZone | fromStdTimeZonePtr(const int *timeZone) |
| QByteArray | ianaIdToWindowsId(const QByteArray &ianaId) |
| bool | isTimeZoneIdAvailable(const QByteArray &ianaId) |
(since 6.5) bool | isUtcOrFixedOffset(Qt::TimeSpec spec) |
| QTimeZone | systemTimeZone() |
| QByteArray | systemTimeZoneId() |
| QTimeZone | utc() |
| QByteArray | windowsIdToDefaultIanaId(const QByteArray &windowsId) |
| QByteArray | windowsIdToDefaultIanaId(const QByteArray &windowsId, QLocale::Territory territory) |
| QList<QByteArray> | windowsIdToIanaIds(const QByteArray &windowsId) |
| QList<QByteArray> | windowsIdToIanaIds(const QByteArray &windowsId, QLocale::Territory territory) |
Related Non-Members
| bool | operator!=(const QTimeZone &lhs, const QTimeZone &rhs) |
| bool | operator==(const QTimeZone &lhs, const QTimeZone &rhs) |
Detailed Description
When dates and times are combined, the meaning of the result depends on how time is being represented. There are various international standards for representing time; one of these, UTC, corresponds to the traditional standard of solar mean time at Greenwich (a.k.a. GMT). All other time systems supported by Qt are ultimately specified in relation to UTC. An instance of this class provides a stateless calculator for conversions between UTC and other time representations.
Some time representations are simply defined at a fixed offset to UTC. Others are defined by governments for use within their jurisdictions. The latter are properly known as time zones, but QTimeZone (since Qt 6.5) is unifies their representation with that of general time systems. One time zone generally supported on most operating systems is designated local time; this is presumed to correspond to the time zone within which the user is living.
For time zones other than local time, UTC and those at fixed offsets from UTC, Qt can only provide support when the operating system provides some way to access that information. When Qt is built, the timezone feature controls whether such information is available. When it is not, some constructors and methods of QTimeZone are excluded from its API; these are documented as depending on feature timezone. Note that, even when Qt is built with this feature enabled, it may be unavailable to users whose systems are misconfigured, or where some standard packages (for example, the tzdata package on Linux) are not installed. This feature is enabled by default when time zone information is available.
This class is primarily designed for use in QDateTime; most applications will not need to access this class directly and should instead use an instance of it when constructing a QDateTime.
Note: For consistency with QDateTime, QTimeZone does not account for leap seconds.
Remarks
QTimeZone, like QDateTime, measures offsets from UTC in seconds. This contrasts with their measurement of time generally, which they do in milliseconds. Real-world time zones generally have UTC offsets that are whole-number multiples of five minutes (300 seconds), at least since well before 1970. A positive offset from UTC gives a time representation puts noon on any given day before UTC noon on that day; a negative offset puts noon after UTC noon on the same day.
Lightweight Time Representations
QTimeZone can represent UTC, local time and fixed offsets from UTC even when feature timezone is disabled. The form in which it does so is also available when the feature is enabled; it is a more lightweight form and processing using it will typically be more efficient, unless methods only available when feature timezone is enabled are being exercised. See Initialization and QTimeZone::fromSecondsAheadOfUtc(int) for how to construct these representations.
This documentation distinguishes between "time zone", used to describe a time representation described by system-supplied or standard information, and time representations more generally, which include these lightweight forms. The methods available only when feature timezone is enabled are apt to be cheaper for time zones than for lightweight time representations, for which these methods may construct a suitable transient time zone object to which to forward the query.
IANA Time Zone IDs
QTimeZone uses the IANA time zone IDs as defined in the IANA Time Zone Database (http://www.iana.org/time-zones). This is to ensure a standard ID across all supported platforms. Most platforms support the IANA IDs and the IANA Database natively, but for Windows a mapping is required to the native IDs. See below for more details.
The IANA IDs can and do change on a regular basis, and can vary depending on how recently the host system data was updated. As such you cannot rely on any given ID existing on any host system. You must use availableTimeZoneIds() to determine what IANA IDs are available.
The IANA IDs and database are also know as the Olson IDs and database, named after the original compiler of the database.
UTC Offset Time Zones
A default UTC time zone backend is provided which is always available when feature timezone is enabled. This provides a set of generic Offset From UTC time zones in the range UTC-16:00 to UTC+16:00. These time zones can be created using either the standard ISO format names, such as "UTC+00:00", as listed by availableTimeZoneIds(), or using a name of similar form in combination with the number of offset seconds.
Windows Time Zones
Windows native time zone support is severely limited compared to the standard IANA TZ Database. Windows time zones cover larger geographic areas and are thus less accurate in their conversions. They also do not support as much historical data and so may only be accurate for the current year. In particular, when MS's zone data claims that DST was observed prior to 1900 (this is historically known to be untrue), the claim is ignored and the standard time (allegedly) in force in 1900 is taken to have always been in effect.
QTimeZone uses a conversion table derived from the Unicode CLDR data to map between IANA IDs and Windows IDs. Depending on your version of Windows and Qt, this table may not be able to provide a valid conversion, in which "UTC" will be returned.
QTimeZone provides a public API to use this conversion table. The Windows ID used is the Windows Registry Key for the time zone which is also the MS Exchange EWS ID as well, but is different to the Time Zone Name (TZID) and COD code used by MS Exchange in versions before 2007.
Note: When Qt is built with the ICU library, it is used in preference to the Windows system APIs, bypassing all problems with those APIs using different names.
System Time Zone
The method systemTimeZoneId() returns the current system IANA time zone ID which on Unix-like systems will always be correct. On Windows this ID is translated from the Windows system ID using an internal translation table and the user's selected country. As a consequence there is a small chance any Windows install may have IDs not known by Qt, in which case "UTC" will be returned.
Creating a new QTimeZone instance using the system time zone ID will only produce a fixed named copy of the time zone, it will not change if the system time zone changes. QTimeZone::systemTimeZone() will return an instance representing the zone named by this system ID. Note that constructing a QDateTime using this system zone may behave differently than constructing a QDateTime that uses Qt::LocalTime as its Qt::TimeSpec, as the latter directly uses system APIs for accessing local time information, which may behave differently (and, in particular, might adapt if the user adjusts the system zone setting).
Time Zone Offsets
The difference between UTC and the local time in a time zone is expressed as an offset in seconds from UTC, i.e. the number of seconds to add to UTC to obtain the local time. The total offset is comprised of two component parts, the standard time offset and the daylight-saving time offset. The standard time offset is the number of seconds to add to UTC to obtain standard time in the time zone. The daylight-saving time offset is the number of seconds to add to the standard time offset to obtain daylight-saving time (abbreviated DST and sometimes called "daylight time" or "summer time") in the time zone. The usual case for DST (using standard time in winter, DST in summer) has a positive daylight-saving time offset. However, some zones have negative DST offsets, used in winter, with summer using standard time.
Note that the standard and DST offsets for a time zone may change over time as countries have changed DST laws or even their standard time offset.
License
This class includes data obtained from the CLDR data files under the terms of the Unicode Data Files and Software License. See Unicode Common Locale Data Repository (CLDR) for details.
See also QDateTime and QCalendar.
Member Type Documentation
[since 6.5] enum QTimeZone::Initialization
The type of the simplest lightweight time representations.
This enumeration identifies a type of lightweight time representation to pass to a QTimeZone constructor, where no further data are required. They correspond to the like-named members of Qt::TimeSpec.
| Constant | Value | Description |
|---|---|---|
QTimeZone::LocalTime | 0 | This time representation corresponds to the one implicitly used by system functions using time_t and struct tm value to map between local time and UTC time. |
QTimeZone::UTC | 1 | This time representation, Coordinated Universal Time, is the base representation to which civil time is referred in all supported time representations. It is defined by the International Telecommunication Union. |
This enum was introduced in Qt 6.5.
enum QTimeZone::NameType
The type of time zone name.
| Constant | Value | Description |
|---|---|---|
QTimeZone::DefaultName | 0 | The default form of the time zone name, one of LongName, ShortName or OffsetName |
QTimeZone::LongName | 1 | The long form of the time zone name, e.g. "Central European Time" |
QTimeZone::ShortName | 2 | The short form of the time zone name, usually an abbreviation, e.g. "CET", in locales that have one for the zone, otherwise a compact GMT-offset form, e.g. "GMT+1" |
QTimeZone::OffsetName | 3 | The standard ISO offset form of the time zone name, e.g. "UTC+01:00" |
This type is only available when feature timezone is enabled.
QTimeZone::OffsetDataList
Synonym for QList<OffsetData>.
This type is only available when feature timezone is enabled.
enum QTimeZone::TimeType
The type of time zone time, for example when requesting the name. In time zones that do not apply DST, all three values may return the same result.
| Constant | Value | Description |
|---|---|---|
QTimeZone::StandardTime | 0 | The standard time in a time zone, i.e. when Daylight-Saving is not in effect. For example when formatting a display name this will show something like "Pacific Standard Time". |
QTimeZone::DaylightTime | 1 | A time when Daylight-Saving is in effect. For example when formatting a display name this will show something like "Pacific daylight-saving time". |
QTimeZone::GenericTime | 2 | A time which is not specifically Standard or Daylight-Saving time, either an unknown time or a neutral form. For example when formatting a display name this will show something like "Pacific Time". |
This type is only available when feature timezone is enabled.
Member Function Documentation
[static, since 6.5] QTimeZone QTimeZone::fromDurationAheadOfUtc(std::chrono::seconds offset)
[static, since 6.5] QTimeZone QTimeZone::fromSecondsAheadOfUtc(int offset)
Returns a time representation at a fixed offset, in seconds, ahead of UTC.
The offset from UTC must be in the range -16 hours to +16 hours otherwise an invalid time zone will be returned. The returned QTimeZone is a lightweight time representation, not a time zone (backed by system-supplied or standard data).
If the offset is 0, the timeSpec() of the returned instance will be Qt::UTC. Otherwise, if offset is valid, timeSpec() is Qt::OffsetFromUTC. An invalid time zone, when returned, has Qt::TimeZone as its timeSpec().
This function was introduced in Qt 6.5.
See also QTimeZone(int), asBackendZone(), fixedSecondsAheadOfUtc(), MinUtcOffsetSecs, and MaxUtcOffsetSecs.
[noexcept] QTimeZone::QTimeZone()
Create a null/invalid time zone instance.
[noexcept, since 6.5] QTimeZone::QTimeZone(QTimeZone::Initialization spec)
Creates a lightweight instance describing UTC or local time.
This function was introduced in Qt 6.5.
See also fromSecondsAheadOfUtc(), asBackendZone(), utc(), and systemTimeZone().
[explicit] QTimeZone::QTimeZone(const QByteArray &ianaId)
Creates a time zone instance with the requested IANA ID ianaId.
The ID must be one of the available system IDs or a valid UTC-with-offset ID, otherwise an invalid time zone will be returned. For UTC-with-offset IDs, when they are not in fact IANA IDs, the id() of the resulting instance may differ from the ID passed to the constructor.
This constructor is only available when feature timezone is enabled.
See also availableTimeZoneIds() and id().
[explicit] QTimeZone::QTimeZone(int offsetSeconds)
Creates a time zone instance with the given offset, offsetSeconds, from UTC.
The offsetSeconds from UTC must be in the range -16 hours to +16 hours otherwise an invalid time zone will be returned.
This constructor is only available when feature timezone is enabled. The returned instance is equivalent to the lightweight time representation QTimeZone::fromSecondsAheadOfUtc(offsetSeconds), albeit implemented as a time zone.
See also MinUtcOffsetSecs, MaxUtcOffsetSecs, and id().
QTimeZone::QTimeZone(const QByteArray &zoneId, int offsetSeconds, const QString &name, const QString &abbreviation, QLocale::Territory territory = QLocale::AnyTerritory, const QString &comment = QString())
Creates a custom time zone instance at fixed offset from UTC.
The returned time zone has an ID of zoneId and an offset from UTC of offsetSeconds. The name will be the name used by displayName() for the LongName, the abbreviation will be used by displayName() for the ShortName and by abbreviation(), and the optional territory will be used by territory(). The comment is an optional note that may be displayed in a GUI to assist users in selecting a time zone.
The offsetSeconds from UTC must be in the range -16 hours to +16 hours. The zoneId must not be an ID for which isTimeZoneIdAvailable() is true, unless it is a UTC-offset name that doesn't appear in availableTimeZoneIds().
If the custom time zone does not have a specific territory then set it to the default value of QLocale::AnyTerritory.
This constructor is only available when feature timezone is enabled.
See also id(), offsetFromUtc(), displayName(), abbreviation(), territory(), comment(), MinUtcOffsetSecs, and MaxUtcOffsetSecs.
[noexcept] QTimeZone::QTimeZone(const QTimeZone &other)
Copy constructor: copy other to this.
[noexcept] QTimeZone::QTimeZone(QTimeZone &&other)
Move constructor of this from other.
[noexcept] QTimeZone::~QTimeZone()
Destroys the time zone.
QString QTimeZone::abbreviation(const QDateTime &atDateTime) const
Returns the time zone abbreviation at the given atDateTime.
The abbreviation may change depending on DST or even historical events.
Note: The abbreviation is not guaranteed to be unique to this time zone and should not be used in place of the ID or display name. The abbreviation may be localized, depending on the underlying operating system. To get consistent localization, use displayName(atDateTime, QTimeZone::ShortName, locale).
This method is only available when feature timezone is enabled.
See also displayName().
[since 6.5] QTimeZone QTimeZone::asBackendZone() const
Converts this QTimeZone to one whose timeSpec() is Qt::TimeZone.
In all cases, the result's timeSpec() is Qt::TimeZone. When this QTimeZone's timeSpec() is Qt::TimeZone, this QTimeZone itself is returned. If timeSpec() is Qt::LocalTime then systemTimeZone() is returned.
If timeSpec() is Qt::UTC, QTimeZone::utc() is returned. If it is Qt::OffsetFromUTC then QTimeZone(int) is passed its offset and the result is returned.
When using a lightweight time representation - local time, UTC time or time at a fixed offset from UTC - using methods only supported when feature timezone is enabled may be more expensive than using a corresponding time zone. This method maps a lightweight time representation to a corresponding time zone - that is, an instance based on system-supplied or standard data.
This method is only available when feature timezone is enabled.
This function was introduced in Qt 6.5.
See also QTimeZone(QTimeZone::Initialization) and fromSecondsAheadOfUtc().
[static] QList<QByteArray> QTimeZone::availableTimeZoneIds()
Returns a list of all available IANA time zone IDs on this system.
This method is only available when feature timezone is enabled.
Note: the QTimeZone constructor will also accept some UTC-offset IDs that are not in the list returned - it would be impractical to list all possible UTC-offset IDs.
See also isTimeZoneIdAvailable().
[static] QList<QByteArray> QTimeZone::availableTimeZoneIds(QLocale::Territory territory)
Returns a list of all available IANA time zone IDs for a given territory.
As a special case, a territory of AnyTerritory selects those time zones that have a non-territorial association, such as UTC, while World selects those time-zones for which there is a global default IANA ID. If you require a list of all time zone IDs for all territories then use the standard availableTimeZoneIds() method.
This method is only available when feature timezone is enabled.
See also isTimeZoneIdAvailable() and territory().
[static] QList<QByteArray> QTimeZone::availableTimeZoneIds(int offsetSeconds)
Returns a list of all available IANA time zone IDs with a given standard time offset of offsetSeconds.
Where the given offset is supported, QTimeZone(offsetSeconds).id() is included in the list, even if it is not an IANA ID. This only arises when there is no IANA UTC-offset ID with the given offset.
This method is only available when feature timezone is enabled.
See also isTimeZoneIdAvailable() and QTimeZone(int).
QString QTimeZone::comment() const
Returns any comment for the time zone.
A comment may be provided by the host platform to assist users in choosing the correct time zone. Depending on the platform this may not be localized.
This method is only available when feature timezone is enabled.
int QTimeZone::daylightTimeOffset(const QDateTime &atDateTime) const
Returns the daylight-saving time offset at the given atDateTime, i.e. the number of seconds to add to the standard time offset to obtain the local daylight-saving time.
For example, for the time zone "Europe/Berlin" the DST offset is +3600 seconds. During standard time daylightTimeOffset() will return 0, and when daylight-saving is in effect it will return +3600.
This method is only available when feature timezone is enabled.
See also offsetFromUtc() and standardTimeOffset().
QString QTimeZone::displayName(QTimeZone::TimeType timeType, QTimeZone::NameType nameType = DefaultName, const QLocale &locale = QLocale()) const
Returns the localized time zone display name.
The name returned is the one for the given locale, applicable when the given timeType is in effect and of the form indicated by nameType. Where the time zone display names have changed over time, the current names will be used. If no suitably localized name of the given type is available, another name type may be used, or an empty string may be returned.
If the locale is not provided, then the application default locale will be used. For custom timezones created by client code, the data supplied to the constructor are used, as no localization data will be available for it. If this timezone is invalid, an empty string is returned. This may also arise for the representation of local time if determining the system time zone fails.
This method is only available when feature timezone is enabled.
See also abbreviation().
QString QTimeZone::displayName(const QDateTime &atDateTime, QTimeZone::NameType nameType = DefaultName, const QLocale &locale = QLocale()) const
Returns the localized time zone display name.
The name returned is the one for the given locale, applicable at the given atDateTime, and of the form indicated by nameType. The display name may change depending on DST or historical events. If no suitably localized name of the given type is available, another name type may be used, or an empty string may be returned.
If the locale is not provided, then the application default locale will be used. For custom timezones created by client code, the data supplied to the constructor are used, as no localization data will be available for it. If this timezone is invalid, an empty string is returned. This may also arise for the representation of local time if determining the system time zone fails.
This method is only available when feature timezone is enabled.
See also abbreviation().
[constexpr noexcept, since 6.5] int QTimeZone::fixedSecondsAheadOfUtc() const
For a lightweight time representation whose timeSpec() is Qt::OffsetFromUTC, this returns the fixed offset from UTC that it describes. For any other time representation it returns 0, even if that time representation does have a constant offset from UTC.
This function was introduced in Qt 6.5.
[static] QTimeZone QTimeZone::fromCFTimeZone(CFTimeZoneRef timeZone)
Constructs a new QTimeZone containing a copy of the CFTimeZone timeZone.
See also toCFTimeZone().
[static] QTimeZone QTimeZone::fromNSTimeZone(const NSTimeZone *timeZone)
Constructs a new QTimeZone containing a copy of the NSTimeZone timeZone.
See also toNSTimeZone().
[static, since 6.4] QTimeZone QTimeZone::fromStdTimeZonePtr(const int *timeZone)
Returns a QTimeZone object representing the same time zone as timeZone. The IANA ID of timeZone must be one of the available system IDs, otherwise an invalid time zone will be returned.
This method is only available when feature timezone is enabled.
This function was introduced in Qt 6.4.
[since 6.8] bool QTimeZone::hasAlternativeName(QByteArrayView alias) const
Returns true if alias is an alternative name for this timezone.
The IANA (formerly Olson) database has renamed some zones during its history. There are also some zones that only differed prior to 1970 but are now treated as synonymous. Some backends may have data reaching to before 1970 and produce distinct zones in the latter case. Others may produce zones indistinguishable except by id(). This method determines whether an ID refers (at least since 1970) to the same zone that this timezone object describes.
This method is only available when feature timezone is enabled.
This function was introduced in Qt 6.8.
bool QTimeZone::hasDaylightTime() const
Returns true if the time zone has practiced daylight-saving at any time.
This method is only available when feature timezone is enabled.
See also isDaylightTime() and daylightTimeOffset().
bool QTimeZone::hasTransitions() const
Returns true if the system backend supports obtaining transitions.
Transitions are changes in the time-zone: these happen when DST turns on or off and when authorities alter the offsets for the time-zone.
This method is only available when feature timezone is enabled.
See also nextTransition(), previousTransition(), and transitions().
[static] QByteArray QTimeZone::ianaIdToWindowsId(const QByteArray &ianaId)
Returns the Windows ID equivalent to the given ianaId.
This method is only available when feature timezone is enabled.
See also windowsIdToDefaultIanaId() and windowsIdToIanaIds().
QByteArray QTimeZone::id() const
Returns the IANA ID for the time zone.
IANA IDs are used on all platforms. On Windows these are translated from the Windows ID into the best match IANA ID for the time zone and territory.
If this timezone instance was not constructed from an IANA ID, its ID is determined by how it was constructed. In most cases, the ID passed when constructing the instance is used. (The constructor for a custom zone uses the ID it is passed, which must not be an IANA ID.) There are two exceptions.
- Instances constructed by passing only a UTC offset in seconds have no ID passed when constructing.
- The constructor taking only an IANA ID will also accept some UTC-offset IDs that are not in fact IANA IDs: its handling of these is equivalent to passing the corresponding offset in seconds, as for the first exception.
In the two exceptional cases, if there is an IANA UTC-offset zone with the specified offset, the instance constructed uses that IANA zone's ID, even though this may differ from the (non-IANA) UTC-offset ID passed to the constructor. Otherwise, the instance uses an ID synthesized from its offset, with the form UTC±hh:mm:ss, omitting any trailing :00 for zero seconds or minutes. Again, this may differ from the UTC-offset ID passed to the constructor.
This method is only available when feature timezone is enabled.
bool QTimeZone::isDaylightTime(const QDateTime &atDateTime) const
Returns true if daylight-saving was in effect at the given atDateTime.
This method is only available when feature timezone is enabled.
See also hasDaylightTime() and daylightTimeOffset().
[static] bool QTimeZone::isTimeZoneIdAvailable(const QByteArray &ianaId)
Returns true if a given time zone ianaId is available on this system.
This may include some non-IANA IDs, notably UTC-offset IDs, that are not listed in availableTimeZoneIds().
This method is only available when feature timezone is enabled.
See also availableTimeZoneIds().
[constexpr noexcept, since 6.5] bool QTimeZone::isUtcOrFixedOffset() const
Returns true if timeSpec() is Qt::UTC or Qt::OffsetFromUTC.
When it is true, the time description does not change over time, such as having seasonal daylight-saving changes, as may happen for local time or a time zone. Knowing this may save the calling code to need for various other checks.
This function was introduced in Qt 6.5.
[static constexpr noexcept, since 6.5] bool QTimeZone::isUtcOrFixedOffset(Qt::TimeSpec spec)
Returns true if spec is Qt::UTC or Qt::OffsetFromUTC.
This function was introduced in Qt 6.5.
bool QTimeZone::isValid() const
Returns true if this time zone is valid.
QTimeZone::OffsetData QTimeZone::nextTransition(const QDateTime &afterDateTime) const
Returns the first time zone Transition after the given afterDateTime. This is most useful when you have a Transition time and wish to find the Transition after it.
If there is no transition after the given afterDateTime then an invalid OffsetData will be returned with an invalid QDateTime as its atUtc.
The given afterDateTime is exclusive.
This method is only available when feature timezone is enabled.
See also hasTransitions(), previousTransition(), and transitions().
QTimeZone::OffsetData QTimeZone::offsetData(const QDateTime &forDateTime) const
Returns the effective offset details at the given forDateTime.
This is the equivalent of calling abbreviation() and all three offset functions individually but may be more efficient and may get a different localization for the abbreviation. If this data is not available for the given datetime, an invalid OffsetData will be returned with an invalid QDateTime as its atUtc.
This method is only available when feature timezone is enabled.
See also offsetFromUtc(), standardTimeOffset(), daylightTimeOffset(), and abbreviation().
int QTimeZone::offsetFromUtc(const QDateTime &atDateTime) const
Returns the total effective offset at the given atDateTime, i.e. the number of seconds to add to UTC to obtain the local time. This includes any DST offset that may be in effect, i.e. it is the sum of standardTimeOffset() and daylightTimeOffset() for the given datetime.
For example, for the time zone "Europe/Berlin" the standard time offset is +3600 seconds and the DST offset is +3600 seconds. During standard time offsetFromUtc() will return +3600 (UTC+01:00), and during DST it will return +7200 (UTC+02:00).
This method is only available when feature timezone is enabled.
See also standardTimeOffset() and daylightTimeOffset().
QTimeZone::OffsetData QTimeZone::previousTransition(const QDateTime &beforeDateTime) const
Returns the first time zone Transition before the given beforeDateTime. This is most useful when you have a Transition time and wish to find the Transition before it.
If there is no transition before the given beforeDateTime then an invalid OffsetData will be returned with an invalid QDateTime as its atUtc.
The given beforeDateTime is exclusive.
This method is only available when feature timezone is enabled.
See also hasTransitions(), nextTransition(), and transitions().
int QTimeZone::standardTimeOffset(const QDateTime &atDateTime) const
Returns the standard time offset at the given atDateTime, i.e. the number of seconds to add to UTC to obtain the local Standard Time. This excludes any DST offset that may be in effect.
For example, for the time zone "Europe/Berlin" the standard time offset is +3600 seconds. During both standard and DST offsetFromUtc() will return +3600 (UTC+01:00).
This method is only available when feature timezone is enabled.
See also offsetFromUtc() and daylightTimeOffset().
[noexcept] void QTimeZone::swap(QTimeZone &other)
Swaps this time zone instance with other. This operation is very fast and never fails.
[static] QTimeZone QTimeZone::systemTimeZone()
Returns a QTimeZone object that describes local system time.
This method is only available when feature timezone is enabled. The returned instance is usually equivalent to the lightweight time representation QTimeZone(QTimeZone::LocalTime), albeit implemented as a time zone.
The returned object will not change to reflect any subsequent change to the system time zone. It represents the local time that was in effect when asBackendZone() was called. On misconfigured systems, such as those that lack the timezone data relied on by the backend for which Qt was compiled, it may be invalid. In such a case, a warning is output.
See also utc(), Initialization, asBackendZone(), and systemTimeZoneId().
[static] QByteArray QTimeZone::systemTimeZoneId()
Returns the current system time zone IANA ID.
Equivalent to calling systemTimeZone().id(), but may bypass some computation to obtain it. Constructing a QTimeZone from the returned byte array will produce the same result as systemTimeZone().
If the backend is unable to determine the correct system zone, the result is empty. In this case, systemTimeZone().isValid() is false and a warning is output if either this method of systemTimeZone() is called.
If the backend is able to determine the correct system zone but not its name, an empty byte array is returned. For example, on Windows, the system native ID is converted to an IANA ID - if the system ID isn't known to the internal translation code, the result shall be empty. In this case, systemTimeZone().isValid() shall be true.
This method is only available when feature timezone is enabled.
Note: Prior to Qt 6.7, when the result could not be determined, the misleading result "UTC" was returned.
See also systemTimeZone().
[since 6.2] QLocale::Territory QTimeZone::territory() const
Returns the territory for the time zone.
A return of AnyTerritory means the zone has no known territorial association. In some cases this may be because the zone has no associated territory - for example, UTC - or because the zone is used in several territories - for example, CET. In other cases, the QTimeZone backend may not know which territory the zone is associated with - for example, because it is not the primary zone of the territory in which it is used.
This method is only available when feature timezone is enabled.
This function was introduced in Qt 6.2.
[constexpr noexcept, since 6.5] Qt::TimeSpec QTimeZone::timeSpec() const
Returns a Qt::TimeSpec identifying the type of time representation.
If the result is Qt::TimeZone, this time description is a time zone (backed by system-supplied or standard data); otherwise, it is a lightweight time representation. If the result is Qt::LocalTime it describes local time: see Qt::TimeSpec for details.
This function was introduced in Qt 6.5.
See also fixedSecondsAheadOfUtc() and asBackendZone().
CFTimeZoneRef QTimeZone::toCFTimeZone() const
Creates a CFTimeZone from a QTimeZone.
The caller owns the CFTimeZone object and is responsible for releasing it.
See also fromCFTimeZone().
NSTimeZone *QTimeZone::toNSTimeZone() const
Creates an NSTimeZone from a QTimeZone.
The NSTimeZone object is autoreleased.
See also fromNSTimeZone().
QTimeZone::OffsetDataList QTimeZone::transitions(const QDateTime &fromDateTime, const QDateTime &toDateTime) const
Returns a list of all time zone transitions between the given datetimes.
The given fromDateTime and toDateTime are inclusive. The atUtc member of each entry describes the moment of the transition, at which the offsets and abbreviation given by other members take effect.
This method is only available when feature timezone is enabled.
See also hasTransitions(), nextTransition(), and previousTransition().
[static] QTimeZone QTimeZone::utc()
Returns a QTimeZone object that describes UTC as a time zone.
This method is only available when feature timezone is enabled. It is equivalent to passing 0 to QTimeZone(int offsetSeconds) and to the lightweight time representation QTimeZone(QTimeZone::UTC), albeit implemented as a time zone, unlike the latter.
See also systemTimeZone(), Initialization, and asBackendZone().
[static] QByteArray QTimeZone::windowsIdToDefaultIanaId(const QByteArray &windowsId)
Returns the default IANA ID for a given windowsId.
Because a Windows ID can cover several IANA IDs in several different territories, this function returns the most frequently used IANA ID with no regard for the territory and should thus be used with care. It is usually best to request the default for a specific territory.
This method is only available when feature timezone is enabled.
See also ianaIdToWindowsId() and windowsIdToIanaIds().
[static] QByteArray QTimeZone::windowsIdToDefaultIanaId(const QByteArray &windowsId, QLocale::Territory territory)
Returns the default IANA ID for a given windowsId and territory.
Because a Windows ID can cover several IANA IDs within a given territory, the most frequently used IANA ID in that territory is returned.
As a special case, AnyTerritory returns the default of those IANA IDs that have a non-territorial association, while World returns the default for the given windowsId in territories that have no specific association with it.
If the return is empty, there is no IANA ID specific to the given territory for this windowsId. It is reasonable, in this case, to fall back to windowsIdToDefaultIanaId(windowsId).
This method is only available when feature timezone is enabled.
See also ianaIdToWindowsId(), windowsIdToIanaIds(), and territory().
[static] QList<QByteArray> QTimeZone::windowsIdToIanaIds(const QByteArray &windowsId)
Returns all the IANA IDs for a given windowsId.
The returned list is sorted alphabetically.
This method is only available when feature timezone is enabled.
See also ianaIdToWindowsId() and windowsIdToDefaultIanaId().
[static] QList<QByteArray> QTimeZone::windowsIdToIanaIds(const QByteArray &windowsId, QLocale::Territory territory)
Returns all the IANA IDs for a given windowsId and territory.
As a special case, AnyTerritory selects those IANA IDs that have a non-territorial association, while World selects the default for the given windowsId in territories that have no specific association with it.
The returned list is in order of frequency of usage, i.e. larger zones within a territory are listed first.
This method is only available when feature timezone is enabled.
See also ianaIdToWindowsId(), windowsIdToDefaultIanaId(), and territory().
[noexcept] QTimeZone &QTimeZone::operator=(QTimeZone &&other)
Move-assigns other to this QTimeZone instance, transferring the ownership of its data to this instance.
QTimeZone &QTimeZone::operator=(const QTimeZone &other)
Assignment operator, assign other to this.
Member Variable Documentation
const int QTimeZone::MaxUtcOffsetSecs
Timezone offsets from UTC are expected to be no higher than this.
The highest UTC offset of any early 21st century timezone is +14 hours (Christmas Island, Kiribati, Kiritimati), or 14 hours east of Greenwich.
Historically, before 1867, when Russia sold Alaska to America, Alaska used the same date as Russia, so had offsets over 15 hours east of Greenwich. As Alaska was using local solar mean time, its offsets varied, but all were less than 16 hours east of Greenwich.
See also MinUtcOffsetSecs.
const int QTimeZone::MinUtcOffsetSecs
Timezone offsets from UTC are expected to be no lower than this.
The lowest UTC offset of any early 21st century timezone is -12 hours (Baker Island, USA), or 12 hours west of Greenwich.
Historically, until 1844, The Philippines (then controlled by Spain) used the same date as Spain's American holdings, so had offsets close to 16 hours west of Greenwich. As The Philippines was using local solar mean time, it is possible some outlying territory of it may have been operating at more than 16 hours west of Greenwich, but no early 21st century timezone traces its history back to such an extreme.
See also MaxUtcOffsetSecs.
Related Non-Members
[noexcept] bool operator!=(const QTimeZone &lhs, const QTimeZone &rhs)
Returns true if lhs time zone is not equal to the rhs time zone.
Two representations are different if they are internally described differently, even if they agree in their representation of all moments of time. In particular, a lightweight time representation may coincide with a time zone but the two will not be equal.
[noexcept] bool operator==(const QTimeZone &lhs, const QTimeZone &rhs)
Returns true if lhs time zone is equal to the rhs time zone.
Two representations are different if they are internally described differently, even if they agree in their representation of all moments of time. In particular, a lightweight time representation may coincide with a time zone but the two will not be equal.
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
