KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QTimeZone

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QTimeZone

Sub-classes: NameType, QFlags_NameType, TimeType, QFlags_TimeType, OffsetData

Public constructors

new QTimeZonenewConstructor QTimeZone::QTimeZone()
new QTimeZonenew(bytes ianaId)Constructor QTimeZone::QTimeZone(const QByteArray &ianaId)
new QTimeZonenew(int offsetSeconds)Constructor QTimeZone::QTimeZone(int offsetSeconds)
new QTimeZonenew(bytes zoneId,
int offsetSeconds,
string name,
string abbreviation,
const QLocale_Country country = QLocale::AnyCountry,
string comment = QString())
Constructor QTimeZone::QTimeZone(const QByteArray &zoneId, int offsetSeconds, const QString &name, const QString &abbreviation, QLocale::Country country, const QString &comment)
new QTimeZonenew(const QTimeZone other)Constructor QTimeZone::QTimeZone(const QTimeZone &other)

Public methods

[const]bool!=(const QTimeZone other)Method bool QTimeZone::operator!=(const QTimeZone &other)
[const]bool==(const QTimeZone other)Method bool QTimeZone::operator==(const QTimeZone &other)
void_assign(const QTimeZone other)Assigns another object to self
[const]QTimeZone ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]stringabbreviation(const QDateTime atDateTime)Method QString QTimeZone::abbreviation(const QDateTime &atDateTime)
QTimeZoneassign(const QTimeZone other)Method QTimeZone &QTimeZone::operator=(const QTimeZone &other)
[const]stringcommentMethod QString QTimeZone::comment()
[const]QLocale_CountrycountryMethod QLocale::Country QTimeZone::country()
[const]intdaylightTimeOffset(const QDateTime atDateTime)Method int QTimeZone::daylightTimeOffset(const QDateTime &atDateTime)
[const]stringdisplayName(const QDateTime atDateTime,
const QTimeZone_NameType nameType = QTimeZone::DefaultName,
const QLocale locale = QLocale())
Method QString QTimeZone::displayName(const QDateTime &atDateTime, QTimeZone::NameType nameType, const QLocale &locale)
[const]stringdisplayName(const QTimeZone_TimeType timeType,
const QTimeZone_NameType nameType = QTimeZone::DefaultName,
const QLocale locale = QLocale())
Method QString QTimeZone::displayName(QTimeZone::TimeType timeType, QTimeZone::NameType nameType, const QLocale &locale)
[const]new QTimeZone ptrdupCreates a copy of self
[const]boolhasDaylightTimeMethod bool QTimeZone::hasDaylightTime()
[const]boolhasTransitionsMethod bool QTimeZone::hasTransitions()
[const]bytesidMethod QByteArray QTimeZone::id()
[const]boolisDaylightTime?(const QDateTime atDateTime)Method bool QTimeZone::isDaylightTime(const QDateTime &atDateTime)
[const]boolisValid?Method bool QTimeZone::isValid()
[const]QTimeZone_OffsetDatanextTransition(const QDateTime afterDateTime)Method QTimeZone::OffsetData QTimeZone::nextTransition(const QDateTime &afterDateTime)
[const]QTimeZone_OffsetDataoffsetData(const QDateTime forDateTime)Method QTimeZone::OffsetData QTimeZone::offsetData(const QDateTime &forDateTime)
[const]intoffsetFromUtc(const QDateTime atDateTime)Method int QTimeZone::offsetFromUtc(const QDateTime &atDateTime)
[const]QTimeZone_OffsetDatapreviousTransition(const QDateTime beforeDateTime)Method QTimeZone::OffsetData QTimeZone::previousTransition(const QDateTime &beforeDateTime)
[const]intstandardTimeOffset(const QDateTime atDateTime)Method int QTimeZone::standardTimeOffset(const QDateTime &atDateTime)
voidswap(QTimeZone other)Method void QTimeZone::swap(QTimeZone &other)
[const]QTimeZone_OffsetData[]transitions(const QDateTime fromDateTime,
const QDateTime toDateTime)
Method QVector<QTimeZone::OffsetData> QTimeZone::transitions(const QDateTime &fromDateTime, const QDateTime &toDateTime)

