Struct qt_core::QDate

#[repr(C)]pub struct QDate { /* fields omitted */ }

The QDate class provides date functions.

C++ class: QDate.

C++ documentation:

The QDate class provides date functions.

A QDate object contains a calendar date, i.e. year, month, and day numbers, in the Gregorian calendar. It can read the current date from the system clock. It provides functions for comparing dates, and for manipulating dates. For example, it is possible to add and subtract days, months, and years to dates.

A QDate object is typically created by giving the year, month, and day numbers explicitly. Note that QDate interprets two digit years as is, i.e., years 0 - 99. A QDate can also be constructed with the static function currentDate(), which creates a QDate object containing the system clock's date. An explicit date can also be set using setDate(). The fromString() function returns a QDate given a string and a date format which is used to interpret the date within the string.

The year(), month(), and day() functions provide access to the year, month, and day numbers. Also, dayOfWeek() and dayOfYear() functions are provided. The same information is provided in textual format by the toString(), shortDayName(), longDayName(), shortMonthName(), and longMonthName() functions.

QDate provides a full set of operators to compare two QDate objects where smaller means earlier, and larger means later.

You can increment (or decrement) a date by a given number of days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two dates.

The daysInMonth() and daysInYear() functions return how many days there are in this date's month and year, respectively. The isLeapYear() function indicates whether a date is in a leap year.

No Year 0

There is no year 0. Dates in that year are considered invalid. The year -1 is the year "1 before Christ" or "1 before current era." The day before 1 January 1 CE is 31 December 1 BCE.

Range of Valid Dates

Dates are stored internally as a Julian Day number, an integer count of every day in a contiguous range, with 24 November 4714 BCE in the Gregorian calendar being Julian Day 0 (1 January 4713 BCE in the Julian calendar). As well as being an efficient and accurate way of storing an absolute date, it is suitable for converting a Date into other calendar systems such as Hebrew, Islamic or Chinese. The Julian Day number can be obtained using QDate::toJulianDay() and can be set using QDate::fromJulianDay().

The range of dates able to be stored by QDate as a Julian Day number is for technical reasons limited to between -784350574879 and 784354017364, which means from before 2 billion BCE to after 2 billion CE.

Methods

impl QDate

pub unsafe fn add_days(&self, days: i64) -> CppBox<QDate>

Returns a QDate object containing a date ndays later than the date of this object (or earlier if ndays is negative).

Calls C++ function: QDate QDate::addDays(qint64 days) const.

C++ documentation:

Returns a QDate object containing a date ndays later than the date of this object (or earlier if ndays is negative).

Returns a null date if the current date is invalid or the new date is out of range.

See also addMonths(), addYears(), and daysTo().

pub unsafe fn add_months_1a(&self, months: c_int) -> CppBox<QDate>

Returns a QDate object containing a date nmonths later than the date of this object (or earlier if nmonths is negative).

Calls C++ function: QDate QDate::addMonths(int months) const.

C++ documentation:

Returns a QDate object containing a date nmonths later than the date of this object (or earlier if nmonths is negative).

Note: If the ending day/month combination does not exist in the resulting month/year, this function will return a date that is the latest valid date.

See also addDays() and addYears().

pub unsafe fn add_months_2a(
    &self,
    months: c_int,
    cal: impl CastInto<Ref<QCalendar>>
) -> CppBox<QDate>

This is supported on cpp_lib_version="5.14.0" only.

Returns a QDate object containing a date nmonths later than the date of this object (or earlier if nmonths is negative).

Calls C++ function: QDate QDate::addMonths(int months, QCalendar cal) const.

C++ documentation:

Returns a QDate object containing a date nmonths later than the date of this object (or earlier if nmonths is negative).

Uses cal as calendar, if supplied, else the Gregorian calendar.

Note: If the ending day/month combination does not exist in the resulting month/year, this function will return a date that is the latest valid date in the selected month.

See also addDays() and addYears().

pub unsafe fn add_years_1a(&self, years: c_int) -> CppBox<QDate>

Returns a QDate object containing a date nyears later than the date of this object (or earlier if nyears is negative).

Calls C++ function: QDate QDate::addYears(int years) const.

C++ documentation:

Returns a QDate object containing a date nyears later than the date of this object (or earlier if nyears is negative).

Note: If the ending day/month combination does not exist in the resulting year (i.e., if the date was Feb 29 and the final year is not a leap year), this function will return a date that is the latest valid date (that is, Feb 28).

See also addDays() and addMonths().

pub unsafe fn add_years_2a(
    &self,
    years: c_int,
    cal: impl CastInto<Ref<QCalendar>>
) -> CppBox<QDate>

This is supported on cpp_lib_version="5.14.0" only.

Returns a QDate object containing a date nyears later than the date of this object (or earlier if nyears is negative).

Calls C++ function: QDate QDate::addYears(int years, QCalendar cal) const.

C++ documentation:

Returns a QDate object containing a date nyears later than the date of this object (or earlier if nyears is negative).

Uses cal as calendar, if supplied, else the Gregorian calendar.

Note: If the ending day/month combination does not exist in the resulting year (e.g., for the Gregorian calendar, if the date was Feb 29 and the final year is not a leap year), this function will return a date that is the latest valid date in the given month (in the example, Feb 28).

See also addDays() and addMonths().

pub unsafe fn copy_from(&self, other: impl CastInto<Ref<QDate>>) -> Ref<QDate>

The QDate class provides date functions.

Calls C++ function: QDate& QDate::operator=(const QDate& other).

C++ documentation:

The QDate class provides date functions.

A QDate object contains a calendar date, i.e. year, month, and day numbers, in the Gregorian calendar. It can read the current date from the system clock. It provides functions for comparing dates, and for manipulating dates. For example, it is possible to add and subtract days, months, and years to dates.

A QDate object is typically created by giving the year, month, and day numbers explicitly. Note that QDate interprets two digit years as is, i.e., years 0 - 99. A QDate can also be constructed with the static function currentDate(), which creates a QDate object containing the system clock's date. An explicit date can also be set using setDate(). The fromString() function returns a QDate given a string and a date format which is used to interpret the date within the string.

The year(), month(), and day() functions provide access to the year, month, and day numbers. Also, dayOfWeek() and dayOfYear() functions are provided. The same information is provided in textual format by the toString(), shortDayName(), longDayName(), shortMonthName(), and longMonthName() functions.

QDate provides a full set of operators to compare two QDate objects where smaller means earlier, and larger means later.

You can increment (or decrement) a date by a given number of days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two dates.

The daysInMonth() and daysInYear() functions return how many days there are in this date's month and year, respectively. The isLeapYear() function indicates whether a date is in a leap year.

No Year 0

There is no year 0. Dates in that year are considered invalid. The year -1 is the year "1 before Christ" or "1 before current era." The day before 1 January 1 CE is 31 December 1 BCE.

Range of Valid Dates

