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 #ifndef UI_BASE_TEXT_BYTES_FORMATTING_H_ | 5 #ifndef UI_BASE_TEXT_BYTES_FORMATTING_H_ |
6 #define UI_BASE_TEXT_BYTES_FORMATTING_H_ | 6 #define UI_BASE_TEXT_BYTES_FORMATTING_H_ |
7 | 7 |
8 #include "base/basictypes.h" | 8 #include "base/basictypes.h" |
9 #include "base/strings/string16.h" | 9 #include "base/strings/string16.h" |
10 #include "ui/base/ui_export.h" | 10 #include "ui/base/ui_export.h" |
11 | 11 |
12 namespace ui { | 12 namespace ui { |
13 | 13 |
14 // Simple API ------------------------------------------------------------------ | 14 // Simple API ------------------------------------------------------------------ |
15 | 15 |
16 // Simple call to return a byte quantity as a string in human-readable format. | 16 // Simple call to return a byte quantity as a string in human-readable format. |
17 // Ex: FormatBytes(512) => "512 B" | 17 // Ex: FormatBytes(512) => "512 B" |
18 // Ex: FormatBytes(101479) => "99.1 kB" | 18 // Ex: FormatBytes(101479) => "99.1 kB" |
19 UI_EXPORT string16 FormatBytes(int64 bytes); | 19 UI_EXPORT base::string16 FormatBytes(int64 bytes); |
20 | 20 |
21 // Simple call to return a speed as a string in human-readable format. | 21 // Simple call to return a speed as a string in human-readable format. |
22 // Ex: FormatSpeed(512) => "512 B/s" | 22 // Ex: FormatSpeed(512) => "512 B/s" |
23 // Ex: FormatSpeed(101479) => "99.1 kB/s" | 23 // Ex: FormatSpeed(101479) => "99.1 kB/s" |
24 UI_EXPORT string16 FormatSpeed(int64 bytes); | 24 UI_EXPORT base::string16 FormatSpeed(int64 bytes); |
25 | 25 |
26 // Less-Simple API ------------------------------------------------------------- | 26 // Less-Simple API ------------------------------------------------------------- |
27 | 27 |
28 enum DataUnits { | 28 enum DataUnits { |
29 DATA_UNITS_BYTE = 0, | 29 DATA_UNITS_BYTE = 0, |
30 DATA_UNITS_KIBIBYTE, | 30 DATA_UNITS_KIBIBYTE, |
31 DATA_UNITS_MEBIBYTE, | 31 DATA_UNITS_MEBIBYTE, |
32 DATA_UNITS_GIBIBYTE, | 32 DATA_UNITS_GIBIBYTE, |
33 DATA_UNITS_TEBIBYTE, | 33 DATA_UNITS_TEBIBYTE, |
34 DATA_UNITS_PEBIBYTE | 34 DATA_UNITS_PEBIBYTE |
35 }; | 35 }; |
36 | 36 |
37 // Return the unit type that is appropriate for displaying the amount of bytes | 37 // Return the unit type that is appropriate for displaying the amount of bytes |
38 // passed in. Most of the time, an explicit call to this isn't necessary; just | 38 // passed in. Most of the time, an explicit call to this isn't necessary; just |
39 // use FormatBytes()/FormatSpeed() above. | 39 // use FormatBytes()/FormatSpeed() above. |
40 UI_EXPORT DataUnits GetByteDisplayUnits(int64 bytes); | 40 UI_EXPORT DataUnits GetByteDisplayUnits(int64 bytes); |
41 | 41 |
42 // Return a byte quantity as a string in human-readable format with an optional | 42 // Return a byte quantity as a string in human-readable format with an optional |
43 // unit suffix. Specify in the |units| argument the units to be used. | 43 // unit suffix. Specify in the |units| argument the units to be used. |
44 // Ex: FormatBytes(512, DATA_UNITS_KIBIBYTE, true) => "0.5 kB" | 44 // Ex: FormatBytes(512, DATA_UNITS_KIBIBYTE, true) => "0.5 kB" |
45 // Ex: FormatBytes(10*1024, DATA_UNITS_MEBIBYTE, false) => "0.1" | 45 // Ex: FormatBytes(10*1024, DATA_UNITS_MEBIBYTE, false) => "0.1" |
46 UI_EXPORT string16 FormatBytesWithUnits(int64 bytes, DataUnits units, | 46 UI_EXPORT base::string16 FormatBytesWithUnits(int64 bytes, |
47 bool show_units); | 47 DataUnits units, |
| 48 bool show_units); |
48 | 49 |
49 // As above, but with "/s" units for speed values. | 50 // As above, but with "/s" units for speed values. |
50 // Ex: FormatSpeed(512, DATA_UNITS_KIBIBYTE, true) => "0.5 kB/s" | 51 // Ex: FormatSpeed(512, DATA_UNITS_KIBIBYTE, true) => "0.5 kB/s" |
51 // Ex: FormatSpeed(10*1024, DATA_UNITS_MEBIBYTE, false) => "0.1" | 52 // Ex: FormatSpeed(10*1024, DATA_UNITS_MEBIBYTE, false) => "0.1" |
52 string16 FormatSpeedWithUnits(int64 bytes, DataUnits units, bool show_units); | 53 base::string16 FormatSpeedWithUnits(int64 bytes, |
| 54 DataUnits units, |
| 55 bool show_units); |
53 | 56 |
54 } // namespace ui | 57 } // namespace ui |
55 | 58 |
56 #endif // UI_BASE_TEXT_BYTES_FORMATTING_H_ | 59 #endif // UI_BASE_TEXT_BYTES_FORMATTING_H_ |
OLD | NEW |