[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / EvasCanvas.cs
index 6f778c6..c45b9e5 100644 (file)
@@ -20,15 +20,17 @@ using System.Collections.Generic;
 namespace ElmSharp
 {
     /// <summary>
-    /// Low level Evas canvas functions. Sub groups will present more high level ones, though.
-    /// Most of these functions deal with low level Evas actions, like:
-    /// create/destroy raw canvases, not bound to any displaying engine
-    /// tell a canvas i got focused(in a windowing context, for example)
-    /// tell a canvas a region should not be calculated anymore in rendering
-    /// tell a canvas to render its contents, immediately
-    /// Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them.Thus, you'll be looking at this section only if you're building low level stuff.
-    /// The groups within present you functions that deal with the canvas directly, too, and not yet with its objects.They are the functions you need to use at a minimum to get a working canvas.
+    /// Low-level Evas canvas functions. Subgroups will be present more than the high-level ones, though.
+    /// Most of these functions deal with low-level Evas actions like:
+    /// create/destroy raw canvases, not bound to any displaying engine.
+    /// tell a canvas, I got focused (in a windowing context, for example).
+    /// tell a canvas, a region should not be calculated anymore in rendering.
+    /// tell a canvas, to render its contents immediately.
+    /// Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them. Thus, you will be looking at this section only if you're building low-level stuff.
+    /// The groups within, present you functions that deal with the canvas directly too, and not yet with its objects. They are the functions you need to use at a minimum to get a working canvas.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class EvasCanvas
     {
         IntPtr _handle = IntPtr.Zero;
@@ -40,9 +42,27 @@ namespace ElmSharp
         }
 
         /// <summary>
+        /// Gets the current known default pointer coordinates.
+        /// This function returns the current known canvas unit coordinates of the mouse pointer.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        public Point Pointer
+        {
+            get
+            {
+                int mx, my;
+                Interop.Evas.evas_pointer_canvas_xy_get(_handle, out mx, out my);
+                return new Point { X = mx, Y = my };
+            }
+        }
+
+        /// <summary>
         /// Gets or sets the image cache.
-        /// This function returns the image cache size of canvas in bytes.
+        /// This function returns the image cache size of the canvas in bytes.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int ImageCacheSize
         {
             get
@@ -56,50 +76,60 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Flush the image cache of the canvas.
+        /// Flushes the image cache of the canvas.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void FlushImageCache()
         {
             Interop.Evas.evas_image_cache_flush(_handle);
         }
 
         /// <summary>
-        /// Add a damage rectangle.
+        /// Adds a damage rectangle.
         /// </summary>
         /// <param name="x">The rectangle's top left corner's horizontal coordinate.</param>
         /// <param name="y">The rectangle's top left corner's vertical coordinate.</param>
         /// <param name="width">The rectangle's width.</param>
         /// <param name="height">The rectangle's height.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void AddDamageRectangle(int x, int y, int width, int height)
         {
             Interop.Evas.evas_damage_rectangle_add(_handle, x, y, width, height);
         }
 
         /// <summary>
-        /// Add an "obscured region" to an Evas canvas.
+        /// Adds an "obscured region" to an Evas canvas.
         /// </summary>
         /// <param name="x">The rectangle's top left corner's horizontal coordinate.</param>
         /// <param name="y">The rectangle's top left corner's vertical coordinate.</param>
         /// <param name="width">The rectangle's width.</param>
         /// <param name="height">The rectangle's height.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void AddObscuredRectangle(int x, int y, int width, int height)
         {
             Interop.Evas.evas_obscured_rectangle_add(_handle, x, y, width, height);
         }
 
         /// <summary>
-        /// Remove all "obscured regions" from an Evas canvas.
+        /// Removes all the "obscured regions" from an Evas canvas.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void ClearObscuredRectangle()
         {
             Interop.Evas.evas_obscured_clear(_handle);
         }
 
         /// <summary>
-        /// Adds or registers a event to a given canvas event.
+        /// Adds or registers an event to a given canvas event.
         /// </summary>
-        /// <param name="type">The type of event that triggers</param>
-        /// <param name="action">The action to be called when the event is triggered</param>
+        /// <param name="type">The type of event that triggers.</param>
+        /// <param name="action">The action to be called when the event is triggered.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void AddEventAction(EvasObjectCallbackType type, Action action)
         {
             if (action != null)
@@ -116,10 +146,12 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Deletes a event to a given canvas event.
+        /// Deletes an event to a given canvas event.
         /// </summary>
-        /// <param name="type">The type of event that triggers</param>
+        /// <param name="type">The type of event that triggers.</param>
         /// <param name="action">The action to be called when the event is triggered</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void DeleteEventAction(EvasObjectCallbackType type, Action action)
         {
             if (action != null)
@@ -136,6 +168,11 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Creates an Evas canvas handle.
+        /// </summary>
+        /// <param name="evasObject">EvasObject</param>
+        /// <returns>Handle IntPtr.</returns>
         IntPtr CreateHandle(IntPtr evasObject)
         {
             return Interop.Evas.evas_object_evas_get(evasObject);
@@ -152,6 +189,14 @@ namespace ElmSharp
                 Action = action;
             }
 
+            /// <summary>
+            /// Indicates whether this instance and a specified object are equal.
+            /// </summary>
+            /// <param name="obj">The object to compare with the current instance.</param>
+            /// <returns>
+            /// true if the object and this instance are of the same type and represent the same value,
+            /// otherwise false.
+            /// </returns>
             public override bool Equals(object obj)
             {
                 EventData e = obj as EventData;