Dates are stored internally as a Julian Day number, an integer count of every day in a contiguous range, with 24 November 4714 BCE in the Gregorian calendar being Julian Day 0 (1 January 4713 BCE in the Julian calendar). As well as being an efficient and accurate way of storing an absolute date, it is suitable for converting a Date into other calendar systems such as Hebrew, Islamic or Chinese. The Julian Day number can be obtained using QDate::toJulianDay() and can be set using QDate::fromJulianDay().

The range of dates able to be stored by QDate as a Julian Day number is for technical reasons limited to between -784350574879 and 784354017364, which means from before 2 billion BCE to after 2 billion CE.

pub unsafe fn current_date() -> CppBox<QDate>

Returns the current date, as reported by the system clock.

Calls C++ function: static QDate QDate::currentDate().

C++ documentation:

Returns the current date, as reported by the system clock.

See also QTime::currentTime() and QDateTime::currentDateTime().

pub unsafe fn day_0a(&self) -> c_int

Returns the day of the month (1 to 31) of this date.

Calls C++ function: int QDate::day() const.

C++ documentation:

Returns the day of the month (1 to 31) of this date.

Returns 0 if the date is invalid.

See also year(), month(), and dayOfWeek().

pub unsafe fn day_1a(&self, cal: impl CastInto<Ref<QCalendar>>) -> c_int

This is supported on cpp_lib_version="5.14.0" only.

Returns the day of the month for this date.

Calls C++ function: int QDate::day(QCalendar cal) const.

C++ documentation:

Returns the day of the month for this date.

Uses cal as calendar if supplied, else the Gregorian calendar (for which the return ranges from 1 to 31). Returns 0 if the date is invalid.

See also year(), month(), and dayOfWeek().

pub unsafe fn day_of_week_0a(&self) -> c_int

Returns the weekday (1 = Monday to 7 = Sunday) for this date.

Calls C++ function: int QDate::dayOfWeek() const.

C++ documentation:

Returns the weekday (1 = Monday to 7 = Sunday) for this date.

Returns 0 if the date is invalid.

See also day(), dayOfYear(), and Qt::DayOfWeek.

pub unsafe fn day_of_week_1a(&self, cal: impl CastInto<Ref<QCalendar>>) -> c_int

This is supported on cpp_lib_version="5.14.0" only.

Returns the weekday (1 = Monday to 7 = Sunday) for this date.

Calls C++ function: int QDate::dayOfWeek(QCalendar cal) const.

C++ documentation:

Returns the weekday (1 = Monday to 7 = Sunday) for this date.

Uses cal as calendar if supplied, else the Gregorian calendar. Returns 0 if the date is invalid. Some calendars may give special meaning (e.g. intercallary days) to values greater than 7.

See also day(), dayOfYear(), and Qt::DayOfWeek.

pub unsafe fn day_of_year_0a(&self) -> c_int

Returns the day of the year (1 to 365 or 366 on leap years) for this date.

Calls C++ function: int QDate::dayOfYear() const.

C++ documentation:

Returns the day of the year (1 to 365 or 366 on leap years) for this date.

Returns 0 if the date is invalid.

See also day() and dayOfWeek().

pub unsafe fn day_of_year_1a(&self, cal: impl CastInto<Ref<QCalendar>>) -> c_int

This is supported on cpp_lib_version="5.14.0" only.

Returns the day of the year (1 for the first day) for this date.

Calls C++ function: int QDate::dayOfYear(QCalendar cal) const.

C++ documentation:

Returns the day of the year (1 for the first day) for this date.

Uses cal as calendar if supplied, else the Gregorian calendar. Returns 0 if either the date or the first day of its year is invalid.

See also day() and dayOfWeek().

pub unsafe fn days_in_month_0a(&self) -> c_int

Returns the number of days in the month (28 to 31) for this date.

Calls C++ function: int QDate::daysInMonth() const.

C++ documentation:

Returns the number of days in the month (28 to 31) for this date.

Returns 0 if the date is invalid.

See also day() and daysInYear().

pub unsafe fn days_in_month_1a(
    &self,
    cal: impl CastInto<Ref<QCalendar>>
) -> c_int

This is supported on cpp_lib_version="5.14.0" only.

Returns the number of days in the month for this date.

Calls C++ function: int QDate::daysInMonth(QCalendar cal) const.

C++ documentation:

Returns the number of days in the month for this date.

Uses cal as calendar if supplied, else the Gregorian calendar (for which the result ranges from 28 to 31). Returns 0 if the date is invalid.

See also day() and daysInYear().

pub unsafe fn days_in_year_0a(&self) -> c_int

Returns the number of days in the year (365 or 366) for this date.

Calls C++ function: int QDate::daysInYear() const.

C++ documentation:

Returns the number of days in the year (365 or 366) for this date.

Returns 0 if the date is invalid.

See also day() and daysInMonth().

pub unsafe fn days_in_year_1a(
    &self,
    cal: impl CastInto<Ref<QCalendar>>
) -> c_int

This is supported on cpp_lib_version="5.14.0" only.

Returns the number of days in the year for this date.

Calls C++ function: int QDate::daysInYear(QCalendar cal) const.

C++ documentation:

Returns the number of days in the year for this date.

Uses cal as calendar if supplied, else the Gregorian calendar (for which the result is 365 or 366). Returns 0 if the date is invalid.

See also day() and daysInMonth().

pub unsafe fn days_to(&self, arg1: impl CastInto<Ref<QDate>>) -> i64

Returns the number of days from this date to d (which is negative if d is earlier than this date).

Calls C++ function: qint64 QDate::daysTo(const QDate& arg1) const.

C++ documentation:

Returns the number of days from this date to d (which is negative if d is earlier than this date).

Returns 0 if either date is invalid.

Example:

QDate d1(1995, 5, 17);  // May 17, 1995
QDate d2(1995, 5, 20);  // May 20, 1995
d1.daysTo(d2);          // returns 3
d2.daysTo(d1);          // returns -3

See also addDays().

pub unsafe fn end_of_day_time_spec_int(
    &self,
    spec: TimeSpec,
    offset_seconds: c_int
) -> CppBox<QDateTime>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: QDateTime QDate::endOfDay(Qt::TimeSpec spec = …, int offsetSeconds = …) const.

pub unsafe fn end_of_day_q_time_zone(
    &self,
    zone: impl CastInto<Ref<QTimeZone>>
) -> CppBox<QDateTime>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: QDateTime QDate::endOfDay(const QTimeZone& zone) const.

pub unsafe fn end_of_day_time_spec(&self, spec: TimeSpec) -> CppBox<QDateTime>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: QDateTime QDate::endOfDay(Qt::TimeSpec spec = …) const.

pub unsafe fn end_of_day(&self) -> CppBox<QDateTime>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: QDateTime QDate::endOfDay() const.

pub unsafe fn from_julian_day(jd: i64) -> CppBox<QDate>

Converts the Julian day jd to a QDate.

Calls C++ function: static QDate QDate::fromJulianDay(qint64 jd_).

C++ documentation:

Converts the Julian day jd to a QDate.

See also toJulianDay().

