/// <summary>
/// Specifically manages the input method framework which enables the virtual or hardware keyboards.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class InputMethodContext : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// Dispose
/// </summary>
/// <param name="type">Dispose Type</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
/// Please DO NOT use! This will be deprecated!
/// Dispose() method in Singletone classes (ex: FocusManager, StyleManager, VisualFactory, InputMethodContext, TtsPlayer, Window) is not required.
[EditorBrowsable(EditorBrowsableState.Never)]
/// <summary>
/// This structure is used to pass on data from the IMF regarding predictive text.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class EventData : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// <summary>
/// swigCMemOwn
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
protected bool swigCMemOwn;
internal EventData(IntPtr cPtr, bool cMemoryOwn)
/// <summary>
/// A Flat to check if it is already disposed.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
protected bool disposed = false;
/// <summary>
/// Dispose.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
~EventData()
{
if (!isDisposeQueued)
/// <summary>
/// The dispose pattern.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
/// <summary>
/// Dispose.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
/// The default constructor.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public EventData() : this(NDalicManualPINVOKE.new_InputMethodContext_EventData__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <param name="aPredictiveString">The pre-edit or the commit string.</param>
/// <param name="aCursorOffset">Start the position from the current cursor position to start deleting characters.</param>
/// <param name="aNumberOfChars">The number of characters to delete from the cursorOffset.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public EventData(InputMethodContext.EventType aEventName, string aPredictiveString, int aCursorOffset, int aNumberOfChars) : this(NDalicManualPINVOKE.new_InputMethodContext_EventData__SWIG_1((int)aEventName, aPredictiveString, aCursorOffset, aNumberOfChars), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// The pre-edit or the commit string.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string PredictiveString
{
set
/// <summary>
/// The name of the event from the IMF.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public InputMethodContext.EventType EventName
{
set
/// <summary>
/// The start position from the current cursor position to start deleting characters.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int CursorOffset
{
set
/// <summary>
/// The number of characters to delete from the cursorOffset.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int NumberOfChars
{
set
/// <summary>
/// Data required by the IMF from the callback.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class CallbackData : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// <summary>
/// swigCMemOwn
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
protected bool swigCMemOwn;
internal IntPtr GetCallbackDataPtr()
/// <summary>
/// A Flat to check if it is already disposed.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
protected bool disposed = false;
/// <summary>
/// Dispose.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
~CallbackData()
{
if (!isDisposeQueued)
/// <summary>
/// The dispose pattern.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
/// <summary>
/// Dispose.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
/// <summary>
/// The default constructor.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public CallbackData() : this(NDalicManualPINVOKE.new_InputMethodContext_CallbackData__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <param name="aCursorPosition">The new position of the cursor.</param>
/// <param name="aCurrentText">The current text string.</param>
/// <param name="aPreeditResetRequired">Flag if preedit reset is required.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public CallbackData(bool aUpdate, int aCursorPosition, string aCurrentText, bool aPreeditResetRequired) : this(NDalicManualPINVOKE.new_InputMethodContext_CallbackData__SWIG_1(aUpdate, aCursorPosition, aCurrentText, aPreeditResetRequired), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// The current text string.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string CurrentText
{
set
/// <summary>
/// The current text string.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int CursorPosition
{
set
/// <summary>
/// If the cursor position needs to be updated.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool Update
{
set
/// <summary>
/// Flags if preedit reset is required.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool PreeditResetRequired
{
set
/// <summary>
/// Destroy the context of the IMF.<br/>
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
/// Please do not use! This will be deprecated, instead please USE Tizen.NUI.InputMethodContext.Instance.DestroyContext()!
[Obsolete("Please do not use! This will be deprecated! Please use InputMethodContext.Instance.DestroyContext() instead!")]
[EditorBrowsable(EditorBrowsableState.Never)]
/// It means that the text editing is started somewhere.<br/>
/// If the hardware keyboard isn't connected, then it will show the virtual keyboard.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Activate()
{
NDalicManualPINVOKE.InputMethodContext_Activate(swigCPtr);
/// Deactivates the IMF.<br/>
/// It means that the text editing is finished somewhere.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void Deactivate()
{
NDalicManualPINVOKE.InputMethodContext_Deactivate(swigCPtr);
/// If true, then the keyboard will be restored (activated) after focus is regained.
/// </summary>
/// <returns>The restoration status.</returns>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool RestoreAfterFocusLost()
{
bool ret = NDalicManualPINVOKE.InputMethodContext_RestoreAfterFocusLost(swigCPtr);
/// Sets the status whether the IMF has to restore the keyboard after losing focus.
/// </summary>
/// <param name="toggle">True means that keyboard should be restored after the focus is lost and regained.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void SetRestoreAfterFocusLost(bool toggle)
{
NDalicManualPINVOKE.InputMethodContext_SetRestoreAfterFocusLost(swigCPtr, toggle);
/// <summary>
/// Sends a message reset to the preedit state or the IMF module.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public new void Reset()
{
NDalicManualPINVOKE.InputMethodContext_Reset(swigCPtr);
/// <summary>
/// Notifies the IMF context that the cursor position has changed, required for features like auto-capitalization.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void NotifyCursorPosition()
{
NDalicManualPINVOKE.InputMethodContext_NotifyCursorPosition(swigCPtr);
/// Sets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
/// </summary>
/// <param name="cursorPosition">The position of the cursor.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void SetCursorPosition(uint cursorPosition)
{
NDalicManualPINVOKE.InputMethodContext_SetCursorPosition(swigCPtr, cursorPosition);
/// Gets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
/// </summary>
/// <returns>The current position of the cursor.</returns>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public uint GetCursorPosition()
{
uint ret = NDalicManualPINVOKE.InputMethodContext_GetCursorPosition(swigCPtr);
/// A method to store the string required by the IMF, this is used to provide predictive word suggestions.
/// </summary>
/// <param name="text">The text string surrounding the current cursor point.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void SetSurroundingText(string text)
{
NDalicManualPINVOKE.InputMethodContext_SetSurroundingText(swigCPtr, text);
/// Gets the current text string set within the IMF manager, this is used to offer predictive suggestions.
/// </summary>
/// <returns>The surrounding text.</returns>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string GetSurroundingText()
{
string ret = NDalicManualPINVOKE.InputMethodContext_GetSurroundingText(swigCPtr);
/// Notifies the IMF context that text input is set to multiline or not.
/// </summary>
/// <param name="multiLine">True if multiline text input is used.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void NotifyTextInputMultiLine(bool multiLine)
{
NDalicManualPINVOKE.InputMethodContext_NotifyTextInputMultiLine(swigCPtr, multiLine);
/// Returns the text direction of the keyboard's current input language.
/// </summary>
/// <returns>The direction of the text.</returns>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public InputMethodContext.TextDirection GetTextDirection()
{
InputMethodContext.TextDirection ret = (InputMethodContext.TextDirection)NDalicManualPINVOKE.InputMethodContext_GetTextDirection(swigCPtr);
/// the values then taken down. So ideally, GetInputMethodArea() should be called after Show().
/// </summary>
/// <returns>Rectangle which is keyboard panel x, y, width, height.</returns>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public Rectangle GetInputMethodArea()
{
Rectangle ret = new Rectangle(NDalicManualPINVOKE.InputMethodContext_GetInputMethodArea(swigCPtr), true);
/// Sets up the input-panel specific data.
/// </summary>
/// <param name="text">The specific data to be set to the input panel.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void SetInputPanelUserData(string text)
{
NDalicManualPINVOKE.InputMethodContext_SetInputPanelUserData(swigCPtr, text);
/// Gets the specific data of the current active input panel.
/// </summary>
/// <param name="text">The specific data to be received from the input panel.</param>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void GetInputPanelUserData(out string text)
{
NDalicManualPINVOKE.InputMethodContext_GetInputPanelUserData(swigCPtr, out text);
/// Gets the state of the current active input panel.
/// </summary>
/// <returns>The state of the input panel.</returns>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public InputMethodContext.State GetInputPanelState()
{
InputMethodContext.State ret = (InputMethodContext.State)NDalicManualPINVOKE.InputMethodContext_GetInputPanelState(swigCPtr);
/// The default is true.
/// </summary>
/// <param name="visible">True if the return key is visible (enabled), false otherwise.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void SetReturnKeyState(bool visible)
{
NDalicManualPINVOKE.InputMethodContext_SetReturnKeyState(swigCPtr, visible);
/// Enables to show the input panel automatically when focused.
/// </summary>
/// <param name="enabled">If true, the input panel will be shown when focused.</param>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void AutoEnableInputPanel(bool enabled)
{
NDalicManualPINVOKE.InputMethodContext_AutoEnableInputPanel(swigCPtr, enabled);
/// <summary>
/// Shows the input panel.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void ShowInputPanel()
{
NDalicManualPINVOKE.InputMethodContext_ShowInputPanel(swigCPtr);
/// <summary>
/// Hides the input panel.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public void HideInputPanel()
{
NDalicManualPINVOKE.InputMethodContext_HideInputPanel(swigCPtr);
/// The default keyboard type is SoftwareKeyboard.
/// </summary>
/// <returns>The keyboard type.</returns>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public InputMethodContext.KeyboardType GetKeyboardType()
{
InputMethodContext.KeyboardType ret = (InputMethodContext.KeyboardType)NDalicManualPINVOKE.InputMethodContext_GetKeyboardType(swigCPtr);
/// For example, en_US, en_GB, en_PH, fr_FR, ...
/// </summary>
/// <returns>The current language locale of the input panel.</returns>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public string GetInputPanelLocale()
{
string ret = NDalicManualPINVOKE.InputMethodContext_GetInputPanelLocale(swigCPtr);
/// <summary>
/// InputMethodContext activated event arguments.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class ActivatedEventArgs : EventArgs
{
/// <summary>
/// InputMethodContext
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public InputMethodContext InputMethodContext
{
get;
/// <summary>
/// InputMethodContext activated.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public event EventHandler<ActivatedEventArgs> Activated
{
add
/// <summary>
/// InputMethodContext event received event arguments.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class EventReceivedEventArgs : EventArgs
{
/// <summary>
/// InputMethodContext
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public InputMethodContext InputMethodContext
{
get;
/// <summary>
/// EventData
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public EventData EventData
{
get;
/// <summary>
/// InputMethodContext event received.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public event EventHandlerWithReturnType<object, EventReceivedEventArgs, CallbackData> EventReceived
{
add
/// <summary>
/// InputMethodContext status changed event arguments.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class StatusChangedEventArgs : EventArgs
{
/// <summary>
/// InputMethodContext status
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public bool StatusChanged
{
get;
/// <summary>
/// InputMethodContext status changed.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public event EventHandler<StatusChangedEventArgs> StatusChanged
{
add
/// <summary>
/// InputMethodContext resized event.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class ResizedEventArgs : EventArgs
{
/// <summary>
/// resized.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int Resized
{
get;
/// <summary>
/// InputMethodContext resized.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public event EventHandler<ResizedEventArgs> Resized
{
add
/// <summary>
/// InputMethodContext language changed event args.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class LanguageChangedEventArgs : EventArgs
{
/// <summary>
/// language changed.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public int LanguageChanged
{
get;
/// <summary>
/// InputMethodContext language changed.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public event EventHandler<LanguageChangedEventArgs> LanguageChanged
{
add
/// <summary>
/// InputMethodContext keyboard type changed event arguments.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public class KeyboardTypeChangedEventArgs : EventArgs
{
/// <summary>
/// InputMethodContext keyboard type
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public KeyboardType KeyboardType
{
get;
/// <summary>
/// InputMethodContext keyboard type changed.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public event EventHandler<KeyboardTypeChangedEventArgs> KeyboardTypeChanged
{
add
/// <summary>
/// The direction of the text.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum TextDirection
{
/// <summary>
/// <summary>
/// Events that are generated by the IMF.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum EventType
{
/// <summary>
/// No event.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
Void,
/// <summary>
/// Pre-Edit changed.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
Preedit,
/// <summary>
/// Commit received.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
Commit,
/// <summary>
/// An event to delete a range of characters from the string.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
DeleteSurrounding,
/// <summary>
/// An event to query string and the cursor position.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
GetSurrounding,
/// <summary>
/// Private command sent from the input panel.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
PrivateCommand
}
/// <summary>
/// Enumeration for the state of the input panel.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum State
{
/// <summary>
/// Unknown state.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
Default = 0,
/// <summary>
/// Input panel is shown.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
Show,
/// <summary>
/// Input panel is hidden.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
Hide,
/// <summary>
/// Input panel in process of being shown.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
WillShow
}
/// <summary>
/// Enumeration for the types of keyboard.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
public enum KeyboardType
{
/// <summary>
/// Software keyboard (virtual keyboard) is default.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
SoftwareKeyboard,
/// <summary>
/// Hardware keyboard.
/// </summary>
- /// <since_tizen> 4 </since_tizen>
+ /// <since_tizen> 5 </since_tizen>
HardwareKeyboard
}
}
projects / platform / core / csapi / tizenfx.git / commitdiff