//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class LocaleManager
- * @brief This class is used for the %LocaleManager identification.
+ * @brief This class provides methods for %LocaleManager identification.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %LocaleManager class helps application programmers handle the system locale information of the device. Each device system has at least one installed locale and often has many locales from which the user can choose.
+ * The %LocaleManager class provides methods for the system locale information of the device. Each device system has at least
+ * one installed locale and often has many locales from which the user can choose.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/lang_country_codes.htm">Retrieving Language and Country Codes</a>.
#include <FLocales.h>
using namespace Tizen::Base;
+using namespace Tizen::Base::Collection;
using namespace Tizen::Locales;
void
public:
/**
* This is the default constructor for this class. @n
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. For full construction, the Construct()
+ * method must be called right after calling this constructor.
*
* @since 2.0
*
- * @see Construct()
- *
*/
LocaleManager(void);
*
* @since 2.0
*
- * @return An instance of Locale
+ * @return The system locale
* @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * The resulting Locale instance is Locale (LANGUAGE_INVALID, COUNTRY_INVALID).
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The resulting Locale instance is Locale(@c LANGUAGE_INVALID, @c COUNTRY_INVALID).
*/
Locale GetSystemLocale(void) const;
/**
- * Gets a list of all the available locales.
+ * Gets the list of all the available locales.
*
* @since 2.0
*
- * @return A list of Locale instances, @n
- * else @c null if the method fails
+ * @return The list of available locales, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The IList returned contains the list of all the locales installed on the system.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The Tizen::Base::Collection::IList returned contains the list of all the locales installed on the system.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAvailableLocalesN(void) const;
*
* @since 2.0
*
- * @return An instance of Tizen::Base::String (ISO 639-2 code format), @n
+ * @return The user selected language as an instance of Tizen::Base::String (ISO 639-2 code format), @n
* else empty string if the method fails
* @exception E_SUCCESS The method is successful.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
- * Gets a list of all the available languages supported by the device, which can be different according to the target country/region of the device.
+ * Gets the list of all the available languages supported by the device, which can be different according to the target
+ * country/region of the device.
*
* @since 2.0
*
- * @return A list of Tizen::Base::String instances (ISO 639-2 code format), @n
- * else @c null if the method fails
+ * @return The list of all available languages as Tizen::Base::String instances (ISO 639-2 code format), @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
/**
- * Gets a list of all the available time zone IDs.
+ * Gets the list of all the available time zone IDs.
*
* @since 2.0
*
- * @return A list of Tizen::Base::String instances, @n
- * else @c null if the method fails
+ * @return The list of all available time zone IDs as Tizen::Base::String instances, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
/**
- * Gets a list of all the available time zone IDs with the specified Greenwich Mean Time (GMT) offset for this time zone.
+ * Gets the list of all the available time zone IDs with the specified Greenwich Mean Time (GMT) offset for this time zone.
*
* @since 2.0
*
- * @return A list of Tizen::Base::String instances, @n
- * else @c null if the method fails
+ * @return The list of all availabke time zone IDs with the GMT offset as Tizen::Base::String instances, @n
+ * else @c null if it fails
* @param[in] rawOffset The specified GMT offset for this time zone (Daylight Saving Time (DST) is not considered) @n
* The value of @c rawOffset is in minutes.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * If there are no time zones for the specified GMT offset, an empty list is returned.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If there are no time zones for the specified GMT offset, an empty list is returned.
*/
Tizen::Base::Collection::IList* GetAvailableTimeZonesN(int rawOffset) const;
projects / platform / framework / native / appfw.git / blobdiff