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 /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API.
97 [EditorBrowsable(EditorBrowsableState.Never)]
98 public event EventHandler CursorPositionChanged
102 if (textFieldCursorPositionChangedEventHandler == null)
104 textFieldCursorPositionChangedCallbackDelegate = (OnCursorPositionChanged);
105 CursorPositionChangedSignal().Connect(textFieldCursorPositionChangedCallbackDelegate);
107 textFieldCursorPositionChangedEventHandler += value;
111 if (textFieldCursorPositionChangedEventHandler == null && CursorPositionChangedSignal().Empty() == false)
113 this.CursorPositionChangedSignal().Disconnect(textFieldCursorPositionChangedCallbackDelegate);
115 textFieldCursorPositionChangedEventHandler -= value;
120 /// The MaxLengthReached event.
122 /// <since_tizen> 3 </since_tizen>
123 public event EventHandler<MaxLengthReachedEventArgs> MaxLengthReached
127 if (textFieldMaxLengthReachedEventHandler == null)
129 textFieldMaxLengthReachedCallbackDelegate = (OnMaxLengthReached);
130 MaxLengthReachedSignal().Connect(textFieldMaxLengthReachedCallbackDelegate);
132 textFieldMaxLengthReachedEventHandler += value;
136 if (textFieldMaxLengthReachedEventHandler == null && MaxLengthReachedSignal().Empty() == false)
138 this.MaxLengthReachedSignal().Disconnect(textFieldMaxLengthReachedCallbackDelegate);
140 textFieldMaxLengthReachedEventHandler -= value;
145 /// The SelectionCleared signal is emitted when selection is cleared.
147 /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API.
148 [EditorBrowsable(EditorBrowsableState.Never)]
149 public event EventHandler SelectionCleared
153 if (textFieldSelectionClearedEventHandler == null)
155 textFieldSelectionClearedCallbackDelegate = (OnSelectionCleared);
156 SelectionClearedSignal().Connect(textFieldSelectionClearedCallbackDelegate);
158 textFieldSelectionClearedEventHandler += value;
162 if (textFieldSelectionClearedEventHandler == null && SelectionClearedSignal().Empty() == false)
164 this.SelectionClearedSignal().Disconnect(textFieldSelectionClearedCallbackDelegate);
166 textFieldSelectionClearedEventHandler -= value;
171 /// The AnchorClicked signal is emitted when the anchor is clicked.
173 /// <since_tizen> 9 </since_tizen>
174 public event EventHandler<AnchorClickedEventArgs> AnchorClicked
178 if (textFieldAnchorClickedEventHandler == null)
180 textFieldAnchorClickedCallbackDelegate = (OnAnchorClicked);
181 AnchorClickedSignal().Connect(textFieldAnchorClickedCallbackDelegate);
183 textFieldAnchorClickedEventHandler += value;
187 textFieldAnchorClickedEventHandler -= value;
188 if (textFieldAnchorClickedEventHandler == null && AnchorClickedSignal().Empty() == false)
190 AnchorClickedSignal().Disconnect(textFieldAnchorClickedCallbackDelegate);
196 /// The SelectionChanged signal is emitted whenever the selected text changed.
198 /// <since_tizen> 9 </since_tizen>
199 public event EventHandler SelectionChanged
203 if (textFieldSelectionChangedEventHandler == null)
205 textFieldSelectionChangedCallbackDelegate = (OnSelectionChanged);
206 SelectionChangedSignal().Connect(textFieldSelectionChangedCallbackDelegate);
208 textFieldSelectionChangedEventHandler += value;
212 if (textFieldSelectionChangedEventHandler == null && SelectionChangedSignal().Empty() == false)
214 this.SelectionChangedSignal().Disconnect(textFieldSelectionChangedCallbackDelegate);
216 textFieldSelectionChangedEventHandler -= value;
221 /// The InputFiltered signal is emitted when the input is filtered by InputFilter. <br />
224 /// See <see cref="InputFilterType"/> and <see cref="InputFilteredEventArgs"/> for a detailed description. <br />
227 /// The following example demonstrates how to use the InputFiltered event.
229 /// field.InputFiltered += (s, e) =>
231 /// if (e.Type == InputFilterType.Accept)
233 /// // If input is filtered by InputFilter of Accept type.
235 /// else if (e.Type == InputFilterType.Reject)
237 /// // If input is filtered by InputFilter of Reject type.
242 [EditorBrowsable(EditorBrowsableState.Never)]
243 public event EventHandler<InputFilteredEventArgs> InputFiltered
247 if (textFieldInputFilteredEventHandler == null)
249 textFieldInputFilteredCallbackDelegate = (OnInputFiltered);
250 InputFilteredSignal().Connect(textFieldInputFilteredCallbackDelegate);
252 textFieldInputFilteredEventHandler += value;
256 textFieldInputFilteredEventHandler -= value;
257 if (textFieldInputFilteredEventHandler == null && InputFilteredSignal().Empty() == false)
259 InputFilteredSignal().Disconnect(textFieldInputFilteredCallbackDelegate);
264 internal TextFieldSignal SelectionClearedSignal()
266 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.SelectionClearedSignal(SwigCPtr), false);
267 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
271 internal TextFieldSignal TextChangedSignal()
273 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.TextChangedSignal(SwigCPtr), false);
274 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
278 internal TextFieldSignal CursorPositionChangedSignal()
280 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.CursorPositionChangedSignal(SwigCPtr), false);
281 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
285 internal TextFieldSignal MaxLengthReachedSignal()
287 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.MaxLengthReachedSignal(SwigCPtr), false);
288 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
292 internal TextFieldSignal AnchorClickedSignal()
294 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.AnchorClickedSignal(SwigCPtr), false);
295 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
299 internal TextFieldSignal SelectionChangedSignal()
301 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.SelectionChangedSignal(SwigCPtr), false);
302 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
306 internal TextFieldSignal InputFilteredSignal()
308 TextFieldSignal ret = new TextFieldSignal(Interop.TextField.InputFilteredSignal(SwigCPtr), false);
309 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
313 private void OnSelectionCleared(IntPtr textField)
315 //no data to be sent to the user
316 textFieldSelectionClearedEventHandler?.Invoke(this, EventArgs.Empty);
319 private void OnTextChanged(IntPtr textField)
321 if (textFieldTextChangedEventHandler != null)
323 TextChangedEventArgs e = new TextChangedEventArgs();
325 // Populate all members of "e" (TextChangedEventArgs) with real data
326 e.TextField = Registry.GetManagedBaseHandleFromNativePtr(textField) as TextField;
327 //here we send all data to user event handlers
328 textFieldTextChangedEventHandler(this, e);
332 private void OnCursorPositionChanged(IntPtr textField, uint oldPosition)
334 // no data to be sent to the user, as in NUI there is no event provide old values.
335 textFieldCursorPositionChangedEventHandler?.Invoke(this, EventArgs.Empty);
338 private void OnMaxLengthReached(IntPtr textField)
340 if (textFieldMaxLengthReachedEventHandler != null)
342 MaxLengthReachedEventArgs e = new MaxLengthReachedEventArgs();
344 // Populate all members of "e" (MaxLengthReachedEventArgs) with real data
345 e.TextField = Registry.GetManagedBaseHandleFromNativePtr(textField) as TextField;
346 //here we send all data to user event handlers
347 textFieldMaxLengthReachedEventHandler(this, e);
351 private void OnAnchorClicked(IntPtr textField, IntPtr href, uint hrefLength)
353 // Note: hrefLength is useful for get the length of a const char* (href) in dali-toolkit.
354 // But NUI can get the length of string (href), so hrefLength is not necessary in NUI.
355 AnchorClickedEventArgs e = new AnchorClickedEventArgs();
357 // Populate all members of "e" (AnchorClickedEventArgs) with real data
358 e.Href = Marshal.PtrToStringAnsi(href);
359 //here we send all data to user event handlers
360 textFieldAnchorClickedEventHandler?.Invoke(this, e);
363 private void OnSelectionChanged(IntPtr textField, uint oldStart, uint oldEnd)
365 // no data to be sent to the user, as in NUI there is no event provide old values.
366 textFieldSelectionChangedEventHandler?.Invoke(this, EventArgs.Empty);
369 private void OnInputFiltered(IntPtr textField, InputFilterType type)
371 InputFilteredEventArgs e = new InputFilteredEventArgs();
373 // Populate all members of "e" (InputFilteredEventArgs) with real data
375 //here we send all data to user event handlers
376 textFieldInputFilteredEventHandler?.Invoke(this, e);
380 /// The TextChanged event arguments.
382 /// <since_tizen> 3 </since_tizen>
383 public class TextChangedEventArgs : EventArgs
385 private TextField textField;
390 /// <since_tizen> 3 </since_tizen>
391 public TextField TextField
405 /// The MaxLengthReached event arguments.
407 /// <since_tizen> 3 </since_tizen>
408 public class MaxLengthReachedEventArgs : EventArgs
410 private TextField textField;
415 /// <since_tizen> 3 </since_tizen>
416 public TextField TextField