diff options
Diffstat (limited to 'doc/src/qml/qmldate.qdoc')
| -rw-r--r-- | doc/src/qml/qmldate.qdoc | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/doc/src/qml/qmldate.qdoc b/doc/src/qml/qmldate.qdoc new file mode 100644 index 0000000000..7ac200db46 --- /dev/null +++ b/doc/src/qml/qmldate.qdoc @@ -0,0 +1,190 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** GNU Free Documentation License +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmlclass Date + \inqmlmodule QtQuick 2 + \brief The Date object provides date functions + + The QML Date object extends the JS Date object with + locale aware functions. + + Functions that accept a locale format may be either an enumeration + value: + \table + \row \i Locale.LongFormat \i The long version of the string; for example, returning "January" as a month name. + \row \i Locale.ShortFormat \i The short version of the string; for example, returning "Jan" as a month name. + \row \i Locale.NarrowFormat \i A special version for use when space is limited; + for example, returning "J" as a month name. Note that the narrow format might contain + the same text for different months and days or it can even be an empty string if the + locale doesn't support narrow names, so you should avoid using it for date formatting. + Also, for the system locale this format is the same as ShortFormat. + \endtable + + or a string specifying the format These expressions may be used for format dates: + \table + \header \i Expression \i Output + \row \i d \i the day as number without a leading zero (1 to 31) + \row \i dd \i the day as number with a leading zero (01 to 31) + \row \i ddd + \i the abbreviated localized day name (e.g. 'Mon' to 'Sun'). + \row \i dddd + \i the long localized day name (e.g. 'Monday' to 'Sunday'). + \row \i M \i the month as number without a leading zero (1 to 12) + \row \i MM \i the month as number with a leading zero (01 to 12) + \row \i MMM + \i the abbreviated localized month name (e.g. 'Jan' to 'Dec'). + \row \i MMMM + \i the long localized month name (e.g. 'January' to 'December'). + \row \i yy \i the year as two digit number (00 to 99) + \row \i yyyy \i the year as four digit number. If the year is negative, + a minus sign is prepended in addition. + \endtable + + All other input characters will be ignored. Any sequence of characters that + are enclosed in singlequotes will be treated as text and not be used as an + expression. Two consecutive singlequotes ("''") are replaced by a singlequote + in the output. + + Example format strings (assuming that the Date is the 20 July + 1969): + + \table + \header \o Format \o Result + \row \o dd.MM.yyyy \o 20.07.1969 + \row \o ddd MMMM d yy \o Sun July 20 69 + \row \o 'The day is' dddd \o The day is Sunday + \endtable + + These expressions may be used for formatting time: + + \table + \header \i Expression \i Output + \row \i h + \i the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) + \row \i hh + \i the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) + \row \i H + \i the hour without a leading zero (0 to 23, even with AM/PM display) + \row \i HH + \i the hour with a leading zero (00 to 23, even with AM/PM display) + \row \i m \i the minute without a leading zero (0 to 59) + \row \i mm \i the minute with a leading zero (00 to 59) + \row \i s \i the second without a leading zero (0 to 59) + \row \i ss \i the second with a leading zero (00 to 59) + \row \i z \i the milliseconds without leading zeroes (0 to 999) + \row \i zzz \i the milliseconds with leading zeroes (000 to 999) + \row \i AP or A + \i use AM/PM display. \e AP will be replaced by either "AM" or "PM". + \row \i ap or a + \i use am/pm display. \e ap will be replaced by either "am" or "pm". + \row \i t \i the timezone (for example "CEST") + \endtable + + All other input characters will be ignored. Any sequence of characters that + are enclosed in singlequotes will be treated as text and not be used as an + expression. Two consecutive singlequotes ("''") are replaced by a singlequote + in the output. + + Example format strings (assuming that the QTime is 14:13:09.042) + + \table + \header \i Format \i Result + \row \i hh:mm:ss.zzz \i 14:13:09.042 + \row \i h:m:s ap \i 2:13:9 pm + \row \i H:m:s a \i 14:13:9 pm + \endtable + + If the date is invalid, an empty string will be returned. + + \sa {QtQuick2::Locale}{Locale} +*/ + +/*! + \qmlmethod string Date::toLocaleString(locale,format) + + Converts the Date to a string containing the date and time + suitable for the specified \a locale + in the specified \a format. + + If the format is not specified Locale.LongFormat will be used. + + If \a locale is not specified, the default locale will be used. + + The following example shows the current date and time formatted + for the German locale: + \code + import QtQuick 2.0 + + Text { + text: "The date is: " + Date().toLocaleString(Qt.locale("de_DE")) + } + \endcode +*/ + +/*! + \qmlmethod string Date::toLocaleDateString(locale,format) + + Converts the Date to a string containing the date suitable for the specified \a locale + in the specified \a format. + + If the format is not specified Locale.LongFormat will be used. + + If \a locale is not specified, the default locale will be used. + + The following example shows the current date formatted + for the German locale: + \code + import QtQuick 2.0 + + Text { + text: "The date is: " + Date().toLocaleDateString(Qt.locale("de_DE")) + } + \endcode +*/ + +/*! + \qmlmethod string Date::toLocaleTimeString(locale,format) + + Converts the Date to a string containing the time suitable for the specified \a locale + in the specified \a format. + + If the format is not specified Locale.LongFormat will be used. + + If \a locale is not specified, the default locale will be used. + + The following example shows the current time formatted + for the German locale: + \code + import QtQuick 2.0 + + Text { + text: "The date is: " + Date().toLocaleTimeString(Qt.locale("de_DE")) + } + \endcode +*/ + |