[ACR-564] deprecate unused API

[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / EvasKeyEventArgs.cs

diff --git a/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs b/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs
index 8955904..2095f28 100644 (file)
--- a/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs
+++ b/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs
@@ -1,4 +1,4 @@
-/*
+/*
  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
@@ -17,35 +17,52 @@
 using System;
 using System.Runtime.InteropServices;
 
+using Tizen.Internals;
+
 namespace ElmSharp
 {
     /// <summary>
-    /// The EvasKeyEventArgs is an EvasKey EventArgs
+    /// The EvasKeyEventArgs is a EvasKey EventArgs.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class EvasKeyEventArgs : EventArgs
     {
         IntPtr _nativeEventInfo;
 
-        EvasEventFlag _eventFlags;
-
         /// <summary>
-        /// BackButton name in Platform
+        /// BackButton name in platform.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public const string PlatformBackButtonName = "XF86Back";
+
         /// <summary>
-        /// MenuButton name in Platform
+        /// MenuButton name in platform.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public const string PlatformMenuButtonName = "XF86Menu";
+
         /// <summary>
-        /// HomeButton name in Platform
+        /// HomeButton name in platform.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public const string PlatformHomeButtonName = "XF86Home";
 
         /// <summary>
-        /// Gets the name of Key
+        /// Gets the name of the key.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public string KeyName { get; private set; }
 
+        /// <summary>
+        /// Sets or gets the flags.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public EvasEventFlag Flags
         {
             get
@@ -70,10 +87,12 @@ namespace ElmSharp
         /// <summary>
         /// Creates and initializes a new instance of the EvasKeyEventArgs class.
         /// </summary>
-        /// <param name="data">data info</param>
-        /// <param name="obj"> object </param>
-        /// <param name="info">information </param>
-        /// <returns>EvasKey eventArgs</returns>
+        /// <param name="data">The data information.</param>
+        /// <param name="obj">The object.</param>
+        /// <param name="info">The information.</param>
+        /// <returns>EvasKey eventArgs.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         static public EvasKeyEventArgs Create(IntPtr data, IntPtr obj, IntPtr info)
         {
             return new EvasKeyEventArgs(info);
@@ -82,69 +101,80 @@ namespace ElmSharp
         /// <summary>
         /// Event structure for Key Down event callbacks.
         /// </summary>
+        [NativeStruct("Evas_Event_Key_Down", Include = "Elementary.h", PkgConfig = "elementary")]
         [StructLayout(LayoutKind.Sequential)]
         struct EvasEventKeyDown
         {
             /// <summary>
-            /// Name string of the key pressed
+            /// Name string of the key pressed.
             /// </summary>
             public string keyname;
+
             /// <summary>
-            /// Data to be passed to the event
+            /// Data to be passed to the event.
             /// </summary>
             public IntPtr data;
+
             /// <summary>
-            /// Modifier keys pressed during the event
+            /// Modifier keys pressed during the event.
             /// </summary>
             public IntPtr modifiers;
+
             /// <summary>
-            /// Locks info
+            /// Locks information.
             /// </summary>
             public IntPtr locks;
+
             /// <summary>
-            /// Logical key: (example, shift+1 == exclamation)
+            /// Logical key: (example, shift+1 == exclamation).
             /// </summary>
             public string key;
+
             /// <summary>
-            /// UTF8 string if this keystroke has produced a visible string to be ADDED
+            /// UTF-8 string, if this keystroke has produced a visible string to be added.
             /// </summary>
             public string str;
+
             /// <summary>
-            /// UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one
+            /// UTF-8 string, if this keystroke has modified a string in the middle of being composed - this string replaces the previous one.
             /// </summary>
             public string compose;
 
             public uint timestamp;
 
             /// <summary>
-            /// Event_flags
+            /// Event_flags.
             /// </summary>
             public EvasEventFlag event_flags;
+
             /// <summary>
             ///
             /// </summary>
             public IntPtr dev;
+
             /// <summary>
-            /// Keycode
+            /// Keycode.
             /// </summary>
             public uint keycode;
         };
     }
 
     /// <summary>
-    /// Flags for Events
+    /// Flags for the events.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     [Flags]
     public enum EvasEventFlag
     {
         /// <summary>
-        /// No fancy flags set
+        /// No fancy flags set.
         /// </summary>
         None = 0,
+
         /// <summary>
-        ///This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything
+        /// This event is being delivered but should be put "on hold" until the on hold flag is unset. The event should be used for informational purposes and maybe some indications visually, but not actually perform anything.
         /// </summary>
         OnHold = 1,
     }
-
-}
+}
\ No newline at end of file