KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QDateTime

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QDateTime

Public constructors

new QDateTimenewConstructor QDateTime::QDateTime()
new QDateTimenew(const QDate arg1)Constructor QDateTime::QDateTime(const QDate &)
new QDateTimenew(const QDate arg1,
const QTime arg2,
const Qt_TimeSpec spec = Qt::LocalTime)
Constructor QDateTime::QDateTime(const QDate &, const QTime &, Qt::TimeSpec spec)
new QDateTimenew(const QDateTime other)Constructor QDateTime::QDateTime(const QDateTime &other)

Public methods

[const]bool!=(const QDateTime other)Method bool QDateTime::operator!=(const QDateTime &other)
[const]bool<(const QDateTime other)Method bool QDateTime::operator<(const QDateTime &other)
[const]bool<=(const QDateTime other)Method bool QDateTime::operator<=(const QDateTime &other)
[const]bool==(const QDateTime other)Method bool QDateTime::operator==(const QDateTime &other)
[const]bool>(const QDateTime other)Method bool QDateTime::operator>(const QDateTime &other)
[const]bool>=(const QDateTime other)Method bool QDateTime::operator>=(const QDateTime &other)
void_assign(const QDateTime other)Assigns another object to self
[const]QDateTime 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]QDateTimeaddDays(int days)Method QDateTime QDateTime::addDays(int days)
[const]QDateTimeaddMSecs(long long msecs)Method QDateTime QDateTime::addMSecs(qint64 msecs)
[const]QDateTimeaddMonths(int months)Method QDateTime QDateTime::addMonths(int months)
[const]QDateTimeaddSecs(int secs)Method QDateTime QDateTime::addSecs(int secs)
[const]QDateTimeaddYears(int years)Method QDateTime QDateTime::addYears(int years)
QDateTimeassign(const QDateTime other)Method QDateTime &QDateTime::operator=(const QDateTime &other)
[const]QDatedateMethod QDate QDateTime::date()
voiddate=(const QDate date)Method void QDateTime::setDate(const QDate &date)
[const]intdaysTo(const QDateTime arg1)Method int QDateTime::daysTo(const QDateTime &)
[const]new QDateTime ptrdupCreates a copy of self
[const]boolisNull?Method bool QDateTime::isNull()
[const]boolisValid?Method bool QDateTime::isValid()
[const]intsecsTo(const QDateTime arg1)Method int QDateTime::secsTo(const QDateTime &)
voidsetDate(const QDate date)Method void QDateTime::setDate(const QDate &date)
voidsetTime(const QTime time)Method void QDateTime::setTime(const QTime &time)
voidsetTimeSpec(const Qt_TimeSpec spec)Method void QDateTime::setTimeSpec(Qt::TimeSpec spec)
voidsetTime_t(unsigned int secsSince1Jan1970UTC)Method void QDateTime::setTime_t(unsigned int secsSince1Jan1970UTC)
voidsetUtcOffset(int seconds)Method void QDateTime::setUtcOffset(int seconds)
[const]QTimetimeMethod QTime QDateTime::time()
voidtime=(const QTime time)Method void QDateTime::setTime(const QTime &time)
[const]Qt_TimeSpectimeSpecMethod Qt::TimeSpec QDateTime::timeSpec()
voidtimeSpec=(const Qt_TimeSpec spec)Method void QDateTime::setTimeSpec(Qt::TimeSpec spec)
[const]QDateTimetoLocalTimeMethod QDateTime QDateTime::toLocalTime()
[const]stringtoString(const Qt_DateFormat f = Qt::TextDate)Method QString QDateTime::toString(Qt::DateFormat f)
[const]stringtoString(string format)Method QString QDateTime::toString(const QString &format)
[const]QDateTimetoTimeSpec(const Qt_TimeSpec spec)Method QDateTime QDateTime::toTimeSpec(Qt::TimeSpec spec)
[const]unsigned inttoTime_tMethod unsigned int QDateTime::toTime_t()
[const]QDateTimetoUTCMethod QDateTime QDateTime::toUTC()
[const]intutcOffsetMethod int QDateTime::utcOffset()
voidutcOffset=(int seconds)Method void QDateTime::setUtcOffset(int seconds)

Public static methods and constants

QDateTimecurrentDateTimeStatic method QDateTime QDateTime::currentDateTime()
QDateTimefromString(string s,
const Qt_DateFormat f = Qt::TextDate)
Static method QDateTime QDateTime::fromString(const QString &s, Qt::DateFormat f)
QDateTimefromString(string s,
string format)
Static method QDateTime QDateTime::fromString(const QString &s, const QString &format)
QDateTimefromTime_t(unsigned int secsSince1Jan1970UTC)Static method QDateTime QDateTime::fromTime_t(unsigned int secsSince1Jan1970UTC)

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 QDateTime other)

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

<

Signature: [const] bool < (const QDateTime other)

Description: Method bool QDateTime::operator<(const QDateTime &other)

<=

Signature: [const] bool <= (const QDateTime other)

Description: Method bool QDateTime::operator<=(const QDateTime &other)

==

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

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

>

Signature: [const] bool > (const QDateTime other)

Description: Method bool QDateTime::operator>(const QDateTime &other)

>=

Signature: [const] bool >= (const QDateTime other)

Description: Method bool QDateTime::operator>=(const QDateTime &other)

_assign

Signature: void _assign (const QDateTime other)

Description: Assigns another object to self

_const_cast

Signature: [const] QDateTime 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.

addDays

Signature: [const] QDateTime addDays (int days)

Description: Method QDateTime QDateTime::addDays(int days)

addMSecs

Signature: [const] QDateTime addMSecs (long long msecs)