Public static methods and constants

[static,const]QTimeZone_TimeTypeDaylightTimeEnum constant QTimeZone::DaylightTime
[static,const]QTimeZone_NameTypeDefaultNameEnum constant QTimeZone::DefaultName
[static,const]QTimeZone_TimeTypeGenericTimeEnum constant QTimeZone::GenericTime
[static,const]QTimeZone_NameTypeLongNameEnum constant QTimeZone::LongName
[static,const]QTimeZone_NameTypeOffsetNameEnum constant QTimeZone::OffsetName
[static,const]QTimeZone_NameTypeShortNameEnum constant QTimeZone::ShortName
[static,const]QTimeZone_TimeTypeStandardTimeEnum constant QTimeZone::StandardTime
bytes[]availableTimeZoneIdsStatic method QList<QByteArray> QTimeZone::availableTimeZoneIds()
bytes[]availableTimeZoneIds(const QLocale_Country country)Static method QList<QByteArray> QTimeZone::availableTimeZoneIds(QLocale::Country country)
bytes[]availableTimeZoneIds(int offsetSeconds)Static method QList<QByteArray> QTimeZone::availableTimeZoneIds(int offsetSeconds)
bytesianaIdToWindowsId(bytes ianaId)Static method QByteArray QTimeZone::ianaIdToWindowsId(const QByteArray &ianaId)
boolisTimeZoneIdAvailable?(bytes ianaId)Static method bool QTimeZone::isTimeZoneIdAvailable(const QByteArray &ianaId)
QTimeZonesystemTimeZoneStatic method QTimeZone QTimeZone::systemTimeZone()
bytessystemTimeZoneIdStatic method QByteArray QTimeZone::systemTimeZoneId()
QTimeZoneutcStatic method QTimeZone QTimeZone::utc()
byteswindowsIdToDefaultIanaId(bytes windowsId)Static method QByteArray QTimeZone::windowsIdToDefaultIanaId(const QByteArray &windowsId)
byteswindowsIdToDefaultIanaId(bytes windowsId,
const QLocale_Country country)
Static method QByteArray QTimeZone::windowsIdToDefaultIanaId(const QByteArray &windowsId, QLocale::Country country)
bytes[]windowsIdToIanaIds(bytes windowsId)Static method QList<QByteArray> QTimeZone::windowsIdToIanaIds(const QByteArray &windowsId)
bytes[]windowsIdToIanaIds(bytes windowsId,
const QLocale_Country country)
Static method QList<QByteArray> QTimeZone::windowsIdToIanaIds(const QByteArray &windowsId, QLocale::Country country)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QTimeZone other)

Description: Method bool QTimeZone::operator!=(const QTimeZone &other)

==

Signature: [const] bool == (const QTimeZone other)

Description: Method bool QTimeZone::operator==(const QTimeZone &other)

DaylightTime

Signature: [static,const] QTimeZone_TimeType DaylightTime

Description: Enum constant QTimeZone::DaylightTime

Python specific notes:
The object exposes a readable attribute 'DaylightTime'. This is the getter.

DefaultName

Signature: [static,const] QTimeZone_NameType DefaultName

Description: Enum constant QTimeZone::DefaultName

Python specific notes:
The object exposes a readable attribute 'DefaultName'. This is the getter.

GenericTime

Signature: [static,const] QTimeZone_TimeType GenericTime

Description: Enum constant QTimeZone::GenericTime

Python specific notes:
The object exposes a readable attribute 'GenericTime'. This is the getter.

LongName

Signature: [static,const] QTimeZone_NameType LongName

Description: Enum constant QTimeZone::LongName

Python specific notes:
The object exposes a readable attribute 'LongName'. This is the getter.

OffsetName

Signature: [static,const] QTimeZone_NameType OffsetName

Description: Enum constant QTimeZone::OffsetName

Python specific notes:
The object exposes a readable attribute 'OffsetName'. This is the getter.

