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 is emitted whenever the primary cursor position changed.
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 /// <since_tizen> 9 </since_tizen>
147 public event EventHandler SelectionCleared
151 if (textFieldSelectionClearedEventHandler == null)
153 textFieldSelectionClearedCallbackDelegate = (OnSelectionCleared);
154 SelectionClearedSignal().Connect(textFieldSelectionClearedCallbackDelegate);
156 textFieldSelectionClearedEventHandler += value;
160 if (textFieldSelectionClearedEventHandler == null && SelectionClearedSignal().Empty() == false)
162 this.SelectionClearedSignal().Disconnect(textFieldSelectionClearedCallbackDelegate);
164 textFieldSelectionClearedEventHandler -= value;
169 /// The AnchorClicked signal is emitted when the anchor is clicked.
171 /// <since_tizen> 9 </since_tizen>
172 public event EventHandler<AnchorClickedEventArgs> AnchorClicked
176 if (textFieldAnchorClickedEventHandler == null)
178 textFieldAnchorClickedCallbackDelegate = (OnAnchorClicked);
179 AnchorClickedSignal().Connect(textFieldAnchorClickedCallbackDelegate);
181 textFieldAnchorClickedEventHandler += value;
185 textFieldAnchorClickedEventHandler -= value;
186 if (textFieldAnchorClickedEventHandler == null && AnchorClickedSignal().Empty() == false)
188 AnchorClickedSignal().Disconnect(textFieldAnchorClickedCallbackDelegate);
194 /// The SelectionChanged signal is emitted whenever the selected text changed.
196 /// <since_tizen> 9 </since_tizen>
197 public event EventHandler SelectionChanged
201 if (textFieldSelectionChangedEventHandler == null)
203 textFieldSelectionChangedCallbackDelegate = (OnSelectionChanged);
204 SelectionChangedSignal().Connect(textFieldSelectionChangedCallbackDelegate);
206 textFieldSelectionChangedEventHandler += value;
210 if (textFieldSelectionChangedEventHandler == null && SelectionChangedSignal().Empty() == false)
212 this.SelectionChangedSignal().Disconnect(textFieldSelectionChangedCallbackDelegate);
214 textFieldSelectionChangedEventHandler -= value;
219 /// The InputFiltered signal is emitted when the input is filtered by InputFilter. <br />
222 /// See <see cref="InputFilterType"/> and <see cref="InputFilteredEventArgs"/> for a detailed description. <br />
225 /// The following example demonstrates how to use the InputFiltered event.
227 /// field.InputFiltered += (s, e) =>
229 /// if (e.Type == InputFilterType.Accept)
231 /// // If input is filtered by InputFilter of Accept type.
233 /// else if (e.Type == InputFilterType.Reject)
235 /// // If input is filtered by InputFilter of Reject type.
240 [EditorBrowsable(EditorBrowsableState.Never)]
241 public event EventHandler<InputFilteredEventArgs> InputFiltered
245 if (textFieldInputFilteredEventHandler == null)
247 textFieldInputFilteredCallbackDelegate = (OnInputFiltered);
248 InputFilteredSignal().Connect(textFieldInputFilteredCallbackDelegate);
250 textFieldInputFilteredEventHandler += value;
254 textFieldInputFilteredEventHandler -= value;
255 if (textFieldInputFilteredEventHandler == null && InputFilteredSignal().Empty() == false)
257 InputFilteredSignal().Disconnect(textFieldInputFilteredCallbackDelegate);
262 internal TextFieldSignal SelectionClearedSignal()
264 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.SelectionClearedSignal(SwigCPtr), false);
265 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
269 internal TextFieldSignal TextChangedSignal()
271 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.TextChangedSignal(SwigCPtr), false);
272 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
276 internal TextFieldSignal CursorPositionChangedSignal()
278 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.CursorPositionChangedSignal(SwigCPtr), false);
279 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
283 internal TextFieldSignal MaxLengthReachedSignal()
285 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.MaxLengthReachedSignal(SwigCPtr), false);
286 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
290 internal TextFieldSignal AnchorClickedSignal()
292 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.AnchorClickedSignal(SwigCPtr), false);
293 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
297 internal TextFieldSignal SelectionChangedSignal()
299 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.SelectionChangedSignal(SwigCPtr), false);
300 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
304 internal TextFieldSignal InputFilteredSignal()
306 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.InputFilteredSignal(SwigCPtr), false);
307 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
311 private void OnSelectionCleared(IntPtr textField)
313 //no data to be sent to the user
314 textFieldSelectionClearedEventHandler?.Invoke(this, EventArgs.Empty);
317 private void OnTextChanged(IntPtr textField)
319 if (textFieldTextChangedEventHandler != null)
321 TextChangedEventArgs e = new TextChangedEventArgs();
323 // Populate all members of "e" (TextChangedEventArgs) with real data
324 e.TextField = Registry.GetManagedBaseHandleFromNativePtr(textField) as TextField;
325 //here we send all data to user event handlers
326 textFieldTextChangedEventHandler(this, e);
330 private void OnCursorPositionChanged(IntPtr textField, uint oldPosition)
332 // no data to be sent to the user, as in NUI there is no event provide old values.
333 textFieldCursorPositionChangedEventHandler?.Invoke(this, EventArgs.Empty);
336 private void OnMaxLengthReached(IntPtr textField)
338 if (textFieldMaxLengthReachedEventHandler != null)
340 MaxLengthReachedEventArgs e = new MaxLengthReachedEventArgs();
342 // Populate all members of "e" (MaxLengthReachedEventArgs) with real data
343 e.TextField = Registry.GetManagedBaseHandleFromNativePtr(textField) as TextField;
344 //here we send all data to user event handlers
345 textFieldMaxLengthReachedEventHandler(this, e);
349 private void OnAnchorClicked(IntPtr textField, IntPtr href, uint hrefLength)
351 // Note: hrefLength is useful for get the length of a const char* (href) in dali-toolkit.
352 // But NUI can get the length of string (href), so hrefLength is not necessary in NUI.
353 AnchorClickedEventArgs e = new AnchorClickedEventArgs();
355 // Populate all members of "e" (AnchorClickedEventArgs) with real data
356 e.Href = Marshal.PtrToStringAnsi(href);
357 //here we send all data to user event handlers
358 textFieldAnchorClickedEventHandler?.Invoke(this, e);
361 private void OnSelectionChanged(IntPtr textField, uint oldStart, uint oldEnd)
363 // no data to be sent to the user, as in NUI there is no event provide old values.
364 textFieldSelectionChangedEventHandler?.Invoke(this, EventArgs.Empty);
367 private void OnInputFiltered(IntPtr textField, InputFilterType type)
369 InputFilteredEventArgs e = new InputFilteredEventArgs();
371 // Populate all members of "e" (InputFilteredEventArgs) with real data
373 //here we send all data to user event handlers
374 textFieldInputFilteredEventHandler?.Invoke(this, e);
378 /// The TextChanged event arguments.
380 /// <since_tizen> 3 </since_tizen>
381 public class TextChangedEventArgs : EventArgs
383 private TextField textField;
388 /// <since_tizen> 3 </since_tizen>
389 public TextField TextField
403 /// The MaxLengthReached event arguments.
405 /// <since_tizen> 3 </since_tizen>
406 public class MaxLengthReachedEventArgs : EventArgs
408 private TextField textField;
413 /// <since_tizen> 3 </since_tizen>
414 public TextField TextField