pub unsafe fn from_string_q_string_date_format(
    s: impl CastInto<Ref<QString>>,
    f: DateFormat
) -> CppBox<QDate>

Returns the QDate represented by the string, using the format given, or an invalid date if the string cannot be parsed.

Calls C++ function: static QDate QDate::fromString(const QString& s, Qt::DateFormat f = …).

C++ documentation:

Returns the QDate represented by the string, using the format given, or an invalid date if the string cannot be parsed.

Note for Qt::TextDate: It is recommended that you use the English short month names (e.g. "Jan"). Although localized month names can also be used, they depend on the user's locale settings.

See also toString() and QLocale::toDate().

pub unsafe fn from_string_2_q_string(
    s: impl CastInto<Ref<QString>>,
    format: impl CastInto<Ref<QString>>
) -> CppBox<QDate>

Returns the QDate represented by the string, using the format given, or an invalid date if the string cannot be parsed.

Calls C++ function: static QDate QDate::fromString(const QString& s, const QString& format).

C++ documentation:

Returns the QDate represented by the string, using the format given, or an invalid date if the string cannot be parsed.

These expressions may be used for the format:

Expression	Output
d	The day as a number without a leading zero (1 to 31)
dd	The day as a number with a leading zero (01 to 31)
ddd	The abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses the system locale to localize the name, i.e. QLocale::system().
dddd	The long localized day name (e.g. 'Monday' to 'Sunday'). Uses the system locale to localize the name, i.e. QLocale::system().
M	The month as a number without a leading zero (1 to 12)
MM	The month as a number with a leading zero (01 to 12)
MMM	The abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses the system locale to localize the name, i.e. QLocale::system().
MMMM	The long localized month name (e.g. 'January' to 'December'). Uses the system locale to localize the name, i.e. QLocale::system().
yy	The year as two digit number (00 to 99)
yyyy	The year as four digit number. If the year is negative, a minus sign is prepended in addition.

All other input characters will be treated as text. Any sequence of characters that are enclosed in single quotes will also be treated as text and will not be used as an expression. For example:

QDate date = QDate::fromString("1MM12car2003", "d'MM'MMcaryyyy");
// date is 1 December 2003

If the format is not satisfied, an invalid QDate is returned. The expressions that don't expect leading zeroes (d, M) will be greedy. This means that they will use two digits even if this will put them outside the accepted range of values and leaves too few digits for other sections. For example, the following format string could have meant January 30 but the M will grab two digits, resulting in an invalid date:

QDate date = QDate::fromString("130", "Md"); // invalid

For any field that is not represented in the format the following defaults are used:

Field	Default value
Year	1900
Month	1
Day	1

The following examples demonstrate the default values:

QDate::fromString("1.30", "M.d");           // January 30 1900
QDate::fromString("20000110", "yyyyMMdd");  // January 10, 2000
QDate::fromString("20000110", "yyyyMd");    // January 10, 2000

See also toString(), QDateTime::fromString(), QTime::fromString(), and QLocale::toDate().

pub unsafe fn from_string_q_string(
    s: impl CastInto<Ref<QString>>
) -> CppBox<QDate>

Returns the QDate represented by the string, using the format given, or an invalid date if the string cannot be parsed.

Calls C++ function: static QDate QDate::fromString(const QString& s).

C++ documentation:

Returns the QDate represented by the string, using the format given, or an invalid date if the string cannot be parsed.

Note for Qt::TextDate: It is recommended that you use the English short month names (e.g. "Jan"). Although localized month names can also be used, they depend on the user's locale settings.

See also toString() and QLocale::toDate().

pub unsafe fn from_string_2_q_string_q_calendar(
    s: impl CastInto<Ref<QString>>,
    format: impl CastInto<Ref<QString>>,
    cal: impl CastInto<Ref<QCalendar>>
) -> CppBox<QDate>

This is supported on cpp_lib_version="5.14.0" only.

Returns the QDate represented by the string, using the format given, or an invalid date if the string cannot be parsed.

Calls C++ function: static QDate QDate::fromString(const QString& s, const QString& format, QCalendar cal).

C++ documentation:

Returns the QDate represented by the string, using the format given, or an invalid date if the string cannot be parsed.

Uses cal as calendar if supplied, else the Gregorian calendar. Ranges of values in the format descriptions below are for the latter; they may be different for other calendars.

These expressions may be used for the format:

Expression	Output
d	The day as a number without a leading zero (1 to 31)
dd	The day as a number with a leading zero (01 to 31)
ddd	The abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses the system locale to localize the name, i.e. QLocale::system().
dddd	The long localized day name (e.g. 'Monday' to 'Sunday'). Uses the system locale to localize the name, i.e. QLocale::system().
M	The month as a number without a leading zero (1 to 12)
MM	The month as a number with a leading zero (01 to 12)
MMM	The abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses the system locale to localize the name, i.e. QLocale::system().
MMMM	The long localized month name (e.g. 'January' to 'December'). Uses the system locale to localize the name, i.e. QLocale::system().
yy	The year as a two digit number (00 to 99)
yyyy	The year as a four digit number, possibly plus a leading minus sign for negative years.

Note: Unlike the other version of this function, day and month names must be given in the user's local language. It is only possible to use the English names if the user's language is English.

All other input characters will be treated as text. Any sequence of characters that are enclosed in single quotes will also be treated as text and will not be used as an expression. For example:

  QDate date = QDate::fromString("1MM12car2003", "d'MM'MMcaryyyy");
  // date is 1 December 2003

If the format is not satisfied, an invalid QDate is returned. The expressions that don't expect leading zeroes (d, M) will be greedy. This means that they will use two digits even if this will put them outside the accepted range of values and leaves too few digits for other sections. For example, the following format string could have meant January 30 but the M will grab two digits, resulting in an invalid date:

  QDate date = QDate::fromString("130", "Md"); // invalid

For any field that is not represented in the format the following defaults are used:

Field	Default value
Year	1900
Month	1
Day	1

The following examples demonstrate the default values:

  QDate::fromString("1.30", "M.d");           // January 30 1900
  QDate::fromString("20000110", "yyyyMMdd");  // January 10, 2000
  QDate::fromString("20000110", "yyyyMd");    // January 10, 2000

See also toString(), QDateTime::fromString(), QTime::fromString(), and QLocale::toDate().

pub unsafe fn get_date_mut(
    &self,
    year: *mut c_int,
    month: *mut c_int,
    day: *mut c_int
)

Extracts the date's year, month, and day, and assigns them to *year, *month, and *day. The pointers may be null.

Calls C++ function: void QDate::getDate(int* year, int* month, int* day).

C++ documentation:

Extracts the date's year, month, and day, and assigns them to *year, *month, and *day. The pointers may be null.

Returns 0 if the date is invalid.

Note: In Qt versions prior to 5.7, this function is marked as non-const.

This function was introduced in Qt 4.5.

See also year(), month(), day(), and isValid().

pub unsafe fn get_date(
    &self,
    year: *mut c_int,
    month: *mut c_int,
    day: *mut c_int
)

