[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / Utility.cs
1 /*
2  * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 using System;
18
19 namespace ElmSharp
20 {
21     /// <summary>
22     /// This class is a static class for utility methods.
23     /// </summary>
24     /// <since_tizen> preview </since_tizen>
25     [Obsolete("This has been deprecated in API12")]
26     public static class Utility
27     {
28         /// <summary>
29         /// Appends a font path to the list of font paths used by the application.
30         /// </summary>
31         /// <param name="path">The new font path.</param>
32         /// <since_tizen> preview </since_tizen>
33         [Obsolete("This has been deprecated in API12")]
34         public static void AppendGlobalFontPath(string path)
35         {
36             Interop.Evas.evas_font_path_global_append(path);
37         }
38
39         /// <summary>
40         /// Prepends a font path to the list of font paths used by the application.
41         /// </summary>
42         /// <param name="path">The new font path.</param>
43         /// <since_tizen> preview </since_tizen>
44         [Obsolete("This has been deprecated in API12")]
45         public static void PrependEvasGlobalFontPath(string path)
46         {
47             Interop.Evas.evas_font_path_global_prepend(path);
48         }
49
50         /// <summary>
51         /// Removes all font paths loaded into the memory by evas_font_path_app_* APIs for the application.
52         /// </summary>
53         /// <since_tizen> preview </since_tizen>
54         [Obsolete("This has been deprecated in API12")]
55         public static void ClearEvasGlobalFontPath()
56         {
57             Interop.Evas.evas_font_path_global_clear();
58         }
59
60         /// <summary>
61         /// Reinitialize FontConfig.
62         /// </summary>
63         /// <since_tizen> preview </since_tizen>
64         [Obsolete("This has been deprecated in API12")]
65         public static void FontReinit()
66         {
67             Interop.Evas.evas_font_reinit();
68         }
69
70         /// <summary>
71         /// Sets the Edje color class.
72         /// </summary>
73         /// <param name="colorClass">Color class.</param>
74         /// <param name="red">Object red value.</param>
75         /// <param name="green">Object green value.</param>
76         /// <param name="blue">Object blue value.</param>
77         /// <param name="alpha">Object alpha value.</param>
78         /// <param name="outlineRed">Outline red value.</param>
79         /// <param name="outlineGreen">Outline green value.</param>
80         /// <param name="outlineBlue">Outline blue value.</param>
81         /// <param name="outlineAlpha">Outline alpha value.</param>
82         /// <param name="shadowRed">Shadow red value.</param>
83         /// <param name="shadowGreen">Shadow green value.</param>
84         /// <param name="shadowBlue">Shadow blue value.</param>
85         /// <param name="shadowAlpha">Shadow alpha value.</param>
86         /// <returns></returns>
87         /// <since_tizen> preview </since_tizen>
88         [Obsolete("This has been deprecated in API12")]
89         public static bool SetEdjeColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha,
90                     int shadowRed, int shadowGreen, int shadowBlue, int shadowAlpha)
91         {
92             return Interop.Elementary.edje_color_class_set(colorClass, red, green, blue, alpha, outlineRed, outlineGreen, outlineBlue, outlineAlpha, shadowRed, shadowGreen, shadowBlue, shadowAlpha);
93         }
94
95         /// <summary>
96         /// Gets the Edje color class.
97         /// </summary>
98         /// <param name="colorClass">Color class.</param>
99         /// <param name="red">Object red value.</param>
100         /// <param name="green">Object green value.</param>
101         /// <param name="blue">Object blue value.</param>
102         /// <param name="alpha">Object alpha value.</param>
103         /// <param name="outlineRed">Outline red value.</param>
104         /// <param name="outlineGreen">Outline green value.</param>
105         /// <param name="outlineBlue">Outline blue value.</param>
106         /// <param name="outlineAlpha">Outline alpha value.</param>
107         /// <param name="shadowRed">Shadow red value.</param>
108         /// <param name="shadowGreen">Shadow green value.</param>
109         /// <param name="shadowBlue">Shadow blue value.</param>
110         /// <param name="shadowAlpha">Shadow alpha value.</param>
111         /// <returns></returns>
112         /// <since_tizen> preview </since_tizen>
113         [Obsolete("This has been deprecated in API12")]
114         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,
115                     out int outlineAlpha, out int shadowRed, out int shadowGreen, out int shadowBlue, out int shadowAlpha)
116         {
117             return Interop.Elementary.edje_color_class_get(colorClass, out red, out green, out blue, out alpha, out outlineRed, out outlineGreen, out outlineBlue, out outlineAlpha,
118                 out shadowRed, out shadowGreen, out shadowBlue, out shadowAlpha);
119         }
120
121         /// <summary>
122         /// Processes all the queued up edje messages.
123         /// This function triggers the processing of messages addressed to any (alive) edje objects.
124         /// </summary>
125         /// <since_tizen> preview </since_tizen>
126         [Obsolete("This has been deprecated in API12")]
127         public static void ProcessEdjeMessageSignal()
128         {
129             Interop.Elementary.edje_message_signal_process();
130         }
131
132         /// <summary>
133         /// Sets the Edje text class.
134         /// </summary>
135         /// <param name="textClass">The text class name.</param>
136         /// <param name="font">The font name.</param>
137         /// <param name="size">The font size.</param>
138         /// <returns>True on success, or False on error.</returns>
139         /// <since_tizen> preview </since_tizen>
140         [Obsolete("This has been deprecated in API12")]
141         public static bool SetEdjeTextClass(string textClass, string font, int size)
142         {
143             return Interop.Elementary.edje_text_class_set(textClass, font, size);
144         }
145
146         /// <summary>
147         /// Gets the Edje text class.
148         /// </summary>
149         /// <param name="textClass">The text class name.</param>
150         /// <param name="font">The font name.</param>
151         /// <param name="size">The font size.</param>
152         /// <returns>True on success, or False on error.</returns>
153         /// <since_tizen> preview </since_tizen>
154         [Obsolete("This has been deprecated in API12")]
155         public static bool GetEdjeTextClass(string textClass, out string font, out int size)
156         {
157             return Interop.Elementary.edje_text_class_get(textClass, out font, out size);
158         }
159
160         /// <summary>
161         /// Delete the text class.
162         /// </summary>
163         /// <param name="textClass">The text class name.</param>
164         /// <since_tizen> preview </since_tizen>
165         [Obsolete("This has been deprecated in API12")]
166         public static void DeleteEdjeTextClass(string textClass)
167         {
168             Interop.Elementary.edje_text_class_del(textClass);
169         }
170
171         /// <summary>
172         /// Pre-multiplies the RGB triplet by an alpha factor.
173         /// </summary>
174         /// <param name="alpha">The alpha factor.</param>
175         /// <param name="red">The red component of the color.</param>
176         /// <param name="green">The green component of the color.</param>
177         /// <param name="blue">The blue component of the color.</param>
178         /// <since_tizen> preview </since_tizen>
179         [Obsolete("This has been deprecated in API12")]
180         public static void PremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
181         {
182             Interop.Evas.evas_color_argb_premul(alpha, ref red, ref green, ref blue);
183         }
184
185         /// <summary>
186         /// Undoes pre-multiplication of the RGB triplet by an alpha factor.
187         /// </summary>
188         /// <param name="alpha">The alpha factor.</param>
189         /// <param name="red">The red component of the color.</param>
190         /// <param name="green">The green component of the color.</param>
191         /// <param name="blue">The blue component of the color.</param>
192         /// <since_tizen> preview </since_tizen>
193         [Obsolete("This has been deprecated in API12")]
194         public static void UnPremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
195         {
196             Interop.Evas.evas_color_argb_unpremul(alpha, ref red, ref green, ref blue);
197         }
198     }
199 }