Merge "Fix duplicated alarms." into tizen_2.2

[platform/framework/native/appfw.git] / inc / FLclTimeZone.h

diff --git a/inc/FLclTimeZone.h b/inc/FLclTimeZone.h
index be6043e..bfddbe9 100644 (file)
--- a/inc/FLclTimeZone.h
+++ b/inc/FLclTimeZone.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -43,9 +42,11 @@ namespace Tizen { namespace Locales
  *
  * The %TimeZone class represents a time zone offset and figures out Daylight Saving Time (DST).
  *
- * The form of time zone ID is "Area/Location". However, the specialized time zone IDs have the different form.@n
+ * The form of time zone ID is "Area/Location". @n
  *
- * The IDs are defined in <a href="http://www.iana.org/time-zones" target="_blank">Time Zone Database</a>. @n
+ * However, the specialized time zone IDs have the different form, such as CST6CDT, EST5EDT and so on. @n
+ *
+ * For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">Time Zone Database</a>. @n
  * 
  * The supported time zone list depends on the device. Therefore, it must be checked by using LocaleManager::GetAvailableTimeZonesN().
  *
@@ -55,6 +56,8 @@ namespace Tizen { namespace Locales
  *
 @code
 
+#include <FBase.h>
+#include <FSystem.h>
 #include <FLocales.h>
 
 using namespace Tizen::Locales;
@@ -73,8 +76,10 @@ MyClass::MyTimeZone(void)
        int dstSavings = timeZone.GetDstSavings();
 
        // Gets the special time zone.
+       DateTime utcTime;
        TimeZone timeZone2;
-       Tizen::Locales::TimeZone::GetTimeZone(L"Europe/Zurich", timeZone2);
+       Tizen::System::SystemTime::GetCurrentTime(utcTime);
+       Tizen::Locales::TimeZone::GetTimeZone(L"Europe/Zurich", utcTime, timeZone2);
 }
 @endcode
  *
@@ -131,7 +136,7 @@ public:
         *
         * @param[in]           rawOffset                                               The base time zone offset to GMT in minutes
         * @param[in]           id                                                              The time zone ID
-        * @remarks                     The form of time zone @c id is "Area/Location". @n For more information on IDs, refer <a href="http://www.iana.org/time-zones">here</a>. @n
+        * @remarks                     The form of time zone @c id is "Area/Location". @n For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">here</a>. @n
         *                                      However, the supported time zone list depends on the device. Therefore, it must be checked before using this method.
         * @see                         LocaleManager::GetAvailableTimeZonesN()
         */
@@ -148,7 +153,7 @@ public:
         * @param[in]           startRule                                               The DST starting rule
         * @param[in]           endRule                                                 The DST end rule
         * @param[in]           dstOffset                                               The amount of time in minutes saved during DST
-        * @remarks                     The form of time zone @c id is "Area/Location". @n For more information on IDs, refer <a href="http://www.iana.org/time-zones">here</a>. @n
+        * @remarks                     The form of time zone @c id is "Area/Location". @n For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">here</a>. @n
         *                                      However, the supported time zone list depends on the device. Therefore, it must be checked before using this method.
         * @see                         LocaleManager::GetAvailableTimeZonesN()
         */
@@ -336,7 +341,7 @@ public:
         * @endif
         * @since                       2.0
         * @if OSPCOMPAT
-        * @compatibility     This method has compatibility issues with OSP compatibile applications. @n
+        * @compatibility     This method has compatibility issues with OSP compatible applications. @n
         *                              For more information, see @ref CompTimeZoneGetOffsetPage "here".
         * @endif
         *
@@ -362,16 +367,17 @@ public:
         * @endif
         * @since                       2.0
         * @if OSPCOMPAT
-        * @compatibility     This method has compatibility issues with OSP compatibile applications. @n
+        * @compatibility     This method has compatibility issues with OSP compatible applications. @n
         *                              For more information, see @ref CompTimeZoneGetOffsetPage "here".
         * @endif
         *
         * @return                      An error code
         * @param[in]           ticks                                           The time ticks value @n
-        *                                                                                              The value can be either GMT time or local wall time.
+        *                                                                                              The value is GMT time from starting day (Jan 1, 1.).
         * @param[out]          offset                                          The offset between the local standard time and GMT, taking into consideration DST
         * @exception           E_SUCCESS                                       The method is successful.
-        * @exception           E_INVALID_ARG                                   The specified @c ticks is invalid. 
+        * @exception           E_INVALID_ARG                                   The specified @c ticks is invalid.
+        * @see                 Base::DateTime::GetTicks()
         */
        result GetOffset(long long ticks, int& offset) const;
 
@@ -456,7 +462,7 @@ public:
         * @endif 
         * @since                       2.0
         * @if OSPCOMPAT
-        * @compatibility     This method has compatibility issues with OSP compatibile applications. @n
+        * @compatibility     This method has compatibility issues with OSP compatible applications. @n
         *                              For more information, see @ref CompTimeZoneGetTimeZonePage "here".
         * @endif
         *
@@ -479,7 +485,7 @@ public:
         * @endif
         * @since                       2.0
         * @if OSPCOMPAT
-        * @compatibility     This method has compatibility issues with OSP compatibile applications. @n
+        * @compatibility     This method has compatibility issues with OSP compatible applications. @n
         *                              For more information, see @ref CompTimeZoneGetTimeZonePage "here".
         * @endif
         *