Extracts the date's year, month, and day, and assigns them to *year, *month, and *day. The pointers may be null.

Calls C++ function: void QDate::getDate(int* year, int* month, int* day) const.

C++ documentation:

Extracts the date's year, month, and day, and assigns them to *year, *month, and *day. The pointers may be null.

Returns 0 if the date is invalid.

Note: In Qt versions prior to 5.7, this function is marked as non-const.

This function was introduced in Qt 4.5.

See also year(), month(), day(), and isValid().

pub unsafe fn is_leap_year(year: c_int) -> bool

Returns true if the specified year is a leap year; otherwise returns false.

Calls C++ function: static bool QDate::isLeapYear(int year).

C++ documentation:

Returns true if the specified year is a leap year; otherwise returns false.

pub unsafe fn is_null(&self) -> bool

Returns true if the date is null; otherwise returns false. A null date is invalid.

Calls C++ function: bool QDate::isNull() const.

C++ documentation:

Returns true if the date is null; otherwise returns false. A null date is invalid.

Note: The behavior of this function is equivalent to isValid().

See also isValid().

pub unsafe fn is_valid_0a(&self) -> bool

Returns true if this date is valid; otherwise returns false.

Calls C++ function: bool QDate::isValid() const.

C++ documentation:

Returns true if this date is valid; otherwise returns false.

See also isNull().

pub unsafe fn is_valid_3a(y: c_int, m: c_int, d: c_int) -> bool

This is an overloaded function.

Calls C++ function: static bool QDate::isValid(int y, int m, int d).

C++ documentation:

This is an overloaded function.

Returns true if the specified date (year, month, and day) is valid; otherwise returns false.

Example:

QDate::isValid(2002, 5, 17);  // true
QDate::isValid(2002, 2, 30);  // false (Feb 30 does not exist)
QDate::isValid(2004, 2, 29);  // true (2004 is a leap year)
QDate::isValid(2000, 2, 29);  // true (2000 is a leap year)
QDate::isValid(2006, 2, 29);  // false (2006 is not a leap year)
QDate::isValid(2100, 2, 29);  // false (2100 is not a leap year)
QDate::isValid(1202, 6, 6);   // true (even though 1202 is pre-Gregorian)

See also isNull() and setDate().

pub unsafe fn long_day_name_2a(
    weekday: c_int,
    type_: MonthNameType
) -> CppBox<QString>

Returns the long name of the weekday for the representation specified by type.

Calls C++ function: static QString QDate::longDayName(int weekday, QDate::MonthNameType type = …).

C++ documentation:

Returns the long name of the weekday for the representation specified by type.

The days are enumerated using the following convention:

• 1 = "Monday"
• 2 = "Tuesday"
• 3 = "Wednesday"
• 4 = "Thursday"
• 5 = "Friday"
• 6 = "Saturday"
• 7 = "Sunday"

The day names will be localized according to the system's locale settings, i.e. using QLocale::system().

Returns an empty string if the date is invalid.

This function was introduced in Qt 4.5.

See also toString(), shortDayName(), shortMonthName(), and longMonthName().

pub unsafe fn long_day_name_1a(weekday: c_int) -> CppBox<QString>

Returns the long name of the weekday for the representation specified by type.

Calls C++ function: static QString QDate::longDayName(int weekday).

C++ documentation:

Returns the long name of the weekday for the representation specified by type.

The days are enumerated using the following convention:

• 1 = "Monday"
• 2 = "Tuesday"
• 3 = "Wednesday"
• 4 = "Thursday"
• 5 = "Friday"
• 6 = "Saturday"
• 7 = "Sunday"

The day names will be localized according to the system's locale settings, i.e. using QLocale::system().

Returns an empty string if the date is invalid.

This function was introduced in Qt 4.5.

See also toString(), shortDayName(), shortMonthName(), and longMonthName().

pub unsafe fn long_month_name_2a(
    month: c_int,
    type_: MonthNameType
) -> CppBox<QString>

Returns the long name of the month for the representation specified by type.

Calls C++ function: static QString QDate::longMonthName(int month, QDate::MonthNameType type = …).

C++ documentation:

Returns the long name of the month for the representation specified by type.

The months are enumerated using the following convention:

• 1 = "January"
• 2 = "February"
• 3 = "March"
• 4 = "April"
• 5 = "May"
• 6 = "June"
• 7 = "July"
• 8 = "August"
• 9 = "September"
• 10 = "October"
• 11 = "November"
• 12 = "December"

The month names will be localized according to the system's locale settings, i.e. using QLocale::system().

Returns an empty string if the date is invalid.

This function was introduced in Qt 4.5.

See also toString(), shortMonthName(), shortDayName(), and longDayName().

pub unsafe fn long_month_name_1a(month: c_int) -> CppBox<QString>

Returns the long name of the month for the representation specified by type.

Calls C++ function: static QString QDate::longMonthName(int month).

C++ documentation:

Returns the long name of the month for the representation specified by type.

The months are enumerated using the following convention:

• 1 = "January"
• 2 = "February"
• 3 = "March"
• 4 = "April"
• 5 = "May"
• 6 = "June"
• 7 = "July"
• 8 = "August"
• 9 = "September"
• 10 = "October"
• 11 = "November"
• 12 = "December"

The month names will be localized according to the system's locale settings, i.e. using QLocale::system().

Returns an empty string if the date is invalid.

This function was introduced in Qt 4.5.

See also toString(), shortMonthName(), shortDayName(), and longDayName().

pub unsafe fn month_0a(&self) -> c_int

Returns the number corresponding to the month of this date, using the following convention:

Calls C++ function: int QDate::month() const.

C++ documentation:

Returns the number corresponding to the month of this date, using the following convention:

• 1 = "January"
• 2 = "February"
• 3 = "March"
• 4 = "April"
• 5 = "May"
• 6 = "June"
• 7 = "July"
• 8 = "August"
• 9 = "September"
• 10 = "October"
• 11 = "November"
• 12 = "December"

Returns 0 if the date is invalid.

See also year() and day().

pub unsafe fn month_1a(&self, cal: impl CastInto<Ref<QCalendar>>) -> c_int

This is supported on cpp_lib_version="5.14.0" only.

Returns the month-number for the date.

Calls C++ function: int QDate::month(QCalendar cal) const.

C++ documentation:

Returns the month-number for the date.

Numbers the months of the year starting with 1 for the first. Uses cal as calendar if supplied, else the Gregorian calendar, for which the month numbering is as follows:

• 1 = "January"
• 2 = "February"
• 3 = "March"
• 4 = "April"
• 5 = "May"
• 6 = "June"
• 7 = "July"
• 8 = "August"
• 9 = "September"
• 10 = "October"
• 11 = "November"
• 12 = "December"

Returns 0 if the date is invalid. Note that some calendars may have more than 12 months in some years.

See also year() and day().

pub unsafe fn new_0a() -> CppBox<QDate>

Constructs a null date. Null dates are invalid.

Calls C++ function: [constructor] void QDate::QDate().

