//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
*/
enum DateTimeStyle
{
- DATE_TIME_STYLE_NONE = -1, /**< The date time style: None */
- DATE_TIME_STYLE_FULL = 0, /**< The date time style: FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42PM PST */
- DATE_TIME_STYLE_LONG = 1, /**< The date time style: LONG is longer, such as July 18, 2012 or 3:30:32PM */
- DATE_TIME_STYLE_MEDIUM = 2, /**< The date time style: MEDIUM is a little longer, such as Jan 12, 1952 */
- DATE_TIME_STYLE_SHORT = 3, /**< The date time style: SHORT is completely numeric, such as 12/13/52 or 3:30PM */
- DATE_TIME_STYLE_DEFAULT = DATE_TIME_STYLE_MEDIUM /**< The default date time style: Medium */
+ DATE_TIME_STYLE_NONE = -1, /**< No date time style */
+ DATE_TIME_STYLE_FULL = 0, /**< The full date time style @n For example, Tuesday, April 12, 1952 AD or 3:30:42PM PST */
+ DATE_TIME_STYLE_LONG = 1, /**< The long date time style @n For example, July 18, 2012 or 3:30:32PM */
+ DATE_TIME_STYLE_MEDIUM = 2, /**< The medium date time style @n For example, Jan 12, 1952 */
+ DATE_TIME_STYLE_SHORT = 3, /**< The short date time style @n This style is completely numeric. For example, 12/13/52 or 3:30PM */
+ DATE_TIME_STYLE_DEFAULT = DATE_TIME_STYLE_MEDIUM /**< The default date time style @n This is set to Medium */
};
/**
* @return A pointer to the system locale date formatter, @n
* else @c null if an error occurs
* @param[in] style The formatting style @n
- * For example, "M/d/yy" is the short form for displaying only date in the US locale.
+ * For example, "M/d/yy" is the short form for displaying only the date in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The current locale is not supported.
- * @exception E_INVALID_ARG The specified @c style is an invalid value.
+ * @exception E_INVALID_ARG The specified @c style is an invalid value.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateDateFormatterN(DateTimeStyle style = DATE_TIME_STYLE_DEFAULT);
* Creates the date formatter with the specified formatting style for the specified locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here".
* @endif
*
* @return A pointer to the specified locale date formatter, @n
* else @c null if an error occurs
* @param[in] locale The locale
* @param[in] style The formatting style @n
- * For example, "M/d/yy" is the short form for displaying only date in the US locale.
+ * For example, "M/d/yy" is the short form for displaying only the date in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale or @c style is invalid.
+ * @exception E_INVALID_ARG The specified @c locale or @c style is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateDateFormatterN(const Locale& locale, DateTimeStyle style = DATE_TIME_STYLE_DEFAULT);
/**
* @if OSPCOMPAT
- * @page CompDateTimeFormatterCreateDateFormatterNPage Compatibility for CreateDateFormatterN()
- * @section CompDateTimeFormatterCreateDateFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompDateTimeFormatterCreateDateFormatterNtSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompDateTimeFormatterCreateDateFormatterNPage Compatibility for CreateDateFormatterN()
+ * @section CompDateTimeFormatterCreateDateFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompDateTimeFormatterCreateDateFormatterNtSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid.
+ * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid.
* @endif
- */
+ */
/**
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The current locale is not supported.
- * @exception E_INVALID_ARG The specified @c style is invalid.
+ * @exception E_INVALID_ARG The specified @c style is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateTimeFormatterN(DateTimeStyle style = DATE_TIME_STYLE_DEFAULT);
* Creates the time formatter with the specified formatting style for the specified @c locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here".
* @endif
*
* @return A pointer to the specified locale time formatter, @n
* For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale or @c style is invalid.
+ * @exception E_INVALID_ARG The specified @c locale or @c style is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateTimeFormatterN(const Locale& locale, DateTimeStyle style = DATE_TIME_STYLE_DEFAULT);
/**
* @if OSPCOMPAT
- * @page CompDateTimeFormatterCreateTimeFormatterNPage Compatibility for CreateTimeFormatterN()
- * @section CompDateTimeFormatterCreateTimeFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompGrDateTimeFormatterCreateTimeFormatterNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid.
+ * @page CompDateTimeFormatterCreateTimeFormatterNPage Compatibility for CreateTimeFormatterN()
+ * @section CompDateTimeFormatterCreateTimeFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompGrDateTimeFormatterCreateTimeFormatterNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid.
* @endif
- */
+ */
/**
* Creates the date/time formatter with the specified formatting style for the system locale.
* @return A pointer to the system locale date/time formatter, @n
* else @c null if an error occurs
* @param[in] dateStyle The date formatting style @n
- * For example, "M/d/yy" is the short form for displaying only date in the US locale.
+ * For example, "M/d/yy" is the short form for displaying only the date in the US locale.
* @param[in] timeStyle The time formatting style @n
* For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The current locale is not supported.
- * @exception E_INVALID_ARG The specified @c dateStyle or @c timeStyle is invalid.
+ * @exception E_INVALID_ARG The specified @c dateStyle or @c timeStyle is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateDateTimeFormatterN(DateTimeStyle dateStyle = DATE_TIME_STYLE_DEFAULT, DateTimeStyle timeStyle = DATE_TIME_STYLE_DEFAULT);
* For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is not supported, or the @c dateStyle or the @c timeStyle is invalid.
+ * @exception E_INVALID_ARG The specified @c locale is not supported, or the @c dateStyle or the @c timeStyle is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static DateTimeFormatter* CreateDateTimeFormatterN(const Locale& locale, DateTimeStyle dateStyle = DATE_TIME_STYLE_DEFAULT, DateTimeStyle timeStyle = DATE_TIME_STYLE_DEFAULT);
/**
- * Formats a Tizen::Base::DateTime object into a date/time string and appends the resulting string to the specified string buffer.
+ * Formats a Tizen::Base::DateTime object into a date/time string and appends the resulting string to the specified string.
*
* @since 2.0
*
* @return An error code
* @param[in] date The Tizen::Base::DateTime object to format
- * @param[out] str The string to append to the resultant string
+ * @param[out] str The string to which formatted string is appended
* @exception E_SUCCESS The method is successful.
* @remarks This method does not handle the time zone information, so "z" pattern always returns "GMT+00:00".
- * @see Tizen::Base::DateTime
*/
virtual result Format(const Tizen::Base::DateTime& date, Tizen::Base::String& str) const;
*
* @return An error code
* @param[in] calendar The Calendar object to format
- * @param[out] str The string to append to the resultant string
+ * @param[out] str The string to which formatted string is appended
* @exception E_SUCCESS The method is successful.
- * @see Tizen::Base::DateTime
+ * @see Tizen::Base::DateTime
*/
virtual result Format(const Calendar& calendar, Tizen::Base::String& str) const;
*
* @since 2.0
*
- * @param[in] pattern The new date and time pattern for the date format
+ * @param[in] pattern The date and time pattern for the date format
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified @c pattern is @c 0.
*/
/**
- * Gets a pattern string describing the date format.
+ * Gets the pattern string describing the date format.
*
* @since 2.0
*
- * @return A string describing the date format
+ * @return The date format pattern string
*/
Tizen::Base::String GetPattern(void) const;
*
* @since 2.0
*
- * @return A pointer to DateTimeSymbols for the formatter instance
+ * @return A pointer to DateTimeSymbols of the formatter
* @see SetDateTimeSymbols()
*/
const DateTimeSymbols* GetDateTimeSymbols(void) const;
/**
- * Sets the date and time format symbols of the date format.
+ * Sets the date and time format symbols of the formatter.
*
* @since 2.0
*
- * @param[in] newSymbols The new date and time format symbols
+ * @param[in] newSymbols The date and time format symbols
* @see GetDateTimeSymbols()
*/
void SetDateTimeSymbols(const DateTimeSymbols& newSymbols);
projects / platform / framework / native / appfw.git / blobdiff