Modified to appropriate exception type (#4170)
authorInhong <inhong1.han@samsung.com>
Mon, 9 May 2022 01:41:39 +0000 (10:41 +0900)
committerGitHub <noreply@github.com>
Mon, 9 May 2022 01:41:39 +0000 (10:41 +0900)
src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs
src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs
src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodExceptionFactory.cs

index 25aaf63..f36e921 100755 (executable)
@@ -66,11 +66,9 @@ namespace Tizen.Uix.InputMethod
         /// <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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void SetSize(int portraitWidth, int portraitHeight, int landscapeWidth, int landscapeHeight)
         {
index dad1147..7ca461d 100644 (file)
@@ -1633,11 +1633,8 @@ namespace Tizen.Uix.InputMethod
         /// 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.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">This exception can be due to operation failed.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void Run(Action create, Action terminate, Action<ContextId, InputMethodContext> show, Action<ContextId> hide)
         {
@@ -1673,11 +1670,8 @@ namespace Tizen.Uix.InputMethod
         /// <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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void SendKeyEvent(KeyCode keyCode, KeyMask keyMask, bool forwardKey = false)
         {
@@ -1696,11 +1690,8 @@ namespace Tizen.Uix.InputMethod
         /// http://tizen.org/privilege/ime
         /// </privilege>
         /// <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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void CommitString(string str)
         {
@@ -1718,11 +1709,8 @@ namespace Tizen.Uix.InputMethod
         /// <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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void ShowPreEditString()
         {
@@ -1740,11 +1728,8 @@ namespace Tizen.Uix.InputMethod
         /// <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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void HidePreEditString()
         {
@@ -1767,12 +1752,8 @@ namespace Tizen.Uix.InputMethod
         /// 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) The IME main loop has not started yet.
-        /// 3) Invalid parameter.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void UpdatePreEditString(string str, IEnumerable<PreEditAttribute> attrs)
         {
@@ -1806,10 +1787,11 @@ namespace Tizen.Uix.InputMethod
         /// </privilege>
         /// <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="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
         /// <exception cref="InvalidOperationException">
         /// This can occur due to the following reasons:
-        /// 1) The application does not have the privilege to call this function.
-        /// 2) The IME main loop has not started yet.
+        /// 1) The IME main loop has not started yet.
+        /// 2) The necessary event is not set.
         /// </exception>
         /// <postcondition>
         /// The requested surrounding text can be received using the SurroundingTextUpdated event, only if it is set.
@@ -1833,12 +1815,9 @@ namespace Tizen.Uix.InputMethod
         /// </privilege>
         /// <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) The IME main loop has not started yet.
-        /// 3) Invalid parameter.
-        /// </exception>
+        /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void DeleteSurroundingText(int offset, int len)
         {
@@ -1860,13 +1839,9 @@ namespace Tizen.Uix.InputMethod
         /// <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) The IME main loop has not started yet.
-        /// 3) Invalid parameter.
-        /// 4) Failed to obtain text due to out of memory.
-        /// </exception>
+        /// <exception cref="OutOfMemoryException">This exception can be due to out of memory.</exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void GetSurroundingText(int maxLenBefore, int maxLenAfter, out string text, out int cursorPosition)
         {
@@ -1888,12 +1863,9 @@ namespace Tizen.Uix.InputMethod
         /// </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>
-        /// <exception cref="InvalidOperationException">
-        /// This can occur due to the following reasons:
-        /// 1) The application does not have the privilege to call this function.
-        /// 2) The IME main loop has not started yet.
-        /// 3) Invalid parameter.
-        /// </exception>
+        /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 4 </since_tizen>
         public static void SetSelection(int start, int end)
         {
@@ -1912,11 +1884,11 @@ namespace Tizen.Uix.InputMethod
         /// http://tizen.org/privilege/ime
         /// </privilege>
         /// <returns>The input panel main window object on success, otherwise null.</returns>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
         /// <exception cref="InvalidOperationException">
         /// This can occur due to the following reasons:
-        /// 1) The application does not have the privilege to call this function.
-        /// 2) The IME main loop has not started yet.
-        /// 3) Operation failed.
+        /// 1) The IME main loop has not started yet.
+        /// 2) Operation failed.
         /// </exception>
         /// <since_tizen> 4 </since_tizen>
         public static EditorWindow GetMainWindow()
@@ -1938,11 +1910,8 @@ namespace Tizen.Uix.InputMethod
         /// <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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 5 </since_tizen>
         public static void RequestHide()
         {
@@ -1960,11 +1929,8 @@ namespace Tizen.Uix.InputMethod
         /// <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.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">This exception can be due to operation failed.</exception>
         /// <since_tizen> 4 </since_tizen>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static void Create()
@@ -1992,11 +1958,7 @@ namespace Tizen.Uix.InputMethod
         /// <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.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
         /// <since_tizen> 4 </since_tizen>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static void Destroy()
@@ -2017,11 +1979,8 @@ namespace Tizen.Uix.InputMethod
         /// http://tizen.org/privilege/ime
         /// </privilege>
         /// <param name="floatingMode"><c>true</c> to set the floating mode to on and <c>false</c> to set it to off.</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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 5 </since_tizen>
         public static void SetFloatingMode(bool floatingMode)
         {
@@ -2042,11 +2001,8 @@ namespace Tizen.Uix.InputMethod
         /// <remarks>
         /// This function can be used in floating mode. If the floating mode is deactivated, calling this function has no effect.
         /// </remarks>
-        /// <exception cref="InvalidOperationException">
-        /// This can occur due to the following reasons:
-        /// 1) The application does not have the privilege to call this function.
-        /// 2) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 5 </since_tizen>
         public static void SetFloatingDragStart()
         {
@@ -2067,11 +2023,8 @@ namespace Tizen.Uix.InputMethod
         /// <remarks>
         /// This function can be used in floating mode. If the floating mode is deactivated, calling this function has no effect.
         /// </remarks>
-        /// <exception cref="InvalidOperationException">
-        /// This can occur due to the following reasons:
-        /// 1) The application does not have the privilege to call this function.
-        /// 2) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 5 </since_tizen>
         public static void SetFloatingDragEnd()
         {
@@ -2092,11 +2045,8 @@ namespace Tizen.Uix.InputMethod
         /// <remarks>
         /// LanguageRequestedCallback is raised after this API is called when the App requests changed language information.
         /// </remarks>
-        /// <exception cref="InvalidOperationException">
-        /// This can occur due to the following reasons:
-        /// 1) The application does not have the privilege to call this function.
-        /// 2) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 6 </since_tizen>
         public static void SendLanguageUpdated()
         {
@@ -2115,11 +2065,8 @@ namespace Tizen.Uix.InputMethod
         /// http://tizen.org/privilege/ime
         /// </privilege>
         /// <param name="enable"><c>true</c> if shift button is clicked, otherwise <c>false</c>.</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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 6 </since_tizen>
         public static void SendShiftModeUpdated(bool enable)
         {
@@ -2137,11 +2084,8 @@ namespace Tizen.Uix.InputMethod
         /// <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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 6 </since_tizen>
         public static void SendCustomGeometryUpdated()
         {
@@ -2160,11 +2104,8 @@ namespace Tizen.Uix.InputMethod
         /// http://tizen.org/privilege/ime
         /// </privilege>
         /// <returns>The selected text.</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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 6 </since_tizen>
         public static string GetSelectedText()
         {
@@ -2273,12 +2214,8 @@ namespace Tizen.Uix.InputMethod
         /// http://tizen.org/privilege/ime
         /// </privilege>
         /// <param name="command">The UTF-8 string to be sent.</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) The IME main loop has not started yet.
-        /// 3) Invalid parameter.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 6 </since_tizen>
         public static void SendPrivateCommand(string command)
         {
@@ -2299,12 +2236,8 @@ namespace Tizen.Uix.InputMethod
         /// <param name="content">The content URI to be sent.</param>
         /// <param name="description">The content description.</param>
         /// <param name="mimeType">The MIME type received from the MimeTypeSetRequest</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) The IME main loop has not started yet.
-        /// 3) Invalid parameter.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 6 </since_tizen>
         public static void CommitContent(string content, string description, string mimeType)
         {
@@ -2330,12 +2263,9 @@ namespace Tizen.Uix.InputMethod
         /// <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="ArgumentException">This exception can be due to an invalid parameter.</exception>
         /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
-        /// <exception cref="InvalidOperationException">
-        /// This can occur due to the following reasons:
-        /// 1) The application does not have the privilege to call this function.
-        /// 2) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 9 </since_tizen>
         public static void SetSize(IntPtr window, int portraitWidth, int portraitHeight, int landscapeWidth, int landscapeHeight)
         {
@@ -2379,11 +2309,8 @@ namespace Tizen.Uix.InputMethod
         /// http://tizen.org/privilege/ime
         /// </privilege>
         /// <param name="position">The cursor position in the preedit string.</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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 10 </since_tizen>
         public static void UpdatePreeditCursor(uint position)
         {
@@ -2402,11 +2329,8 @@ namespace Tizen.Uix.InputMethod
         /// http://tizen.org/privilege/ime
         /// </privilege>
         /// <param name="visible"><c>true</c> to show candidate strings, <c>false</c> otherwise.</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) The IME main loop has not started yet.
-        /// </exception>
+        /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+        /// <exception cref="InvalidOperationException">The IME main loop has not started yet.</exception>
         /// <since_tizen> 10 </since_tizen>
         public static void SetCandidateVisibilityState(bool visible)
         {
index f978ae7..5a0998e 100755 (executable)
@@ -30,14 +30,14 @@ namespace Tizen.Uix.InputMethod
             {
                 case ErrorCode.OutOfMemory:
                     {
-                        exp = new InvalidOperationException("Out Of Memory");
+                        exp = new OutOfMemoryException("Out Of Memory");
                         break;
                     }
 
 
                 case ErrorCode.InvalidParameter:
                     {
-                        exp = new InvalidOperationException("Invalid Parameters Provided");
+                        exp = new ArgumentException("Invalid Parameters Provided");
                         break;
                     }