C++ documentation:

Constructs a null date. Null dates are invalid.

See also isNull() and isValid().

pub unsafe fn new_3a(y: c_int, m: c_int, d: c_int) -> CppBox<QDate>

Constructs a date with year y, month m and day d.

Calls C++ function: [constructor] void QDate::QDate(int y, int m, int d).

C++ documentation:

Constructs a date with year y, month m and day d.

If the specified date is invalid, the date is not set and isValid() returns false.

Warning: Years 1 to 99 are interpreted as is. Year 0 is invalid.

See also isValid().

pub unsafe fn new_4a(
    y: c_int,
    m: c_int,
    d: c_int,
    cal: impl CastInto<Ref<QCalendar>>
) -> CppBox<QDate>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: [constructor] void QDate::QDate(int y, int m, int d, QCalendar cal).

pub unsafe fn new_copy(other: impl CastInto<Ref<QDate>>) -> CppBox<QDate>

The QDate class provides date functions.

Calls C++ function: [constructor] void QDate::QDate(const QDate& other).

C++ documentation:

The QDate class provides date functions.

A QDate object contains a calendar date, i.e. year, month, and day numbers, in the Gregorian calendar. It can read the current date from the system clock. It provides functions for comparing dates, and for manipulating dates. For example, it is possible to add and subtract days, months, and years to dates.

A QDate object is typically created by giving the year, month, and day numbers explicitly. Note that QDate interprets two digit years as is, i.e., years 0 - 99. A QDate can also be constructed with the static function currentDate(), which creates a QDate object containing the system clock's date. An explicit date can also be set using setDate(). The fromString() function returns a QDate given a string and a date format which is used to interpret the date within the string.

The year(), month(), and day() functions provide access to the year, month, and day numbers. Also, dayOfWeek() and dayOfYear() functions are provided. The same information is provided in textual format by the toString(), shortDayName(), longDayName(), shortMonthName(), and longMonthName() functions.

QDate provides a full set of operators to compare two QDate objects where smaller means earlier, and larger means later.

You can increment (or decrement) a date by a given number of days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two dates.

The daysInMonth() and daysInYear() functions return how many days there are in this date's month and year, respectively. The isLeapYear() function indicates whether a date is in a leap year.

No Year 0

There is no year 0. Dates in that year are considered invalid. The year -1 is the year "1 before Christ" or "1 before current era." The day before 1 January 1 CE is 31 December 1 BCE.

Range of Valid Dates

Dates are stored internally as a Julian Day number, an integer count of every day in a contiguous range, with 24 November 4714 BCE in the Gregorian calendar being Julian Day 0 (1 January 4713 BCE in the Julian calendar). As well as being an efficient and accurate way of storing an absolute date, it is suitable for converting a Date into other calendar systems such as Hebrew, Islamic or Chinese. The Julian Day number can be obtained using QDate::toJulianDay() and can be set using QDate::fromJulianDay().

The range of dates able to be stored by QDate as a Julian Day number is for technical reasons limited to between -784350574879 and 784354017364, which means from before 2 billion BCE to after 2 billion CE.

pub unsafe fn set_date_3a(&self, year: c_int, month: c_int, day: c_int) -> bool

Sets the date's year, month, and day. Returns true if the date is valid; otherwise returns false.

Calls C++ function: bool QDate::setDate(int year, int month, int day).

C++ documentation:

Sets the date's year, month, and day. Returns true if the date is valid; otherwise returns false.

If the specified date is invalid, the QDate object is set to be invalid.

This function was introduced in Qt 4.2.

See also isValid().

pub unsafe fn set_date_4a(
    &self,
    year: c_int,
    month: c_int,
    day: c_int,
    cal: impl CastInto<Ref<QCalendar>>
) -> bool

This is supported on cpp_lib_version="5.14.0" only.

Sets this to represent the date, in the given calendar cal, with the given year, month and day numbers. Returns true if the resulting date is valid, otherwise it sets this to represent an invalid date and returns false.

Calls C++ function: bool QDate::setDate(int year, int month, int day, QCalendar cal).

C++ documentation:

Sets this to represent the date, in the given calendar cal, with the given year, month and day numbers. Returns true if the resulting date is valid, otherwise it sets this to represent an invalid date and returns false.

This function was introduced in Qt 5.14.

See also isValid() and QCalendar::dateFromParts().

pub unsafe fn short_day_name_2a(
    weekday: c_int,
    type_: MonthNameType
) -> CppBox<QString>

Returns the short name of the weekday for the representation specified by type.

Calls C++ function: static QString QDate::shortDayName(int weekday, QDate::MonthNameType type = …).

C++ documentation:

Returns the short name of the weekday for the representation specified by type.

The days are enumerated using the following convention:

• 1 = "Mon"
• 2 = "Tue"
• 3 = "Wed"
• 4 = "Thu"
• 5 = "Fri"
• 6 = "Sat"
• 7 = "Sun"

The day names will be localized according to the system's locale settings, i.e. using QLocale::system().

Returns an empty string if the date is invalid.

This function was introduced in Qt 4.5.

See also toString(), shortMonthName(), longMonthName(), and longDayName().

pub unsafe fn short_day_name_1a(weekday: c_int) -> CppBox<QString>

Returns the short name of the weekday for the representation specified by type.

Calls C++ function: static QString QDate::shortDayName(int weekday).

C++ documentation:

Returns the short name of the weekday for the representation specified by type.

The days are enumerated using the following convention:

• 1 = "Mon"
• 2 = "Tue"
• 3 = "Wed"
• 4 = "Thu"
• 5 = "Fri"
• 6 = "Sat"
• 7 = "Sun"

The day names will be localized according to the system's locale settings, i.e. using QLocale::system().

Returns an empty string if the date is invalid.

This function was introduced in Qt 4.5.

See also toString(), shortMonthName(), longMonthName(), and longDayName().

pub unsafe fn short_month_name_2a(
    month: c_int,
    type_: MonthNameType
) -> CppBox<QString>

Returns the short name of the month for the representation specified by type.

Calls C++ function: static QString QDate::shortMonthName(int month, QDate::MonthNameType type = …).

C++ documentation:

Returns the short name of the month for the representation specified by type.

The months are enumerated using the following convention:

• 1 = "Jan"
• 2 = "Feb"
• 3 = "Mar"
• 4 = "Apr"
• 5 = "May"
• 6 = "Jun"
• 7 = "Jul"
• 8 = "Aug"
• 9 = "Sep"
• 10 = "Oct"
• 11 = "Nov"
• 12 = "Dec"

The month names will be localized according to the system's locale settings, i.e. using QLocale::system().

Returns an empty string if the date is invalid.

This function was introduced in Qt 4.5.

See also toString(), longMonthName(), shortDayName(), and longDayName().

pub unsafe fn short_month_name_1a(month: c_int) -> CppBox<QString>

Returns the short name of the month for the representation specified by type.

Calls C++ function: static QString QDate::shortMonthName(int month).

C++ documentation:

Returns the short name of the month for the representation specified by type.

The months are enumerated using the following convention:

• 1 = "Jan"
• 2 = "Feb"
• 3 = "Mar"
• 4 = "Apr"
• 5 = "May"
• 6 = "Jun"
• 7 = "Jul"
• 8 = "Aug"
• 9 = "Sep"
• 10 = "Oct"
• 11 = "Nov"
• 12 = "Dec"

The month names will be localized according to the system's locale settings, i.e. using QLocale::system().

Returns an empty string if the date is invalid.

This function was introduced in Qt 4.5.

See also toString(), longMonthName(), shortDayName(), and longDayName().

pub unsafe fn start_of_day_time_spec_int(
    &self,
    spec: TimeSpec,
    offset_seconds: c_int
) -> CppBox<QDateTime>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: QDateTime QDate::startOfDay(Qt::TimeSpec spec = …, int offsetSeconds = …) const.

pub unsafe fn start_of_day_q_time_zone(
    &self,
    zone: impl CastInto<Ref<QTimeZone>>
) -> CppBox<QDateTime>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: QDateTime QDate::startOfDay(const QTimeZone& zone) const.

pub unsafe fn start_of_day_time_spec(&self, spec: TimeSpec) -> CppBox<QDateTime>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: QDateTime QDate::startOfDay(Qt::TimeSpec spec = …) const.

pub unsafe fn start_of_day(&self) -> CppBox<QDateTime>

This is supported on cpp_lib_version="5.14.0" only.

Calls C++ function: QDateTime QDate::startOfDay() const.

pub unsafe fn to_julian_day(&self) -> i64

Converts the date to a Julian day.

Calls C++ function: qint64 QDate::toJulianDay() const.

C++ documentation:

Converts the date to a Julian day.

See also fromJulianDay().

pub unsafe fn to_string_date_format(&self, f: DateFormat) -> CppBox<QString>

This is an overloaded function.

Calls C++ function: QString QDate::toString(Qt::DateFormat f = …) const.

C++ documentation:

This is an overloaded function.

Returns the date as a string. The format parameter determines the format of the string.

If the format is Qt::TextDate, the string is formatted in the default way. QDate::shortDayName() and QDate::shortMonthName() are used to generate the string, so the day and month names will be localized names using the system locale, i.e. QLocale::system(). An example of this formatting is "Sat May 20 1995".

If the format is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form YYYY-MM-DD, where YYYY is the year, MM is the month of the year (between 01 and 12), and DD is the day of the month between 01 and 31.

If the format is Qt::SystemLocaleShortDate or Qt::SystemLocaleLongDate, the string format depends on the locale settings of the system. Identical to calling QLocale::system().toString(date, QLocale::ShortFormat) or QLocale::system().toString(date, QLocale::LongFormat).

If the format is Qt::DefaultLocaleShortDate or Qt::DefaultLocaleLongDate, the string format depends on the default application locale. This is the locale set with QLocale::setDefault(), or the system locale if no default locale has been set. Identical to calling QLocale().toString(date, QLocale::ShortFormat) or QLocale().toString(date, QLocale::LongFormat).

If the format is Qt::RFC2822Date, the string is formatted in an RFC 2822 compatible way. An example of this formatting is "20 May 1995".

If the date is invalid, an empty string will be returned.

Warning: The Qt::ISODate format is only valid for years in the range 0 to 9999. This restriction may apply to locale-aware formats as well, depending on the locale settings.

See also fromString(), shortDayName(), shortMonthName(), and QLocale::toString().

pub unsafe fn to_string_q_string(
    &self,
    format: impl CastInto<Ref<QString>>
) -> CppBox<QString>

Returns the date as a string. The format parameter determines the format of the result string.

Calls C++ function: QString QDate::toString(const QString& format) const.

C++ documentation:

Returns the date as a string. The format parameter determines the format of the result string.

These expressions may be used:

Expression	Output
d	the day as number without a leading zero (1 to 31)
dd	the day as number with a leading zero (01 to 31)
ddd	the abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses the system locale to localize the name, i.e. QLocale::system().
dddd	the long localized day name (e.g. 'Monday' to 'Sunday'). Uses the system locale to localize the name, i.e. QLocale::system().
M	the month as number without a leading zero (1 to 12)
MM	the month as number with a leading zero (01 to 12)
MMM	the abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses the system locale to localize the name, i.e. QLocale::system().
MMMM	the long localized month name (e.g. 'January' to 'December'). Uses the system locale to localize the name, i.e. QLocale::system().
yy	the year as two digit number (00 to 99)
yyyy	the year as four digit number. If the year is negative, a minus sign is prepended in addition.

All other input characters will be ignored. Any sequence of characters that are enclosed in single quotes will be treated as text and not be used as an expression. Two consecutive single quotes ("''") are replaced by a singlequote in the output. Formats without separators (e.g. "ddMM") are currently not supported.

Example format strings (assuming that the QDate is the 20 July 1969):

Format	Result
dd.MM.yyyy	20.07.1969
ddd MMMM d yy	Sun July 20 69
'The day is' dddd	The day is Sunday

If the datetime is invalid, an empty string will be returned.

See also fromString(), QDateTime::toString(), QTime::toString(), and QLocale::toString().

pub unsafe fn to_string(&self) -> CppBox<QString>

This is an overloaded function.

Calls C++ function: QString QDate::toString() const.

C++ documentation:

This is an overloaded function.

Returns the date as a string. The format parameter determines the format of the string.

If the format is Qt::TextDate, the string is formatted in the default way. QDate::shortDayName() and QDate::shortMonthName() are used to generate the string, so the day and month names will be localized names using the system locale, i.e. QLocale::system(). An example of this formatting is "Sat May 20 1995".

If the format is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form YYYY-MM-DD, where YYYY is the year, MM is the month of the year (between 01 and 12), and DD is the day of the month between 01 and 31.

If the format is Qt::SystemLocaleShortDate or Qt::SystemLocaleLongDate, the string format depends on the locale settings of the system. Identical to calling QLocale::system().toString(date, QLocale::ShortFormat) or QLocale::system().toString(date, QLocale::LongFormat).

If the format is Qt::DefaultLocaleShortDate or Qt::DefaultLocaleLongDate, the string format depends on the default application locale. This is the locale set with QLocale::setDefault(), or the system locale if no default locale has been set. Identical to calling QLocale().toString(date, QLocale::ShortFormat) or QLocale().toString(date, QLocale::LongFormat).

If the format is Qt::RFC2822Date, the string is formatted in an RFC 2822 compatible way. An example of this formatting is "20 May 1995".

If the date is invalid, an empty string will be returned.

Warning: The Qt::ISODate format is only valid for years in the range 0 to 9999. This restriction may apply to locale-aware formats as well, depending on the locale settings.

See also fromString(), shortDayName(), shortMonthName(), and QLocale::toString().

pub unsafe fn to_string_q_string_view(
    &self,
    format: impl CastInto<Ref<QStringView>>
) -> CppBox<QString>

This is supported on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