ShortName

Signature: [static,const] QTimeZone_NameType ShortName

Description: Enum constant QTimeZone::ShortName

Python specific notes:
The object exposes a readable attribute 'ShortName'. This is the getter.

StandardTime

Signature: [static,const] QTimeZone_TimeType StandardTime

Description: Enum constant QTimeZone::StandardTime

Python specific notes:
The object exposes a readable attribute 'StandardTime'. This is the getter.

_assign

Signature: void _assign (const QTimeZone other)

Description: Assigns another object to self

_const_cast

Signature: [const] QTimeZone ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

abbreviation

Signature: [const] string abbreviation (const QDateTime atDateTime)

Description: Method QString QTimeZone::abbreviation(const QDateTime &atDateTime)

assign

Signature: QTimeZone assign (const QTimeZone other)

Description: Method QTimeZone &QTimeZone::operator=(const QTimeZone &other)

availableTimeZoneIds

(1) Signature: [static] bytes[] availableTimeZoneIds

Description: Static method QList<QByteArray> QTimeZone::availableTimeZoneIds()

This method is static and can be called without an instance.

(2) Signature: [static] bytes[] availableTimeZoneIds (const QLocale_Country country)

Description: Static method QList<QByteArray> QTimeZone::availableTimeZoneIds(QLocale::Country country)

This method is static and can be called without an instance.

(3) Signature: [static] bytes[] availableTimeZoneIds (int offsetSeconds)

Description: Static method QList<QByteArray> QTimeZone::availableTimeZoneIds(int offsetSeconds)

This method is static and can be called without an instance.

comment

Signature: [const] string comment

Description: Method QString QTimeZone::comment()

country

Signature: [const] QLocale_Country country

Description: Method QLocale::Country QTimeZone::country()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

daylightTimeOffset

Signature: [const] int daylightTimeOffset (const QDateTime atDateTime)

Description: Method int QTimeZone::daylightTimeOffset(const QDateTime &atDateTime)

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

displayName

(1) Signature: [const] string displayName (const QDateTime atDateTime, const QTimeZone_NameType nameType = QTimeZone::DefaultName, const QLocale locale = QLocale())

Description: Method QString QTimeZone::displayName(const QDateTime &atDateTime, QTimeZone::NameType nameType, const QLocale &locale)

(2) Signature: [const] string displayName (const QTimeZone_TimeType timeType, const QTimeZone_NameType nameType = QTimeZone::DefaultName, const QLocale locale = QLocale())

Description: Method QString QTimeZone::displayName(QTimeZone::TimeType timeType, QTimeZone::NameType nameType, const QLocale &locale)

dup

Signature: [const] new QTimeZone ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hasDaylightTime

Signature: [const] bool hasDaylightTime

Description: Method bool QTimeZone::hasDaylightTime()

hasTransitions

Signature: [const] bool hasTransitions

Description: Method bool QTimeZone::hasTransitions()

ianaIdToWindowsId

Signature: [static] bytes ianaIdToWindowsId (bytes ianaId)

Description: Static method QByteArray QTimeZone::ianaIdToWindowsId(const QByteArray &ianaId)

This method is static and can be called without an instance.

id

Signature: [const] bytes id

Description: Method QByteArray QTimeZone::id()

isDaylightTime?

Signature: [const] bool isDaylightTime? (const QDateTime atDateTime)

Description: Method bool QTimeZone::isDaylightTime(const QDateTime &atDateTime)

isTimeZoneIdAvailable?

Signature: [static] bool isTimeZoneIdAvailable? (bytes ianaId)

Description: Static method bool QTimeZone::isTimeZoneIdAvailable(const QByteArray &ianaId)

This method is static and can be called without an instance.

isValid?

Signature: [const] bool isValid?

Description: Method bool QTimeZone::isValid()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new QTimeZone new

Description: Constructor QTimeZone::QTimeZone()

This method creates an object of class QTimeZone.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QTimeZone new (bytes ianaId)

Description: Constructor QTimeZone::QTimeZone(const QByteArray &ianaId)

