| // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef UI_BASE_L10N_TIME_FORMAT_H_ |
| #define UI_BASE_L10N_TIME_FORMAT_H_ |
| |
| #include "base/basictypes.h" |
| #include "base/strings/string16.h" |
| #include "ui/base/ui_export.h" |
| |
| namespace base { |
| class Time; |
| class TimeDelta; |
| } |
| |
| namespace ui { |
| |
| // Methods to format time values as strings. |
| class UI_EXPORT TimeFormat { |
| public: |
| // TimeElapsed, TimeRemaining and TimeRemainingShort functions: |
| // These functions return a localized string of approximate time duration. The |
| // conditions are simpler than PastTime since these functions are used for |
| // in-progress operations and users have different expectations of units. |
| |
| // Returns times in elapsed-format: "3 mins ago", "2 days ago". |
| static string16 TimeElapsed(const base::TimeDelta& delta); |
| |
| // Returns times in remaining-format: "3 mins left", "2 days left". |
| static string16 TimeRemaining(const base::TimeDelta& delta); |
| |
| // Returns times in remaining-long-format: "3 minutes left", "2 days left". |
| // Currently, this only affects the minutes in long format, the rest |
| // of the time units are formatted the same as TimeRemaining does. |
| static string16 TimeRemainingLong(const base::TimeDelta& delta); |
| |
| // Returns times in short-format: "3 mins", "2 days". |
| static string16 TimeRemainingShort(const base::TimeDelta& delta); |
| |
| // Return times in long-format: "2 hours", "25 minutes". |
| static string16 TimeDurationLong(const base::TimeDelta& delta); |
| |
| // For displaying a relative time in the past. This method returns either |
| // "Today", "Yesterday", or an empty string if it's older than that. Returns |
| // the empty string for days in the future. |
| // |
| // TODO(brettw): This should be able to handle days in the future like |
| // "Tomorrow". |
| // TODO(tc): This should be able to do things like "Last week". This |
| // requires handling singluar/plural for all languages. |
| // |
| // The second parameter is optional, it is midnight of "Now" for relative day |
| // computations: Time::Now().LocalMidnight() |
| // If NULL, the current day's midnight will be retrieved, which can be |
| // slow. If many items are being processed, it is best to get the current |
| // time once at the beginning and pass it for each computation. |
| static string16 RelativeDate(const base::Time& time, |
| const base::Time* optional_midnight_today); |
| |
| private: |
| DISALLOW_IMPLICIT_CONSTRUCTORS(TimeFormat); |
| }; |
| |
| } // namespace ui |
| |
| #endif // UI_BASE_L10N_TIME_FORMAT_H_ |