Release 4.0.0-preview1-00267

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

diff --git a/src/ElmSharp/ElmSharp/Window.cs b/src/ElmSharp/ElmSharp/Window.cs
index 8e879a6..74ab8db 100755 (executable)
--- a/src/ElmSharp/ElmSharp/Window.cs
+++ b/src/ElmSharp/ElmSharp/Window.cs
@@ -71,12 +71,30 @@ namespace ElmSharp
         Transparent = 3,
     }
 
+    /// <summary>
+    /// Enumeration for the keygrab modes of window.
+    /// </summary>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public enum KeyGrabMode
     {
+        /// <summary>
+        /// Unknown keygrab mode
+        /// </summary>
         Shared = 256,
+
+        /// <summary>
+        /// Getting the grabbed-key together with the other client windows.
+        /// </summary>
         Topmost = 512,
+
+        /// <summary>
+        /// Getting the grabbed-key only when window is top of the stack.
+        /// </summary>
         Exclusive = 1024,
+
+        /// <summary>
+        /// Getting the grabbed-key exclusively regardless of window's position.
+        /// </summary>
         OverrideExclusive = 2048,
     }
 
@@ -350,6 +368,9 @@ namespace ElmSharp
             _rotationChanged.On += (s, e) => RotationChanged?.Invoke(this, EventArgs.Empty);
         }
 
+        /// <summary>
+        /// Creates and initializes a new instance of the Window class.
+        /// </summary>
         protected Window()
         {
         }
@@ -422,6 +443,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets available rotation degree.
+        /// </summary>
         [Obsolete("Sorry, it's error typo of AvailableRotations, please use AvailableRotations")]
         public DisplayRotation AavailableRotations { get; set; }
 
@@ -517,6 +541,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the iconified state of a window.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public bool Iconified
         {
@@ -970,12 +997,23 @@ namespace ElmSharp
             Interop.Elementary.elm_win_resize_object_add(Handle, obj);
         }
 
+        /// <summary>
+        /// Set keygrab value of the window.
+        /// This function grabs the key of window using grab_mode.
+        /// </summary>
+        /// <param name="keyname">The keyname to grab.</param>
+        /// <param name="mode">According to the grabmode, it can grab key differently</param>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public void WinKeyGrab(string keyname, KeyGrabMode mode)
         {
             Interop.Elementary.elm_win_keygrab_set(RealHandle, keyname, 0, 0, 0, mode);
         }
 
+        /// <summary>
+        /// Unset keygrab value of the window.
+        /// This function unset keygrab value.Ungrab key of window.
+        /// </summary>
+        /// <param name="keyname">The keyname to grab.</param>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public void WinKeyUngrab(string keyname)
         {
@@ -1000,6 +1038,11 @@ namespace ElmSharp
             Interop.Elementary.eext_win_keygrab_unset(RealHandle, keyname);
         }
 
+        /// <summary>
+        /// Creates a widget handle.
+        /// </summary>
+        /// <param name="parent">Parent EvasObject</param>
+        /// <returns>Handle IntPtr</returns>
         protected override IntPtr CreateHandle(EvasObject parent)
         {
             Interop.Elementary.elm_config_accel_preference_set("3d");
@@ -1040,4 +1083,4 @@ namespace ElmSharp
             return (DisplayRotation)orientation;
         }
     }
-}
+}
\ No newline at end of file