OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 // Basic time formatting methods. These methods use the current locale | 5 // Basic time formatting methods. These methods use the current locale |
6 // formatting for displaying the time. | 6 // formatting for displaying the time. |
7 | 7 |
8 #ifndef BASE_I18N_TIME_FORMATTING_H_ | 8 #ifndef BASE_I18N_TIME_FORMATTING_H_ |
9 #define BASE_I18N_TIME_FORMATTING_H_ | 9 #define BASE_I18N_TIME_FORMATTING_H_ |
10 #pragma once | 10 #pragma once |
11 | 11 |
| 12 #include "base/i18n/base_i18n_export.h" |
12 #include "base/string16.h" | 13 #include "base/string16.h" |
13 | 14 |
14 namespace base { | 15 namespace base { |
15 | 16 |
16 class Time; | 17 class Time; |
17 | 18 |
18 // Argument type used to specify the hour clock type. | 19 // Argument type used to specify the hour clock type. |
19 enum HourClockType { | 20 enum HourClockType { |
20 k12HourClock, // Uses 1-12. e.g., "3:07 PM" | 21 k12HourClock, // Uses 1-12. e.g., "3:07 PM" |
21 k24HourClock, // Uses 0-23. e.g., "15:07" | 22 k24HourClock, // Uses 0-23. e.g., "15:07" |
22 }; | 23 }; |
23 | 24 |
24 // Argument type used to specify whether or not to include AM/PM sign. | 25 // Argument type used to specify whether or not to include AM/PM sign. |
25 enum AmPmClockType { | 26 enum AmPmClockType { |
26 kDropAmPm, // Drops AM/PM sign. e.g., "3:07" | 27 kDropAmPm, // Drops AM/PM sign. e.g., "3:07" |
27 kKeepAmPm, // Keeps AM/PM sign. e.g., "3:07 PM" | 28 kKeepAmPm, // Keeps AM/PM sign. e.g., "3:07 PM" |
28 }; | 29 }; |
29 | 30 |
30 // Returns the time of day, e.g., "3:07 PM". | 31 // Returns the time of day, e.g., "3:07 PM". |
31 string16 TimeFormatTimeOfDay(const Time& time); | 32 BASE_I18N_EXPORT string16 TimeFormatTimeOfDay(const Time& time); |
32 | 33 |
33 // Returns the time of day in the specified hour clock type. e.g. | 34 // Returns the time of day in the specified hour clock type. e.g. |
34 // "3:07 PM" (type == k12HourClock, ampm == kKeepAmPm). | 35 // "3:07 PM" (type == k12HourClock, ampm == kKeepAmPm). |
35 // "3:07" (type == k12HourClock, ampm == kDropAmPm). | 36 // "3:07" (type == k12HourClock, ampm == kDropAmPm). |
36 // "15:07" (type == k24HourClock). | 37 // "15:07" (type == k24HourClock). |
37 string16 TimeFormatTimeOfDayWithHourClockType(const Time& time, | 38 BASE_I18N_EXPORT string16 TimeFormatTimeOfDayWithHourClockType( |
38 HourClockType type, | 39 const Time& time, |
39 AmPmClockType ampm); | 40 HourClockType type, |
| 41 AmPmClockType ampm); |
40 | 42 |
41 // Returns a shortened date, e.g. "Nov 7, 2007" | 43 // Returns a shortened date, e.g. "Nov 7, 2007" |
42 string16 TimeFormatShortDate(const Time& time); | 44 BASE_I18N_EXPORT string16 TimeFormatShortDate(const Time& time); |
43 | 45 |
44 // Returns a numeric date such as 12/13/52. | 46 // Returns a numeric date such as 12/13/52. |
45 string16 TimeFormatShortDateNumeric(const Time& time); | 47 BASE_I18N_EXPORT string16 TimeFormatShortDateNumeric(const Time& time); |
46 | 48 |
47 // Returns a numeric date and time such as "12/13/52 2:44:30 PM". | 49 // Returns a numeric date and time such as "12/13/52 2:44:30 PM". |
48 string16 TimeFormatShortDateAndTime(const Time& time); | 50 BASE_I18N_EXPORT string16 TimeFormatShortDateAndTime(const Time& time); |
49 | 51 |
50 // Formats a time in a friendly sentence format, e.g. | 52 // Formats a time in a friendly sentence format, e.g. |
51 // "Monday, March 6, 2008 2:44:30 PM". | 53 // "Monday, March 6, 2008 2:44:30 PM". |
52 string16 TimeFormatFriendlyDateAndTime(const Time& time); | 54 BASE_I18N_EXPORT string16 TimeFormatFriendlyDateAndTime(const Time& time); |
53 | 55 |
54 // Formats a time in a friendly sentence format, e.g. | 56 // Formats a time in a friendly sentence format, e.g. |
55 // "Monday, March 6, 2008". | 57 // "Monday, March 6, 2008". |
56 string16 TimeFormatFriendlyDate(const Time& time); | 58 BASE_I18N_EXPORT string16 TimeFormatFriendlyDate(const Time& time); |
57 | 59 |
58 // Gets the hour clock type of the current locale. e.g. | 60 // Gets the hour clock type of the current locale. e.g. |
59 // k12HourClock (en-US). | 61 // k12HourClock (en-US). |
60 // k24HourClock (en-GB). | 62 // k24HourClock (en-GB). |
61 HourClockType GetHourClockType(); | 63 BASE_I18N_EXPORT HourClockType GetHourClockType(); |
62 | 64 |
63 } // namespace base | 65 } // namespace base |
64 | 66 |
65 #endif // BASE_I18N_TIME_FORMATTING_H_ | 67 #endif // BASE_I18N_TIME_FORMATTING_H_ |
OLD | NEW |