Description: Method QDateTime QDateTime::addMSecs(qint64 msecs)

addMonths

Signature: [const] QDateTime addMonths (int months)

Description: Method QDateTime QDateTime::addMonths(int months)

addSecs

Signature: [const] QDateTime addSecs (int secs)

Description: Method QDateTime QDateTime::addSecs(int secs)

addYears

Signature: [const] QDateTime addYears (int years)

Description: Method QDateTime QDateTime::addYears(int years)

assign

Signature: QDateTime assign (const QDateTime other)

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

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.

currentDateTime

Signature: [static] QDateTime currentDateTime

Description: Static method QDateTime QDateTime::currentDateTime()

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

date

Signature: [const] QDate date

Description: Method QDate QDateTime::date()

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

date=

Signature: void date= (const QDate date)

Description: Method void QDateTime::setDate(const QDate &date)

Python specific notes:
The object exposes a writable attribute 'date'. This is the setter.

daysTo

Signature: [const] int daysTo (const QDateTime arg1)

Description: Method int QDateTime::daysTo(const QDateTime &)

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.

dup

Signature: [const] new QDateTime ptr dup

Description: Creates a copy of self

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

fromString

(1) Signature: [static] QDateTime fromString (string s, const Qt_DateFormat f = Qt::TextDate)

Description: Static method QDateTime QDateTime::fromString(const QString &s, Qt::DateFormat f)

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

(2) Signature: [static] QDateTime fromString (string s, string format)

Description: Static method QDateTime QDateTime::fromString(const QString &s, const QString &format)

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

fromTime_t

Signature: [static] QDateTime fromTime_t (unsigned int secsSince1Jan1970UTC)

Description: Static method QDateTime QDateTime::fromTime_t(unsigned int secsSince1Jan1970UTC)

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

isNull?

Signature: [const] bool isNull?

Description: Method bool QDateTime::isNull()

isValid?

Signature: [const] bool isValid?

Description: Method bool QDateTime::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 QDateTime new

Description: Constructor QDateTime::QDateTime()

This method creates an object of class QDateTime.

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

(2) Signature: [static] new QDateTime new (const QDate arg1)

Description: Constructor QDateTime::QDateTime(const QDate &)

This method creates an object of class QDateTime.

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

(3) Signature: [static] new QDateTime new (const QDate arg1, const QTime arg2, const Qt_TimeSpec spec = Qt::LocalTime)

Description: Constructor QDateTime::QDateTime(const QDate &, const QTime &, Qt::TimeSpec spec)

This method creates an object of class QDateTime.

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

(4) Signature: [static] new QDateTime new (const QDateTime other)

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

This method creates an object of class QDateTime.

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

secsTo

Signature: [const] int secsTo (const QDateTime arg1)

Description: Method int QDateTime::secsTo(const QDateTime &)

setDate

Signature: void setDate (const QDate date)

Description: Method void QDateTime::setDate(const QDate &date)

Python specific notes:
The object exposes a writable attribute 'date'. This is the setter.

setTime

Signature: void setTime (const QTime time)

Description: Method void QDateTime::setTime(const QTime &time)

Python specific notes:
The object exposes a writable attribute 'time'. This is the setter.

setTimeSpec

Signature: void setTimeSpec (const Qt_TimeSpec spec)

Description: Method void QDateTime::setTimeSpec(Qt::TimeSpec spec)

Python specific notes:
The object exposes a writable attribute 'timeSpec'. This is the setter.

setTime_t

Signature: void setTime_t (unsigned int secsSince1Jan1970UTC)

Description: Method void QDateTime::setTime_t(unsigned int secsSince1Jan1970UTC)

setUtcOffset

Signature: void setUtcOffset (int seconds)

Description: Method void QDateTime::setUtcOffset(int seconds)

Python specific notes:
The object exposes a writable attribute 'utcOffset'. This is the setter.

time

Signature: [const] QTime time

Description: Method QTime QDateTime::time()

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

time=

Signature: void time= (const QTime time)

Description: Method void QDateTime::setTime(const QTime &time)

Python specific notes:
The object exposes a writable attribute 'time'. This is the setter.

timeSpec

Signature: [const] Qt_TimeSpec timeSpec

Description: Method Qt::TimeSpec QDateTime::timeSpec()

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

timeSpec=

Signature: void timeSpec= (const Qt_TimeSpec spec)

Description: Method void QDateTime::setTimeSpec(Qt::TimeSpec spec)

Python specific notes:
The object exposes a writable attribute 'timeSpec'. This is the setter.

toLocalTime

Signature: [const] QDateTime toLocalTime

Description: Method QDateTime QDateTime::toLocalTime()

toString

(1) Signature: [const] string toString (const Qt_DateFormat f = Qt::TextDate)

Description: Method QString QDateTime::toString(Qt::DateFormat f)

(2) Signature: [const] string toString (string format)

Description: Method QString QDateTime::toString(const QString &format)

toTimeSpec

Signature: [const] QDateTime toTimeSpec (const Qt_TimeSpec spec)

Description: Method QDateTime QDateTime::toTimeSpec(Qt::TimeSpec spec)

toTime_t

Signature: [const] unsigned int toTime_t

Description: Method unsigned int QDateTime::toTime_t()

toUTC

Signature: [const] QDateTime toUTC

Description: Method QDateTime QDateTime::toUTC()

utcOffset

Signature: [const] int utcOffset

Description: Method int QDateTime::utcOffset()

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

utcOffset=

Signature: void utcOffset= (int seconds)

Description: Method void QDateTime::setUtcOffset(int seconds)

Python specific notes:
The object exposes a writable attribute 'utcOffset'. This is the setter.