summaryrefslogtreecommitdiffstats
path: root/src/declarative/util/qmldatetimeformatter.cpp
blob: 9d216cf85263ef52d485cfc3010f1800f582f482 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmldatetimeformatter_p.h"

#include <QtCore/qlocale.h>

#include <private/qobject_p.h>

QT_BEGIN_NAMESPACE

//TODO: may need optimisation as the QDateTime member may not be needed?
//      be able to set a locale?

class QmlDateTimeFormatterPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlDateTimeFormatter)
public:
    QmlDateTimeFormatterPrivate() : locale(QLocale::system()), longStyle(false), componentComplete(true) {}

    void updateText();

    QDateTime dateTime;
    QDate date;
    QTime time;
    QLocale locale;
    QString dateTimeText;
    QString dateText;
    QString timeText;
    QString dateTimeFormat; //set for convienience?
    QString dateFormat;
    QString timeFormat;
    bool longStyle;
    bool componentComplete;
};

/*!
    \qmlclass DateTimeFormatter QmlDateTimeFormatter
    \brief The DateTimeFormatter allows you to control the format of a date string.

    \code
    DateTimeFormatter { id: formatter; date: System.date }
    Text { text: formatter.dateText }
    \endcode

    By default, the text properties (dateText, timeText, and dateTimeText) will return the
    date and time using the current system locale's format.
*/

/*!
    \internal
    \class QmlDateTimeFormatter
    \ingroup group_utility
    \brief The QmlDateTimeFormatter class allows you to format a date string.
*/

QmlDateTimeFormatter::QmlDateTimeFormatter(QObject *parent)
: QObject(*(new QmlDateTimeFormatterPrivate), parent)
{
}

QmlDateTimeFormatter::~QmlDateTimeFormatter()
{
}

/*!
    \qmlproperty string DateTimeFormatter::dateText
    \qmlproperty string DateTimeFormatter::timeText
    \qmlproperty string DateTimeFormatter::dateTimeText

    Formatted text representations of the \c date, \c time,
    and \c {date and time}, respectively.

    If there is no explictly specified format the DateTimeFormatter
    will use the system locale's default 'short' setting.

    \code
    // specify source date (assuming today is February 19, 2009)
    DateTimeFormatter { id: formatter; dateTime: Today.date }

    // display the full date and time
    Text { text: formatter.dateText }
    \endcode

    Would be equivalent to the following for a US English locale:

    \code
    // display the date
    Text { text: "2/19/09" }
    \endcode
*/
QString QmlDateTimeFormatter::dateTimeText() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->dateTimeText;
}

QString QmlDateTimeFormatter::dateText() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->dateText;
}

QString QmlDateTimeFormatter::timeText() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->timeText;
}

/*!
    \qmlproperty date DateTimeFormatter::date
    \qmlproperty time DateTimeFormatter::time
    \qmlproperty datetime DateTimeFormatter::dateTime

    The source date and time to be used by the formatter.

    \code
    // setting the date and time
    DateTimeFormatter { date: System.date; time: System.time }
    \endcode

    For convienience it is possible to set the datetime property to set both the date and the time.
    \code
    // setting the datetime
    DateTimeFormatter { dateTime: System.dateTime }
    \endcode

    There can only be one instance of date and time per formatter; if date, time, and dateTime are all
    set the actual date and time used is not guaranteed.

    \note If no date is set, dateTimeText will be just the date;
    If no time is set, the dateTimeText will be just the time.
    
*/
QDate QmlDateTimeFormatter::date() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->date;
}

QTime QmlDateTimeFormatter::time() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->time;
}

QDateTime QmlDateTimeFormatter::dateTime() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->dateTime;
}

/*!
    \qmlproperty string DateTimeFormatter::dateFormat
    \qmlproperty string DateTimeFormatter::timeFormat
    \qmlproperty string DateTimeFormatter::dateTimeFormat

    Specifies a custom format which the DateTime Formatter can use.

    If there is no explictly specified format the DateTimeFormatter
    will use the system locale's default 'short' setting.

    The text's format may be modified by setting:
    \list
    \i \c dateFormat
    \i \c timeFormat
    \i \c dateTimeFormat
    \endlist

    If only the format for date is defined, the time and dateTime formats will be defined
    as the system locale default and likewise for the others.

    Syntax for the format is based on the QDateTime::toString() formatting options.

    \code
    // Format the date such that the dateText is: '1997-12-12'
    DateTimeFormatter { id: formatter; dateTime: Today.dateTime; formatDate: "yyyy-MM-d" }
    \endcode

    Assigning an empty string to a particular format will reset it.
*/
QString QmlDateTimeFormatter::dateTimeFormat() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->dateTimeFormat;
}

