X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2FTizen.NUI%2Fsrc%2Fpublic%2FImfManager.cs;h=40b908b307ab6c1ed5c3cc77e28ed20d4526aaba;hb=4b35f3206e91da1679c600687ba9c753498db73f;hp=9304124082210d17a05f5d2661537fc67687c18a;hpb=f90226ffe7cef19e375866e649f6898b493ae27e;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git
diff --git a/src/Tizen.NUI/src/public/ImfManager.cs b/src/Tizen.NUI/src/public/ImfManager.cs
index 9304124..40b908b 100755
--- a/src/Tizen.NUI/src/public/ImfManager.cs
+++ b/src/Tizen.NUI/src/public/ImfManager.cs
@@ -1,40 +1,47 @@
-/** 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;
namespace Tizen.NUI
{
///
- /// 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.
///
public class ImfManager : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
- internal ImfManager(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicManualPINVOKE.ImfManager_SWIGUpcast(cPtr), cMemoryOwn)
+ internal ImfManager(IntPtr cPtr, bool cMemoryOwn) : base(NDalicManualPINVOKE.ImfManager_SWIGUpcast(cPtr), cMemoryOwn)
{
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
}
internal static global::System.Runtime.InteropServices.HandleRef getCPtr(ImfManager obj)
{
- return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
+ return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero) : obj.swigCPtr;
}
+ ///
+ /// Dispose
+ ///
+ /// Dispose Type
+ /// 3
protected override void Dispose(DisposeTypes type)
{
if (disposed)
@@ -54,6 +61,36 @@ namespace Tizen.NUI
//You should not access any managed member here except static instance.
//because the execution order of Finalizes is non-deterministic.
+ if (_keyboardTypeChangedEventCallback != null)
+ {
+ KeyboardTypeChangedSignal().Disconnect(_keyboardTypeChangedEventCallback);
+ }
+
+ if (_imfManagerLanguageChangedEventCallback != null)
+ {
+ LanguageChangedSignal().Disconnect(_imfManagerLanguageChangedEventCallback);
+ }
+
+ if (_imfManagerResizedEventCallback != null)
+ {
+ ResizedSignal().Disconnect(_imfManagerResizedEventCallback);
+ }
+
+ if (_imfManagerStatusChangedEventCallback != null)
+ {
+ StatusChangedSignal().Disconnect(_imfManagerStatusChangedEventCallback);
+ }
+
+ if (_imfManagerEventReceivedEventCallback != null)
+ {
+ EventReceivedSignal().Disconnect(_imfManagerEventReceivedEventCallback);
+ }
+
+ if (_imfManagerActivatedEventCallback != null)
+ {
+ ActivatedSignal().Disconnect(_imfManagerActivatedEventCallback);
+ }
+
if (swigCPtr.Handle != global::System.IntPtr.Zero)
{
if (swigCMemOwn)
@@ -61,7 +98,7 @@ namespace Tizen.NUI
swigCMemOwn = false;
NDalicManualPINVOKE.delete_ImfManager(swigCPtr);
}
- swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
+ swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero);
}
base.Dispose(type);
@@ -73,9 +110,13 @@ namespace Tizen.NUI
public class ImfEventData : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ ///
+ /// swigCMemOwn
+ ///
+ /// 3
protected bool swigCMemOwn;
- internal ImfEventData(global::System.IntPtr cPtr, bool cMemoryOwn)
+ internal ImfEventData(IntPtr cPtr, bool cMemoryOwn)
{
swigCMemOwn = cMemoryOwn;
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
@@ -83,15 +124,21 @@ namespace Tizen.NUI
internal static global::System.Runtime.InteropServices.HandleRef getCPtr(ImfEventData obj)
{
- return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
+ return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero) : obj.swigCPtr;
}
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ ///
+ /// A Flat to check if it is already disposed.
+ ///
+ /// 3
protected bool disposed = false;
-
+ ///
+ /// Dispose.
+ ///
+ /// 3
~ImfEventData()
{
if (!isDisposeQueued)
@@ -102,8 +149,9 @@ namespace Tizen.NUI
}
///
- /// Dispose pattern
+ /// The dispose pattern.
///
+ /// 3
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
@@ -123,6 +171,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Dispose.
+ ///
+ /// 3
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
@@ -142,20 +194,20 @@ namespace Tizen.NUI
//You should not access any managed member here except static instance.
//because the execution order of Finalizes is non-deterministic.
- if (swigCPtr.Handle != global::System.IntPtr.Zero)
+ if (swigCPtr.Handle != IntPtr.Zero)
{
if (swigCMemOwn)
{
swigCMemOwn = false;
NDalicManualPINVOKE.delete_ImfManager_ImfEventData(swigCPtr);
}
- swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
+ swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero);
}
disposed = true;
}
- internal static ImfEventData GetImfEventDataFromPtr(global::System.IntPtr cPtr)
+ internal static ImfEventData GetImfEventDataFromPtr(IntPtr cPtr)
{
ImfEventData ret = new ImfEventData(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -163,28 +215,51 @@ namespace Tizen.NUI
}
///
- /// Default Constructor
+ /// The default constructor.
///
+ /// 3
public ImfEventData() : this(NDalicManualPINVOKE.new_ImfManager_ImfEventData__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
- /// Constructor
+ /// The constructor.
///
/// The name of the event from the IMF.
- /// The pre-edit or commit string.
- /// Start position from the current cursor position to start deleting characters.
+ /// The pre-edit or the commit string.
+ /// Start the position from the current cursor position to start deleting characters.
/// The number of characters to delete from the cursorOffset.
+ /// 3
public ImfEventData(ImfManager.ImfEvent aEventName, string aPredictiveString, int aCursorOffset, int aNumberOfChars) : this(NDalicManualPINVOKE.new_ImfManager_ImfEventData__SWIG_1((int)aEventName, aPredictiveString, aCursorOffset, aNumberOfChars), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
- /// The pre-edit or commit string.
+ /// The pre-edit or the commit string.
///
+ /// /// 3
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public string predictiveString
+ {
+ set
+ {
+ NDalicManualPINVOKE.ImfManager_ImfEventData_predictiveString_set(swigCPtr, value);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+ get
+ {
+ string ret = NDalicManualPINVOKE.ImfManager_ImfEventData_predictiveString_get(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
+ }
+
+ ///
+ /// The pre-edit or the commit string.
+ ///
+ /// 4
public string PredictiveString
{
set
@@ -203,6 +278,27 @@ namespace Tizen.NUI
///
/// The name of the event from the IMF.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public ImfManager.ImfEvent eventName
+ {
+ set
+ {
+ NDalicManualPINVOKE.ImfManager_ImfEventData_eventName_set(swigCPtr, (int)value);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+ get
+ {
+ ImfManager.ImfEvent ret = (ImfManager.ImfEvent)NDalicManualPINVOKE.ImfManager_ImfEventData_eventName_get(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
+ }
+
+ ///
+ /// The name of the event from the IMF.
+ ///
+ /// 4
public ImfManager.ImfEvent EventName
{
set
@@ -219,8 +315,29 @@ namespace Tizen.NUI
}
///
- /// Start position from the current cursor position to start deleting characters.
+ /// The start position from the current cursor position to start deleting characters.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public int cursorOffset
+ {
+ set
+ {
+ NDalicManualPINVOKE.ImfManager_ImfEventData_cursorOffset_set(swigCPtr, value);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+ get
+ {
+ int ret = NDalicManualPINVOKE.ImfManager_ImfEventData_cursorOffset_get(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
+ }
+
+ ///
+ /// The start position from the current cursor position to start deleting characters.
+ ///
+ /// 4
public int CursorOffset
{
set
@@ -237,8 +354,29 @@ namespace Tizen.NUI
}
///
- /// Number of characters to delete from the cursorOffset.
+ /// The number of characters to delete from the cursorOffset.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public int numberOfChars
+ {
+ set
+ {
+ NDalicManualPINVOKE.ImfManager_ImfEventData_numberOfChars_set(swigCPtr, value);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+ get
+ {
+ int ret = NDalicManualPINVOKE.ImfManager_ImfEventData_numberOfChars_get(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
+ }
+
+ ///
+ /// The number of characters to delete from the cursorOffset.
+ ///
+ /// 4
public int NumberOfChars
{
set
@@ -257,11 +395,15 @@ namespace Tizen.NUI
}
///
- /// Data required by IMF from the callback.
+ /// Data required by the IMF from the callback.
///
public class ImfCallbackData : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ ///
+ /// swigCMemOwn
+ ///
+ /// 3
protected bool swigCMemOwn;
internal IntPtr GetImfCallbackDataPtr()
@@ -269,7 +411,7 @@ namespace Tizen.NUI
return (IntPtr)swigCPtr;
}
- internal ImfCallbackData(global::System.IntPtr cPtr, bool cMemoryOwn)
+ internal ImfCallbackData(IntPtr cPtr, bool cMemoryOwn)
{
swigCMemOwn = cMemoryOwn;
swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
@@ -277,15 +419,22 @@ namespace Tizen.NUI
internal static global::System.Runtime.InteropServices.HandleRef getCPtr(ImfCallbackData obj)
{
- return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
+ return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero) : obj.swigCPtr;
}
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ ///
+ /// A Flat to check if it is already disposed.
+ ///
+ /// 3
protected bool disposed = false;
+ ///
+ /// Dispose.
+ ///
+ /// 3
~ImfCallbackData()
{
if (!isDisposeQueued)
@@ -296,8 +445,9 @@ namespace Tizen.NUI
}
///
- /// Dispose pattern
+ /// The dispose pattern.
///
+ /// 3
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
@@ -317,6 +467,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Dispose.
+ ///
+ /// 3
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
@@ -336,20 +490,20 @@ namespace Tizen.NUI
//You should not access any managed member here except static instance.
//because the execution order of Finalizes is non-deterministic.
- if (swigCPtr.Handle != global::System.IntPtr.Zero)
+ if (swigCPtr.Handle != IntPtr.Zero)
{
if (swigCMemOwn)
{
swigCMemOwn = false;
NDalicManualPINVOKE.delete_ImfManager_ImfCallbackData(swigCPtr);
}
- swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
+ swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero);
}
disposed = true;
}
- internal static ImfCallbackData GetImfCallbackDataFromPtr(global::System.IntPtr cPtr)
+ internal static ImfCallbackData GetImfCallbackDataFromPtr(IntPtr cPtr)
{
ImfCallbackData ret = new ImfCallbackData(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -357,28 +511,51 @@ namespace Tizen.NUI
}
///
- /// Default Constructor
+ /// The default constructor.
///
+ /// 3
public ImfCallbackData() : this(NDalicManualPINVOKE.new_ImfManager_ImfCallbackData__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
- /// Constructor
+ /// The constructor.
///
- /// True if cursor position needs to be updated.
- /// New position of cursor.
- /// Current text string.
+ /// True if the cursor position needs to be updated.
+ /// The new position of the cursor.
+ /// The current text string.
/// Flag if preedit reset is required.
+ /// 3
public ImfCallbackData(bool aUpdate, int aCursorPosition, string aCurrentText, bool aPreeditResetRequired) : this(NDalicManualPINVOKE.new_ImfManager_ImfCallbackData__SWIG_1(aUpdate, aCursorPosition, aCurrentText, aPreeditResetRequired), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
- /// Current text string.
+ /// The current text string.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public string currentText
+ {
+ set
+ {
+ NDalicManualPINVOKE.ImfManager_ImfCallbackData_currentText_set(swigCPtr, value);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+ get
+ {
+ string ret = NDalicManualPINVOKE.ImfManager_ImfCallbackData_currentText_get(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
+ }
+
+ ///
+ /// The current text string.
+ ///
+ /// 4
public string CurrentText
{
set
@@ -395,8 +572,29 @@ namespace Tizen.NUI
}
///
- /// Current text string.
+ /// The current text string.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public int cursorPosition
+ {
+ set
+ {
+ NDalicManualPINVOKE.ImfManager_ImfCallbackData_cursorPosition_set(swigCPtr, value);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+ get
+ {
+ int ret = NDalicManualPINVOKE.ImfManager_ImfCallbackData_cursorPosition_get(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
+ }
+
+ ///
+ /// The current text string.
+ ///
+ /// 4
public int CursorPosition
{
set
@@ -413,8 +611,29 @@ namespace Tizen.NUI
}
///
- /// If cursor position needs to be updated.
+ /// If the cursor position needs to be updated.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool update
+ {
+ set
+ {
+ NDalicManualPINVOKE.ImfManager_ImfCallbackData_update_set(swigCPtr, value);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+ get
+ {
+ bool ret = NDalicManualPINVOKE.ImfManager_ImfCallbackData_update_get(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
+ }
+
+ ///
+ /// If the cursor position needs to be updated.
+ ///
+ /// 4
public bool Update
{
set
@@ -431,8 +650,29 @@ namespace Tizen.NUI
}
///
- /// Flag if preedit reset is required.
+ /// Flags if preedit reset is required.
+ ///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool preeditResetRequired
+ {
+ set
+ {
+ NDalicManualPINVOKE.ImfManager_ImfCallbackData_preeditResetRequired_set(swigCPtr, value);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+ get
+ {
+ bool ret = NDalicManualPINVOKE.ImfManager_ImfCallbackData_preeditResetRequired_get(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
+ }
+
+ ///
+ /// Flags if preedit reset is required.
///
+ /// 4
public bool PreeditResetRequired
{
set
@@ -451,9 +691,19 @@ namespace Tizen.NUI
}
///
- /// Retrieve a handle to the instance of ImfManager.
+ /// Finalize the IMF.
+ ///
+ public void Finalize()
+ {
+ NDalicManualPINVOKE.ImfManager_Finalize(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+
+ ///
+ /// Retrieves a handle to the instance of the ImfManager.
///
/// A handle to the ImfManager.
+ /// 3
public static ImfManager Get()
{
ImfManager ret = new ImfManager(NDalicManualPINVOKE.ImfManager_Get(), true);
@@ -462,10 +712,11 @@ namespace Tizen.NUI
}
///
- /// Activate the IMF.
- /// It means that the text editing is started at somewhere.
- /// If the H/W keyboard isn't connected then it will show the virtual keyboard.
+ /// Activates the IMF.
+ /// It means that the text editing is started somewhere.
+ /// If the hardware keyboard isn't connected, then it will show the virtual keyboard.
///
+ /// 3
public void Activate()
{
NDalicManualPINVOKE.ImfManager_Activate(swigCPtr);
@@ -473,9 +724,10 @@ namespace Tizen.NUI
}
///
- /// Deactivate the IMF.
- /// It means that the text editing is finished at somewhere.
+ /// Deactivates the IMF.
+ /// It means that the text editing is finished somewhere.
///
+ /// 3
public void Deactivate()
{
NDalicManualPINVOKE.ImfManager_Deactivate(swigCPtr);
@@ -483,10 +735,11 @@ namespace Tizen.NUI
}
///
- /// Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
- /// If true then keyboard will be restored (activated) after focus is regained.
+ /// Gets the restoration status which controls if the keyboard is restored after the focus is lost and then regained.
+ /// If true, then the keyboard will be restored (activated) after focus is regained.
///
- /// Restoration status.
+ /// The restoration status.
+ /// 3
public bool RestoreAfterFocusLost()
{
bool ret = NDalicManualPINVOKE.ImfManager_RestoreAfterFocusLost(swigCPtr);
@@ -495,9 +748,10 @@ namespace Tizen.NUI
}
///
- /// Set status whether the IMF has to restore the keyboard after losing focus.
+ /// Sets the status whether the IMF has to restore the keyboard after losing focus.
///
- /// True means that keyboard should be restored after focus lost and regained.
+ /// True means that keyboard should be restored after the focus is lost and regained.
+ /// 3
public void SetRestoreAfterFocusLost(bool toggle)
{
NDalicManualPINVOKE.ImfManager_SetRestoreAfterFocusLost(swigCPtr, toggle);
@@ -505,8 +759,9 @@ namespace Tizen.NUI
}
///
- /// Send message reset the pred-edit state / imf module.
+ /// Sends a message reset to the preedit state or the IMF module.
///
+ /// 3
public new void Reset()
{
NDalicManualPINVOKE.ImfManager_Reset(swigCPtr);
@@ -514,8 +769,9 @@ namespace Tizen.NUI
}
///
- /// Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation.
+ /// Notifies the IMF context that the cursor position has changed, required for features like auto-capitalization.
///
+ /// 3
public void NotifyCursorPosition()
{
NDalicManualPINVOKE.ImfManager_NotifyCursorPosition(swigCPtr);
@@ -523,9 +779,10 @@ namespace Tizen.NUI
}
///
- /// Sets cursor position stored in VirtualKeyboard, this is required by the IMF context.
+ /// Sets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
///
- /// Position of cursor.
+ /// The position of the cursor.
+ /// 3
public void SetCursorPosition(uint cursorPosition)
{
NDalicManualPINVOKE.ImfManager_SetCursorPosition(swigCPtr, cursorPosition);
@@ -533,9 +790,10 @@ namespace Tizen.NUI
}
///
- /// Gets cursor position stored in VirtualKeyboard, this is required by the IMF context.
+ /// Gets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
///
- /// Current position of cursor
+ /// The current position of the cursor.
+ /// 3
public uint GetCursorPosition()
{
uint ret = NDalicManualPINVOKE.ImfManager_GetCursorPosition(swigCPtr);
@@ -544,9 +802,10 @@ namespace Tizen.NUI
}
///
- /// Method to store the string required by the IMF, this is used to provide predictive word suggestions.
+ /// A method to store the string required by the IMF, this is used to provide predictive word suggestions.
///
/// The text string surrounding the current cursor point.
+ /// 3
public void SetSurroundingText(string text)
{
NDalicManualPINVOKE.ImfManager_SetSurroundingText(swigCPtr, text);
@@ -554,9 +813,10 @@ namespace Tizen.NUI
}
///
- /// Gets current text string set within the IMF manager, this is used to offer predictive suggestions.
+ /// Gets the current text string set within the IMF manager, this is used to offer predictive suggestions.
///
- /// Surrounding text.
+ /// The surrounding text.
+ /// 3
public string GetSurroundingText()
{
string ret = NDalicManualPINVOKE.ImfManager_GetSurroundingText(swigCPtr);
@@ -565,9 +825,10 @@ namespace Tizen.NUI
}
///
- /// Notifies IMF context that text input is set to multi line or not.
+ /// Notifies the IMF context that text input is set to multiline or not.
///
/// True if multiline text input is used.
+ /// 3
public void NotifyTextInputMultiLine(bool multiLine)
{
NDalicManualPINVOKE.ImfManager_NotifyTextInputMultiLine(swigCPtr, multiLine);
@@ -575,9 +836,10 @@ namespace Tizen.NUI
}
///
- /// Returns text direction of the keyboard's current input language.
+ /// Returns the text direction of the keyboard's current input language.
///
/// The direction of the text.
+ /// 3
public ImfManager.TextDirection GetTextDirection()
{
ImfManager.TextDirection ret = (ImfManager.TextDirection)NDalicManualPINVOKE.ImfManager_GetTextDirection(swigCPtr);
@@ -586,13 +848,14 @@ namespace Tizen.NUI
}
///
- /// Provides size and position of keyboard.
- /// Position is relative to whether keyboard is visible or not.
- /// If keyboard is not visible then position will be off the screen.
- /// If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
- /// the values then taken down. So ideally GetInputMethodArea() should be called after Show().
+ /// Provides the size and the position of the keyboard.
+ /// The position is relative to whether the keyboard is visible or not.
+ /// If the keyboard is not visible, then the position will be off the screen.
+ /// If the keyboard is not being shown when this method is called, the keyboard is partially setup (IMFContext) to get/>
+ /// the values then taken down. So ideally, GetInputMethodArea() should be called after Show().
///
- /// Rectangle which is keyboard panel x, y, width, height
+ /// Rectangle which is keyboard panel x, y, width, height.
+ /// 3
public Rectangle GetInputMethodArea()
{
Rectangle ret = new Rectangle(NDalicManualPINVOKE.ImfManager_GetInputMethodArea(swigCPtr), true);
@@ -610,6 +873,7 @@ namespace Tizen.NUI
/// Sets up the input-panel specific data.
///
/// The specific data to be set to the input panel.
+ /// 3
public void SetInputPanelUserData(string text)
{
NDalicManualPINVOKE.ImfManager_SetInputPanelUserData(swigCPtr, text);
@@ -619,7 +883,8 @@ namespace Tizen.NUI
///
/// Gets the specific data of the current active input panel.
///
- /// The specific data to be got from the input panel.
+ /// The specific data to be received from the input panel.
+ /// 3
public void GetInputPanelUserData(out string text)
{
NDalicManualPINVOKE.ImfManager_GetInputPanelUserData(swigCPtr, out text);
@@ -630,6 +895,7 @@ namespace Tizen.NUI
/// Gets the state of the current active input panel.
///
/// The state of the input panel.
+ /// 3
public ImfManager.State GetInputPanelState()
{
ImfManager.State ret = (ImfManager.State)NDalicManualPINVOKE.ImfManager_GetInputPanelState(swigCPtr);
@@ -641,7 +907,8 @@ namespace Tizen.NUI
/// Sets the return key on the input panel to be visible or invisible.
/// The default is true.
///
- /// True if the return key is visible(enabled), false otherwise.
+ /// True if the return key is visible (enabled), false otherwise.
+ /// 3
public void SetReturnKeyState(bool visible)
{
NDalicManualPINVOKE.ImfManager_SetReturnKeyState(swigCPtr, visible);
@@ -649,9 +916,10 @@ namespace Tizen.NUI
}
///
- /// Enable to show the input panel automatically when focused.
+ /// Enables to show the input panel automatically when focused.
///
/// If true, the input panel will be shown when focused.
+ /// 3
public void AutoEnableInputPanel(bool enabled)
{
NDalicManualPINVOKE.ImfManager_AutoEnableInputPanel(swigCPtr, enabled);
@@ -661,6 +929,7 @@ namespace Tizen.NUI
///
/// Shows the input panel.
///
+ /// 3
public void ShowInputPanel()
{
NDalicManualPINVOKE.ImfManager_ShowInputPanel(swigCPtr);
@@ -670,6 +939,7 @@ namespace Tizen.NUI
///
/// Hides the input panel.
///
+ /// 3
public void HideInputPanel()
{
NDalicManualPINVOKE.ImfManager_HideInputPanel(swigCPtr);
@@ -680,7 +950,8 @@ namespace Tizen.NUI
/// Gets the keyboard type.
/// The default keyboard type is SoftwareKeyboard.
///
- /// The keyboard type
+ /// The keyboard type.
+ /// 4
public ImfManager.KeyboardType GetKeyboardType()
{
ImfManager.KeyboardType ret = (ImfManager.KeyboardType)NDalicManualPINVOKE.ImfManager_GetKeyboardType(swigCPtr);
@@ -690,9 +961,10 @@ namespace Tizen.NUI
///
/// Gets the current language locale of the input panel.
- /// Ex) en_US, en_GB, en_PH, fr_FR, ...
+ /// For example, en_US, en_GB, en_PH, fr_FR, ...
///
/// The current language locale of the input panel.
+ /// 4
public string GetInputPanelLocale()
{
string ret = NDalicManualPINVOKE.ImfManager_GetInputPanelLocale(swigCPtr);
@@ -701,25 +973,25 @@ namespace Tizen.NUI
}
///
- /// Constructor
+ /// The constructor.
///
+ /// 3
public ImfManager() : this(NDalicManualPINVOKE.new_ImfManager(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- internal static ImfManager GetImfManagerFromPtr(global::System.IntPtr cPtr)
- {
- ImfManager ret = new ImfManager(cPtr, false);
- if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
- return ret;
- }
-
///
/// ImfManager activated event arguments.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
public class ImfManagerActivatedEventArgs : EventArgs
{
+ ///
+ /// ImfManager
+ ///
+ /// 3
public ImfManager ImfManager
{
get;
@@ -730,12 +1002,13 @@ namespace Tizen.NUI
[UnmanagedFunctionPointer(CallingConvention.StdCall)]
private delegate void ImfManagerActivatedEventCallbackType(global::System.IntPtr data);
private ImfManagerActivatedEventCallbackType _imfManagerActivatedEventCallback;
-
private event EventHandler _imfManagerActivatedEventHandler;
///
- /// ImfManager activated.
+ /// ImfManager activated event.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler ImfManagerActivated
{
add
@@ -763,7 +1036,10 @@ namespace Tizen.NUI
{
ImfManagerActivatedEventArgs e = new ImfManagerActivatedEventArgs();
- e.ImfManager = ImfManager.GetImfManagerFromPtr(data);
+ if (data != null)
+ {
+ e.ImfManager = Registry.GetManagedBaseHandleFromNativePtr(data) as ImfManager;
+ }
if (_imfManagerActivatedEventHandler != null)
{
@@ -771,7 +1047,75 @@ namespace Tizen.NUI
}
}
- internal ActivatedSignalType ActivatedSignal()
+ ///
+ /// ImfManager activated event arguments.
+ ///
+ public class ActivatedEventArgs : EventArgs
+ {
+ ///
+ /// ImfManager
+ ///
+ /// 3
+ public ImfManager ImfManager
+ {
+ get;
+ set;
+ }
+ }
+
+ [UnmanagedFunctionPointer(CallingConvention.StdCall)]
+ private delegate void ActivatedEventCallbackType(IntPtr data);
+ private ActivatedEventCallbackType _activatedEventCallback;
+ private event EventHandler _activatedEventHandler;
+
+ ///
+ /// ImfManager activated.
+ ///
+ /// 4
+ public event EventHandler Activated
+ {
+ add
+ {
+ if (_activatedEventHandler == null)
+ {
+ _activatedEventCallback = OnActivated;
+ ActivatedSignal().Connect(_activatedEventCallback);
+ }
+
+ _activatedEventHandler += value;
+ }
+ remove
+ {
+ _activatedEventHandler -= value;
+
+ if (_activatedEventHandler == null && _activatedEventCallback != null)
+ {
+ ActivatedSignal().Disconnect(_activatedEventCallback);
+ }
+ }
+ }
+
+ private void OnActivated(IntPtr data)
+ {
+ ActivatedEventArgs e = new ActivatedEventArgs();
+
+ if (data != null)
+ {
+ e.ImfManager = Registry.GetManagedBaseHandleFromNativePtr(data) as ImfManager;
+ }
+
+ if (_activatedEventHandler != null)
+ {
+ _activatedEventHandler(this, e);
+ }
+ }
+
+ ///
+ /// ImfManager activated signal.
+ ///
+ //Please do not use! this will be internal
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public ActivatedSignalType ActivatedSignal()
{
ActivatedSignalType ret = new ActivatedSignalType(NDalicManualPINVOKE.ImfManager_ActivatedSignal(swigCPtr), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -781,29 +1125,31 @@ namespace Tizen.NUI
///
/// ImfManager event received event arguments.
///
+ //Please do not use! this will be deprecated
+ [EditorBrowsable(EditorBrowsableState.Never)]
public class ImfManagerEventReceivedEventArgs : EventArgs
{
+ ///
+ /// ImfManager
+ ///
+ /// 3
public ImfManager ImfManager
{
get;
set;
}
-
- public ImfEventData ImfEventData
- {
- get;
- set;
- }
}
- private delegate global::System.IntPtr ImfManagerEventReceivedEventCallbackType(global::System.IntPtr imfManager, global::System.IntPtr imfEventData);
+ private delegate void ImfManagerEventReceivedEventCallbackType(global::System.IntPtr data);
private ImfManagerEventReceivedEventCallbackType _imfManagerEventReceivedEventCallback;
+ private event EventHandler _imfManagerEventReceivedEventHandler;
- private event EventHandlerWithReturnType