This is an overloaded function.

Calls C++ function: QString QDate::toString(QStringView format) const.

Warning: no exact match found in C++ documentation. Below is the C++ documentation for QString QDate::toString(Qt::DateFormat format = Qt::TextDate) const:

This is an overloaded function.

Returns the date as a string. The format parameter determines the format of the string.

If the format is Qt::TextDate, the string is formatted in the default way. The day and month names will be localized names using the system locale, i.e. QLocale::system(). An example of this formatting is "Sat May 20 1995".

If the format is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form yyyy-MM-dd, where yyyy is the year, MM is the month of the year (between 01 and 12), and dd is the day of the month between 01 and 31.

If the format is Qt::SystemLocaleShortDate or Qt::SystemLocaleLongDate, the string format depends on the locale settings of the system. Identical to calling QLocale::system().toString(date, QLocale::ShortFormat) or QLocale::system().toString(date, QLocale::LongFormat).

If the format is Qt::DefaultLocaleShortDate or Qt::DefaultLocaleLongDate, the string format depends on the default application locale. This is the locale set with QLocale::setDefault(), or the system locale if no default locale has been set. Identical to calling QLocale().toString(date, QLocale::ShortFormat) or QLocale().toString(date, QLocale::LongFormat).

If the format is Qt::RFC2822Date, the string is formatted in an RFC 2822 compatible way. An example of this formatting is "20 May 1995".

If the date is invalid, an empty string will be returned.

Warning: The Qt::ISODate format is only valid for years in the range 0 to 9999. This restriction may apply to locale-aware formats as well, depending on the locale settings.

See also fromString() and QLocale::toString().

pub unsafe fn to_string_q_string_q_calendar(
    &self,
    format: impl CastInto<Ref<QString>>,
    cal: impl CastInto<Ref<QCalendar>>
) -> CppBox<QString>

This is supported on cpp_lib_version="5.14.0" only.

This is an overloaded function.

Calls C++ function: QString QDate::toString(const QString& format, QCalendar cal) const.

Warning: no exact match found in C++ documentation. Below is the C++ documentation for QString QDate::toString(Qt::DateFormat format = Qt::TextDate) const:

This is an overloaded function.

Returns the date as a string. The format parameter determines the format of the string.

If the format is Qt::TextDate, the string is formatted in the default way. The day and month names will be localized names using the system locale, i.e. QLocale::system(). An example of this formatting is "Sat May 20 1995".

If the format is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form yyyy-MM-dd, where yyyy is the year, MM is the month of the year (between 01 and 12), and dd is the day of the month between 01 and 31.

If the format is Qt::SystemLocaleShortDate or Qt::SystemLocaleLongDate, the string format depends on the locale settings of the system. Identical to calling QLocale::system().toString(date, QLocale::ShortFormat) or QLocale::system().toString(date, QLocale::LongFormat).

If the format is Qt::DefaultLocaleShortDate or Qt::DefaultLocaleLongDate, the string format depends on the default application locale. This is the locale set with QLocale::setDefault(), or the system locale if no default locale has been set. Identical to calling QLocale().toString(date, QLocale::ShortFormat) or QLocale().toString(date, QLocale::LongFormat).

If the format is Qt::RFC2822Date, the string is formatted in an RFC 2822 compatible way. An example of this formatting is "20 May 1995".

If the date is invalid, an empty string will be returned.

Warning: The Qt::ISODate format is only valid for years in the range 0 to 9999. This restriction may apply to locale-aware formats as well, depending on the locale settings.

See also fromString() and QLocale::toString().

pub unsafe fn to_string_date_format_q_calendar(
    &self,
    f: DateFormat,
    cal: impl CastInto<Ref<QCalendar>>
) -> CppBox<QString>

This is supported on cpp_lib_version="5.14.0" only.

This is an overloaded function.

Calls C++ function: QString QDate::toString(Qt::DateFormat f, QCalendar cal) const.

Warning: no exact match found in C++ documentation. Below is the C++ documentation for QString QDate::toString(Qt::DateFormat format = Qt::TextDate) const:

This is an overloaded function.

Returns the date as a string. The format parameter determines the format of the string.

If the format is Qt::TextDate, the string is formatted in the default way. The day and month names will be localized names using the system locale, i.e. QLocale::system(). An example of this formatting is "Sat May 20 1995".

If the format is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form yyyy-MM-dd, where yyyy is the year, MM is the month of the year (between 01 and 12), and dd is the day of the month between 01 and 31.

If the format is Qt::SystemLocaleShortDate or Qt::SystemLocaleLongDate, the string format depends on the locale settings of the system. Identical to calling QLocale::system().toString(date, QLocale::ShortFormat) or QLocale::system().toString(date, QLocale::LongFormat).

If the format is Qt::DefaultLocaleShortDate or Qt::DefaultLocaleLongDate, the string format depends on the default application locale. This is the locale set with QLocale::setDefault(), or the system locale if no default locale has been set. Identical to calling QLocale().toString(date, QLocale::ShortFormat) or QLocale().toString(date, QLocale::LongFormat).

If the format is Qt::RFC2822Date, the string is formatted in an RFC 2822 compatible way. An example of this formatting is "20 May 1995".

If the date is invalid, an empty string will be returned.

Warning: The Qt::ISODate format is only valid for years in the range 0 to 9999. This restriction may apply to locale-aware formats as well, depending on the locale settings.

See also fromString() and QLocale::toString().

pub unsafe fn to_string_q_string_view_q_calendar(
    &self,
    format: impl CastInto<Ref<QStringView>>,
    cal: impl CastInto<Ref<QCalendar>>
) -> CppBox<QString>

This is supported on cpp_lib_version="5.14.0" only.

This is an overloaded function.

Calls C++ function: QString QDate::toString(QStringView format, QCalendar cal) const.

Warning: no exact match found in C++ documentation. Below is the C++ documentation for QString QDate::toString(Qt::DateFormat format = Qt::TextDate) const:

This is an overloaded function.

Returns the date as a string. The format parameter determines the format of the string.

If the format is Qt::TextDate, the string is formatted in the default way. The day and month names will be localized names using the system locale, i.e. QLocale::system(). An example of this formatting is "Sat May 20 1995".

If the format is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form yyyy-MM-dd, where yyyy is the year, MM is the month of the year (between 01 and 12), and dd is the day of the month between 01 and 31.

If the format is Qt::SystemLocaleShortDate or Qt::SystemLocaleLongDate, the string format depends on the locale settings of the system. Identical to calling QLocale::system().toString(date, QLocale::ShortFormat) or QLocale::system().toString(date, QLocale::LongFormat).

If the format is Qt::DefaultLocaleShortDate or Qt::DefaultLocaleLongDate, the string format depends on the default application locale. This is the locale set with QLocale::setDefault(), or the system locale if no default locale has been set. Identical to calling QLocale().toString(date, QLocale::ShortFormat) or QLocale().toString(date, QLocale::LongFormat).

If the format is Qt::RFC2822Date, the string is formatted in an RFC 2822 compatible way. An example of this formatting is "20 May 1995".