This method creates an object of class QTimeZone.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QTimeZone new (int offsetSeconds)

Description: Constructor QTimeZone::QTimeZone(int offsetSeconds)

This method creates an object of class QTimeZone.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QTimeZone new (bytes zoneId, int offsetSeconds, string name, string abbreviation, const QLocale_Country country = QLocale::AnyCountry, string comment = QString())

Description: Constructor QTimeZone::QTimeZone(const QByteArray &zoneId, int offsetSeconds, const QString &name, const QString &abbreviation, QLocale::Country country, const QString &comment)

This method creates an object of class QTimeZone.

Python specific notes:
This method is the default initializer of the object.

(5) Signature: [static] new QTimeZone new (const QTimeZone other)

Description: Constructor QTimeZone::QTimeZone(const QTimeZone &other)

This method creates an object of class QTimeZone.

Python specific notes:
This method is the default initializer of the object.

nextTransition

Signature: [const] QTimeZone_OffsetData nextTransition (const QDateTime afterDateTime)

Description: Method QTimeZone::OffsetData QTimeZone::nextTransition(const QDateTime &afterDateTime)

offsetData

Signature: [const] QTimeZone_OffsetData offsetData (const QDateTime forDateTime)

Description: Method QTimeZone::OffsetData QTimeZone::offsetData(const QDateTime &forDateTime)

offsetFromUtc

Signature: [const] int offsetFromUtc (const QDateTime atDateTime)

Description: Method int QTimeZone::offsetFromUtc(const QDateTime &atDateTime)

previousTransition

Signature: [const] QTimeZone_OffsetData previousTransition (const QDateTime beforeDateTime)

Description: Method QTimeZone::OffsetData QTimeZone::previousTransition(const QDateTime &beforeDateTime)

standardTimeOffset

Signature: [const] int standardTimeOffset (const QDateTime atDateTime)

Description: Method int QTimeZone::standardTimeOffset(const QDateTime &atDateTime)

swap

Signature: void swap (QTimeZone other)

Description: Method void QTimeZone::swap(QTimeZone &other)

systemTimeZone

Signature: [static] QTimeZone systemTimeZone

Description: Static method QTimeZone QTimeZone::systemTimeZone()

This method is static and can be called without an instance.

systemTimeZoneId

Signature: [static] bytes systemTimeZoneId

Description: Static method QByteArray QTimeZone::systemTimeZoneId()

This method is static and can be called without an instance.

transitions

Signature: [const] QTimeZone_OffsetData[] transitions (const QDateTime fromDateTime, const QDateTime toDateTime)

Description: Method QVector<QTimeZone::OffsetData> QTimeZone::transitions(const QDateTime &fromDateTime, const QDateTime &toDateTime)

utc

Signature: [static] QTimeZone utc

Description: Static method QTimeZone QTimeZone::utc()

This method is static and can be called without an instance.

windowsIdToDefaultIanaId

(1) Signature: [static] bytes windowsIdToDefaultIanaId (bytes windowsId)

Description: Static method QByteArray QTimeZone::windowsIdToDefaultIanaId(const QByteArray &windowsId)

This method is static and can be called without an instance.

(2) Signature: [static] bytes windowsIdToDefaultIanaId (bytes windowsId, const QLocale_Country country)

Description: Static method QByteArray QTimeZone::windowsIdToDefaultIanaId(const QByteArray &windowsId, QLocale::Country country)

This method is static and can be called without an instance.

windowsIdToIanaIds

(1) Signature: [static] bytes[] windowsIdToIanaIds (bytes windowsId)

Description: Static method QList<QByteArray> QTimeZone::windowsIdToIanaIds(const QByteArray &windowsId)

This method is static and can be called without an instance.

(2) Signature: [static] bytes[] windowsIdToIanaIds (bytes windowsId, const QLocale_Country country)

Description: Static method QList<QByteArray> QTimeZone::windowsIdToIanaIds(const QByteArray &windowsId, QLocale::Country country)

This method is static and can be called without an instance.