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

API reference - Class QDate

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QDate

Sub-classes: MonthNameType, QFlags_MonthNameType

Public constructors

new QDatenewConstructor QDate::QDate()
new QDatenew(int y,
int m,
int d)
Constructor QDate::QDate(int y, int m, int d)

Public methods

[const]bool!=(const QDate other)Method bool QDate::operator!=(const QDate &other)
[const]bool<(const QDate other)Method bool QDate::operator<(const QDate &other)
[const]bool<=(const QDate other)Method bool QDate::operator<=(const QDate &other)
[const]bool==(const QDate other)Method bool QDate::operator==(const QDate &other)
[const]bool>(const QDate other)Method bool QDate::operator>(const QDate &other)
[const]bool>=(const QDate other)Method bool QDate::operator>=(const QDate &other)
[const]QDate 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]QDateaddDays(long long days)Method QDate QDate::addDays(qint64 days)
[const]QDateaddMonths(int months)Method QDate QDate::addMonths(int months)
[const]QDateaddYears(int years)Method QDate QDate::addYears(int years)
voidassign(const QDate other)Assigns another object to self
[const]intdayMethod int QDate::day()
[const]intdayOfWeekMethod int QDate::dayOfWeek()
[const]intdayOfYearMethod int QDate::dayOfYear()
[const]intdaysInMonthMethod int QDate::daysInMonth()
[const]intdaysInYearMethod int QDate::daysInYear()
[const]long longdaysTo(const QDate arg1)Method qint64 QDate::daysTo(const QDate &)
[const]new QDate ptrdupCreates a copy of self
voidgetDate(int ptr year,
int ptr month,
int ptr day)
Method void QDate::getDate(int *year, int *month, int *day)
[const]voidgetDate(int ptr year,
int ptr month,
int ptr day)
Method void QDate::getDate(int *year, int *month, int *day)
[const]boolisNull?Method bool QDate::isNull()
[const]boolisValid?Method bool QDate::isValid()
[const]intmonthMethod int QDate::month()
boolsetDate(int year,
int month,
int day)
Method bool QDate::setDate(int year, int month, int day)
[const]long longtoJulianDayMethod qint64 QDate::toJulianDay()
[const]stringtoString(const Qt_DateFormat f = Qt::TextDate)Method QString QDate::toString(Qt::DateFormat f)
[const]stringtoString(string format)Method QString QDate::toString(const QString &format)
[const]intweekNumber(int ptr yearNum = nullptr)Method int QDate::weekNumber(int *yearNum)
[const]intyearMethod int QDate::year()

Public static methods and constants

[static,const]QDate_MonthNameTypeDateFormatEnum constant QDate::DateFormat
[static,const]QDate_MonthNameTypeStandaloneFormatEnum constant QDate::StandaloneFormat
QDatecurrentDateStatic method QDate QDate::currentDate()
QDatefromJulianDay(long long jd_)Static method QDate QDate::fromJulianDay(qint64 jd_)
QDatefromString(string s,
const Qt_DateFormat f = Qt::TextDate)
Static method QDate QDate::fromString(const QString &s, Qt::DateFormat f)
QDatefromString(string s,
string format)
Static method QDate QDate::fromString(const QString &s, const QString &format)
boolisLeapYear?(int year)Static method bool QDate::isLeapYear(int year)
boolisValid?(int y,
int m,
int d)
Static method bool QDate::isValid(int y, int m, int d)
stringlongDayName(int weekday,
const QDate_MonthNameType type = QDate::DateFormat)
Static method QString QDate::longDayName(int weekday, QDate::MonthNameType type)
stringlongMonthName(int month,
const QDate_MonthNameType type = QDate::DateFormat)
Static method QString QDate::longMonthName(int month, QDate::MonthNameType type)
stringshortDayName(int weekday,
const QDate_MonthNameType type = QDate::DateFormat)
Static method QString QDate::shortDayName(int weekday, QDate::MonthNameType type)
stringshortMonthName(int month,
const QDate_MonthNameType type = QDate::DateFormat)
Static method QString QDate::shortMonthName(int month, QDate::MonthNameType type)

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

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

<

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

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

<=

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

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

==

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

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

>

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

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

>=

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

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

