diff options
Diffstat (limited to 'src/corelib/time/qcalendar.cpp')
| -rw-r--r-- | src/corelib/time/qcalendar.cpp | 551 |
1 files changed, 285 insertions, 266 deletions
diff --git a/src/corelib/time/qcalendar.cpp b/src/corelib/time/qcalendar.cpp index b569a6834c..d308aeba2b 100644 --- a/src/corelib/time/qcalendar.cpp +++ b/src/corelib/time/qcalendar.cpp @@ -136,6 +136,7 @@ Q_GLOBAL_STATIC(Registry, calendarRegistry); \class QCalendarBackend \inmodule QtCore + \internal \reentrant \brief The QCalendarBackend class provides basic calendaring functions. @@ -167,7 +168,7 @@ Q_GLOBAL_STATIC(Registry, calendarRegistry); */ /*! - Constructs the calendar and registers it. + Constructs the calendar and registers it under \a name using \a id. */ QCalendarBackend::QCalendarBackend(const QString &name, QCalendar::System id) { @@ -192,7 +193,7 @@ QCalendarBackend::~QCalendarBackend() return the member of that enum that produces it. Other calendars should return User. - \sa QCalendar::fromEnum() + \sa QCalendarBackend::fromEnum() */ QCalendar::System QCalendarBackend::calendarSystem() const { @@ -200,7 +201,7 @@ QCalendar::System QCalendarBackend::calendarSystem() const } /*! - The primary name of this calendar. + The primary name of this calendar. */ QString QCalendar::name() const { @@ -220,10 +221,10 @@ QString QCalendar::name() const Calendars with intercallary days may represent these as extra days of the preceding month, or as short months separate from the usual ones. In the former case, daysInMonth(month, year) should be the number of ordinary days - in the month, although \c{isDateValid(year, month, day)} might return \c true for - some larger values of \c day. + in the month, although \c{isDateValid(year, month, day)} might return \c true + for some larger values of \c day. - \sa daysInYear(), monthsInYear(), minDaysInMonth(), maxDaysInMonth() + \sa daysInYear(), monthsInYear(), minimumDaysInMonth(), maximumDaysInMonth() */ // properties of the calendar @@ -295,7 +296,7 @@ int QCalendarBackend::daysInYear(int year) const This base implementation returns 12 for any valid year. - \sa daysInYear(), maxMonthsInYear(), isDateValid() + \sa daysInYear(), maximumMonthsInYear(), isDateValid() */ int QCalendarBackend::monthsInYear(int year) const { @@ -353,13 +354,14 @@ bool QCalendarBackend::hasYearZero() const This base implementation returns 31, as this is a common case. For calendars with intercallary days, although daysInMonth() doesn't include - the intercallary days in its count for an individual month, maxDaysInMonth() - should include intercallary days, so that it is the maximum value of \c day - for which \c{isDateValid(year, month, day)} can be true. + the intercallary days in its count for an individual month, + maximumDaysInMonth() should include intercallary days, so that it is the + maximum value of \c day for which \c{isDateValid(year, month, day)} can be + true. - \sa maxMonthsInYear(), daysInMonth() + \sa maximumMonthsInYear(), daysInMonth() */ -int QCalendarBackend::maxDaysInMonth() const +int QCalendarBackend::maximumDaysInMonth() const { return 31; } @@ -369,9 +371,9 @@ int QCalendarBackend::maxDaysInMonth() const This base implementation returns 29, as this is a common case. - \sa maxMonthsInYear(), daysInMonth() + \sa maximumMonthsInYear(), daysInMonth() */ -int QCalendarBackend::minDaysInMonth() const +int QCalendarBackend::minimumDaysInMonth() const { return 29; } @@ -381,9 +383,9 @@ int QCalendarBackend::minDaysInMonth() const This base implementation returns 12, as this is a common case. - \sa maxDaysInMonth(), monthsInYear() + \sa maximumDaysInMonth(), monthsInYear() */ -int QCalendarBackend::maxMonthsInYear() const +int QCalendarBackend::maximumMonthsInYear() const { return 12; } @@ -391,7 +393,7 @@ int QCalendarBackend::maxMonthsInYear() const // Julian day number calculations /*! - \fn bool dateToJulianDay(int year, int month, int day, qint64 *jd) const + \fn bool QCalendarBackend::dateToJulianDay(int year, int month, int day, qint64 *jd) const Computes the Julian day number corresponding to the specified \a year, \a month, and \a day. Returns true and sets \a jd if there is such a date in @@ -401,7 +403,7 @@ int QCalendarBackend::maxMonthsInYear() const */ /*! - \fn QCalendar::YearMonthDay julianDayToDate(qint64 jd) const + \fn QCalendar::YearMonthDay QCalendarBackend::julianDayToDate(qint64 jd) const Computes the year, month, and day in this calendar for the given Julian day number \a jd. If the given day falls outside this calendar's scope @@ -413,7 +415,7 @@ int QCalendarBackend::maxMonthsInYear() const */ /*! - Returns the day of the week for a given Julian Day Number. + Returns the day of the week for the given Julian Day Number \a jd. This is 1 for Monday through 7 for Sunday. @@ -438,101 +440,104 @@ int QCalendarBackend::dayOfWeek(qint64 jd) const // Month and week-day name look-ups (implemented in qlocale.cpp): /*! - \fn QString QCalendarBackend::monthName(const QLocale &locale, int month, int year, - QLocale::FormatType format) const + \fn QString QCalendarBackend::monthName(const QLocale &locale, int month, int year, + QLocale::FormatType format) const - Returns the name of the specified \a month in the given \a year for the chosen - \a locale, using the given \a format to determine how complete the name is. + Returns the name of the specified \a month in the given \a year for the + chosen \a locale, using the given \a format to determine how complete the + name is. - If \a year is Unspecified, return the name for the month that usually has this - number within a typical year. Calendars with a leap month that isn't always - the last may need to take account of the year to map the month number to the - particular year's month with that number. + If \a year is Unspecified, return the name for the month that usually has + this number within a typical year. Calendars with a leap month that isn't + always the last may need to take account of the year to map the month number + to the particular year's month with that number. - \note Backends for which CLDR provides data can configure the default - implementation of the two month name look-up methods by arranging for - localeMonthIndexData() and localeMonthData() to provide access to the CLDR - data (see cldr2qlocalexml.py, qlocalexml2cpp.py and existing backends). - Conversely, backends that override both month name look-up methods need not - return anything meaningful from localeMonthIndexData() or localeMonthData(). + \note Backends for which CLDR provides data can configure the default + implementation of the two month name look-up methods by arranging for + localeMonthIndexData() and localeMonthData() to provide access to the CLDR + data (see cldr2qlocalexml.py, qlocalexml2cpp.py and existing backends). + Conversely, backends that override both month name look-up methods need not + return anything meaningful from localeMonthIndexData() or localeMonthData(). - \sa standaloneMonthName(), QLocale::monthName() + \sa standaloneMonthName(), QLocale::monthName() */ /*! - \fn QString QCalendarBackend::standaloneMonthName(const QLocale &locale, int month, int year - QLocale::FormatType format) const + \fn QString QCalendarBackend::standaloneMonthName(const QLocale &locale, int month, int year + QLocale::FormatType format) const - Returns the standalone name of the specified \a month in the chosen \a locale, - using the specified \a format to determine how complete the name is. + Returns the standalone name of the specified \a month in the chosen \a + locale, using the specified \a format to determine how complete the name is. - If \a year is Unspecified, return the standalone name for the month that - usually has this number within a typical year. Calendars with a leap month - that isn't always the last may need to take account of the year to map the - month number to the particular year's month with that number. + If \a year is Unspecified, return the standalone name for the month that + usually has this number within a typical year. Calendars with a leap month + that isn't always the last may need to take account of the year to map the + month number to the particular year's month with that number. - \sa monthName(), QLocale::standaloneMonthName() + \sa monthName(), QLocale::standaloneMonthName() */ /*! - \fn QString QCalendarBackend::weekDayName(const QLocale &locale, int day, - QLocale::FormatType format) const + \fn QString QCalendarBackend::weekDayName(const QLocale &locale, int day, + QLocale::FormatType format) const - Returns the name of the specified \a day of the week in the chosen \a locale, - using the specified \a format to determine how complete the name is. + Returns the name of the specified \a day of the week in the chosen \a + locale, using the specified \a format to determine how complete the name is. - The base implementation handles \a day values from 1 to 7 using the day names - CLDR provides, which are suitable for calendards that use the same - (Hebrew-derived) week as the Gregorian calendar. + The base implementation handles \a day values from 1 to 7 using the day + names CLDR provides, which are suitable for calendards that use the same + (Hebrew-derived) week as the Gregorian calendar. - Calendars whose dayOfWeek() returns a value outside the range from 1 to 7 need - to reimplement this method to handle such extra week-day values. They can - assume that \a day is a value returned by the same calendar's dayOfWeek(). + Calendars whose dayOfWeek() returns a value outside the range from 1 to 7 + need to reimplement this method to handle such extra week-day values. They + can assume that \a day is a value returned by the same calendar's + dayOfWeek(). - \sa dayOfWeek(), standaloneWeekDayName(), QLocale::dayName() + \sa dayOfWeek(), standaloneWeekDayName(), QLocale::dayName() */ /*! - \fn QString QCalendarBackend::standaloneWeekDayName(const QLocale &locale, int day, - QLocale::FormatType format) const + \fn QString QCalendarBackend::standaloneWeekDayName(const QLocale &locale, int day, + QLocale::FormatType format) const - Returns the standalone name of the specified \a day of the week in the chosen - \a locale, using the specified \a format to determine how complete the name - is. + Returns the standalone name of the specified \a day of the week in the + chosen \a locale, using the specified \a format to determine how complete + the name is. - The base implementation handles \a day values from 1 to 7 using the standalone - day names CLDR provides, which are suitable for calendards that use the same - (Hebrew-derived) week as the Gregorian calendar. + The base implementation handles \a day values from 1 to 7 using the + standalone day names CLDR provides, which are suitable for calendards that + use the same (Hebrew-derived) week as the Gregorian calendar. - Calendars whose dayOfWeek() returns a value outside the range from 1 to 7 need - to reimplement this method to handle such extra week-day values. They can - assume that \a day is a value returned by the same calendar's dayOfWeek(). + Calendars whose dayOfWeek() returns a value outside the range from 1 to 7 + need to reimplement this method to handle such extra week-day values. They + can assume that \a day is a value returned by the same calendar's + dayOfWeek(). - \sa dayOfWeek(), weekDayName(), QLocale::standaloneDayName() + \sa dayOfWeek(), weekDayName(), QLocale::standaloneDayName() */ /*! - \fn QString QCalendarBackend::dateTimeToString(QStringView format, const QDateTime &datetime, - const QDate &dateOnly, const QTime &timeOnly, - const QLocale &locale) const - - Returns a string representing a given date, time or date-time. - - If \a datetime is specified and valid, it is used and both date and time - format tokens are converted to appropriate representations of the parts of the - datetime. Otherwise, if \a dateOnly is valid, only date format tokens are - converted; else, if \a timeOnly is valid, only time format tokens are - converted. If none are valid, an empty string is returned. - - The specified \a locale influences how some format tokens are converted; for - example, when substituting day and month names and their short-forms. For the - supported formatting tokens, see QDate::toString() and QTime::toString(). As - described above, the provided date, time and date-time determine which of - these tokens are recognized: where these appear in \a format they are replaced - by data. Any text in \a format not recognized as a format token is copied - verbatim into the result string. - - \sa QDate::toString(), QTime::toString(), QDateTime::toString() + \fn QString QCalendarBackend::dateTimeToString(QStringView format, const QDateTime &datetime, + const QDate &dateOnly, const QTime &timeOnly, + const QLocale &locale) const + + Returns a string representing a given date, time or date-time. + + If \a datetime is specified and valid, it is used and both date and time + format tokens are converted to appropriate representations of the parts of + the datetime. Otherwise, if \a dateOnly is valid, only date format tokens + are converted; else, if \a timeOnly is valid, only time format tokens are + converted. If none are valid, an empty string is returned. + + The specified \a locale influences how some format tokens are converted; for + example, when substituting day and month names and their short-forms. For + the supported formatting tokens, see QDate::toString() and + QTime::toString(). As described above, the provided date, time and date-time + determine which of these tokens are recognized: where these appear in \a + format they are replaced by data. Any text in \a format not recognized as a + format token is copied verbatim into the result string. + + \sa QDate::toString(), QTime::toString(), QDateTime::toString() */ // End of methods implemented in qlocale.cpp @@ -541,7 +546,7 @@ int QCalendarBackend::dayOfWeek(qint64 jd) const QCalendarBackend sub-class must be registered before being exposed to Date and Time APIs. - \sa registerCalendar(), fromName() + \sa registerAlias(), fromName() */ QStringList QCalendarBackend::availableCalendars() { @@ -569,16 +574,16 @@ bool QCalendarBackend::registerAlias(const QString &name) } /*! - Returns a pointer to a named calendar backend. + Returns a pointer to a named calendar backend. - If the given \a name is present in availableCalendars(), the backend matching - it is returned; otherwise, \c nullptr is returned. Matching of names ignores - case. Note that this won't provoke construction of a calendar backend, it will - only return ones that have been instantiated (and not yet destroyed) by some - other means. However, calendars available via the QCalendar::System enum are - always registered when this is called. + If the given \a name is present in availableCalendars(), the backend + matching it is returned; otherwise, \c nullptr is returned. Matching of + names ignores case. Note that this won't provoke construction of a calendar + backend, it will only return ones that have been instantiated (and not yet + destroyed) by some other means. However, calendars available via the + QCalendar::System enum are always registered when this is called. - \sa availableCalendars(), registerCalendar(), fromEnum() + \sa availableCalendars(), registerAlias(), fromEnum() */ const QCalendarBackend *QCalendarBackend::fromName(QStringView name) { @@ -590,7 +595,7 @@ const QCalendarBackend *QCalendarBackend::fromName(QStringView name) } /*! - \overload + \overload */ const QCalendarBackend *QCalendarBackend::fromName(QLatin1String name) { @@ -602,11 +607,11 @@ const QCalendarBackend *QCalendarBackend::fromName(QLatin1String name) } /*! - Returns a pointer to a calendar backend, specified by enum. + Returns a pointer to a calendar backend, specified by enum. - This will instantiate the indicated calendar (which will enable fromName() to - return it subsequently), but only for the Qt-supported calendars for which - (where relevant) the appropriate feature has been enabled. + This will instantiate the indicated calendar (which will enable fromName() + to return it subsequently), but only for the Qt-supported calendars for + which (where relevant) the appropriate feature has been enabled. */ const QCalendarBackend *QCalendarBackend::fromEnum(QCalendar::System system) { @@ -641,28 +646,29 @@ const QCalendarBackend *QCalendarBackend::fromEnum(QCalendar::System system) } /*! - \since 5.14 - - \class QCalendar - \inmodule QtCore - \reentrant - \brief The QCalendar class describes calendar systems. - - A QCalendar object maps a year, month, and day-number to a specific day - (ultimately identified by its Julian day number), using the rules of a - particular system. + \since 5.14 - The default QCalendar() is a proleptic Gregorian calendar, which has no year - zero. Other calendars may be supported by enabling suitable features or - loading plugins. Calendars supported as features can be constructed by passing - the QCalendar::System enumeration to the constructor. All supported calendars - may be constructed by name, once they have been constructed. (Thus plugins - instantiate their calendar backend to register it.) Built-in backends, - accessible via QCalendar::System, are also always available by name. + \class QCalendar + \inmodule QtCore + \reentrant + \brief The QCalendar class describes calendar systems. + + A QCalendar object maps a year, month, and day-number to a specific day + (ultimately identified by its Julian day number), using the rules of a + particular system. + + The default QCalendar() is a proleptic Gregorian calendar, which has no year + zero. Other calendars may be supported by enabling suitable features or + loading plugins. Calendars supported as features can be constructed by + passing the QCalendar::System enumeration to the constructor. All supported + calendars may be constructed by name, once they have been constructed. (Thus + plugins instantiate their calendar backend to register it.) Built-in + backends, accessible via QCalendar::System, are also always available by + name. - A QCalendar value is immutable. + A QCalendar value is immutable. - \sa QCalendarBackend, QDate, QDateTime + \sa QDate, QDateTime */ /*! @@ -675,25 +681,27 @@ const QCalendarBackend *QCalendarBackend::fromEnum(QCalendar::System system) \value Milankovic A revised Julian calendar used by some Orthodox churches. \value Jalali The Solar Hijri calendar (also called Persian). \value IslamicCivil The (tabular) Islamic Civil calendar. + \omitvalue Last + \omitvalue User \sa QCalendar */ /*! - \fn QCalendar::QCalendar() - \fn QCalendar::QCalendar(QCalendar::System system) - \fn QCalendar::QCalendar(QLatin1String name) - \fn QCalendar::QCalendar(QStringView name) + \fn QCalendar::QCalendar() + \fn QCalendar::QCalendar(QCalendar::System system) + \fn QCalendar::QCalendar(QLatin1String name) + \fn QCalendar::QCalendar(QStringView name) - Constructs a calendar object. + Constructs a calendar object. - The choice of calendar to use may be indicated as \a system, using the - enumeration QCalendar::System, or by \a name, using a string (either Unicode - or Latin 1). Construction by name may depend on an instance of the given - calendar being constructed by other means first. With no argument, the default - constructor returns the Gregorian calendar. + The choice of calendar to use may be indicated as \a system, using the + enumeration QCalendar::System, or by \a name, using a string (either Unicode + or Latin 1). Construction by name may depend on an instance of the given + calendar being constructed by other means first. With no argument, the + default constructor returns the Gregorian calendar. - \sa QCalendar, System + \sa QCalendar, System, isValid() */ QCalendar::QCalendar() @@ -715,15 +723,25 @@ QCalendar::QCalendar(QLatin1String name) QCalendar::QCalendar(QStringView name) : d(QCalendarBackend::fromName(name)) {} +/* + \fn bool QCalendar::isValid() const + + Returns true if this is a valid calendar object. + + Constructing a calendar with an unrecognised calendar name may result in an + invalid object. Use this method to check after creating a calendar by name. +*/ + // Date queries: /*! - Returns the number of days in the given \a month of the given \a year. + Returns the number of days in the given \a month of the given \a year. - Months are numbered consecutively, starting with 1 for the first month of each - year. + Months are numbered consecutively, starting with 1 for the first month of + each year. If \a year is \c Unspecified (its default, if not passed), the + month's length in a normal year is returned. - \sa maxDaysInMonth(), minDaysInMonth() + \sa maximumDaysInMonth(), minimumDaysInMonth() */ int QCalendar::daysInMonth(int month, int year) const { @@ -731,7 +749,7 @@ int QCalendar::daysInMonth(int month, int year) const } /*! - Returns the number of days in the given \a year. + Returns the number of days in the given \a year. */ int QCalendar::daysInYear(int year) const { @@ -747,12 +765,12 @@ int QCalendar::monthsInYear(int year) const } /*! - Returns \c true precisely if the given \a year, \a month, and \a day specify a - valid date in this calendar. + Returns \c true precisely if the given \a year, \a month, and \a day specify + a valid date in this calendar. - Usually this means 1 <= month <= monthsInYear(year) and 1 <= day <= - daysInMonth(month, year). However, calendars with intercallary days or months - may complicate that. + Usually this means 1 <= month <= monthsInYear(year) and 1 <= day <= + daysInMonth(month, year). However, calendars with intercallary days or + months may complicate that. */ bool QCalendar::isDateValid(int year, int month, int day) const { @@ -772,13 +790,13 @@ bool QCalendar::isGregorian() const } /*! - Returns \c true if the given year is a leap year. + Returns \c true if the given \a year is a leap year. - Since the year is not a whole number of days long, some years are longer than - others. The difference may be a whole month or just a single day; the details - vary between calendars. + Since the year is not a whole number of days long, some years are longer + than others. The difference may be a whole month or just a single day; the + details vary between calendars. - \sa isDateValid() + \sa isDateValid() */ bool QCalendar::isLeapYear(int year) const { @@ -786,9 +804,9 @@ bool QCalendar::isLeapYear(int year) const } /*! - Returns \c true if this calendar is a lunar calendar. + Returns \c true if this calendar is a lunar calendar. - A lunar calendar is one based primarily on the phases of the moon. + A lunar calendar is one based primarily on the phases of the moon. */ bool QCalendar::isLunar() const { @@ -796,11 +814,11 @@ bool QCalendar::isLunar() const } /*! - Returns \c true if this calendar is luni-solar. + Returns \c true if this calendar is luni-solar. - A luni-solar calendar expresses the phases of the moon but adapts itself to - also keep track of the Sun's varying position in the sky, relative to the - fixed stars. + A luni-solar calendar expresses the phases of the moon but adapts itself to + also keep track of the Sun's varying position in the sky, relative to the + fixed stars. */ bool QCalendar::isLuniSolar() const { @@ -808,10 +826,10 @@ bool QCalendar::isLuniSolar() const } /*! - Returns \c true if this calendar is solar. + Returns \c true if this calendar is solar. - A solar calendar is based primarily on the Sun's varying position in the sky, - relative to the fixed stars. + A solar calendar is based primarily on the Sun's varying position in the + sky, relative to the fixed stars. */ bool QCalendar::isSolar() const { @@ -819,13 +837,13 @@ bool QCalendar::isSolar() const } /*! - Returns \c true if this calendar is proleptic. + Returns \c true if this calendar is proleptic. - A proleptic calendar is able to describe years arbitrarily long before its - first. These are represented by negative year numbers and possibly by a year - zero. + A proleptic calendar is able to describe years arbitrarily long before its + first. These are represented by negative year numbers and possibly by a year + zero. - \sa hasYearZero() + \sa hasYearZero() */ bool QCalendar::isProleptic() const { @@ -833,29 +851,29 @@ bool QCalendar::isProleptic() const } /*! - Returns \c true if this calendar has a year zero. - - A non-proleptic calendar with no year zero represents years from its first - year onwards but provides no way to describe years before its first; such a - calendar has no year zero and is not proleptic. - - A calendar which represents years before its first may number these years - simply by following the usual integer counting, so that the year before the - first is year zero, with negative-numbered years preceding this; such a - calendar is proleptic and has a year zero. A calendar might also have a year - zero (for example, the year of some great event, with subsequent years being - the first year after that event, the second year after, and so on) without - describing years before its year zero. Such a calendar would have a year zero - without being proleptic. - - Some calendars, however, represent years before their first by an alternate - numbering; for example, the proleptic Gregorian calendar's first year is 1 CE - and the year before it is 1 BCE, preceded by 2 BCE and so on. In this case, - we use negative year numbers, with year -1 as the year before year 1, year -2 - as the year before year -1 and so on. Such a calendar is proleptic but has no - year zero. - - \sa isProleptic() + Returns \c true if this calendar has a year zero. + + A calendar may represent years from its first year onwards but provide no + way to describe years before its first; such a calendar has no year zero and + is not proleptic. + + A calendar which represents years before its first may number these years + simply by following the usual integer counting, so that the year before the + first is year zero, with negative-numbered years preceding this; such a + calendar is proleptic and has a year zero. A calendar might also have a year + zero (for example, the year of some great event, with subsequent years being + the first year after that event, the second year after, and so on) without + describing years before its year zero. Such a calendar would have a year + zero without being proleptic. + + Some calendars, however, represent years before their first by an alternate + numbering; for example, the proleptic Gregorian calendar's first year is 1 + CE and the year before it is 1 BCE, preceded by 2 BCE and so on. In this + case, we use negative year numbers for this alternate numbering, with year + -1 as the year before year 1, year -2 as the year before year -1 and so + on. Such a calendar is proleptic but has no year zero. + + \sa isProleptic() */ bool QCalendar::hasYearZero() const { @@ -863,40 +881,40 @@ bool QCalendar::hasYearZero() const } /*! - Returns the number of days in the longest month in the calendar, in any year. + Returns the number of days in the longest month in the calendar, in any year. - \sa daysInMonth(), minDaysInMonth() + \sa daysInMonth(), minimumDaysInMonth() */ -int QCalendar::maxDaysInMonth() const +int QCalendar::maximumDaysInMonth() const { - return d ? d->maxDaysInMonth() : 0; + return d ? d->maximumDaysInMonth() : 0; } /*! - Returns the number of days in the shortest month in the calendar, in any year. + Returns the number of days in the shortest month in the calendar, in any year. - \sa daysInMonth(), maxDaysInMonth() + \sa daysInMonth(), maximumDaysInMonth() */ -int QCalendar::minDaysInMonth() const +int QCalendar::minimumDaysInMonth() const { - return d ? d->minDaysInMonth() : 0; + return d ? d->minimumDaysInMonth() : 0; } /*! - Returns the largest number of months that any year may contain. + Returns the largest number of months that any year may contain. - \sa monthName(), standaloneMonthName(), monthsInYear() + \sa monthName(), standaloneMonthName(), monthsInYear() */ -int QCalendar::maxMonthsInYear() const +int QCalendar::maximumMonthsInYear() const { - return d ? d->maxMonthsInYear() : 0; + return d ? d->maximumMonthsInYear() : 0; } // Julian Day conversions: /*! \fn QDate QCalendar::dateFromParts(int year, int month, int day) const - \fn QDate QCalendar::dateFromParts(QCalendar::YearMonthDay parts) const + \fn QDate QCalendar::dateFromParts(const QCalendar::YearMonthDay &parts) const Converts a year, month, and day to a QDate. @@ -924,7 +942,7 @@ QDate QCalendar::dateFromParts(const QCalendar::YearMonthDay &parts) const Converts a QDate to a year, month, and day of the month. The returned structure's isValid() shall be false if the calendar is unable - to represent the given \a date. Otherwise its \a year, \a month, and \a day + to represent the given \a date. Otherwise its year, month, and day members record the so-named parts of its representation. \sa dateFromParts(), isProleptic(), hasYearZero() @@ -935,13 +953,13 @@ QCalendar::YearMonthDay QCalendar::partsFromDate(QDate date) const } /*! - Returns the day of the week number for the given \a date. + Returns the day of the week number for the given \a date. - Returns zero if the calendar is unable to represent the indicated date. - Returns 1 for Monday through 7 for Sunday. Calendars with intercallary days - may use other numbers to represent these. + Returns zero if the calendar is unable to represent the indicated date. + Returns 1 for Monday through 7 for Sunday. Calendars with intercallary days + may use other numbers to represent these. - \sa partsFromDate(), Qt::DayOfWeek + \sa partsFromDate(), Qt::DayOfWeek */ int QCalendar::dayOfWeek(QDate date) const { @@ -951,28 +969,28 @@ int QCalendar::dayOfWeek(QDate date) const // Locale data access /*! - Returns a suitably localised name for a month. + Returns a suitably localised name for a month. - The month is indicated by a number, with \a month = 1 meaning the first month - of the year and subsequent months numbered accordingly. Returns an empty - string if the \a month number is unrecognized. + The month is indicated by a number, with \a month = 1 meaning the first + month of the year and subsequent months numbered accordingly. Returns an + empty string if the \a month number is unrecognized. - The \a year may be Unspecified, in which case the mapping from numbers to - names for a typical year's months should be used. Some calendars have leap - months that aren't always at the end of the year; their mapping of month - numbers to names may then depend on the placement of a leap month. Thus the - year should normally be specified, if known. + The \a year may be Unspecified, in which case the mapping from numbers to + names for a typical year's months should be used. Some calendars have leap + months that aren't always at the end of the year; their mapping of month + numbers to names may then depend on the placement of a leap month. Thus the + year should normally be specified, if known. - The name is returned in the form that would normally be used in a full date, - in the specified \a locale; the \a format determines how fully it shall be - expressed (i.e. to what extent it is abbreviated). + The name is returned in the form that would normally be used in a full date, + in the specified \a locale; the \a format determines how fully it shall be + expressed (i.e. to what extent it is abbreviated). - \sa standaloneMonthName(), maxMonthsInYear(), dateTimeString() + \sa standaloneMonthName(), maximumMonthsInYear(), dateTimeToString() */ QString QCalendar::monthName(const QLocale &locale, int month, int year, QLocale::FormatType format) const { - const int maxMonth = year == Unspecified ? maxMonthsInYear() : monthsInYear(year); + const int maxMonth = year == Unspecified ? maximumMonthsInYear() : monthsInYear(year); if (!d || month < 1 || month > maxMonth) return QString(); @@ -980,28 +998,28 @@ QString QCalendar::monthName(const QLocale &locale, int month, int year, } /*! - Returns a suitably localised standalone name for a month. + Returns a suitably localised standalone name for a month. - The month is indicated by a number, with \a month = 1 meaning the first month - of the year and subsequent months numbered accordingly. Returns an empty - string if the \a month number is unrecognized. + The month is indicated by a number, with \a month = 1 meaning the first + month of the year and subsequent months numbered accordingly. Returns an + empty string if the \a month number is unrecognized. - The \a year may be Unspecified, in which case the mapping from numbers to - names for a typical year's months should be used. Some calendars have leap - months that aren't always at the end of the year; their mapping of month - numbers to names may then depend on the placement of a leap month. Thus the - year should normally be specified, if known. + The \a year may be Unspecified, in which case the mapping from numbers to + names for a typical year's months should be used. Some calendars have leap + months that aren't always at the end of the year; their mapping of month + numbers to names may then depend on the placement of a leap month. Thus the + year should normally be specified, if known. - The name is returned in the form that would be used in isolation in the - specified \a locale; the \a format determines how fully it shall be expressed - (i.e. to what extent it is abbreviated). + The name is returned in the form that would be used in isolation in the + specified \a locale; the \a format determines how fully it shall be + expressed (i.e. to what extent it is abbreviated). - \sa monthName(), maxMonthsInYear(), dateTimeString() + \sa monthName(), maximumMonthsInYear(), dateTimeToString() */ QString QCalendar::standaloneMonthName(const QLocale &locale, int month, int year, QLocale::FormatType format) const { - const int maxMonth = year == Unspecified ? maxMonthsInYear() : monthsInYear(year); + const int maxMonth = year == Unspecified ? maximumMonthsInYear() : monthsInYear(year); if (!d || month < 1 || month > maxMonth) return QString(); @@ -1009,18 +1027,18 @@ QString QCalendar::standaloneMonthName(const QLocale &locale, int month, int yea } /*! - Returns a suitably localised name for a day of the week. + Returns a suitably localised name for a day of the week. - The days of the week are numbered from 1 for Monday through 7 for Sunday. Some - calendars may support higher numbers for other days (e.g. intercallary days, - that are not part of any week). Returns an empty string if the \a day number - is unrecognized. + The days of the week are numbered from 1 for Monday through 7 for + Sunday. Some calendars may support higher numbers for other days + (e.g. intercallary days, that are not part of any week). Returns an empty + string if the \a day number is unrecognized. - The name is returned in the form that would normally be used in a full date, - in the specified \a locale; the \a format determines how fully it shall be - expressed (i.e. to what extent it is abbreviated). + The name is returned in the form that would normally be used in a full date, + in the specified \a locale; the \a format determines how fully it shall be + expressed (i.e. to what extent it is abbreviated). - \sa standaloneWeekDayName(), dayOfWeek() + \sa standaloneWeekDayName(), dayOfWeek() */ QString QCalendar::weekDayName(const QLocale &locale, int day, QLocale::FormatType format) const @@ -1029,19 +1047,20 @@ QString QCalendar::weekDayName(const QLocale &locale, int day, } /*! - Returns a suitably localised standalone name for a day of the week. + Returns a suitably localised standalone name for a day of the week. - The days of the week are numbered from 1 for Monday through 7 for Sunday. Some - calendars may support higher numbers for other days (e.g. intercallary days, - that are not part of any week). Returns an empty string if the \a day number - is unrecognized. + The days of the week are numbered from 1 for Monday through 7 for + Sunday. Some calendars may support higher numbers for other days + (e.g. intercallary days, that are not part of any week). Returns an empty + string if the \a day number is unrecognized. - The name is returned in the form that would be used in isolation (for example - as a column heading in a calendar's tabular display of a month with successive - weeks as rows) in the specified \a locale; the \a format determines how fully - it shall be expressed (i.e. to what extent it is abbreviated). + The name is returned in the form that would be used in isolation (for + example as a column heading in a calendar's tabular display of a month with + successive weeks as rows) in the specified \a locale; the \a format + determines how fully it shall be expressed (i.e. to what extent it is + abbreviated). - \sa weekDayName(), dayOfWeek() + \sa weekDayName(), dayOfWeek() */ QString QCalendar::standaloneWeekDayName(const QLocale &locale, int day, QLocale::FormatType format) const @@ -1050,23 +1069,23 @@ QString QCalendar::standaloneWeekDayName(const QLocale &locale, int day, } /*! - Returns a string representing a given date, time or date-time. - - If \a datetime is valid, it is represented and format specifiers for both date - and time fields are recognized; otherwise, if \a dateOnly is valid, it is - represented and only format specifiers for date fields are recognized; - finally, if \a timeOnly is valid, it is represented and only format specifiers - for time fields are recognized. If none of these is valid, an empty string is - returned. - - See QDate::toString and QTime::toString() for the supported field specifiers. - Characters in \a format that are recognized as field specifiers are replaced - by text representing appropriate data from the date and/or time being - represented. The texts to represent them may depend on the \a locale - specified. Other charagers in \a format are copied verbatim into the returned - string. - - \sa monthName(), weekDayName(), QDate::toString(), QTime::toString() + Returns a string representing a given date, time or date-time. + + If \a datetime is valid, it is represented and format specifiers for both + date and time fields are recognized; otherwise, if \a dateOnly is valid, it + is represented and only format specifiers for date fields are recognized; + finally, if \a timeOnly is valid, it is represented and only format + specifiers for time fields are recognized. If none of these is valid, an + empty string is returned. + + See QDate::toString and QTime::toString() for the supported field + specifiers. Characters in \a format that are recognized as field specifiers + are replaced by text representing appropriate data from the date and/or time + being represented. The texts to represent them may depend on the \a locale + specified. Other charagers in \a format are copied verbatim into the + returned string. + + \sa monthName(), weekDayName(), QDate::toString(), QTime::toString() */ QString QCalendar::dateTimeToString(QStringView format, const QDateTime &datetime, const QDate &dateOnly, const QTime &timeOnly, |