using Tizen.Uix.InputMethod;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// EinaList Interop Class
+ /// The EinaList Interop class.
/// </summary>
internal static class EinaList
{
using Tizen.Uix.InputMethod;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// InputMethod Interop Class
+ /// The InputMethod Interop class.
/// </summary>
internal static class InputMethod
{
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Partial Libraries Class
+ /// The Partial Libraries class.
/// </summary>
internal static partial class Libraries
{
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to AccessibilityStateChanged Event
+ /// This class contains the data related to the AccessibilityStateChanged event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class AccessibilityStateChangedEventArgs
}
/// <summary>
- /// Accessibility option state
+ /// Accessibility option state.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool State
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to CursorPositionUpdated Event
+ /// This class contains the data related to the CursorPositionUpdated event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class CursorPositionUpdatedEventArgs
}
/// <summary>
- /// The cursor position
+ /// The cursor position.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int CursorPosition
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to DataSet Event
+ /// This class contains the data related to the DataSet event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SetDataEventArgs
}
/// <summary>
- /// The specific data to be set to the input panel
+ /// The specific data to be set to the input panel.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public byte[] Data
}
/// <summary>
- /// The length of data, in bytes, to send to the input panel
+ /// The length of data, in bytes, to be sent to the input panel.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public uint DataLength
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to DisplayLanguageChanged Event
+ /// This class contains the data related to the DisplayLanguageChanged event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DisplayLanguageChangedEventArgs
}
/// <summary>
- /// The language code
+ /// The language code.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string Language
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// The Editor window class
+ /// The editor window class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class EditorWindow : Window
}
/// <summary>
- /// This API creates handle for editor window.
+ /// This API creates a handle for the editor window.
/// </summary>
/// <since_tizen> 4 </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
}
/// <summary>
- /// This API gets handle for editor window.
+ /// This API gets a handle for the editor window.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public IntPtr GetHandle()
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="portraitWidth">The width in portrait mode</param>
- /// <param name="portraitHeight">The height in portrait mode</param>
- /// <param name="landscapeWidth">The width in landscape mode</param>
- /// <param name="landscapeHeight">The height in landscape mode</param>
+ /// <param name="portraitWidth">The width in the portrait mode.</param>
+ /// <param name="portraitHeight">The height in the portrait mode.</param>
+ /// <param name="landscapeWidth">The width in the landscape mode.</param>
+ /// <param name="landscapeHeight">The height in the landscape mode.</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void SetSize(int portraitWidth, int portraitHeight, int landscapeWidth, int landscapeHeight)
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to FocusedIn Event
+ /// This class contains the data related to the FocusedIn event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class FocusedInEventArgs
}
/// <summary>
- /// The input context identification value of an associated text input UI control
+ /// The input context identification value of an associated text input UI control.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int ContextId
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to FocusedOut Event
+ /// This class contains the data related to the FocusedOut event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class FocusedOutEventArgs
}
/// <summary>
- /// The input context identification value of an associated text input UI control
+ /// The input context identification value of an associated text input UI control.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int ContextId
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// Enumeration for Input Panel Layout
+ /// Enumeration for the input panel layout.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum InputPanelLayout
{
/// <summary>
- /// Normal
+ /// Normal.
/// </summary>
LayoutNormal,
/// <summary>
- /// Number
+ /// Number.
/// </summary>
LayoutNumber,
/// <summary>
- /// Email
+ /// Email.
/// </summary>
LayoutEMail,
/// <summary>
- /// URL
+ /// URL.
/// </summary>
LayoutURL,
/// <summary>
- /// Phone Number
+ /// Phone Number.
/// </summary>
LayoutPhoneNumber,
/// <summary>
- /// IP
+ /// IP.
/// </summary>
LayoutIP,
/// <summary>
- /// Month
+ /// Month.
/// </summary>
LayoutMonth,
/// <summary>
- /// Number Only
+ /// Number Only.
/// </summary>
LayoutNumberOnly,
/// <summary>
- /// Invalid
+ /// Invalid.
/// </summary>
LayoutInvalid,
/// <summary>
- /// HEX
+ /// HEX.
/// </summary>
LayoutHEX,
/// <summary>
- /// Terminal
+ /// Terminal.
/// </summary>
LayoutTerminal,
/// <summary>
- /// Password
+ /// Password.
/// </summary>
LayoutPassword,
/// <summary>
- /// Date Time
+ /// Date and time.
/// </summary>
LayoutDateTime,
/// <summary>
- /// Emoticon
+ /// Emoticon.
/// </summary>
LayoutEmoticon,
/// <summary>
- /// Voice
+ /// Voice.
/// </summary>
LayoutVoice,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for Layout Variation
+ /// Enumeration for the layout variation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum LayoutVariation
{
/// <summary>
- /// The plain normal layout
+ /// The plain normal layout.
/// </summary>
NormalNormal = 0,
/// <summary>
- /// Filename layout; symbols such as '/', '\*', '\', '|', '<', '>', '?', '"' and ':' should be disabled
+ /// Filename layout; symbols such as '/', '\*', '\', '|', '<', '>', '?', '"', and ':' should be disabled.
/// </summary>
NormalFileName,
/// <summary>
- /// The name of a person
+ /// The name of a person.
/// </summary>
NormalPersonName,
/// <summary>
- /// The plain normal number layout
+ /// The plain normal number layout.
/// </summary>
NumberOnlyNormal = 0,
/// <summary>
- /// The number layout to allow a negative sign
+ /// The number layout to allow a negative sign.
/// </summary>
NumberOnlySigned,
/// <summary>
- /// The number layout to allow decimal point to provide fractional value
+ /// The number layout to allow a decimal point to provide fractional value.
/// </summary>
NumberOnlyDecimal,
/// <summary>
- /// The number layout to allow decimal point and negative sign
+ /// The number layout to allow a decimal point and negative sign.
/// </summary>
NumberOnlySignedAndDecimal,
/// <summary>
- /// The normal password layout
+ /// The normal password layout.
/// </summary>
PasswordNormal = 0,
/// <summary>
- /// The password layout to allow only number
+ /// The password layout to allow only a number.
/// </summary>
PasswordNumberOnly,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for AutoCapital Type
+ /// Enumeration for the AutoCapital types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AutoCapitalization
{
/// <summary>
- /// None
+ /// None.
/// </summary>
None,
/// <summary>
- /// Word
+ /// Word.
/// </summary>
Word,
/// <summary>
- /// Sentence
+ /// Sentence.
/// </summary>
Sentence,
/// <summary>
- /// All Character
+ /// All characters.
/// </summary>
AllCharacter,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for InputPanel ReturnKey Type
+ /// Enumeration for the InputPanel ReturnKey types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum InputPanelReturnKey
{
/// <summary>
- /// Default
+ /// Default.
/// </summary>
Default,
/// <summary>
- /// Done
+ /// Done.
/// </summary>
Done,
/// <summary>
- /// Go
+ /// Go.
/// </summary>
Go,
/// <summary>
- /// Join
+ /// Join.
/// </summary>
Join,
/// <summary>
- /// Login
+ /// Login.
/// </summary>
Login,
/// <summary>
- /// Next
+ /// Next.
/// </summary>
Next,
/// <summary>
- /// Search
+ /// Search.
/// </summary>
Search,
/// <summary>
- /// Send
+ /// Send.
/// </summary>
Send,
/// <summary>
- /// SignIn
+ /// SignIn.
/// </summary>
SignIn,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for InputHints
+ /// Enumeration for the InputHints.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum InputHints
{
/// <summary>
- /// None
+ /// None.
/// </summary>
None,
/// <summary>
- /// AutoComplete
+ /// AutoComplete.
/// </summary>
AutoComplete,
/// <summary>
- /// SensitiveData
+ /// SensitiveData.
/// </summary>
SensitiveData,
/// <summary>
- /// Multiline
+ /// Multiline.
/// </summary>
Multiline,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for BiDi Direction
+ /// Enumeration for the BiDirection.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum BiDirection
{
/// <summary>
- /// Neutral
+ /// Neutral.
/// </summary>
Neutral,
/// <summary>
- /// LTR
+ /// LTR.
/// </summary>
LTR,
/// <summary>
- /// RTL
+ /// RTL.
/// </summary>
RTL,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for InputPanel Language
+ /// Enumeration for the InputPanel language.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum InputPanelLanguage
{
/// <summary>
- /// Automatic
+ /// Automatic.
/// </summary>
Automatic,
/// <summary>
- /// Alphabet
+ /// Alphabet.
/// </summary>
Alphabet,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// This class represents the context of InputMethodEditor
+ /// This class represents the context of the InputMethodEditor.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class InputMethodContext
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// Enumeration for Device Class
+ /// Enumeration for the device class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DeviceClass
{
/// <summary>
- /// None
+ /// None.
/// </summary>
None,
/// <summary>
- /// Seat
+ /// Seat.
/// </summary>
Seat,
/// <summary>
- /// Keyboard
+ /// Keyboard.
/// </summary>
Keyboard,
/// <summary>
- /// Mouse
+ /// Mouse.
/// </summary>
Mouse,
/// <summary>
- /// Touch
+ /// Touch.
/// </summary>
Touch,
/// <summary>
- /// Pen
+ /// Pen.
/// </summary>
Pen,
/// <summary>
- /// Pointer
+ /// Pointer.
/// </summary>
Pointer,
/// <summary>
- /// Gamepad
+ /// Gamepad.
/// </summary>
Gamepad,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// Enumeration for Device SubClass
+ /// Enumeration for the device subclass.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DeviceSubclass
{
/// <summary>
- /// None
+ /// None.
/// </summary>
None,
/// <summary>
- /// Finger
+ /// Finger.
/// </summary>
Finger,
/// <summary>
- /// FingerNail
+ /// FingerNail.
/// </summary>
FingerNail,
/// <summary>
- /// Knuckle
+ /// Knuckle.
/// </summary>
Knuckle,
/// <summary>
- /// Palm
+ /// Palm.
/// </summary>
Palm,
/// <summary>
- /// HandSize
+ /// HandSize.
/// </summary>
HandSize,
/// <summary>
- /// HandFlat
+ /// HandFlat.
/// </summary>
HandFlat,
/// <summary>
- /// PenTip
+ /// PenTip.
/// </summary>
PenTip,
/// <summary>
- /// Trackpad
+ /// Trackpad.
/// </summary>
Trackpad,
/// <summary>
- /// Trackpoint
+ /// Trackpoint.
/// </summary>
Trackpoint,
/// <summary>
- /// Trackball
+ /// Trackball.
/// </summary>
Trackball,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined
};
/// <summary>
- /// this class gives the device information, like the name, class and subclass
+ /// This class gives the device information, like the name, class, and subclass.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class InputMethodDeviceInformation
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// Enumeration of the key codes.
- /// If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded 24-bit UCS character.The UCS value is keycode & 0x00ffffff.
- /// Defines the list of keys supported by the system.Note that certain keys may not be available on all devices.
+ /// Enumeration for the key codes.
+ /// If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded to 24-bit UCS character. The UCS value is keycode & 0x00ffffff.
+ /// Defines the list of keys supported by the system. Note that certain keys may not be available on all the devices.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum KeyCode
{
/// <summary>
- /// The backspace key
+ /// The Backspace key.
/// </summary>
BackSpace = 0xFF08,
/// <summary>
- /// The tab key
+ /// The Tab key.
/// </summary>
Tab = 0xFF09,
/// <summary>
- /// The linefeed key
+ /// The Linefeed key.
/// </summary>
Linefeed = 0xFF0A,
/// <summary>
- /// The clear key
+ /// The Clear key.
/// </summary>
Clear = 0xFF0B,
/// <summary>
- /// The return key
+ /// The Return key.
/// </summary>
Return = 0xFF0D,
/// <summary>
- /// The pause key
+ /// The Pause key.
/// </summary>
Pause = 0xFF13,
/// <summary>
- /// The scroll lock key
+ /// The Scroll lock key.
/// </summary>
ScrollLock = 0xFF14,
/// <summary>
- /// The sys req key
+ /// The System Request key.
/// </summary>
SysReq = 0xFF15,
/// <summary>
- /// The escape key
+ /// The Escape key.
/// </summary>
Escape = 0xFF1B,
/// <summary>
- /// The delete key
+ /// The Delete key.
/// </summary>
Delete = 0xFFFF,
/* Cursor control & motion */
/// <summary>
- /// The home key
+ /// The Home key.
/// </summary>
Home = 0xFF50,
/// <summary>
- /// The left directional key
+ /// The Left directional key.
/// </summary>
Left = 0xFF51,
/// <summary>
- /// The up directional key
+ /// The Up directional key.
/// </summary>
Up = 0xFF52,
/// <summary>
- /// The right directional key
+ /// The Right directional key.
/// </summary>
Right = 0xFF53,
/// <summary>
- /// The down directional key
+ /// The Down directional key.
/// </summary>
Down = 0xFF54,
/// <summary>
- /// The prior, previous key
+ /// The Prior, Previous key.
/// </summary>
Prior = 0xFF55,
/// <summary>
- /// The page up key
+ /// The Page Up key.
/// </summary>
Page_Up = 0xFF55,
/// <summary>
- /// The next key
+ /// The Next key.
/// </summary>
Next = 0xFF56,
/// <summary>
- /// The page down key
+ /// The Page Down key.
/// </summary>
Page_Down = 0xFF56,
/// <summary>
- /// The end key
+ /// The End key.
/// </summary>
End = 0xFF57,
/// <summary>
- /// The begin key
+ /// The Begin key.
/// </summary>
Begin = 0xFF58,
/* Misc Functions */
/// <summary>
- /// The select key
+ /// The Select key.
/// </summary>
Select = 0xFF60,
/// <summary>
- /// The print key
+ /// The Print key.
/// </summary>
Print = 0xFF61,
/// <summary>
- /// The execute, run, do key
+ /// The Execute, Run, Do key.
/// </summary>
Execute = 0xFF62,
/// <summary>
- /// The insert key
+ /// The Insert key.
/// </summary>
Insert = 0xFF63,
/// <summary>
- /// The undo key
+ /// The Undo key.
/// </summary>
Undo = 0xFF65,
/// <summary>
- /// The redo key
+ /// The Redo key.
/// </summary>
Redo = 0xFF66,
/// <summary>
- /// The menu key
+ /// The Menu key.
/// </summary>
Menu = 0xFF67,
/// <summary>
- /// The find key
+ /// The Find key.
/// </summary>
Find = 0xFF68,
/// <summary>
- /// The cancel, stop, abort, exit key
+ /// The Cancel, Stop, Abort, Exit key.
/// </summary>
Cancel = 0xFF69,
/// <summary>
- /// The help key
+ /// The Help key.
/// </summary>
Help = 0xFF6A,
/// <summary>
- /// The break key
+ /// The Break key.
/// </summary>
Break = 0xFF6B,
/// <summary>
- /// The character set switch key
+ /// The character set switch key.
/// </summary>
Mode_switch = 0xFF7E,
/// <summary>
- /// The num lock key
+ /// The Number Lock key.
/// </summary>
Num_Lock = 0xFF7F,
/* Keypad */
/// <summary>
- /// The Numpad space key
+ /// The Numpad Space key.
/// </summary>
KPSpace = 0xFF80,
/// <summary>
- /// The Numpad tab key
+ /// The Numpad Tab key.
/// </summary>
KPTab = 0xFF89,
/// <summary>
- /// The Numpad enter key
+ /// The Numpad Enter key.
/// </summary>
KPEnter = 0xFF8D,
/// <summary>
- /// The Numpad function 1 key
+ /// The Numpad Function 1 key.
/// </summary>
KPF1 = 0xFF91,
/// <summary>
- /// The Numpad function 2 key
+ /// The Numpad Function 2 key.
/// </summary>
KPF2 = 0xFF92,
/// <summary>
- /// The Numpad function 3 key
+ /// The Numpad Function 3 key.
/// </summary>
KPF3 = 0xFF93,
/// <summary>
- /// The Numpad function 4 key
+ /// The Numpad Function 4 key.
/// </summary>
KPF4 = 0xFF94,
/// <summary>
- /// The Numpad home key
+ /// The Numpad Home key.
/// </summary>
KPHome = 0xFF95,
/// <summary>
- /// The Numpad left key
+ /// The Numpad Left key.
/// </summary>
KPLeft = 0xFF96,
/// <summary>
- /// The Numpad up key
+ /// The Numpad Up key.
/// </summary>
KPUp = 0xFF97,
/// <summary>
- /// The Numpad right key
+ /// The Numpad Right key.
/// </summary>
KPRight = 0xFF98,
/// <summary>
- /// The Numpad down key
+ /// The Numpad Down key.
/// </summary>
KPDown = 0xFF99,
/// <summary>
- /// The Numpad prior, previous key
+ /// The Numpad Prior, Previous key.
/// </summary>
KPPrior = 0xFF9A,
/// <summary>
- /// The Numpad page up key
+ /// The Numpad Page Up key.
/// </summary>
KPPage_Up = 0xFF9A,
/// <summary>
- /// The Numpad next key
+ /// The Numpad Next key.
/// </summary>
KPNext = 0xFF9B,
/// <summary>
- /// The Numpad page down key
+ /// The Numpad Page Down key.
/// </summary>
KPPage_Down = 0xFF9B,
/// <summary>
- /// The Numpad end key
+ /// The Numpad End key.
/// </summary>
KPEnd = 0xFF9C,
/// <summary>
- /// The Numpad begin key
+ /// The Numpad Begin key.
/// </summary>
KPBegin = 0xFF9D,
/// <summary>
- /// The Numpad insert key
+ /// The Numpad Insert key.
/// </summary>
KPInsert = 0xFF9E,
/// <summary>
- /// The Numpad delete key
+ /// The Numpad Delete key.
/// </summary>
KPDelete = 0xFF9F,
/// <summary>
- /// The Numpad equal key
+ /// The Numpad Equal key.
/// </summary>
KPEqual = 0xFFBD,
/// <summary>
- /// The Numpad multiply key
+ /// The Numpad Multiply key.
/// </summary>
KPMultiply = 0xFFAA,
/// <summary>
- /// The Numpad add key
+ /// The Numpad Add key.
/// </summary>
KPAdd = 0xFFAB,
/// <summary>
- /// The Numpad separator key
+ /// The Numpad Separator key.
/// </summary>
KPSeparator = 0xFFAC,
/// <summary>
- /// The Numpad subtract key
+ /// The Numpad Subtract key.
/// </summary>
KPSubtract = 0xFFAD,
/// <summary>
- /// The Numpad decimal key
+ /// The Numpad Decimal key.
/// </summary>
KPDecimal = 0xFFAE,
/// <summary>
- /// The Numpad divide key
+ /// The Numpad Divide key.
/// </summary>
KPDivide = 0xFFAF,
/// <summary>
- /// The Numpad 0 key
+ /// The Numpad 0 key.
/// </summary>
KP0 = 0xFFB0,
/// <summary>
- /// The Numpad 1 key
+ /// The Numpad 1 key.
/// </summary>
KP1 = 0xFFB1,
/// <summary>
- /// The Numpad 2 key
+ /// The Numpad 2 key.
/// </summary>
KP2 = 0xFFB2,
/// <summary>
- /// The Numpad 3 key
+ /// The Numpad 3 key.
/// </summary>
KP3 = 0xFFB3,
/// <summary>
- /// The Numpad 4 key
+ /// The Numpad 4 key.
/// </summary>
KP4 = 0xFFB4,
/// <summary>
- /// The Numpad 5 key
+ /// The Numpad 5 key.
/// </summary>
KP5 = 0xFFB5,
/// <summary>
- /// The Numpad 6 key
+ /// The Numpad 6 key.
/// </summary>
KP6 = 0xFFB6,
/// <summary>
- /// The Numpad 7 key
+ /// The Numpad 7 key.
/// </summary>
KP7 = 0xFFB7,
/// <summary>
- /// The Numpad 8 key
+ /// The Numpad 8 key.
/// </summary>
KP8 = 0xFFB8,
/// <summary>
- /// The Numpad 9 key
+ /// The Numpad 9 key.
/// </summary>
KP9 = 0xFFB9,
/* Auxiliary Functions */
/// <summary>
- /// The function 1 key
+ /// The Function 1 key.
/// </summary>
F1 = 0xFFBE,
/// <summary>
- /// The function 2 key
+ /// The Function 2 key.
/// </summary>
F2 = 0xFFBF,
/// <summary>
- /// The function 3 key
+ /// The Function 3 key.
/// </summary>
F3 = 0xFFC0,
/// <summary>
- /// The function 4 key
+ /// The Function 4 key.
/// </summary>
F4 = 0xFFC1,
/// <summary>
- /// The function 5 key
+ /// The Function 5 key.
/// </summary>
F5 = 0xFFC2,
/// <summary>
- /// The function 6 key
+ /// The Function 6 key.
/// </summary>
F6 = 0xFFC3,
/// <summary>
- /// The function 7 key
+ /// The Function 7 key.
/// </summary>
F7 = 0xFFC4,
/// <summary>
- /// The function 8 key
+ /// The Function 8 key.
/// </summary>
F8 = 0xFFC5,
/// <summary>
- /// The function 9 key
+ /// The Function 9 key.
/// </summary>
F9 = 0xFFC6,
/// <summary>
- /// The function 10 key
+ /// The Function 10 key.
/// </summary>
F10 = 0xFFC7,
/// <summary>
- /// The function 11 key
+ /// The Function 11 key.
/// </summary>
F11 = 0xFFC8,
/// <summary>
- /// The function 12 key
+ /// The Function 12 key.
/// </summary>
F12 = 0xFFC9,
/// <summary>
- /// The function 13 key
+ /// The Function 13 key.
/// </summary>
F13 = 0xFFCA,
/// <summary>
- /// The function 14 key
+ /// The Function 14 key.
/// </summary>
F14 = 0xFFCB,
/// <summary>
- /// The function 15 key
+ /// The Function 15 key.
/// </summary>
F15 = 0xFFCC,
/// <summary>
- /// The function 16 key
+ /// The Function 16 key.
/// </summary>
F16 = 0xFFCD,
/// <summary>
- /// The function 17 key
+ /// The Function 17 key.
/// </summary>
F17 = 0xFFCE,
/// <summary>
- /// The function 18 key
+ /// The Function 18 key.
/// </summary>
F18 = 0xFFCF,
/// <summary>
- /// The function 19 key
+ /// The Function 19 key.
/// </summary>
F19 = 0xFFD0,
/// <summary>
- /// The function 20 key
+ /// The Function 20 key.
/// </summary>
F20 = 0xFFD1,
/// <summary>
- /// The function 21 key
+ /// The Function 21 key.
/// </summary>
F21 = 0xFFD2,
/// <summary>
- /// The function 22 key
+ /// The Function 22 key.
/// </summary>
F22 = 0xFFD3,
/// <summary>
- /// The function 23 key
+ /// The Function 23 key.
/// </summary>
F23 = 0xFFD4,
/// <summary>
- /// The function 24 key
+ /// The Function 24 key.
/// </summary>
F24 = 0xFFD5,
/// <summary>
- /// The function 25 key
+ /// The Function 25 key.
/// </summary>
F25 = 0xFFD6,
/// <summary>
- /// The function 26 key
+ /// The Function 26 key.
/// </summary>
F26 = 0xFFD7,
/// <summary>
- /// The function 27 key
+ /// The Function 27 key.
/// </summary>
F27 = 0xFFD8,
/// <summary>
- /// The function 28 key
+ /// The Function 28 key.
/// </summary>
F28 = 0xFFD9,
/// <summary>
- /// The function 29 key
+ /// The Function 29 key.
/// </summary>
F29 = 0xFFDA,
/// <summary>
- /// The function 30 key
+ /// The Function 30 key.
/// </summary>
F30 = 0xFFDB,
/// <summary>
- /// The function 31 key
+ /// The Function 31 key.
/// </summary>
F31 = 0xFFDC,
/// <summary>
- /// The function 32 key
+ /// The Function 32 key.
/// </summary>
F32 = 0xFFDD,
/// <summary>
- /// The function 33 key
+ /// The Function 33 key.
/// </summary>
F33 = 0xFFDE,
/// <summary>
- /// The function 34 key
+ /// The Function 34 key.
/// </summary>
F34 = 0xFFDF,
/// <summary>
- /// The function 35 key
+ /// The Function 35 key.
/// </summary>
F35 = 0xFFE0,
/* Modifier keys */
/// <summary>
- /// The left shift key
+ /// The Left Shift key.
/// </summary>
ShiftL = 0xFFE1,
/// <summary>
- /// The right shift key
+ /// The Right Shift key.
/// </summary>
ShiftR = 0xFFE2,
/// <summary>
- /// The left control key
+ /// The Left Control key.
/// </summary>
ControlL = 0xFFE3,
/// <summary>
- /// The right control key
+ /// The Right Control key.
/// </summary>
ControlR = 0xFFE4,
/// <summary>
- /// The caps lock key
+ /// The Caps Lock key.
/// </summary>
CapsLock = 0xFFE5,
/// <summary>
- /// The shift lock key
+ /// The Shift Lock key.
/// </summary>
ShiftLock = 0xFFE6,
/// <summary>
- /// The left meta key
+ /// The Left Meta key.
/// </summary>
MetaL = 0xFFE7,
/// <summary>
- /// The right meta key
+ /// The Right Meta key.
/// </summary>
MetaR = 0xFFE8,
/// <summary>
- /// The left alt key
+ /// The Left Alt key.
/// </summary>
AltL = 0xFFE9,
/// <summary>
- /// The right alt key
+ /// The Right Alt key.
/// </summary>
AltR = 0xFFEA,
/// <summary>
- /// The left super key
+ /// The Left Super key.
/// </summary>
SuperL = 0xFFEB,
/// <summary>
- /// The right super key
+ /// The Right Super key.
/// </summary>
SuperR = 0xFFEC,
/// <summary>
- /// The left hyper key
+ /// The Left Hyper key.
/// </summary>
HyperL = 0xFFED,
/// <summary>
- /// The right hyper key
+ /// The Right Hyper key.
/// </summary>
HyperR = 0xFFEE,
/* Latin 1 */
/// <summary>
- /// The space key
+ /// The Space key.
/// </summary>
Space = 0x020,
/// <summary>
- /// The exclamation key
+ /// The Exclamation key.
/// </summary>
Exclam = 0x021,
/// <summary>
- /// The quotedbl key
+ /// The Quotedbl key.
/// </summary>
Quotedbl = 0x022,
/// <summary>
- /// The number sign key
+ /// The Number Sign key.
/// </summary>
NumberSign = 0x023,
/// <summary>
- /// The dollar key
+ /// The Dollar key.
/// </summary>
Dollar = 0x024,
/// <summary>
- /// The percent key
+ /// The Percent key.
/// </summary>
Percent = 0x025,
/// <summary>
- /// The ampersand key
+ /// The Ampersand key.
/// </summary>
Ampersand = 0x026,
/// <summary>
- /// The apostrophe key
+ /// The Apostrophe key.
/// </summary>
Apostrophe = 0x027,
/// <summary>
- /// The parenleft key
+ /// The Parenleft key.
/// </summary>
Parenleft = 0x028,
/// <summary>
- /// The parenright key
+ /// The Parenright key.
/// </summary>
Parenright = 0x029,
/// <summary>
- /// The asterisk key
+ /// The Asterisk key.
/// </summary>
Asterisk = 0x02a,
/// <summary>
- /// The plus key
+ /// The Plus key.
/// </summary>
Plus = 0x02b,
/// <summary>
- /// The comma key
+ /// The Comma key.
/// </summary>
Comma = 0x02c,
/// <summary>
- /// The minus key
+ /// The Minus key.
/// </summary>
Minus = 0x02d,
/// <summary>
- /// The period key
+ /// The Period key.
/// </summary>
Period = 0x02e,
/// <summary>
- /// The slash key
+ /// The Slash key.
/// </summary>
Slash = 0x02f,
/// <summary>
- /// The 0 key
+ /// The 0 key.
/// </summary>
Keypad0 = 0x030,
/// <summary>
- /// The 1 key
+ /// The 1 key.
/// </summary>
Keypad1 = 0x031,
/// <summary>
- /// The 2 key
+ /// The 2 key.
/// </summary>
Keypad2 = 0x032,
/// <summary>
- /// The 3 key
+ /// The 3 key.
/// </summary>
Keypad3 = 0x033,
/// <summary>
- /// The 4 key
+ /// The 4 key.
/// </summary>
Keypad4 = 0x034,
/// <summary>
- /// The 5 key
+ /// The 5 key.
/// </summary>
Keypad5 = 0x035,
/// <summary>
- /// The 6 key
+ /// The 6 key.
/// </summary>
Keypad6 = 0x036,
/// <summary>
- /// The 7 key
+ /// The 7 key.
/// </summary>
Keypad7 = 0x037,
/// <summary>
- /// The 8 key
+ /// The 8 key.
/// </summary>
Keypad8 = 0x038,
/// <summary>
- /// The 9 key
+ /// The 9 key.
/// </summary>
Keypad9 = 0x039,
/// <summary>
- /// The colon key
+ /// The Colon key.
/// </summary>
Colon = 0x03a,
/// <summary>
- /// The semicolon key
+ /// The Semicolon key.
/// </summary>
Semicolon = 0x03b,
/// <summary>
- /// The less key
+ /// The Less key.
/// </summary>
Less = 0x03c,
/// <summary>
- /// The equal key
+ /// The Equal key.
/// </summary>
Equal = 0x03d,
/// <summary>
- /// The greater key
+ /// The Greater key.
/// </summary>
Greater = 0x03e,
/// <summary>
- /// The question key
+ /// The Question key.
/// </summary>
Question = 0x03f,
/// <summary>
- /// The at key
+ /// The At key.
/// </summary>
At = 0x040,
/// <summary>
- /// The A key
+ /// The A key.
/// </summary>
KeypadA = 0x041,
/// <summary>
- /// The B key
+ /// The B key.
/// </summary>
KeypadB = 0x042,
/// <summary>
- /// The C key
+ /// The C key.
/// </summary>
KeypadC = 0x043,
/// <summary>
- /// The D key
+ /// The D key.
/// </summary>
KeypadD = 0x044,
/// <summary>
- /// The E key
+ /// The E key.
/// </summary>
KeypadE = 0x045,
/// <summary>
- /// The F key
+ /// The F key.
/// </summary>
KeypadF = 0x046,
/// <summary>
- /// The G key
+ /// The G key.
/// </summary>
KeypadG = 0x047,
/// <summary>
- /// The H key
+ /// The H key.
/// </summary>
KeypadH = 0x048,
/// <summary>
- /// The I key
+ /// The I key.
/// </summary>
KeypadI = 0x049,
/// <summary>
- /// The J key
+ /// The J key.
/// </summary>
KeypadJ = 0x04a,
/// <summary>
- /// The K key
+ /// The K key.
/// </summary>
KeypadK = 0x04b,
/// <summary>
- /// The L key
+ /// The L key.
/// </summary>
KeypadL = 0x04c,
/// <summary>
- /// The M key
+ /// The M key.
/// </summary>
KeypadM = 0x04d,
/// <summary>
- /// The N key
+ /// The N key.
/// </summary>
KeypadN = 0x04e,
/// <summary>
- /// The O key
+ /// The O key.
/// </summary>
KeypadO = 0x04f,
/// <summary>
- /// The P key
+ /// The P key.
/// </summary>
KeypadP = 0x050,
/// <summary>
- /// The Q key
+ /// The Q key.
/// </summary>
KeypadQ = 0x051,
/// <summary>
- /// The R key
+ /// The R key.
/// </summary>
KeypadR = 0x052,
/// <summary>
- /// The S key
+ /// The S key.
/// </summary>
KeypadS = 0x053,
/// <summary>
- /// The T key
+ /// The T key.
/// </summary>
KeypadT = 0x054,
/// <summary>
- /// The U key
+ /// The U key.
/// </summary>
KeypadU = 0x055,
/// <summary>
- /// The V key
+ /// The V key.
/// </summary>
KeypadV = 0x056,
/// <summary>
- /// The W key
+ /// The W key.
/// </summary>
KeypadW = 0x057,
/// <summary>
- /// The X key
+ /// The X key.
/// </summary>
KeypadX = 0x058,
/// <summary>
- /// The Y key
+ /// The Y key.
/// </summary>
KeypadY = 0x059,
/// <summary>
- /// The Z key
+ /// The Z key.
/// </summary>
KeypadZ = 0x05a,
/// <summary>
- /// The left bracket key
+ /// The Left Bracket key.
/// </summary>
BracketLeft = 0x05b,
/// <summary>
- /// The backslash key
+ /// The Backslash key.
/// </summary>
Backslash = 0x05c,
/// <summary>
- /// The right bracket key
+ /// The Right Bracket key.
/// </summary>
BracketRight = 0x05d,
/// <summary>
- /// The circumflex key
+ /// The Circumflex key.
/// </summary>
AsciiCircum = 0x05e,
/// <summary>
- /// The underscore key
+ /// The Underscore key.
/// </summary>
Underscore = 0x05f,
/// <summary>
- /// The grave key
+ /// The Grave key.
/// </summary>
Grave = 0x060,
/// <summary>
- /// The a key
+ /// The a key.
/// </summary>
Keypada = 0x061,
/// <summary>
- /// The b key
+ /// The b key.
/// </summary>
Keypadb = 0x062,
/// <summary>
- /// The c key
+ /// The c key.
/// </summary>
Keypadc = 0x063,
/// <summary>
- /// The d key
+ /// The d key.
/// </summary>
Keypadd = 0x064,
/// <summary>
- /// The e key
+ /// The e key.
/// </summary>
Keypade = 0x065,
/// <summary>
- /// The f key
+ /// The f key.
/// </summary>
Keypadf = 0x066,
/// <summary>
- /// The g key
+ /// The g key.
/// </summary>
Keypadg = 0x067,
/// <summary>
- /// The h key
+ /// The h key.
/// </summary>
Keypadh = 0x068,
/// <summary>
- /// The i key
+ /// The i key.
/// </summary>
Keypadi = 0x069,
/// <summary>
- /// The j key
+ /// The j key.
/// </summary>
Keypadj = 0x06a,
/// <summary>
- /// The k key
+ /// The k key.
/// </summary>
Keypadk = 0x06b,
/// <summary>
- /// The l key
+ /// The l key.
/// </summary>
Keypadl = 0x06c,
/// <summary>
- /// The m key
+ /// The m key.
/// </summary>
Keypadm = 0x06d,
/// <summary>
- /// The n key
+ /// The n key.
/// </summary>
Keypadn = 0x06e,
/// <summary>
- /// The o key
+ /// The o key.
/// </summary>
Keypado = 0x06f,
/// <summary>
- /// The p key
+ /// The p key.
/// </summary>
Keypadp = 0x070,
/// <summary>
- /// The q key
+ /// The q key.
/// </summary>
Keypadq = 0x071,
/// <summary>
- /// The r key
+ /// The r key.
/// </summary>
Keypadr = 0x072,
/// <summary>
- /// The s key
+ /// The s key.
/// </summary>
Keypads = 0x073,
/// <summary>
- /// The t key
+ /// The t key.
/// </summary>
Keypadt = 0x074,
/// <summary>
- /// The u key
+ /// The u key.
/// </summary>
Keypadu = 0x075,
/// <summary>
- /// The v key
+ /// The v key.
/// </summary>
Keypadv = 0x076,
/// <summary>
- /// The w key
+ /// The w key.
/// </summary>
Keypadw = 0x077,
/// <summary>
- /// The x key
+ /// The x key.
/// </summary>
Keypadx = 0x078,
/// <summary>
- /// The y key
+ /// The y key.
/// </summary>
Keypady = 0x079,
/// <summary>
- /// The z key
+ /// The z key.
/// </summary>
Keypadz = 0x07a,
/// <summary>
- /// The left brace key
+ /// The Left Brace key.
/// </summary>
BraceLeft = 0x07b,
/// <summary>
- /// The bar key
+ /// The Bar key.
/// </summary>
Bar = 0x07c,
/// <summary>
- /// The right brace key
+ /// The Right Brace key.
/// </summary>
BraceRight = 0x07d,
/// <summary>
- /// The tilde key
+ /// The Tilde key.
/// </summary>
AsciiTilde = 0x07e,
};
/// <summary>
- /// Enumeration of the key masks.
- /// The key masks indicate which modifier keys is pressed down during the keyboard hit.The special MASK_RELEASED indicates the key release event.
+ /// Enumeration for the key masks.
+ /// The key masks indicate which modifier keys are pressed down during the keyboard hit. The special MASK_RELEASED indicates the key release event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum KeyMask
{
/// <summary>
- /// Key press event without modifier key
+ /// Key press event without the modifier key.
/// </summary>
Pressed = 0,
/// <summary>
- /// The Shift key is pressed down
+ /// The Shift key is pressed down.
/// </summary>
Shift = (1 << 0),
/// <summary>
- /// The CapsLock key is pressed down
+ /// The CapsLock key is pressed down.
/// </summary>
CapsLock = (1 << 1),
/// <summary>
- /// The Control key is pressed down
+ /// The Control key is pressed down.
/// </summary>
Control = (1 << 2),
/// <summary>
- /// The Alt key is pressed down
+ /// The Alt key is pressed down.
/// </summary>
Alt = (1 << 3),
/// <summary>
- /// The Meta key is pressed down
+ /// The Meta key is pressed down.
/// </summary>
Meta = (1 << 4),
/// <summary>
- /// The Win (between Control and Alt) is pressed down
+ /// The Win key (between Control and Alt) is pressed down.
/// </summary>
Win = (1 << 5),
/// <summary>
- /// The Hyper key is pressed down
+ /// The Hyper key is pressed down.
/// </summary>
Hyper = (1 << 6),
/// <summary>
- /// The NumLock key is pressed down
+ /// The NumLock key is pressed down.
/// </summary>
NumLock = (1 << 7),
/// <summary>
- /// Key release event
+ /// Key release event.
/// </summary>
Released = (1 << 15),
}
/// <summary>
- /// This class contains api's related to IME(Input method editor)
+ /// This class contains the API's related to the IME (Input method editor).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class InputMethodEditor
};
/// <summary>
- /// Structure representing ContextId
+ /// Structure representing the ContextId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public struct ContextId : IEquatable<ContextId>
}
/// <summary>
- /// compare whether ContextId are equal
+ /// Compares whether the ContextIds are equal.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool Equals(ContextId other)
}
/// <summary>
- /// rectangle representing the position and size of UI Control
+ /// Rectangle representing the position and size of the UI control.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public struct Rect
{
/// <summary>
- /// The x position in screen
+ /// The X position in the screen.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int x;
/// <summary>
- /// The y position in screen
+ /// The Y position in the screen.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int y;
/// <summary>
- /// The window width
+ /// The window width.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int w;
/// <summary>
- /// The window height
+ /// The window height.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int h;
}
/// <summary>
- /// An Action with 1 out parameter
+ /// An action with 1 out parameter.
/// </summary>
- /// <typeparam name="T">Generic Type</typeparam>
- /// <param name="a">The out parameter</param>
+ /// <typeparam name="T">Generic Type.</typeparam>
+ /// <param name="a">The out parameter.</param>
/// <since_tizen> 4 </since_tizen>
public delegate void OutAction<T>(out T a);
/// <summary>
- /// An Action with an array out parameter
+ /// An action with an array out parameter.
/// </summary>
- /// <typeparam name="T">Generic Type</typeparam>
- /// <param name="a">The out parameter 1</param>
+ /// <typeparam name="T">Generic Type.</typeparam>
+ /// <param name="a">The out parameter 1.</param>
/// <since_tizen> 4 </since_tizen>
public delegate void OutArrayAction<T>(out T[] a);
/// <summary>
- /// An Action with 3 Input Parameter returning a bool
+ /// An action with 3 input parameters returning a bool.
/// </summary>
- /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
- /// <typeparam name="T1">Generic Type for Parameter 2</typeparam>
- /// <typeparam name="T2">Generic Type for Parameter 3</typeparam>
- /// <param name="a">The Input Parameter 1</param>
- /// <param name="b">The Input Parameter 2</param>
- /// <param name="c">The Input Parameter 3</param>
+ /// <typeparam name="T">Generic type for parameter 1.</typeparam>
+ /// <typeparam name="T1">Generic type for parameter 2.</typeparam>
+ /// <typeparam name="T2">Generic type for parameter 3.</typeparam>
+ /// <param name="a">The input parameter 1.</param>
+ /// <param name="b">The input parameter 2.</param>
+ /// <param name="c">The input parameter 3.</param>
/// <returns></returns>
/// <since_tizen> 4 </since_tizen>
public delegate bool BoolAction<T, T1, T2>(T a, T1 b, T2 c);
/// <summary>
/// Called to set the preferred language to the input panel.
- /// It will be only called when the client application changes the edit field's language attribute after the input panel is shown.
+ /// It will only be called when the client application changes the edit field's language attribute after the input panel is shown.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<LanguageSetEventArgs> LanguageSet
/// <summary>
/// Called when an associated text input UI control requests the input panel to set its layout.
- /// It will be only called when the client application changes the edit field's layout attribute after the input panel is shown.
+ /// It will only be called when the client application changes the edit field's layout attribute after the input panel is shown.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<LayoutSetEventArgs> LayoutSet
/// <summary>
/// Called when an associated text input UI control requests the input panel to set the Return key label.
- /// The input panel can show text or image on the Return button according to the Return key action.
+ /// The input panel can show the text or an image on the Return button, according to the Return key action.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<ReturnKeySetEventArgs> ReturnKeySet
}
/// <summary>
- /// Called when the system display Language is changed.
+ /// Called when the system display language is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<DisplayLanguageChangedEventArgs> DisplayLanguageChanged
}
/// <summary>
- /// Called when Accessibility in Settings application is on or off.
+ /// Called when Accessibility in settings application is on or off.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<AccessibilityStateChangedEventArgs> AccessibilityStateChanged
}
/// <summary>
- /// Sets the languageRequested Action
+ /// Sets the languageRequested action.
/// </summary>
/// <param name="languageRequested">
/// Called when an associated text input UI control requests the language from the input panel, requesting for language code.
}
/// <summary>
- /// Sets the processKey Action
- /// If the key event is from the external device, DeviceInfo will have its name, class and subclass information.
+ /// Sets the processKey action.
+ /// If the key event is from the external device, DeviceInfo will have its name, class, and subclass information.
/// </summary>
/// <param name="processKey">
- /// The Action is alled when the key event is received from the external devices or SendKey function.
+ /// The action is called when the key event is received from the external devices or the SendKey function.
/// This Event processes the key event before an associated text input UI control does.
/// </param>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// Sets the imDataRequested Action
+ /// Sets the imDataRequested action.
/// </summary>
/// <param name="imDataRequested">
/// Called when an associated text input UI control requests the application specific data from the input panel, requesting for data array and it's length.
}
/// <summary>
- /// Sets the GeometryRequested Action
+ /// Sets the GeometryRequested action.
/// </summary>
/// <param name="geometryRequested">
- /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x,y,w,h values.
+ /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x, y, w, h values.
/// </param>
/// <since_tizen> 4 </since_tizen>
public static void SetGeometryRequestedCallback(OutAction<Rect> geometryRequested)
}
/// <summary>
- /// Runs the main loop of IME application.
- /// This function starts to run IME application's main loop.
+ /// Runs the main loop of the IME application.
+ /// This function starts to run the IME application's main loop.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// <remarks>
/// This API is a blocking call, as it starts the main loop of the application.
/// </remarks>
- /// <param name="create">This is called to initialize IME application before the main loop starts up</param>
- /// <param name="terminate">This is called when IME application is terminated</param>
+ /// <param name="create">This is called to initialize the IME application before the main loop starts up.</param>
+ /// <param name="terminate">This is called when the IME application is terminated.</param>
/// <param name="show">
- /// This is called when IME application is shown
- /// It provides the Context Information and the Context Id
+ /// This is called when the IME application is shown.
+ /// It provides the context information and the context ID.
/// </param>
/// <param name="hide">
- /// This is called when IME application is hidden
- /// It provides the Context Id
+ /// This is called when the IME application is hidden.
+ /// It provides the context ID.
/// </param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) Operation failed
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) Operation failed.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void Run(Action create, Action terminate, Action<ContextId, InputMethodContext> show, Action<ContextId> hide)
/// Sends a key event to the associated text input UI control.
/// </summary>
/// <remarks>
- /// This function sends key down or up event with key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly.
+ /// This function sends a key down or up event with the key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly.
/// And if forwardKey is false, the ProcessKey event receives the key event before the edit field.
/// </remarks>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="keyCode">The key code to be sent</param>
- /// <param name="keyMask">The modifier key mask</param>
- /// <param name="forwardKey">The flag to send the key event directly to the edit field</param>
+ /// <param name="keyCode">The key code to be sent.</param>
+ /// <param name="keyMask">The modifier key mask.</param>
+ /// <param name="forwardKey">The flag to send the key event directly to the edit field.</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void SendKeyEvent(KeyCode keyCode, KeyMask keyMask, bool forwardKey = false)
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="str">The string to be committed</param>
+ /// <param name="str">The string to be committed.</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void CommitString(string str)
}
/// <summary>
- /// Requests to show preedit string.
+ /// Requests to show the pre-edit string.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void ShowPreEditString()
}
/// <summary>
- /// Requests to hide preedit string.
+ /// Requests to hide the pre-edit string.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void HidePreEditString()
}
/// <summary>
- /// Updates a new preedit string.
+ /// Updates a new pre-edit string.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="str">The string to be updated in preedit</param>
+ /// <param name="str">The string to be updated in pre-edit.</param>
/// <param name="attrs">
- /// The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color and reversal color.
- /// The attrs list can be empty if no attributes to set
+ /// The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color, and reversal color.
+ /// The attrs list can be empty if no attributes to set.
/// </param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
- /// 3) Invalid Parameter
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
+ /// 3) Invalid parameter.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void UpdatePreEditString(string str, IEnumerable<PreEditAttribute> attrs)
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="maxLenBefore">The maximum length of string to be retrieved before the cursor, -1 means unlimited</param>
- /// <param name="maxLenAfter">The maximum length of string to be retrieved after the cursor, -1 means unlimited</param>
+ /// <param name="maxLenBefore">The maximum length of the string to be retrieved before the cursor, -1 means unlimited.</param>
+ /// <param name="maxLenAfter">The maximum length of the string to be retrieved after the cursor, -1 means unlimited.</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
/// </exception>
/// <postcondition>
- /// The requested surrounding text can be received using the SurroundingTextUpdated Event, only if it is set.
+ /// The requested surrounding text can be received using the SurroundingTextUpdated event, only if it is set.
/// </postcondition>
/// <since_tizen> 4 </since_tizen>
public static void RequestSurroundingText(int maxLenBefore, int maxLenAfter)
}
/// <summary>
- /// Requests to delete surrounding text.
+ /// Requests to delete the surrounding text.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="offset">The offset value from the cursor position</param>
- /// <param name="len">The length of the text to delete</param>
+ /// <param name="offset">The offset value from the cursor position.</param>
+ /// <param name="len">The length of the text to delete.</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
- /// 3) Invalid Parameter
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
+ /// 3) Invalid parameter.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void DeleteSurroundingText(int offset, int len)
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="maxLenBefore">The maximum length of string to be retrieved before the cursor, -1 means unlimited</param>
- /// <param name="maxLenAfter">The maximum length of string to be retrieved after the cursor, -1 means unlimited</param>
- /// <param name="text">The surrounding text</param>
- /// <param name="cursorPosition">The cursor position</param>
+ /// <param name="maxLenBefore">The maximum length of the string to be retrieved before the cursor, -1 means unlimited.</param>
+ /// <param name="maxLenAfter">The maximum length of the string to be retrieved after the cursor, -1 means unlimited.</param>
+ /// <param name="text">The surrounding text.</param>
+ /// <param name="cursorPosition">The cursor position.</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
- /// 3) Invalid Parameter
- /// 4) Failed to obtain text due to out of memory
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
+ /// 3) Invalid parameter.
+ /// 4) Failed to obtain text due to out of memory.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void GetSurroundingText(int maxLenBefore, int maxLenAfter, out string text, out int cursorPosition)
}
/// <summary>
- /// Requests to set selection.
+ /// Requests to set the selection.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <param name="start">The start cursor position in text (in characters not bytes)</param>
- /// <param name="end">The end cursor position in text (in characters not bytes)</param>
+ /// <param name="start">The start cursor position in text (in characters not bytes).</param>
+ /// <param name="end">The end cursor position in text (in characters not bytes).</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
- /// 3) Invalid Parameter
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
+ /// 3) Invalid parameter.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void SetSelection(int start, int end)
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
- /// <returns>The input panel main window object on success, otherwise null</returns>
+ /// <returns>The input panel main window object on success, otherwise null.</returns>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) IME main loop isn't started yet
- /// 3) Operation Failed
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) The IME main loop isn't started yet.
+ /// 3) Operation failed.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static EditorWindow GetMainWindow()
}
/// <summary>
- /// This API requests the InputMethodEditor to initialize
+ /// This API requests the InputMethodEditor to initialize.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) Operation Failed
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) Operation failed.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void Create()
}
/// <summary>
- /// This API requests the InputMethodEditor to finalize
+ /// This API requests the InputMethodEditor to finalize.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/ime
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
- /// 1) The application does not have the privilege to call this function
- /// 2) Operation Failed
+ /// 1) The application does not have the privilege to call this function.
+ /// 2) Operation failed.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public static void Destroy()
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to LanguageSet Event
+ /// This class contains the data related to the LanguageSet event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class LanguageSetEventArgs
}
/// <summary>
- /// The preferred language that the client application wants
+ /// The preferred language that the client application wants.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public InputPanelLanguage Language
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to LayoutSet Event
+ /// This class contains the data related to the LayoutSet event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class LayoutSetEventArgs
}
/// <summary>
- /// The input panel layout
+ /// The input panel layout.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public InputPanelLayout Layout
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// Enumeration for Attribute Type
+ /// Enumeration for the attribute types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AttributeType
{
/// <summary>
- /// No attribute
+ /// No attribute.
/// </summary>
None,
/// <summary>
- /// A font style attribute, e.g., underline, etc.
+ /// A font style attribute, for example, underline, etc.
/// </summary>
FontStyle
};
/// <summary>
- /// This class represents the attributes for preedit string.
+ /// This class represents the attributes for the pre-edit string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class PreEditAttribute
{
/// <summary>
- /// The start position in the string of this attribute
+ /// The start position in the string of this attribute.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public uint Start
}
/// <summary>
- /// The character length of this attribute, the range is [Start, Start+Length]
+ /// The character length of this attribute, the range is [Start, Start+Length].
/// </summary>
/// <since_tizen> 4 </since_tizen>
public uint Length
}
/// <summary>
- /// The type of this attribute
+ /// The type of this attribute.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public AttributeType Type
}
/// <summary>
- /// The value of this attribute
+ /// The value of this attribute.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public uint Value
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to ReturnKeyStateSet Event
+ /// This class contains the data related to the ReturnKeyStateSet event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ReturnKeyStateSetEventArgs
}
/// <summary>
- /// The bool state to disable Return key. The Return key is enabled by default
+ /// The bool state to disable the Return key. The Return key is enabled by default.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool State
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to ReturnKeySet Event
+ /// This class contains the data related to the ReturnKeySet event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ReturnKeySetEventArgs
}
/// <summary>
- /// The type of Return key on the input panel
+ /// The type of the Return key on the input panel.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public InputPanelReturnKey Type
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to RotationChanged Event
+ /// This class contains the data related to the RotationChanged event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class RotationChangedEventArgs
}
/// <summary>
- /// The rotation degree
+ /// The rotation degree.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int Degree
namespace Tizen.Uix.InputMethod
{
/// <summary>
- /// This Class contains data related to SurroundingTextUpdated Event
+ /// This class contains the data related to the SurroundingTextUpdated event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SurroundingTextUpdatedEventArgs
}
/// <summary>
- /// The input context identification value of an associated text input UI control
+ /// The input context identification value of an associated text input UI control.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int ContextId
}
/// <summary>
- /// The cursor position
+ /// The cursor position.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int CursorPosition
}
/// <summary>
- /// The string requested
+ /// The string requested.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string Text
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Partial Libraries Class
+ /// The Partial Libraries class.
/// </summary>
internal static partial class Libraries
{
using static Tizen.Uix.SttEngine.Engine;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// SttEngine Interop Class
+ /// The SttEngine Interop class.
/// </summary>
internal static class SttEngine
{
namespace Tizen.Uix.SttEngine
{
/// <summary>
- /// Enumeration for audio type.
+ /// Enumeration for the audio types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AudioType
{
/// <summary>
- /// Signed 16bit audio type, Little endian
+ /// Signed 16-bit audio type, little endian.
/// </summary>
PcmS16Le = 0,
/// <summary>
- /// Unsigned 8bit audio type
+ /// Unsigned 8-bit audio type.
/// </summary>
PcmU8
};
/// <summary>
- /// Enumeration for result.
+ /// Enumeration for the results.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ResultEvent
{
/// <summary>
- /// Event when either the full matched or the final result is delivered
+ /// Event when either the full matched or the final result is delivered.
/// </summary>
FinalResult = 0,
/// <summary>
- /// Event when the partial matched result is delivered
+ /// Event when the partial matched result is delivered.
/// </summary>
PartialResult,
/// <summary>
- /// Event when the recognition has failed
+ /// Event when the recognition has failed.
/// </summary>
Error
};
/// <summary>
- /// Enumeration for result time.
+ /// Enumeration for the result time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TimeEvent
{
/// <summary>
- /// Event when the token is beginning type
+ /// Event when the token is beginning type.
/// </summary>
Beginning = 0,
/// <summary>
- /// Event when the token is middle type
+ /// Event when the token is middle type.
/// </summary>
Middle = 1,
/// <summary>
- /// Event when the token is end type
+ /// Event when the token is end type.
/// </summary>
End = 2
};
/// <summary>
- /// Enumeration for speech status.
+ /// Enumeration for the speech status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum SpeechStatus
{
/// <summary>
- /// Beginning point of speech is detected
+ /// Beginning point of the speech is detected.
/// </summary>
BeginningPointDetected = 0,
/// <summary>
- /// End point of speech is detected
+ /// End point of the speech is detected.
/// </summary>
EndPointDetected
};
/// <summary>
- /// Enumeration representing the result message
+ /// Enumeration for representing the result message.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ResultMessage
{
/// <summary>
- /// No Error
+ /// No error.
/// </summary>
None,
/// <summary>
- /// Recognition failed because the speech started too soon.
+ /// Recognition failed because the speech started too soon.
/// </summary>
TooSoon,
/// <summary>
- /// Recognition failed because the speech is too short.
+ /// Recognition failed because the speech is too short.
/// </summary>
TooShort,
/// <summary>
- /// Recognition failed because the speech is too long.
+ /// Recognition failed because the speech is too long.
/// </summary>
TooLong,
/// <summary>
- /// Recognition failed because the speech is too quiet to listen.
+ /// Recognition failed because the speech is too quiet to listen.
/// </summary>
TooQuiet,
/// <summary>
- /// Recognition failed because the speech is too loud to listen.
+ /// Recognition failed because the speech is too loud to listen.
/// </summary>
TooLoud,
/// <summary>
- /// Recognition failed because the speech is too fast to listen.
+ /// Recognition failed because the speech is too fast to listen.
/// </summary>
TooFast
};
/// <summary>
- /// Enum for Error values that can occur
+ /// Enumeration for the error values that can occur.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Error
{
/// <summary>
- /// Successful, No error
+ /// Successful, no error.
/// </summary>
None = ErrorCode.None,
/// <summary>
- /// Out of Memory
+ /// Out of memory.
/// </summary>
OutOfMemory = ErrorCode.OutOfMemory,
/// <summary>
- /// I/O error
+ /// I/O error.
/// </summary>
IoError = ErrorCode.IoError,
/// <summary>
- /// Invalid parameter
+ /// Invalid parameter.
/// </summary>
InvalidParameter = ErrorCode.InvalidParameter,
/// <summary>
- /// Network down(Out of network)
+ /// Network down (Out of network).
/// </summary>
NetworkDown = ErrorCode.NetworkDown,
/// <summary>
- /// Invalid state
+ /// Invalid state.
/// </summary>
InvalidState = ErrorCode.InvalidState,
/// <summary>
- /// Invalid language
+ /// Invalid language.
/// </summary>
InvalidLanguage = ErrorCode.InvalidLanguage,
/// <summary>
- /// Operation failed
+ /// Operation failed.
/// </summary>
OperationFailed = ErrorCode.OperationFailed,
/// <summary>
- /// Not supported feature of current engine
+ /// Not supported feature of the current engine.
/// </summary>
NotSupportedFeature = ErrorCode.NotSupportedFeature,
/// <summary>
- /// NOT supported
+ /// Not supported.
/// </summary>
NotSupported = ErrorCode.NotSupported,
/// <summary>
- /// Permission denied
+ /// Permission denied.
/// </summary>
PermissionDenied = ErrorCode.PermissionDenied,
/// <summary>
- /// Recording timed out
+ /// Recording timed out.
/// </summary>
RecordingTimedOut = ErrorCode.RecordingTimedOut
};
/// <summary>
- /// This Class represents the Stt Engine which has to be inherited to make the engine.
+ /// This class represents the STT Engine, which has to be inherited to make the engine.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public abstract class Engine
private IntPtr _structIntPtrHandle;
/// <summary>
- /// An Action with 2 Input Parameter returning a Error
+ /// An action with 2 input parameters returning an error.
/// </summary>
- /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
- /// <param name="a">The Input Parameter 1</param>
- /// <param name="b">The Input Parameter 2</param>
- /// <returns>Error Value</returns>
+ /// <typeparam name="T">Generic type for parameter 1.</typeparam>
+ /// <param name="a">The input parameter 1.</param>
+ /// <param name="b">The input parameter 2.</param>
+ /// <returns>Error value.</returns>
/// <since_tizen> 4 </since_tizen>
public delegate Error Action<T>(T a, T b);
/// <summary>
- /// An Action with 2 Out Parameter returning a Error
+ /// An action with 2 out parameters returning an error.
/// </summary>
- /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
- /// <param name="a">The Input Parameter 1</param>
- /// <param name="b">The Input Parameter 2</param>
- /// <returns>Error Value</returns>
+ /// <typeparam name="T">Generic type for parameter 1.</typeparam>
+ /// <param name="a">The input parameter 1.</param>
+ /// <param name="b">The input parameter 2.</param>
+ /// <returns>Error value.</returns>
/// <since_tizen> 4 </since_tizen>
public delegate Error OutAction<T>(T a, out T b);
/// <summary>
- /// Called when Stt engine provides the time stamp of result to the engine service user.
+ /// Called when the STT engine provides the time stamp of result to the engine service user.
/// This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
/// </summary>
- /// <param name="index">The result index</param>
- /// <param name="resultEvent">The token event</param>
- /// <param name="text">The result text</param>
- /// <param name="startTime">The time started speaking the result text</param>
- /// <param name="endTime">The time finished speaking the result text</param>
- /// <param name="userData">The User data</param>
- /// <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>
+ /// <param name="index">The result index.</param>
+ /// <param name="resultEvent">The token event.</param>
+ /// <param name="text">The result text.</param>
+ /// <param name="startTime">The time started speaking the result text.</param>
+ /// <param name="endTime">The time finished speaking the result text.</param>
+ /// <param name="userData">The user data.</param>
+ /// <returns>true to continue with the next iteration of the loop, false to break out of the loop.</returns>
/// <precondition>SendResult() should be called.</precondition>
/// <since_tizen> 4 </since_tizen>
public delegate bool ResultTime(int index, TimeEvent resultEvent, string text, long startTime, long endTime, IntPtr userData);
/// <summary>
- /// Called when Stt engine informs the engine service user about whole supported language list.
+ /// Called when the STT engine informs the engine service user about the whole supported language list.
/// This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
/// </summary>
/// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code
- /// followed by ISO 639-1 for the two-letter language code
- /// for example, "ko_KR" for Korean, "en_US" for American English</param>
- /// <param name="userData">The User data</param>
- /// <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>
- /// <precondition>ForEachSupportedLanguages() should be called</precondition>
+ /// followed by an ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
+ /// <param name="userData">The user data.</param>
+ /// <returns>true to continue with the next iteration of the loop, false to break out of the loop.</returns>
+ /// <precondition>ForEachSupportedLanguages() should be called.</precondition>
/// <since_tizen> 4 </since_tizen>
public delegate bool SupportedLanguages(string language, IntPtr userData);
/// <summary>
- /// Called when the engine service user requests the basic information of Stt engine.
+ /// Called when the engine service user requests the basic information of the STT engine.
/// </summary>
/// <remarks>
- /// In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. Therefore, engineSetting must be transferred to the engine service user.
+ /// In order to upload the engine at Tizen Appstore, both a service application and a UI application are necessary. Therefore, engineSetting must be transferred to the engine service user.
/// </remarks>
- /// <param name="engineUuid">UUID of engine</param>
- /// <param name="engineName">Name of engine</param>
- /// <param name="engineSetting">The engine setting application(ui app)'s app ID</param>
- /// <param name="useNetwork">A variable for checking whether the network is used or not</param>
+ /// <param name="engineUuid">UUID of the engine.</param>
+ /// <param name="engineName">Name of the engine.</param>
+ /// <param name="engineSetting">The engine setting application (UI app)'s ID.</param>
+ /// <param name="useNetwork">A variable for checking whether the network is used or not.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. OperationFailed
/// 3. InvalidParameter
public abstract Error GetInformation(out string engineUuid, out string engineName, out string engineSetting, out bool useNetwork);
/// <summary>
- /// Called when the engine service user initializes Stt engine.
- /// This callback function is called by the engine service user to request for Stt engine to be started.
+ /// Called when the engine service user initializes the STT engine.
+ /// This callback function is called by the engine service user to request for the STT engine to be started.
/// </summary>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidParameter
/// 3. InvalidState
public abstract Error Initialize();
/// <summary>
- /// Called when the engine service user deinitializes Stt engine.
- /// This callback function is called by the engine service user to request for Stt engine to be deinitialized.
+ /// Called when the engine service user deinitializes the STT engine.
+ /// This callback function is called by the engine service user to request for the STT engine to be deinitialized.
/// </summary>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// </returns>
/// Called when the engine service user gets the whole supported language list.
/// </summary>
/// <remarks>
- /// In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages
+ /// In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all the supported languages
/// and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'.
/// </remarks>
- /// <param name="callback">The callback function</param>
- /// <param name="userData">The user data which must be passed to the callback delegate 'SupportedLanguages'</param>
+ /// <param name="callback">The callback function,</param>
+ /// <param name="userData">The user data, which must be passed to the callback delegate 'SupportedLanguages'.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// </returns>
/// <postcondition>
- /// This callback function invokes SupportedLanguages repeatedly for getting supported languages.
+ /// This callback function invokes SupportedLanguages repeatedly for getting the supported languages.
/// </postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error ForEachSupportedLanguages(SupportedLanguages callback, IntPtr userData);
/// <summary>
- /// Called when the engine service user checks whether the corresponding language is valid or not in Stt engine.
+ /// Called when the engine service user checks whether the corresponding language is valid or not in the STT engine.
/// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code
- /// For example, "ko_KR" for Korean, "en_US" for American English</param>
- /// <param name="isValid">A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code followed by an ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
+ /// <param name="isValid">A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidParameter
/// </returns>
public abstract Error IsValidLanguage(string language, out bool isValid);
/// <summary>
- /// Called when the engine service user checks whether Stt engine supports silence detection.
+ /// Called when the engine service user checks whether the STT engine supports silence detection.
/// </summary>
- /// <returns>true to support silence detection, false not to support silence detection</returns>
+ /// <returns>true to support silence detection, false not to support silence detection.</returns>
/// <since_tizen> 4 </since_tizen>
public abstract bool SupportSilenceDetection();
/// <summary>
- /// Called when the engine service user checks whether Stt engine supports the corresponding recognition type.
+ /// Called when the engine service user checks whether the STT engine supports the corresponding recognition type.
/// </summary>
- /// <param name="type">The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
- /// <param name="isSupported">A variable for checking whether Stt engine supports the corresponding recognition type.
- /// true to support recognition type, false not to support recognition type</param>
+ /// <param name="type">The type for recognition, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL".</param>
+ /// <param name="isSupported">A variable for checking whether the STT engine supports the corresponding recognition type.
+ /// true to support the recognition type, false not to support the recognition type.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidParameter
/// </returns>
public abstract Error SupportRecognitionType(string type, out bool isSupported);
/// <summary>
- /// Called when the engine service user gets the proper recording format of Stt engine.
+ /// Called when the engine service user gets the proper recording format of the STT engine.
/// The recording format is used for creating the recorder.
/// </summary>
- /// <param name="types">The format used by the recorder</param>
- /// <param name="rate">The sample rate used by the recorder</param>
- /// <param name="channels">The number of channels used by the recorder</param>
+ /// <param name="types">The format used by the recorder.</param>
+ /// <param name="rate">The sample rate used by the recorder.</param>
+ /// <param name="channels">The number of channels used by the recorder.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// </returns>
/// <summary>
/// Called when the engine service user sets the silence detection.
- /// If the engine service user sets this option as 'TRUE', Stt engine will detect the silence (EPD) and send the callback event about it.
+ /// If the engine service user sets this option as 'TRUE', the STT engine will detect the silence (EPD) and send the callback event about it.
/// </summary>
- /// <param name="isSet">A variable for setting the silence detection. true to detect the silence, false not to detect the silence</param>
+ /// <param name="isSet">A variable for setting the silence detection. true to detect the silence, false not to detect the silence.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. NotSupportedFeature
public abstract Error SetSilenceDetection(bool isSet);
/// <summary>
- /// Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine.
- /// This callback function is called when the engine service user requests for Stt engine to check the application's agreement about using the engine.
+ /// Called when the engine service user requests for the STT engine to check whether the application agreed the usage of the STT engine.
+ /// This callback function is called when the engine service user requests for the STT engine to check the application's agreement about using the engine.
/// According to the need, the engine developer can provide some user interfaces to check the agreement.
/// </summary>
/// <param name="appid">The Application ID</param>
- /// <param name="isAgreed">A variable for checking whether the application agreed to use Stt engine or not. true to agree, false to disagree</param>
+ /// <param name="isAgreed">A variable for checking whether the application agreed to use the STT engine or not. true to agree, false to disagree.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. NotSupportedFeature
public abstract Error CheckAppAgreed(string appid, out bool isAgreed);
/// <summary>
- /// Called when the engine service user checks whether Stt engine needs the application's credential.
+ /// Called when the engine service user checks whether STT engine needs the application's credential.
/// </summary>
- /// <returns>true if Stt engine needs the application's credential, otherwise false </returns>
+ /// <returns>true if the STT engine needs the application's credential, otherwise false.</returns>
/// <since_tizen> 4 </since_tizen>
public abstract bool NeedAppCredential();
/// <remarks>
/// In this function, the engine service user's callback delegate 'ResultTime' is invoked repeatedly for sending the time information to the engine service user
/// and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'.
- /// timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer.
+ /// timeInfo is transferred from SendResult. The type of timeInfo is up to the STT engine developer.
/// </remarks>
- /// <param name="timeInfo">The time information</param>
- /// <param name="callback">The callback function</param>
- /// <param name="userData">The user data which must be passed to the callback function ResultTime</param>
+ /// <param name="timeInfo">The time information.</param>
+ /// <param name="callback">The callback function.</param>
+ /// <param name="userData">The user data, which must be passed to the callback function ResultTime.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// </returns>
/// <precondition>
- /// SendResult will invoke this function
+ /// SendResult will invoke this function.
/// </precondition>
/// <postcondition>
- /// This function invokes ResultTime repeatedly for getting result time information.
+ /// This function invokes the ResultTime repeatedly for getting the result time information.
/// </postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error ForEachResultTime(IntPtr timeInfo, ResultTime callback, IntPtr userData);
/// <summary>
/// Called when the engine service user starts to recognize the recording data.
- /// In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult().
- /// Also, if Stt engine needs the application's credential, it sets the credential granted to the application.
- /// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code
- /// For example, "ko_KR" for Korean, "en_US" for American English</param>
- /// <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
- /// <param name="appid">The Application ID</param>
- /// <param name="credential">The credential granted to the application</param>
- /// <param name="userData">The user data to be passed to the callback function</param>
+ /// In this callback function, the STT engine must transfer the recognition result and userData to the engine service user using SendResult().
+ /// Also, if the STT engine needs the application's credential, it sets the credential granted to the application.
+ /// </summary>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code followed by an ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
+ /// <param name="type">The recognition type, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL".</param>
+ /// <param name="appid">The application ID.</param>
+ /// <param name="credential">The credential granted to the application.</param>
+ /// <param name="userData">The user data to be passed to the callback function.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// <summary>
/// Called when the engine service user sets and sends the recording data for speech recognition.
- /// This callback function is called by the engine service user to send the recording data to Stt engine.The engine receives the recording data and uses for speech recognition.
- /// this function should be returned immediately after recording data copy.
+ /// This callback function is called by the engine service user to send the recording data to the STT engine. The engine receives the recording data and uses for speech recognition.
+ /// This function should be returned immediately after recording data copy.
/// </summary>
- /// <param name="data">The recording data</param>
- /// <param name="length">The length of recording data</param>
+ /// <param name="data">The recording data.</param>
+ /// <param name="length">The length of the recording data.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// 4. OperationFailed
/// </returns>
/// <precondition>
- /// Start should succeed</precondition>
+ /// Start should succeed.</precondition>
/// <postcondition>
/// If the engine supports partial result, SendResult() should be invoked.</postcondition>
/// <since_tizen> 4 </since_tizen>
/// Called when the engine service user stops to recognize the recording data.
/// This callback function is called by the engine service user to stop recording and to get the recognition result.
/// </summary>
- /// <returns>Following Error Codes can be returned
+ /// <returns>The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. OperationFailed
/// 4. NetworkDown
/// </returns>
/// <precondition>
- /// Start should succeed</precondition>
+ /// Start should succeed.</precondition>
/// <postcondition>
- /// After processing of the engine, , SendResult() should be invoked.</postcondition>
+ /// After processing of the engine, SendResult() should be invoked.</postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error Stop();
/// <summary>
/// Called when the engine service user cancels to recognize the recording data.
- /// This callback function is called by the engine service user to cancel to recognize the recording data.Also, when starting the recorder is failed, this function is called.
+ /// This callback function is called by the engine service user to cancel to recognize the recording data. Also, when starting the recorder is failed, this function is called.
/// </summary>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// </returns>
- /// <precondition>Stt engine is in recognition processing or recording.</precondition>
+ /// <precondition>The STT engine is in recognition processing or recording.</precondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error Cancel();
/// <summary>
- /// Public Constructor
+ /// Public constructor.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.recognition
}
/// <summary>
- /// Main function for Speech-To-Text (STT) engine.
- /// This function is the main function for operating Stt engine.
+ /// Main function for the Speech-To-Text (STT) engine.
+ /// This function is the main function for operating the STT engine.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// <remarks>
/// ServiceAppMain should be used for working the engine after this function.
/// </remarks>
- /// <param name="argc">The Number of Arguments</param>
- /// <param name="argv">The Arguments Array</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <param name="argc">The number of arguments.</param>
+ /// <param name="argv">The arguments array.</param>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
/// <since_tizen> 4 </since_tizen>
public void EngineMain(int argc, string[] argv)
{
/// http://tizen.org/feature/microphone
/// </feature>
/// <remarks>
- /// This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user.
- /// This function is called in the following situations; 1) after Stop() is called, 2) the end point of speech is detected from recording, or 3) partial result is occurred.
- /// The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime().
- /// The type of timeInfo is up to the Stt engine developer.
+ /// This API is used in SetRecordingData() and Stop(), when the STT engine sends the recognition result to the engine service user.
+ /// This function is called in the following situations: 1) After Stop() is called, 2) The end point of speech is detected from recording, or 3) Partial result is occurred.
+ /// The recognition result must be transferred to the engine service user through this function. Also, the timeInfo must be transferred to ForEachResultTime().
+ /// The type of timeInfo is up to the STT engine developer.
/// </remarks>
- /// <param name="resultEvent">The result event</param>
- /// <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
- /// <param name="result">Result texts</param>
- /// <param name="resultCount">Result text count</param>
- /// <param name="msg">Engine message</param>
- /// <param name="timeInfo">The time information</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <param name="resultEvent">The result event.</param>
+ /// <param name="type">The recognition type, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL".</param>
+ /// <param name="result">Result texts.</param>
+ /// <param name="resultCount">Result text count.</param>
+ /// <param name="msg">Engine message.</param>
+ /// <param name="timeInfo">The time information.</param>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
/// <precondition>
- /// EngineMain function should be invoked before this function is called. Stop will invoke this function.
+ /// The EngineMain function should be invoked before this function is called. Stop will invoke this function.
/// </precondition>
/// <postcondition>
/// This function invokes ForEachResultTime
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </feature>
- /// <param name="error">The Error Reason</param>
- /// <param name="msg">The error message</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of Operation failure</exception>
+ /// <param name="error">The error reason.</param>
+ /// <param name="msg">The error message.</param>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
/// <precondition>
- /// Main function should be invoked before this function is called.
+ /// The main function should be invoked before this function is called.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public void SendError(Error error, string msg)
}
/// <summary>
- /// Sends the speech status to the engine service user when Stt engine notifies the change of the speech status.
+ /// Sends the speech status to the engine service user when the STT engine notifies the change of the speech status.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </feature>
/// <remarks>
- /// This API is invoked when Stt engine wants to notify the change of the speech status anytime. NOTE that this API can be invoked for recognizing the speech.
+ /// This API is invoked when the STT engine wants to notify the change of the speech status anytime. Note that this API can be invoked for recognizing the speech.
/// </remarks>
/// <param name="status">SpeechStatus</param>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
/// <precondition>
- /// Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function.
+ /// The main function should be invoked before this function is called. The Start() and SetRecordingData() will invoke this function.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public void SendSpeechStatus(SpeechStatus status)
/// http://tizen.org/feature/microphone
/// </feature>
/// <param name="callback">
- /// Called when Stt engine receives the private data from the engine service user.
- /// This callback function is called when the engine service user sends the private data to Stt engine.
+ /// Called when the STT engine receives the private data from the engine service user.
+ /// This callback function is called when the engine service user sends the private data to the STT engine.
/// In Parameters:
/// a = Key -- The key field of private data
/// b = data -- The data field of private data
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidParameter
/// 3. OperationFailed
/// </param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
/// <precondition>
- /// Main function should be invoked before this function is called.
+ /// The main function should be invoked before this function is called.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public void SetPrivateDataSetDelegate(Action<string> callback)
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </feature>
- /// <param name="callback">callback function
- /// Called when Stt engine provides the engine service user with the private data.
- /// This callback function is called when the engine service user gets the private data from Stt engine.
- /// Out Parameters:
+ /// <param name="callback">The callback function.
+ /// Called when the STT engine provides the engine service user with the private data.
+ /// This callback function is called when the engine service user gets the private data from the STT engine.
+ /// Out parameters:
/// a = Key -- The key field of private data
/// b = data -- The data field of private data
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidParameter
/// 3. OperationFailed
/// </param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of an operation failure.</exception>
/// <precondition>
- /// Main function should be invoked before this function is called.
+ /// The main function should be invoked before this function is called.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public void SetPrivateDataRequestedDelegate(OutAction<string> callback)
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Partial Libraries Class
+ /// The Partial Libraries class.
/// </summary>
internal static partial class Libraries
{
using static Tizen.Uix.TtsEngine.Engine;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// TtsEngine Interop Class
+ /// The TtsEngine Interop class.
/// </summary>
internal static class TtsEngine
{
namespace Tizen.Uix.TtsEngine
{
/// <summary>
- /// Enumeration for audio type.
+ /// Enumeration for the audio types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AudioType
{
/// <summary>
- /// Signed 16-bit audio type
+ /// Signed 16-bit audio type.
/// </summary>
RawS16 = 0,
/// <summary>
- /// Unsigned 8-bit audio type
+ /// Unsigned 8-bit audio type.
/// </summary>
RawU8,
/// <summary>
- /// Maximum Value
+ /// Maximum value.
/// </summary>
Max
};
/// <summary>
- /// Enumeration for result.
+ /// Enumeration for the results.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ResultEvent
{
/// <summary>
- /// Event when the voice synthesis is failed
+ /// Event when the voice synthesis fails.
/// </summary>
Fail = -1,
/// <summary>
- /// Event when the sound data is first data by callback function
+ /// Event when the sound data is the first data by the callback function.
/// </summary>
Start = 1,
/// <summary>
- /// Event when the next sound data exist, not first and not last
+ /// Event when the next sound data exists, not the first and the last.
/// </summary>
Continue = 2,
/// <summary>
- /// Event when the sound data is last data or sound data is only one result
+ /// Event when the sound data is the last data or the sound data is the only result.
/// </summary>
Finish = 3
};
/// <summary>
- /// Enumeration for Voice Type
+ /// Enumeration for the voice types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum VoiceType
{
/// <summary>
- /// male voice type.
+ /// Male voice type.
/// </summary>
Male = 1,
/// <summary>
- /// female voice type.
+ /// Female voice type.
/// </summary>
Female = 2,
/// <summary>
- /// child's voice type.
+ /// Child's voice type.
/// </summary>
Child = 3
}
/// <summary>
- /// Enum for Error values that can occur
+ /// Enumeration for the error values that can occur.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Error
{
/// <summary>
- /// Successful, No error
+ /// Successful, no error.
/// </summary>
None = ErrorCode.None,
/// <summary>
- /// Out of Memory
+ /// Out of memory.
/// </summary>
OutOfMemory = ErrorCode.OutOfMemory,
/// <summary>
- /// I/O error
+ /// I/O error.
/// </summary>
IoError = ErrorCode.IoError,
/// <summary>
- /// Invalid parameter
+ /// Invalid parameter.
/// </summary>
InvalidParameter = ErrorCode.InvalidParameter,
/// <summary>
- /// Network down(Out of network)
+ /// Network down (Out of network).
/// </summary>
NetworkDown = ErrorCode.NetworkDown,
/// <summary>
- /// Invalid state
+ /// Invalid state.
/// </summary>
InvalidState = ErrorCode.InvalidState,
/// <summary>
- /// Invalid voice
+ /// Invalid voice.
/// </summary>
InvalidVoice = ErrorCode.InvalidVoice,
/// <summary>
- /// Operation failed
+ /// Operation failed.
/// </summary>
OperationFailed = ErrorCode.OperationFailed,
/// <summary>
- /// Not supported feature of current engine
+ /// Not supported feature of the current engine.
/// </summary>
NotSupportedFeature = ErrorCode.NotSupportedFeature,
/// <summary>
- /// NOT supported
+ /// Not supported.
/// </summary>
NotSupported = ErrorCode.NotSupported,
/// <summary>
- /// Permission denied
+ /// Permission denied.
/// </summary>
PermissionDenied = ErrorCode.PermissionDenied
};
/// <summary>
- /// This Class represents the Tts Engine which has to be inherited to make the engine.
+ /// This class represents the TTS engine, which has to be inherited to make the engine.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public abstract class Engine
private IntPtr _structIntPtrHandle;
/// <summary>
- /// An Action with 2 Input Parameter returning a Error
+ /// An action with 2 input parameters returning an error.
/// </summary>
- /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
- /// <param name="a">The Input Parameter 1</param>
- /// <param name="b">The Input Parameter 2</param>
- /// <returns>Error Value</returns>
+ /// <typeparam name="T">Generic type for parameter 1.</typeparam>
+ /// <param name="a">The input parameter 1.</param>
+ /// <param name="b">The input parameter 2.</param>
+ /// <returns>Error value.</returns>
/// <since_tizen> 4 </since_tizen>
public delegate Error Action<T>(T a, T b);
/// <summary>
- /// An Action with 2 Out Parameter returning a Error
+ /// An action with 2 out parameters returning an error.
/// </summary>
- /// <typeparam name="T">Generic Type for Parameter 1</typeparam>
- /// <param name="a">The Input Parameter 1</param>
- /// <param name="b">The Input Parameter 2</param>
- /// <returns>Error Value</returns>
+ /// <typeparam name="T">Generic type for parameter 1.</typeparam>
+ /// <param name="a">The input parameter 1.</param>
+ /// <param name="b">The input parameter 2.</param>
+ /// <returns>Error value.</returns>
/// <since_tizen> 4 </since_tizen>
public delegate Error OutAction<T>(T a, out T b);
/// <summary>
- /// Called when TTS engine informs the engine service user about whole supported language and voice type list.
- /// This callback function is implemented by the engine service user.Therefore, the engine developer does NOT have to implement this callback function.
+ /// Called when the TTS engine informs the engine service user about whole supported language and voice type list.
+ /// This callback function is implemented by the engine service user, therefore, the engine developer does NOT have to implement this callback function.
/// </summary>
/// <remarks>
/// This callback function is called by ForEachSupportedVoices() to inform the whole supported voice list. userData must be transferred from ForEachSupportedVoices().
/// </remarks>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English</param>
- /// <param name="type">The voice type</param>
- /// <param name="userData">The user data passed from ForEachSupportedVoices()</param>
- /// <returns>true to continue with the next iteration of the loop false to break out of the loop</returns>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
+ /// <param name="type">The voice type.</param>
+ /// <param name="userData">The user data passed from ForEachSupportedVoices().</param>
+ /// <returns>true to continue with the next iteration of the loop, false to break out of the loop.</returns>
/// <precondition>ForEachSupportedVoices() will invoke this callback function.</precondition>
/// <since_tizen> 4 </since_tizen>
public delegate bool SupportedVoice(string language, VoiceType type, IntPtr userData);
/// Called when the engine service user starts to synthesize a voice, asynchronously.
/// </summary>
/// <remarks>
- /// In this callback function, TTS engine must transfer the synthesized result to the engine service user using SendResult().
- /// Also, if TTS engine needs the application's credential, it can set the credential granted to the application.
+ /// In this callback function, the TTS engine must transfer the synthesized result to the engine service user using SendResult().
+ /// Also, if the TTS engine needs the application's credential, it can set the credential granted to the application.
/// </remarks>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English</param>
- /// <param name="type">The voice type</param>
- /// <param name="text">Texts</param>
- /// <param name="speed">The speed of speaking</param>
- /// <param name="appid">The Application ID</param>
- /// <param name="credential">The credential granted to the application</param>
- /// <param name="userData">The user data which must be passed to SendResult() function</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
+ /// <param name="type">The voice type.</param>
+ /// <param name="text">Texts.</param>
+ /// <param name="speed">The speed of speaking.</param>
+ /// <param name="appid">The application ID.</param>
+ /// <param name="credential">The credential granted to the application.</param>
+ /// <param name="userData">The user data which must be passed to the SendResult() function.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. InvalidParameter
/// 6. NetworkDown
/// 7. PermissionDenied
/// </returns>
- /// <postcondition>This function invokes SendResult()</postcondition>
+ /// <postcondition>This function invokes SendResult().</postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error StartSynthesis(string language, int type, string text, int speed, string appid, string credential, IntPtr userData);
/// <summary>
- /// Called when the engine service user requests the basic information of TTS engine.
+ /// Called when the engine service user requests the basic information of the TTS engine.
/// </summary>
/// <remarks>
/// The allocated engineUuid, engineName, and engineSetting will be released internally.
- /// In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary.
+ /// In order to upload the engine at Tizen Appstore, both a service application and a UI application are necessary.
/// Therefore, engineSetting must be transferred to the engine service user.
/// </remarks>
- /// <param name="engineUuid">UUID of engine</param>
- /// <param name="engineName">Name of engine</param>
- /// <param name="engineSetting">The engine setting application(ui app)'s app ID</param>
- /// <param name="useNetwork">The status for using network</param>
+ /// <param name="engineUuid">UUID of the engine.</param>
+ /// <param name="engineName">Name of the engine.</param>
+ /// <param name="engineSetting">The engine setting application (UI application)'s ID.</param>
+ /// <param name="useNetwork">The status for using the network.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// </returns>
public abstract Error GetInformation(out string engineUuid, out string engineName, out string engineSetting, out bool useNetwork);
/// <summary>
- /// Called when the engine service user initializes TTS engine.
+ /// Called when the engine service user initializes the TTS engine.
/// </summary>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. NotSupportedFeature
public abstract Error Initialize();
/// <summary>
- /// Called when the engine service user deinitializes TTS engine.
+ /// Called when the engine service user deinitializes the TTS engine.
/// </summary>
/// <remarks>
- /// NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of resources is necessary.
+ /// NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of the resources is necessary.
/// </remarks>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// </returns>
/// Called when the engine service user gets the whole supported voice list.
/// </summary>
/// <remarks>
- /// In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all supported voices,
+ /// In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all the supported voices,
/// and userData must be transferred to 'SupportedVoice()'. If 'SupportedVoice()' returns false, it should be stopped to call 'SupportedVoice()'.</remarks>
- /// <param name="callback">The callback function</param>
- /// <param name="userData">The user data which must be passed to SupportedVoice()</param>
+ /// <param name="callback">The callback function.</param>
+ /// <param name="userData">The user data which must be passed to SupportedVoice().</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. OperationFailed
/// </returns>
- /// <postcondition>This callback function invokes SupportedVoice() repeatedly for getting all supported voices.</postcondition>
+ /// <postcondition>This callback function invokes SupportedVoice() repeatedly for getting all the supported voices.</postcondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error ForEachSupportedVoices(SupportedVoice callback, IntPtr userData);
/// <summary>
- /// Called when the engine service user checks whether the voice is valid or not in TTS engine.
+ /// Called when the engine service user checks whether the voice is valid or not in the TTS engine.
/// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English</param>
- /// <param name="type">The voice type</param>
- /// <param name="isValid">A variable for checking whether the corresponding voice is valid or not. true to be valid, false to be invalid</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
+ /// <param name="type">The voice type.</param>
+ /// <param name="isValid">A variable for checking whether the corresponding voice is valid or not. true to be valid, false to be invalid.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidParameter
/// </returns>
public abstract Error IsValidVoice(string language, int type, out bool isValid);
/// <summary>
- /// Called when the engine service user sets the default pitch of TTS engine.
+ /// Called when the engine service user sets the default pitch of the TTS engine.
/// </summary>
- /// <param name="pitch">The default pitch</param>
+ /// <param name="pitch">The default pitch.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. OperationFailed
/// <summary>
/// Called when the engine service user requests to load the corresponding voice type for the first time.
/// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English</param>
- /// <param name="type">The voice type</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
+ /// <param name="type">The voice type.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. OperationFailed
/// <summary>
/// Called when the engine service user requests to unload the corresponding voice type or to stop using voice.
/// </summary>
- /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code.
- /// For example, "ko_KR" for Korean, "en_US" for American English</param>
- /// <param name="type">The voice type</param>
+ /// <param name="language">The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code.
+ /// For example, "ko_KR" for Korean, "en_US" for American English.</param>
+ /// <param name="type">The voice type.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. OperationFailed
public abstract Error UnloadVoice(string language, int type);
/// <summary>
- /// Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine.
- /// This callback function is called when the engine service user requests for TTS engine to check the application's agreement about using the engine.
+ /// Called when the engine service user requests for the TTS engine to check whether the application agreed the usage of the TTS engine.
+ /// This callback function is called when the engine service user requests for the TTS engine to check the application's agreement about using the the engine.
/// According to the need, the engine developer can provide some user interfaces to check the agreement.
/// </summary>
/// <remarks>
- /// If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as isAgreed in accordance with the intention.
+ /// If the TTS engine developer does not want to check the agreement, the developer needs to return proper values as isAgreed in accordance with the intention.
/// true if the developer regards that every application agreed the usage of the engine, false if the developer regards that every application disagreed.
/// NOTE that, however, there may be any legal issue unless the developer checks the agreement.
/// Therefore, we suggest that the engine developers should provide a function to check the agreement.
/// </remarks>
- /// <param name="appid">The Application ID</param>
- /// <param name="isAgreed">A variable for checking whether the application agreed to use TTS engine or not. true to agree, false to disagree</param>
+ /// <param name="appid">The application ID.</param>
+ /// <param name="isAgreed">A variable for checking whether the application agreed to use the TTS engine or not. true to agree, false to disagree.</param>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// 3. NotSupportedFeature
public abstract Error CheckAppAgreed(string appid, out bool isAgreed);
/// <summary>
- /// Called when the engine service user checks whether TTS engine needs the application's credential.
+ /// Called when the engine service user checks whether the TTS engine needs the application's credentials.
/// </summary>
- /// <returns> true if TTS engine needs the application's credential, otherwise false </returns>
+ /// <returns>true if TTS engine needs the application's credentials, otherwise false. </returns>
/// <since_tizen> 4 </since_tizen>
public abstract bool NeedAppCredential();
/// Called when the engine service user cancels to synthesize a voice.
/// </summary>
/// <returns>
- /// Following Error Codes can be returned
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidState
/// </returns>
/// <precondition>
- /// StartSynthesis should be performed
+ /// StartSynthesis should be performed.
/// </precondition>
/// <since_tizen> 4 </since_tizen>
public abstract Error CancelSynthesis();
/// <summary>
- /// Public Constructor
+ /// Public constructor.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
}
/// <summary>
- /// Main function for Text-To-Speech (TTS) engine.
- /// This function is the main function for operating TTS engine.
+ /// Main function for the Text-To-Speech (TTS) engine.
+ /// This function is the main function for operating the TTS engine.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// <remarks>
/// ServiceAppMain should be used for working the engine after this function.
/// </remarks>
- /// <param name="argc">The argument count(original)</param>
- /// <param name="argv">The argument(original)</param>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <param name="argc">The argument count (original).</param>
+ /// <param name="argv">The argument (original).</param>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
/// <since_tizen> 4 </since_tizen>
public void EngineMain(int argc, string[] argv)
{
}
/// <summary>
- /// Gets the speed range from Tizen platform
+ /// Gets the speed range from the Tizen platform.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
/// <remarks>
- /// This API is used when TTS engine wants to get the speed range from Tizen platform
+ /// This API is used when the TTS engine wants to get the speed range from the Tizen platform.
/// </remarks>
- /// <param name="min">The minimum speed value</param>
- /// <param name="normal">The normal speed value</param>
- /// <param name="max">The maximum speed value</param>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <param name="min">The minimum speed value.</param>
+ /// <param name="normal">The normal speed value.</param>
+ /// <param name="max">The maximum speed value.</param>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
/// <since_tizen> 4 </since_tizen>
public void GetSpeedRange(out int min, out int normal, out int max)
{
}
/// <summary>
- /// Gets the pitch range from Tizen platform.
+ /// Gets the pitch range from the Tizen platform.
/// </summary>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
/// <remarks>
- /// This API is used when TTS engine wants to get the pitch range from Tizen platform.
+ /// This API is used when the TTS engine wants to get the pitch range from the Tizen platform.
/// </remarks>
- /// <param name="min">The minimum pitch value</param>
- /// <param name="normal">The normal pitch value</param>
- /// <param name="max">The maximum pitch value</param>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <param name="min">The minimum pitch value.</param>
+ /// <param name="normal">The normal pitch value.</param>
+ /// <param name="max">The maximum pitch value.</param>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
/// <since_tizen> 4 </since_tizen>
public void GetPitchRange(out int min, out int normal, out int max)
{
/// http://tizen.org/feature/speech.synthesis
/// </feature>
/// <remarks>
- /// This API is used in StartSynthesis(), when TTS engine sends the synthesized result to the engine service user.
+ /// This API is used in StartSynthesis(), when the TTS engine sends the synthesized result to the engine service user.
/// The synthesized result must be transferred to the engine service user through this function.
/// </remarks>
- /// <param name="resultEvent">The result event</param>
- /// <param name="data">Result data</param>
- /// <param name="dataSize">Result data size</param>
- /// <param name="audioType">The audio type</param>
- /// <param name="rate">The sample rate</param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <param name="resultEvent">The result event.</param>
+ /// <param name="data">The result data.</param>
+ /// <param name="dataSize">The result data size.</param>
+ /// <param name="audioType">The audio type.</param>
+ /// <param name="rate">The sample rate.</param>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
/// <precondition>
/// EngineMain function should be invoked before this function is called. StartSynthesis() will invoke this function.
/// </precondition>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
- /// <param name="error">The error reason</param>
- /// <param name="msg">The error message</param>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <param name="error">The error reason.</param>
+ /// <param name="msg">The error message.</param>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of operation failure.</exception>
/// <precondition>
/// EngineMain function should be invoked before this function is called.
/// </precondition>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
/// <param name="callback">
- /// Called when the engine service user gets the private data from Tts engine.
- /// In Parameters:
- /// a = Key -- The key field of private data
- /// b = data -- The data field of private data
- /// Following Error Codes can be returned
+ /// Called when the engine service user gets the private data from the TTS engine.
+ /// In parameters:
+ /// a = Key -- The key field of private data.
+ /// b = data -- The data field of private data.
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidParameter
/// 3. OperationFailed
/// 4. NotSupported
/// </param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of operation failure.</exception>
/// <precondition>
/// Main function should be invoked before this function is called.
/// </precondition>
/// <feature>
/// http://tizen.org/feature/speech.synthesis
/// </feature>
- /// <param name="callback">callback function
- /// Called when TTS engine receives the private data from the engine service user.
- /// This callback function is called when the engine service user sends the private data to TTS engine.
- /// Out Parameters:
- /// a = Key -- The key field of private data
- /// b = data -- The data field of private data
- /// Following Error Codes can be returned
+ /// <param name="callback">The callback function.
+ /// Called when the TTS engine receives the private data from the engine service user.
+ /// This callback function is called when the engine service user sends the private data to the TTS engine.
+ /// Out parameters:
+ /// a = Key -- The key field of private data.
+ /// b = data -- The data field of private data.
+ /// The following error codes can be returned:
/// 1. None
/// 2. InvalidParameter
/// 3. OperationFailed
/// 4. NotSupported
/// </param>
- /// <exception cref="ArgumentException">Thrown in case of Invalid Parameter</exception>
- /// <exception cref="NotSupportedException">Thrown in case of Not supported</exception>
- /// <exception cref="InvalidOperationException">thrown in case of Operation failure</exception>
+ /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">Thrown in case of not supported.</exception>
+ /// <exception cref="InvalidOperationException">thrown in case of operation failure.</exception>
/// <precondition>
/// Main function should be invoked before this function is called.
/// </precondition>
projects / platform / core / csapi / tizenfx.git / commitdiff