2 * Copyright(c) 2021 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 using System.ComponentModel;
20 using System.Runtime.InteropServices;
22 namespace Tizen.NUI.BaseComponents
25 /// A control which provides a single line editable text field.
27 /// <since_tizen> 3 </since_tizen>
28 public partial class TextField
30 private EventHandler<TextChangedEventArgs> textFieldTextChangedEventHandler;
31 private TextChangedCallbackDelegate textFieldTextChangedCallbackDelegate;
32 private EventHandler textFieldCursorPositionChangedEventHandler;
33 private CursorPositionChangedCallbackDelegate textFieldCursorPositionChangedCallbackDelegate;
34 private EventHandler<MaxLengthReachedEventArgs> textFieldMaxLengthReachedEventHandler;
35 private MaxLengthReachedCallbackDelegate textFieldMaxLengthReachedCallbackDelegate;
36 private EventHandler<AnchorClickedEventArgs> textFieldAnchorClickedEventHandler;
37 private AnchorClickedCallbackDelegate textFieldAnchorClickedCallbackDelegate;
39 private EventHandler textFieldSelectionChangedEventHandler;
40 private SelectionChangedCallbackDelegate textFieldSelectionChangedCallbackDelegate;
42 private EventHandler<InputFilteredEventArgs> textFieldInputFilteredEventHandler;
43 private InputFilteredCallbackDelegate textFieldInputFilteredCallbackDelegate;
44 private EventHandler textFieldSelectionClearedEventHandler;
45 private SelectionClearedCallbackDelegate textFieldSelectionClearedCallbackDelegate;
47 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
48 private delegate void TextChangedCallbackDelegate(IntPtr textField);
50 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
51 private delegate void CursorPositionChangedCallbackDelegate(IntPtr textField, uint oldPosition);
53 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
54 private delegate void MaxLengthReachedCallbackDelegate(IntPtr textField);
56 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
57 private delegate void AnchorClickedCallbackDelegate(IntPtr textField, IntPtr href, uint hrefLength);
59 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
60 private delegate void SelectionChangedCallbackDelegate(IntPtr textField, uint oldStart, uint oldEnd);
62 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
63 private delegate void InputFilteredCallbackDelegate(IntPtr textField, InputFilterType type);
65 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
66 private delegate void SelectionClearedCallbackDelegate(IntPtr textField);
69 /// The TextChanged event.
71 /// <since_tizen> 3 </since_tizen>
72 public event EventHandler<TextChangedEventArgs> TextChanged
76 if (textFieldTextChangedEventHandler == null)
78 textFieldTextChangedCallbackDelegate = (OnTextChanged);
79 TextChangedSignal().Connect(textFieldTextChangedCallbackDelegate);
81 textFieldTextChangedEventHandler += value;
85 textFieldTextChangedEventHandler -= value;
86 if (textFieldTextChangedEventHandler == null && TextChangedSignal().Empty() == false)
88 TextChangedSignal().Disconnect(textFieldTextChangedCallbackDelegate);
94 /// The CursorPositionChanged event.
96 /// <since_tizen> 9 </since_tizen>
97 public event EventHandler CursorPositionChanged
101 if (textFieldCursorPositionChangedEventHandler == null)
103 textFieldCursorPositionChangedCallbackDelegate = (OnCursorPositionChanged);
104 CursorPositionChangedSignal().Connect(textFieldCursorPositionChangedCallbackDelegate);
106 textFieldCursorPositionChangedEventHandler += value;
110 if (textFieldCursorPositionChangedEventHandler == null && CursorPositionChangedSignal().Empty() == false)
112 this.CursorPositionChangedSignal().Disconnect(textFieldCursorPositionChangedCallbackDelegate);
114 textFieldCursorPositionChangedEventHandler -= value;
119 /// The MaxLengthReached event.
121 /// <since_tizen> 3 </since_tizen>
122 public event EventHandler<MaxLengthReachedEventArgs> MaxLengthReached
126 if (textFieldMaxLengthReachedEventHandler == null)
128 textFieldMaxLengthReachedCallbackDelegate = (OnMaxLengthReached);
129 MaxLengthReachedSignal().Connect(textFieldMaxLengthReachedCallbackDelegate);
131 textFieldMaxLengthReachedEventHandler += value;
135 if (textFieldMaxLengthReachedEventHandler == null && MaxLengthReachedSignal().Empty() == false)
137 this.MaxLengthReachedSignal().Disconnect(textFieldMaxLengthReachedCallbackDelegate);
139 textFieldMaxLengthReachedEventHandler -= value;
144 /// The SelectionCleared signal is emitted when selection is cleared.
146 /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API.
147 [EditorBrowsable(EditorBrowsableState.Never)]
148 public event EventHandler SelectionCleared
152 if (textFieldSelectionClearedEventHandler == null)
154 textFieldSelectionClearedCallbackDelegate = (OnSelectionCleared);
155 SelectionClearedSignal().Connect(textFieldSelectionClearedCallbackDelegate);
157 textFieldSelectionClearedEventHandler += value;
161 if (textFieldSelectionClearedEventHandler == null && SelectionClearedSignal().Empty() == false)
163 this.SelectionClearedSignal().Disconnect(textFieldSelectionClearedCallbackDelegate);
165 textFieldSelectionClearedEventHandler -= value;
170 /// The AnchorClicked signal is emitted when the anchor is clicked.
172 /// <since_tizen> 9 </since_tizen>
173 public event EventHandler<AnchorClickedEventArgs> AnchorClicked
177 if (textFieldAnchorClickedEventHandler == null)
179 textFieldAnchorClickedCallbackDelegate = (OnAnchorClicked);
180 AnchorClickedSignal().Connect(textFieldAnchorClickedCallbackDelegate);
182 textFieldAnchorClickedEventHandler += value;
186 textFieldAnchorClickedEventHandler -= value;
187 if (textFieldAnchorClickedEventHandler == null && AnchorClickedSignal().Empty() == false)
189 AnchorClickedSignal().Disconnect(textFieldAnchorClickedCallbackDelegate);
195 /// The SelectionChanged signal is emitted whenever the selected text changed.
197 /// <since_tizen> 9 </since_tizen>
198 public event EventHandler SelectionChanged
202 if (textFieldSelectionChangedEventHandler == null)
204 textFieldSelectionChangedCallbackDelegate = (OnSelectionChanged);
205 SelectionChangedSignal().Connect(textFieldSelectionChangedCallbackDelegate);
207 textFieldSelectionChangedEventHandler += value;
211 if (textFieldSelectionChangedEventHandler == null && SelectionChangedSignal().Empty() == false)
213 this.SelectionChangedSignal().Disconnect(textFieldSelectionChangedCallbackDelegate);
215 textFieldSelectionChangedEventHandler -= value;
220 /// The InputFiltered signal is emitted when the input is filtered by InputFilter. <br />
223 /// See <see cref="InputFilterType"/> and <see cref="InputFilteredEventArgs"/> for a detailed description. <br />
226 /// The following example demonstrates how to use the InputFiltered event.
228 /// field.InputFiltered += (s, e) =>
230 /// if (e.Type == InputFilterType.Accept)
232 /// // If input is filtered by InputFilter of Accept type.
234 /// else if (e.Type == InputFilterType.Reject)
236 /// // If input is filtered by InputFilter of Reject type.
241 [EditorBrowsable(EditorBrowsableState.Never)]
242 public event EventHandler<InputFilteredEventArgs> InputFiltered
246 if (textFieldInputFilteredEventHandler == null)
248 textFieldInputFilteredCallbackDelegate = (OnInputFiltered);
249 InputFilteredSignal().Connect(textFieldInputFilteredCallbackDelegate);
251 textFieldInputFilteredEventHandler += value;
255 textFieldInputFilteredEventHandler -= value;
256 if (textFieldInputFilteredEventHandler == null && InputFilteredSignal().Empty() == false)
258 InputFilteredSignal().Disconnect(textFieldInputFilteredCallbackDelegate);
263 internal TextFieldSignal SelectionClearedSignal()
265 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.SelectionClearedSignal(SwigCPtr), false);
266 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
270 internal TextFieldSignal TextChangedSignal()
272 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.TextChangedSignal(SwigCPtr), false);
273 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
277 internal TextFieldSignal CursorPositionChangedSignal()
279 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.CursorPositionChangedSignal(SwigCPtr), false);
280 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
284 internal TextFieldSignal MaxLengthReachedSignal()
286 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.MaxLengthReachedSignal(SwigCPtr), false);
287 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
291 internal TextFieldSignal AnchorClickedSignal()
293 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.AnchorClickedSignal(SwigCPtr), false);
294 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
298 internal TextFieldSignal SelectionChangedSignal()
300 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.SelectionChangedSignal(SwigCPtr), false);
301 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
305 internal TextFieldSignal InputFilteredSignal()
307 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.InputFilteredSignal(SwigCPtr), false);
308 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
312 private void OnSelectionCleared(IntPtr textField)
314 //no data to be sent to the user
315 textFieldSelectionClearedEventHandler?.Invoke(this, EventArgs.Empty);
318 private void OnTextChanged(IntPtr textField)
320 if (textFieldTextChangedEventHandler != null)
322 TextChangedEventArgs e = new TextChangedEventArgs();
324 // Populate all members of "e" (TextChangedEventArgs) with real data
325 e.TextField = Registry.GetManagedBaseHandleFromNativePtr(textField) as TextField;
326 //here we send all data to user event handlers
327 textFieldTextChangedEventHandler(this, e);
331 private void OnCursorPositionChanged(IntPtr textField, uint oldPosition)
333 // no data to be sent to the user, as in NUI there is no event provide old values.
334 textFieldCursorPositionChangedEventHandler?.Invoke(this, EventArgs.Empty);
337 private void OnMaxLengthReached(IntPtr textField)
339 if (textFieldMaxLengthReachedEventHandler != null)
341 MaxLengthReachedEventArgs e = new MaxLengthReachedEventArgs();
343 // Populate all members of "e" (MaxLengthReachedEventArgs) with real data
344 e.TextField = Registry.GetManagedBaseHandleFromNativePtr(textField) as TextField;
345 //here we send all data to user event handlers
346 textFieldMaxLengthReachedEventHandler(this, e);
350 private void OnAnchorClicked(IntPtr textField, IntPtr href, uint hrefLength)
352 // Note: hrefLength is useful for get the length of a const char* (href) in dali-toolkit.
353 // But NUI can get the length of string (href), so hrefLength is not necessary in NUI.
354 AnchorClickedEventArgs e = new AnchorClickedEventArgs();
356 // Populate all members of "e" (AnchorClickedEventArgs) with real data
357 e.Href = Marshal.PtrToStringAnsi(href);
358 //here we send all data to user event handlers
359 textFieldAnchorClickedEventHandler?.Invoke(this, e);
362 private void OnSelectionChanged(IntPtr textField, uint oldStart, uint oldEnd)
364 // no data to be sent to the user, as in NUI there is no event provide old values.
365 textFieldSelectionChangedEventHandler?.Invoke(this, EventArgs.Empty);
368 private void OnInputFiltered(IntPtr textField, InputFilterType type)
370 InputFilteredEventArgs e = new InputFilteredEventArgs();
372 // Populate all members of "e" (InputFilteredEventArgs) with real data
374 //here we send all data to user event handlers
375 textFieldInputFilteredEventHandler?.Invoke(this, e);
379 /// The TextChanged event arguments.
381 /// <since_tizen> 3 </since_tizen>
382 public class TextChangedEventArgs : EventArgs
384 private TextField textField;
389 /// <since_tizen> 3 </since_tizen>
390 public TextField TextField
404 /// The MaxLengthReached event arguments.
406 /// <since_tizen> 3 </since_tizen>
407 public class MaxLengthReachedEventArgs : EventArgs
409 private TextField textField;
414 /// <since_tizen> 3 </since_tizen>
415 public TextField TextField