If the date is invalid, an empty string will be returned.

Warning: The Qt::ISODate format is only valid for years in the range 0 to 9999. This restriction may apply to locale-aware formats as well, depending on the locale settings.

See also fromString() and QLocale::toString().

pub unsafe fn week_number_1a(&self, year_num: *mut c_int) -> c_int

Returns the week number (1 to 53), and stores the year in *yearNumber unless yearNumber is null (the default).

Calls C++ function: int QDate::weekNumber(int* yearNum = …) const.

C++ documentation:

Returns the week number (1 to 53), and stores the year in *yearNumber unless yearNumber is null (the default).

Returns 0 if the date is invalid.

In accordance with ISO 8601, weeks start on Monday and the first Thursday of a year is always in week 1 of that year. Most years have 52 weeks, but some have 53.

*yearNumber is not always the same as year(). For example, 1 January 2000 has week number 52 in the year 1999, and 31 December 2002 has week number 1 in the year 2003.

See also isValid().

pub unsafe fn week_number_0a(&self) -> c_int

Returns the week number (1 to 53), and stores the year in *yearNumber unless yearNumber is null (the default).

Calls C++ function: int QDate::weekNumber() const.

C++ documentation:

Returns the week number (1 to 53), and stores the year in *yearNumber unless yearNumber is null (the default).

Returns 0 if the date is invalid.

In accordance with ISO 8601, weeks start on Monday and the first Thursday of a year is always in week 1 of that year. Most years have 52 weeks, but some have 53.

*yearNumber is not always the same as year(). For example, 1 January 2000 has week number 52 in the year 1999, and 31 December 2002 has week number 1 in the year 2003.

See also isValid().

pub unsafe fn year_0a(&self) -> c_int

Returns the year of this date. Negative numbers indicate years before 1 CE, such that year -44 is 44 BCE.

Calls C++ function: int QDate::year() const.

C++ documentation:

Returns the year of this date. Negative numbers indicate years before 1 CE, such that year -44 is 44 BCE.

Returns 0 if the date is invalid.

See also month() and day().

pub unsafe fn year_1a(&self, cal: impl CastInto<Ref<QCalendar>>) -> c_int

This is supported on cpp_lib_version="5.14.0" only.

Returns the year of this date.

Calls C++ function: int QDate::year(QCalendar cal) const.

C++ documentation:

Returns the year of this date.

Uses cal as calendar, if supplied, else the Gregorian calendar.

Returns 0 if the date is invalid. For some calendars, dates before their first year may all be invalid.

If using a calendar which has a year 0, check using isValid() if the return is 0. Such calendars use negative year numbers in the obvious way, with year 1 preceded by year 0, in turn preceded by year -1 and so on.

Some calendars, despite having no year 0, have a conventional numbering of the years before their first year, counting backwards from 1. For example, in the proleptic Gregorian calendar, successive years before 1 CE (the first year) are identified as 1 BCE, 2 BCE, 3 BCE and so on. For such calendars, negative year numbers are used to indicate these years before year 1, with -1 indicating the year before 1.

See also month(), day(), QCalendar::hasYearZero(), and QCalendar::isProleptic().

Trait Implementations

impl CppDeletable for QDate

unsafe fn delete(&self)

The QDate class provides date functions.

Calls C++ function: [destructor] void QDate::~QDate().

C++ documentation:

The QDate class provides date functions.

A QDate object contains a calendar date, i.e. year, month, and day numbers, in the Gregorian calendar. It can read the current date from the system clock. It provides functions for comparing dates, and for manipulating dates. For example, it is possible to add and subtract days, months, and years to dates.

A QDate object is typically created by giving the year, month, and day numbers explicitly. Note that QDate interprets two digit years as is, i.e., years 0 - 99. A QDate can also be constructed with the static function currentDate(), which creates a QDate object containing the system clock's date. An explicit date can also be set using setDate(). The fromString() function returns a QDate given a string and a date format which is used to interpret the date within the string.

The year(), month(), and day() functions provide access to the year, month, and day numbers. Also, dayOfWeek() and dayOfYear() functions are provided. The same information is provided in textual format by the toString(), shortDayName(), longDayName(), shortMonthName(), and longMonthName() functions.

QDate provides a full set of operators to compare two QDate objects where smaller means earlier, and larger means later.

You can increment (or decrement) a date by a given number of days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two dates.

The daysInMonth() and daysInYear() functions return how many days there are in this date's month and year, respectively. The isLeapYear() function indicates whether a date is in a leap year.

No Year 0

There is no year 0. Dates in that year are considered invalid. The year -1 is the year "1 before Christ" or "1 before current era." The day before 1 January 1 CE is 31 December 1 BCE.

Range of Valid Dates

Dates are stored internally as a Julian Day number, an integer count of every day in a contiguous range, with 24 November 4714 BCE in the Gregorian calendar being Julian Day 0 (1 January 4713 BCE in the Julian calendar). As well as being an efficient and accurate way of storing an absolute date, it is suitable for converting a Date into other calendar systems such as Hebrew, Islamic or Chinese. The Julian Day number can be obtained using QDate::toJulianDay() and can be set using QDate::fromJulianDay().

The range of dates able to be stored by QDate as a Julian Day number is for technical reasons limited to between -784350574879 and 784354017364, which means from before 2 billion BCE to after 2 billion CE.

impl Ge<Ref<QDate>> for QDate

unsafe fn ge(&self, other: &Ref<QDate>) -> bool

Returns true if this date is later than or equal to d; otherwise returns false.

Calls C++ function: bool QDate::operator>=(const QDate& other) const.

C++ documentation:

Returns true if this date is later than or equal to d; otherwise returns false.

impl Gt<Ref<QDate>> for QDate

unsafe fn gt(&self, other: &Ref<QDate>) -> bool

Returns true if this date is later than d; otherwise returns false.

Calls C++ function: bool QDate::operator>(const QDate& other) const.

C++ documentation:

Returns true if this date is later than d; otherwise returns false.

impl Le<Ref<QDate>> for QDate

unsafe fn le(&self, other: &Ref<QDate>) -> bool

Returns true if this date is earlier than or equal to d; otherwise returns false.

Calls C++ function: bool QDate::operator<=(const QDate& other) const.

C++ documentation:

Returns true if this date is earlier than or equal to d; otherwise returns false.

impl Lt<Ref<QDate>> for QDate

unsafe fn lt(&self, other: &Ref<QDate>) -> bool

Returns true if this date is earlier than d; otherwise returns false.

Calls C++ function: bool QDate::operator<(const QDate& other) const.

C++ documentation:

Returns true if this date is earlier than d; otherwise returns false.

impl PartialEq<Ref<QDate>> for QDate

fn eq(&self, other: &Ref<QDate>) -> bool

Returns true if this date is equal to d; otherwise returns false.

Calls C++ function: bool QDate::operator==(const QDate& other) const.

C++ documentation:

Returns true if this date is equal to d; otherwise returns false.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.