15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Basic time formatting methods. These methods use the current locale 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// formatting for displaying the time. 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_I18N_TIME_FORMATTING_H_ 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_I18N_TIME_FORMATTING_H_ 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/i18n/base_i18n_export.h" 12868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/string16.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Time; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Argument type used to specify the hour clock type. 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum HourClockType { 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) k12HourClock, // Uses 1-12. e.g., "3:07 PM" 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) k24HourClock, // Uses 0-23. e.g., "15:07" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Argument type used to specify whether or not to include AM/PM sign. 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum AmPmClockType { 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kDropAmPm, // Drops AM/PM sign. e.g., "3:07" 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kKeepAmPm, // Keeps AM/PM sign. e.g., "3:07 PM" 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns the time of day, e.g., "3:07 PM". 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)BASE_I18N_EXPORT string16 TimeFormatTimeOfDay(const Time& time); 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns the time of day in the specified hour clock type. e.g. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "3:07 PM" (type == k12HourClock, ampm == kKeepAmPm). 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "3:07" (type == k12HourClock, ampm == kDropAmPm). 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "15:07" (type == k24HourClock). 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)BASE_I18N_EXPORT string16 TimeFormatTimeOfDayWithHourClockType( 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Time& time, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HourClockType type, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AmPmClockType ampm); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns a shortened date, e.g. "Nov 7, 2007" 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)BASE_I18N_EXPORT string16 TimeFormatShortDate(const Time& time); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns a numeric date such as 12/13/52. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)BASE_I18N_EXPORT string16 TimeFormatShortDateNumeric(const Time& time); 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns a numeric date and time such as "12/13/52 2:44:30 PM". 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)BASE_I18N_EXPORT string16 TimeFormatShortDateAndTime(const Time& time); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Formats a time in a friendly sentence format, e.g. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "Monday, March 6, 2008 2:44:30 PM". 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)BASE_I18N_EXPORT string16 TimeFormatFriendlyDateAndTime(const Time& time); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Formats a time in a friendly sentence format, e.g. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "Monday, March 6, 2008". 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)BASE_I18N_EXPORT string16 TimeFormatFriendlyDate(const Time& time); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Gets the hour clock type of the current locale. e.g. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// k12HourClock (en-US). 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// k24HourClock (en-GB). 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)BASE_I18N_EXPORT HourClockType GetHourClockType(); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace base 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_I18N_TIME_FORMATTING_H_ 67