QString QmlDateTimeFormatter::dateFormat() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->dateFormat;
}

QString QmlDateTimeFormatter::timeFormat() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->timeFormat;
}

/*!
    \qmlproperty bool DateTimeFormatter::longStyle

    This property causes the formatter to use the system locale's long format rather than short format
    by default.

    This setting is off by default.
*/
bool QmlDateTimeFormatter::longStyle() const
{
    Q_D(const QmlDateTimeFormatter);
    return d->longStyle;
}

void QmlDateTimeFormatter::setDateTime(const QDateTime &dateTime)
{
    Q_D(QmlDateTimeFormatter);
    if (d->dateTime == dateTime)
        return;
    d->dateTime = dateTime;
    d->date = d->dateTime.date();
    d->time = d->dateTime.time();
    d->updateText();
}

void QmlDateTimeFormatter::setTime(const QTime &time)
{
    Q_D(QmlDateTimeFormatter);
    if (d->dateTime.time() == time)
        return;
    d->time = time;
    d->dateTime.setTime(time);
    d->updateText();
}

void QmlDateTimeFormatter::setDate(const QDate &date)
{
    Q_D(QmlDateTimeFormatter);
    if (d->dateTime.date() == date)
        return;
    d->date = date;
    bool clearTime = d->dateTime.time().isValid() ? false : true;   //because setting date generates default time
    d->dateTime.setDate(date);
    if (clearTime)
        d->dateTime.setTime(QTime());
    d->updateText();
}

//DateTime formatting may be a combination of date and time?
void QmlDateTimeFormatter::setDateTimeFormat(const QString &format)
{
    Q_D(QmlDateTimeFormatter);
    //no format checking
    d->dateTimeFormat = format;
    d->updateText();
}

void QmlDateTimeFormatter::setDateFormat(const QString &format)
{
    Q_D(QmlDateTimeFormatter);
    //no format checking
    d->dateFormat = format;
    d->updateText();
}

void QmlDateTimeFormatter::setTimeFormat(const QString &format)
{
    Q_D(QmlDateTimeFormatter);
    //no format checking
    d->timeFormat = format;
    d->updateText();
}

void QmlDateTimeFormatter::setLongStyle(bool longStyle)
{
    Q_D(QmlDateTimeFormatter);
    d->longStyle = longStyle;
    d->updateText();
}

void QmlDateTimeFormatterPrivate::updateText()
{
    Q_Q(QmlDateTimeFormatter);
    if (!componentComplete)
        return;

    QString str;
    QString str1;
    QString str2;

    Qt::DateFormat defaultFormat = longStyle ? Qt::SystemLocaleLongDate : Qt::SystemLocaleShortDate;

    if (dateFormat.isEmpty())
        str1 = date.toString(defaultFormat);
    else
        str1 = date.toString(dateFormat);

    if (timeFormat.isEmpty())
        str2 = time.toString(defaultFormat);
    else
        str2 = time.toString(timeFormat);

    if (dateTimeFormat.isEmpty())
        str = dateTime.toString(defaultFormat);
    //else if (!formatTime.isEmpty() && !formatDate.isEmpty())
    //    str = str1 + QLatin1Char(' ') + str2;
    else
        str = dateTime.toString(dateTimeFormat);

    if (dateTimeText == str && dateText == str1 && timeText == str2)
        return;

    dateTimeText = str;
    dateText = str1;
    timeText = str2;

    emit q->textChanged();
}

void QmlDateTimeFormatter::classBegin()
{
    Q_D(QmlDateTimeFormatter);
    d->componentComplete = false;
}

void QmlDateTimeFormatter::componentComplete()
{
    Q_D(QmlDateTimeFormatter);
    d->componentComplete = true;
    d->updateText();
}

QML_DEFINE_TYPE(Qt,4,6,DateTimeFormatter,QmlDateTimeFormatter)

QT_END_NAMESPACE