Review Uix.InputMethod/SttEngine/TtsEngine API cs files
[platform/core/csapi/tizenfx.git] / src / Tizen.Uix.InputMethod / Tizen.Uix.InputMethod / EditorWindow.cs
1 /*
2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3 *
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 using Tizen;
18 using System;
19 using ElmSharp;
20 using static Interop.InputMethod;
21
22 namespace Tizen.Uix.InputMethod
23 {
24     /// <summary>
25     /// The editor window class.
26     /// </summary>
27     /// <since_tizen> 4 </since_tizen>
28     public class EditorWindow : Window
29     {
30         internal static IntPtr _handle = IntPtr.Zero;
31         private IntPtr _realHandle = IntPtr.Zero;
32
33         internal EditorWindow():base("Edit")
34         {
35             _realHandle = _handle;
36         }
37
38         /// <summary>
39         /// This API creates a handle for the editor window.
40         /// </summary>
41         /// <since_tizen> 4 </since_tizen>
42         protected override IntPtr CreateHandle(EvasObject parent)
43         {
44             return _handle;
45         }
46
47         /// <summary>
48         /// This API gets a handle for the editor window.
49         /// </summary>
50         /// <since_tizen> 4 </since_tizen>
51         public IntPtr GetHandle()
52         {
53             return _handle;
54         }
55
56         /// <summary>
57         /// This API updates the input panel window's size information.
58         /// </summary>
59         /// <privilege>
60         /// http://tizen.org/privilege/ime
61         /// </privilege>
62         /// <param name="portraitWidth">The width in the portrait mode.</param>
63         /// <param name="portraitHeight">The height in the portrait mode.</param>
64         /// <param name="landscapeWidth">The width in the landscape mode.</param>
65         /// <param name="landscapeHeight">The height in the landscape mode.</param>
66         /// <exception cref="InvalidOperationException">
67         /// This can occur due to the following reasons:
68         /// 1) The application does not have the privilege to call this function.
69         /// 2) The IME main loop isn't started yet.
70         /// </exception>
71         /// <since_tizen> 4 </since_tizen>
72         public static void SetSize(int portraitWidth, int portraitHeight, int landscapeWidth, int landscapeHeight)
73         {
74             ErrorCode error = ImeSetSize(portraitWidth, portraitHeight, landscapeWidth, landscapeHeight);
75             if (error != ErrorCode.None)
76             {
77                 Log.Error(LogTag, "SetSize Failed with error " + error);
78                 throw InputMethodExceptionFactory.CreateException(error);
79             }
80         }
81     }
82 }