DateFormat

Signature: [static,const] QDate_MonthNameType DateFormat

Description: Enum constant QDate::DateFormat

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

StandaloneFormat

Signature: [static,const] QDate_MonthNameType StandaloneFormat

Description: Enum constant QDate::StandaloneFormat

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

_const_cast

Signature: [const] QDate 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] QDate addDays (long long days)

Description: Method QDate QDate::addDays(qint64 days)

addMonths

Signature: [const] QDate addMonths (int months)

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

addYears

Signature: [const] QDate addYears (int years)

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

assign

Signature: void assign (const QDate other)

Description: Assigns another object to self

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.

currentDate

Signature: [static] QDate currentDate

Description: Static method QDate QDate::currentDate()

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

day

Signature: [const] int day

Description: Method int QDate::day()

dayOfWeek

Signature: [const] int dayOfWeek

Description: Method int QDate::dayOfWeek()

dayOfYear

Signature: [const] int dayOfYear

Description: Method int QDate::dayOfYear()

daysInMonth

Signature: [const] int daysInMonth

Description: Method int QDate::daysInMonth()

daysInYear

Signature: [const] int daysInYear

Description: Method int QDate::daysInYear()

daysTo

Signature: [const] long long daysTo (const QDate arg1)

Description: Method qint64 QDate::daysTo(const QDate &)

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 QDate ptr dup

Description: Creates a copy of self

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

fromJulianDay

Signature: [static] QDate fromJulianDay (long long jd_)

Description: Static method QDate QDate::fromJulianDay(qint64 jd_)

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

fromString

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

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

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

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

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

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

getDate

(1) Signature: void getDate (int ptr year, int ptr month, int ptr day)

Description: Method void QDate::getDate(int *year, int *month, int *day)

(2) Signature: [const] void getDate (int ptr year, int ptr month, int ptr day)

Description: Method void QDate::getDate(int *year, int *month, int *day)

isLeapYear?

Signature: [static] bool isLeapYear? (int year)

Description: Static method bool QDate::isLeapYear(int year)

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

isNull?

Signature: [const] bool isNull?

Description: Method bool QDate::isNull()

isValid?

(1) Signature: [const] bool isValid?

Description: Method bool QDate::isValid()

Python specific notes:
This instance method is available as '_inst_isValid' in Python.

(2) Signature: [static] bool isValid? (int y, int m, int d)

Description: Static method bool QDate::isValid(int y, int m, int d)

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

Python specific notes:
This class method is available as '_class_isValid' in Python.

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.

longDayName

Signature: [static] string longDayName (int weekday, const QDate_MonthNameType type = QDate::DateFormat)

Description: Static method QString QDate::longDayName(int weekday, QDate::MonthNameType type)

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

longMonthName

Signature: [static] string longMonthName (int month, const QDate_MonthNameType type = QDate::DateFormat)

Description: Static method QString QDate::longMonthName(int month, QDate::MonthNameType type)

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

month

Signature: [const] int month

Description: Method int QDate::month()

new

(1) Signature: [static] new QDate new

Description: Constructor QDate::QDate()

This method creates an object of class QDate.

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

(2) Signature: [static] new QDate new (int y, int m, int d)

Description: Constructor QDate::QDate(int y, int m, int d)

This method creates an object of class QDate.

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

setDate

Signature: bool setDate (int year, int month, int day)

Description: Method bool QDate::setDate(int year, int month, int day)

shortDayName

Signature: [static] string shortDayName (int weekday, const QDate_MonthNameType type = QDate::DateFormat)

Description: Static method QString QDate::shortDayName(int weekday, QDate::MonthNameType type)

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

shortMonthName

Signature: [static] string shortMonthName (int month, const QDate_MonthNameType type = QDate::DateFormat)

Description: Static method QString QDate::shortMonthName(int month, QDate::MonthNameType type)

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

toJulianDay

Signature: [const] long long toJulianDay

Description: Method qint64 QDate::toJulianDay()

toString

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

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

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

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

weekNumber

Signature: [const] int weekNumber (int ptr yearNum = nullptr)

Description: Method int QDate::weekNumber(int *yearNum)

year

Signature: [const] int year

Description: Method int QDate::year()