Release 4.0.0-preview1-00304

[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / ImfManager.cs

diff --git a/src/Tizen.NUI/src/public/ImfManager.cs b/src/Tizen.NUI/src/public/ImfManager.cs
index 062e1a7..79cbe73 100755 (executable)
--- a/src/Tizen.NUI/src/public/ImfManager.cs
+++ b/src/Tizen.NUI/src/public/ImfManager.cs
@@ -1,18 +1,19 @@
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 using System;
 using System.Runtime.InteropServices;
 using System.ComponentModel;
@@ -20,7 +21,7 @@ using System.ComponentModel;
 namespace Tizen.NUI
 {
     /// <summary>
-    /// Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
+    /// Specifically manages the input method framework which enables the virtual or hardware keyboards.
     /// </summary>
     public class ImfManager : BaseHandle
     {
@@ -36,6 +37,11 @@ namespace Tizen.NUI
             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero) : obj.swigCPtr;
         }
 
+        /// <summary>
+        /// Dispose
+        /// </summary>
+        /// <param name="type">Dispose Type</param>
+        /// <since_tizen> 3 </since_tizen>
         protected override void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -104,6 +110,10 @@ namespace Tizen.NUI
         public class ImfEventData : global::System.IDisposable
         {
             private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+            /// <summary>
+            /// swigCMemOwn
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             protected bool swigCMemOwn;
 
             internal ImfEventData(IntPtr cPtr, bool cMemoryOwn)
@@ -119,10 +129,16 @@ namespace Tizen.NUI
 
             //A Flag to check who called Dispose(). (By User or DisposeQueue)
             private bool isDisposeQueued = false;
-            //A Flat to check if it is already disposed.
+            /// <summary>
+            /// A Flat to check if it is already disposed.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             protected bool disposed = false;
 
-
+            /// <summary>
+            /// Dispose.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             ~ImfEventData()
             {
                 if (!isDisposeQueued)
@@ -155,6 +171,10 @@ namespace Tizen.NUI
                 }
             }
 
+            /// <summary>
+            /// Dispose.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             protected virtual void Dispose(DisposeTypes type)
             {
                 if (disposed)
@@ -219,9 +239,8 @@ namespace Tizen.NUI
             /// <summary>
             /// The pre-edit or the commit string.
             /// </summary>
-            //Please do not use! this will be deprecated
+            /// /// <since_tizen> 3 </since_tizen>
             [EditorBrowsable(EditorBrowsableState.Never)]
-            /// <since_tizen> 3 </since_tizen>
             public string predictiveString
             {
                 set
@@ -381,6 +400,10 @@ namespace Tizen.NUI
         public class ImfCallbackData : global::System.IDisposable
         {
             private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+            /// <summary>
+            /// swigCMemOwn
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             protected bool swigCMemOwn;
 
             internal IntPtr GetImfCallbackDataPtr()
@@ -401,10 +424,17 @@ namespace Tizen.NUI
 
             //A Flag to check who called Dispose(). (By User or DisposeQueue)
             private bool isDisposeQueued = false;
-            //A Flat to check if it is already disposed.
+            /// <summary>
+            /// A Flat to check if it is already disposed.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             protected bool disposed = false;
 
 
+            /// <summary>
+            /// Dispose.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             ~ImfCallbackData()
             {
                 if (!isDisposeQueued)
@@ -437,6 +467,10 @@ namespace Tizen.NUI
                 }
             }
 
+            /// <summary>
+            /// Dispose.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             protected virtual void Dispose(DisposeTypes type)
             {
                 if (disposed)
@@ -657,6 +691,15 @@ namespace Tizen.NUI
         }
 
         /// <summary>
+        /// Finalize the IMF.<br/>
+        /// </summary>
+        public void Finalize()
+        {
+            NDalicManualPINVOKE.ImfManager_Finalize(swigCPtr);
+            if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+        }
+
+        /// <summary>
         /// Retrieves a handle to the instance of the ImfManager.
         /// </summary>
         /// <returns>A handle to the ImfManager.</returns>
@@ -945,6 +988,10 @@ namespace Tizen.NUI
         [EditorBrowsable(EditorBrowsableState.Never)]
         public class ImfManagerActivatedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ImfManager ImfManager
             {
                 get;
@@ -1005,6 +1052,10 @@ namespace Tizen.NUI
         /// </summary>
         public class ActivatedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ImfManager ImfManager
             {
                 get;
@@ -1078,6 +1129,10 @@ namespace Tizen.NUI
         [EditorBrowsable(EditorBrowsableState.Never)]
         public class ImfManagerEventReceivedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ImfManager ImfManager
             {
                 get;
@@ -1137,12 +1192,20 @@ namespace Tizen.NUI
         /// </summary>
         public class EventReceivedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ImfManager ImfManager
             {
                 get;
                 set;
             }
 
+            /// <summary>
+            /// ImfEventData
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ImfEventData ImfEventData
             {
                 get;
@@ -1229,6 +1292,10 @@ namespace Tizen.NUI
         [EditorBrowsable(EditorBrowsableState.Never)]
         public class ImfManagerStatusChangedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ImfManager ImfManager
             {
                 get;
@@ -1288,6 +1355,10 @@ namespace Tizen.NUI
         /// </summary>
         public class StatusChangedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager status
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public bool StatusChanged
             {
                 get;
@@ -1357,6 +1428,10 @@ namespace Tizen.NUI
         [EditorBrowsable(EditorBrowsableState.Never)]
         public class ImfManagerResizedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ImfManager ImfManager
             {
                 get;
@@ -1469,6 +1544,10 @@ namespace Tizen.NUI
         [EditorBrowsable(EditorBrowsableState.Never)]
         public class ImfManagerLanguageChangedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ImfManager ImfManager
             {
                 get;
@@ -1579,6 +1658,10 @@ namespace Tizen.NUI
         /// </summary>
         public class KeyboardTypeChangedEventArgs : EventArgs
         {
+            /// <summary>
+            /// ImfManager keyboard type
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public KeyboardType KeyboardType
             {
                 get;
@@ -1667,7 +1750,7 @@ namespace Tizen.NUI
             /// </summary>
             Preedit,
             /// <summary>
-            /// Commit recieved.
+            /// Commit received.
             /// </summary>
             Commit,
             /// <summary>