[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / Utility.cs
index baff802..9f3d153 100644 (file)
  * limitations under the License.
  */
 
  * limitations under the License.
  */
 
+using System;
+
 namespace ElmSharp
 {
 namespace ElmSharp
 {
+    /// <summary>
+    /// This class is a static class for utility methods.
+    /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public static class Utility
     {
         /// <summary>
         /// Appends a font path to the list of font paths used by the application.
         /// </summary>
         /// <param name="path">The new font path.</param>
     public static class Utility
     {
         /// <summary>
         /// Appends a font path to the list of font paths used by the application.
         /// </summary>
         /// <param name="path">The new font path.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void AppendGlobalFontPath(string path)
         {
             Interop.Evas.evas_font_path_global_append(path);
         public static void AppendGlobalFontPath(string path)
         {
             Interop.Evas.evas_font_path_global_append(path);
@@ -31,70 +40,90 @@ namespace ElmSharp
         /// Prepends a font path to the list of font paths used by the application.
         /// </summary>
         /// <param name="path">The new font path.</param>
         /// Prepends a font path to the list of font paths used by the application.
         /// </summary>
         /// <param name="path">The new font path.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void PrependEvasGlobalFontPath(string path)
         {
             Interop.Evas.evas_font_path_global_prepend(path);
         }
 
         /// <summary>
         public static void PrependEvasGlobalFontPath(string path)
         {
             Interop.Evas.evas_font_path_global_prepend(path);
         }
 
         /// <summary>
-        /// Removes all font paths loaded into memory by evas_font_path_app_* APIs for the application.
+        /// Removes all font paths loaded into the memory by evas_font_path_app_* APIs for the application.
         /// </summary>
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void ClearEvasGlobalFontPath()
         {
             Interop.Evas.evas_font_path_global_clear();
         }
 
         /// <summary>
         public static void ClearEvasGlobalFontPath()
         {
             Interop.Evas.evas_font_path_global_clear();
         }
 
         /// <summary>
-        /// Sets Edje color class.
+        /// Reinitialize FontConfig.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        public static void FontReinit()
+        {
+            Interop.Evas.evas_font_reinit();
+        }
+
+        /// <summary>
+        /// Sets the Edje color class.
         /// </summary>
         /// </summary>
-        /// <param name="colorClass">Color class</param>
-        /// <param name="red">Object Red value</param>
-        /// <param name="green">Object Red value</param>
-        /// <param name="blue">Object Red value</param>
-        /// <param name="alpha">Object Red value</param>
-        /// <param name="outlineRed">Outline Red value</param>
-        /// <param name="outlineGreen">Outline Green value</param>
-        /// <param name="outlineBlue">Outline Blue value</param>
-        /// <param name="outlineAlpha">Outline Alpha value</param>
-        /// <param name="shadowRed">Shadow Red value</param>
-        /// <param name="shadowGreen">Shadow Green value</param>
-        /// <param name="shadowBlue">Shadow Bluevalue</param>
-        /// <param name="shadowAlpha">Shadow Alpha value</param>
+        /// <param name="colorClass">Color class.</param>
+        /// <param name="red">Object red value.</param>
+        /// <param name="green">Object green value.</param>
+        /// <param name="blue">Object blue value.</param>
+        /// <param name="alpha">Object alpha value.</param>
+        /// <param name="outlineRed">Outline red value.</param>
+        /// <param name="outlineGreen">Outline green value.</param>
+        /// <param name="outlineBlue">Outline blue value.</param>
+        /// <param name="outlineAlpha">Outline alpha value.</param>
+        /// <param name="shadowRed">Shadow red value.</param>
+        /// <param name="shadowGreen">Shadow green value.</param>
+        /// <param name="shadowBlue">Shadow blue value.</param>
+        /// <param name="shadowAlpha">Shadow alpha value.</param>
         /// <returns></returns>
         /// <returns></returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static bool SetEdjeColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha,
         public static bool SetEdjeColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha,
-            int shadowRed, int shadowGreen, int shadowBlue, int shadowAlpha)
+                    int shadowRed, int shadowGreen, int shadowBlue, int shadowAlpha)
         {
             return Interop.Elementary.edje_color_class_set(colorClass, red, green, blue, alpha, outlineRed, outlineGreen, outlineBlue, outlineAlpha, shadowRed, shadowGreen, shadowBlue, shadowAlpha);
         }
 
         /// <summary>
         {
             return Interop.Elementary.edje_color_class_set(colorClass, red, green, blue, alpha, outlineRed, outlineGreen, outlineBlue, outlineAlpha, shadowRed, shadowGreen, shadowBlue, shadowAlpha);
         }
 
         /// <summary>
-        /// Gets Edje color class.
+        /// Gets the Edje color class.
         /// </summary>
         /// </summary>
-        /// <param name="colorClass">Color class</param>
-        /// <param name="red">Object Red value</param>
-        /// <param name="green">Object Red value</param>
-        /// <param name="blue">Object Red value</param>
-        /// <param name="alpha">Object Red value</param>
-        /// <param name="outlineRed">Outline Red value</param>
-        /// <param name="outlineGreen">Outline Green value</param>
-        /// <param name="outlineBlue">Outline Blue value</param>
-        /// <param name="outlineAlpha">Outline Alpha value</param>
-        /// <param name="shadowRed">Shadow Red value</param>
-        /// <param name="shadowGreen">Shadow Green value</param>
-        /// <param name="shadowBlue">Shadow Bluevalue</param>
-        /// <param name="shadowAlpha">Shadow Alpha value</param>
+        /// <param name="colorClass">Color class.</param>
+        /// <param name="red">Object red value.</param>
+        /// <param name="green">Object green value.</param>
+        /// <param name="blue">Object blue value.</param>
+        /// <param name="alpha">Object alpha value.</param>
+        /// <param name="outlineRed">Outline red value.</param>
+        /// <param name="outlineGreen">Outline green value.</param>
+        /// <param name="outlineBlue">Outline blue value.</param>
+        /// <param name="outlineAlpha">Outline alpha value.</param>
+        /// <param name="shadowRed">Shadow red value.</param>
+        /// <param name="shadowGreen">Shadow green value.</param>
+        /// <param name="shadowBlue">Shadow blue value.</param>
+        /// <param name="shadowAlpha">Shadow alpha value.</param>
         /// <returns></returns>
         /// <returns></returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static bool GetEdjeColorClass(string colorClass, out int red, out int green, out int blue, out int alpha, out int outlineRed, out int outlineGreen, out int outlineBlue,
         public static bool GetEdjeColorClass(string colorClass, out int red, out int green, out int blue, out int alpha, out int outlineRed, out int outlineGreen, out int outlineBlue,
-            out int outlineAlpha, out int shadowRed, out int shadowGreen, out int shadowBlue, out int shadowAlpha)
+                    out int outlineAlpha, out int shadowRed, out int shadowGreen, out int shadowBlue, out int shadowAlpha)
         {
             return Interop.Elementary.edje_color_class_get(colorClass, out red, out green, out blue, out alpha, out outlineRed, out outlineGreen, out outlineBlue, out outlineAlpha,
                 out shadowRed, out shadowGreen, out shadowBlue, out shadowAlpha);
         }
 
         /// <summary>
         {
             return Interop.Elementary.edje_color_class_get(colorClass, out red, out green, out blue, out alpha, out outlineRed, out outlineGreen, out outlineBlue, out outlineAlpha,
                 out shadowRed, out shadowGreen, out shadowBlue, out shadowAlpha);
         }
 
         /// <summary>
-        /// Processes all queued up edje messages.
+        /// Processes all the queued up edje messages.
         /// This function triggers the processing of messages addressed to any (alive) edje objects.
         /// </summary>
         /// This function triggers the processing of messages addressed to any (alive) edje objects.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void ProcessEdjeMessageSignal()
         {
             Interop.Elementary.edje_message_signal_process();
         public static void ProcessEdjeMessageSignal()
         {
             Interop.Elementary.edje_message_signal_process();
@@ -103,10 +132,12 @@ namespace ElmSharp
         /// <summary>
         /// Sets the Edje text class.
         /// </summary>
         /// <summary>
         /// Sets the Edje text class.
         /// </summary>
-        /// <param name="textClass">The text class name</param>
-        /// <param name="font">The font name</param>
-        /// <param name="size">The font size</param>
-        /// <returns>True, on success or false, on error</returns>
+        /// <param name="textClass">The text class name.</param>
+        /// <param name="font">The font name.</param>
+        /// <param name="size">The font size.</param>
+        /// <returns>True on success, or False on error.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static bool SetEdjeTextClass(string textClass, string font, int size)
         {
             return Interop.Elementary.edje_text_class_set(textClass, font, size);
         public static bool SetEdjeTextClass(string textClass, string font, int size)
         {
             return Interop.Elementary.edje_text_class_set(textClass, font, size);
@@ -115,10 +146,12 @@ namespace ElmSharp
         /// <summary>
         /// Gets the Edje text class.
         /// </summary>
         /// <summary>
         /// Gets the Edje text class.
         /// </summary>
-        /// <param name="textClass">The text class name</param>
-        /// <param name="font">The font name</param>
-        /// <param name="size">The font size</param>
-        /// <returns>True, on success or false, on error</returns>
+        /// <param name="textClass">The text class name.</param>
+        /// <param name="font">The font name.</param>
+        /// <param name="size">The font size.</param>
+        /// <returns>True on success, or False on error.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static bool GetEdjeTextClass(string textClass, out string font, out int size)
         {
             return Interop.Elementary.edje_text_class_get(textClass, out font, out size);
         public static bool GetEdjeTextClass(string textClass, out string font, out int size)
         {
             return Interop.Elementary.edje_text_class_get(textClass, out font, out size);
@@ -127,31 +160,37 @@ namespace ElmSharp
         /// <summary>
         /// Delete the text class.
         /// </summary>
         /// <summary>
         /// Delete the text class.
         /// </summary>
-        /// <param name="textClass"></param>
+        /// <param name="textClass">The text class name.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void DeleteEdjeTextClass(string textClass)
         {
             Interop.Elementary.edje_text_class_del(textClass);
         }
 
         /// <summary>
         public static void DeleteEdjeTextClass(string textClass)
         {
             Interop.Elementary.edje_text_class_del(textClass);
         }
 
         /// <summary>
-        /// Pre-multiplies a rgb triplet by an alpha factor.
+        /// Pre-multiplies the RGB triplet by an alpha factor.
         /// </summary>
         /// </summary>
-        /// <param name="alpha">The alpha factor</param>
-        /// <param name="red">The Red component of the color</param>
-        /// <param name="green">The Green component of the color</param>
-        /// <param name="blue">The Blue component of the color</param>
+        /// <param name="alpha">The alpha factor.</param>
+        /// <param name="red">The red component of the color.</param>
+        /// <param name="green">The green component of the color.</param>
+        /// <param name="blue">The blue component of the color.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void PremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
         {
             Interop.Evas.evas_color_argb_premul(alpha, ref red, ref green, ref blue);
         }
 
         /// <summary>
         public static void PremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
         {
             Interop.Evas.evas_color_argb_premul(alpha, ref red, ref green, ref blue);
         }
 
         /// <summary>
-        /// Undoes pre-multiplies a rgb triplet by an alpha factor.
+        /// Undoes pre-multiplication of the RGB triplet by an alpha factor.
         /// </summary>
         /// </summary>
-        /// <param name="alpha">The alpha factor</param>
-        /// <param name="red">The Red component of the color</param>
-        /// <param name="green">The Green component of the color</param>
-        /// <param name="blue">The Blue component of the color</param>
+        /// <param name="alpha">The alpha factor.</param>
+        /// <param name="red">The red component of the color.</param>
+        /// <param name="green">The green component of the color.</param>
+        /// <param name="blue">The blue component of the color.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void UnPremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
         {
             Interop.Evas.evas_color_argb_unpremul(alpha, ref red, ref green, ref blue);
         public static void UnPremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
         {
             Interop.Evas.evas_color_argb_unpremul(alpha, ref red, ref green, ref blue);