2 * Copyright(c) 2020 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.
18 using System.ComponentModel;
19 using Tizen.NUI.BaseComponents;
21 namespace Tizen.NUI.Accessibility
24 /// AccessibilityManager manages registration of views in an accessibility focus chain and changing the focused view within that chain.
25 /// This class provides the functionality of registering the focus order and description of views and maintaining the focus chain.
26 /// It provides functionality of setting the focus and moving the focus forward and backward.
27 /// It also draws a highlight for the focused view and emits a signal when the focus is changed.
29 /// <since_tizen> 6 </since_tizen>
30 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
31 [EditorBrowsable(EditorBrowsableState.Never)]
32 public partial class AccessibilityManager : BaseHandle
34 private static readonly AccessibilityManager instance = AccessibilityManager.Get();
36 internal AccessibilityManager(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.AccessibilityManager.AccessibilityManager_SWIGUpcast(cPtr), cMemoryOwn)
40 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(AccessibilityManager obj)
42 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
45 /// This will not be public opened.
46 [EditorBrowsable(EditorBrowsableState.Never)]
47 protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
49 Interop.AccessibilityManager.delete_AccessibilityManager(swigCPtr);
52 // Callback for AccessibilityManager StatusChangedSignal
53 private bool OnStatusChanged(IntPtr data)
55 if (_accessibilityManagerStatusChangedEventHandler != null)
57 //here we send all data to user event handlers
58 return _accessibilityManagerStatusChangedEventHandler(instance, null);
63 // Callback for AccessibilityManager ActionNextSignal
64 private bool OnActionNext(IntPtr data)
66 if (_accessibilityManagerActionNextEventHandler != null)
68 //here we send all data to user event handlers
69 return _accessibilityManagerActionNextEventHandler(instance, null);
74 // Callback for AccessibilityManager ActionPreviousSignal
75 private bool OnActionPrevious(IntPtr data)
77 if (_accessibilityManagerActionPreviousEventHandler != null)
79 //here we send all data to user event handlers
80 return _accessibilityManagerActionPreviousEventHandler(instance, null);
85 // Callback for AccessibilityManager ActionActivateSignal
86 private bool OnActionActivate(IntPtr data)
88 if (_accessibilityManagerActionActivateEventHandler != null)
90 //here we send all data to user event handlers
91 return _accessibilityManagerActionActivateEventHandler(instance, null);
96 // Callback for AccessibilityManager ActionReadSignal
97 private bool OnActionRead(IntPtr data)
100 if (_accessibilityManagerActionReadEventHandler != null)
102 //here we send all data to user event handlers
103 return _accessibilityManagerActionReadEventHandler(instance, null);
108 // Callback for AccessibilityManager ActionOverSignal
109 private bool OnActionOver(IntPtr data)
111 if (_accessibilityManagerActionOverEventHandler != null)
113 //here we send all data to user event handlers
114 return _accessibilityManagerActionOverEventHandler(instance, null);
119 // Callback for AccessibilityManager ActionReadNextSignal
120 private bool OnActionReadNext(IntPtr data)
122 if (_accessibilityManagerActionReadNextEventHandler != null)
124 //here we send all data to user event handlers
125 return _accessibilityManagerActionReadNextEventHandler(instance, null);
130 // Callback for AccessibilityManager ActionReadPreviousSignal
131 private bool OnActionReadPrevious(IntPtr data)
133 if (_accessibilityManagerActionReadPreviousEventHandler != null)
135 //here we send all data to user event handlers
136 return _accessibilityManagerActionReadPreviousEventHandler(instance, null);
141 // Callback for AccessibilityManager ActionUpSignal
142 private bool OnActionUp(IntPtr data)
144 if (_accessibilityManagerActionUpEventHandler != null)
146 //here we send all data to user event handlers
147 return _accessibilityManagerActionUpEventHandler(instance, null);
152 // Callback for AccessibilityManager ActionDownSignal
153 private bool OnActionDown(IntPtr data)
155 if (_accessibilityManagerActionDownEventHandler != null)
157 //here we send all data to user event handlers
158 return _accessibilityManagerActionDownEventHandler(instance, null);
163 // Callback for AccessibilityManager ActionClearFocusSignal
164 private bool OnActionClearFocus(IntPtr data)
166 if (_accessibilityManagerActionClearFocusEventHandler != null)
168 //here we send all data to user event handlers
169 return _accessibilityManagerActionClearFocusEventHandler(instance, null);
174 // Callback for AccessibilityManager ActionBackSignal
175 private bool OnActionBack(IntPtr data)
177 if (_accessibilityManagerActionBackEventHandler != null)
179 //here we send all data to user event handlers
180 return _accessibilityManagerActionBackEventHandler(instance, null);
185 // Callback for AccessibilityManager ActionScrollUpSignal
186 private bool OnActionScrollUp(IntPtr data)
188 if (_accessibilityManagerActionScrollUpEventHandler != null)
190 //here we send all data to user event handlers
191 return _accessibilityManagerActionScrollUpEventHandler(instance, null);
196 // Callback for AccessibilityManager ActionScrollDownSignal
197 private bool OnActionScrollDown(IntPtr data)
199 if (_accessibilityManagerActionScrollDownEventHandler != null)
201 //here we send all data to user event handlers
202 return _accessibilityManagerActionScrollDownEventHandler(instance, null);
207 // Callback for AccessibilityManager ActionPageLeftSignal
208 private bool OnActionPageLeft(IntPtr data)
210 if (_accessibilityManagerActionPageLeftEventHandler != null)
212 //here we send all data to user event handlers
213 return _accessibilityManagerActionPageLeftEventHandler(instance, null);
218 // Callback for AccessibilityManager ActionPageRightSignal
219 private bool OnActionPageRight(IntPtr data)
221 if (_accessibilityManagerActionPageRightEventHandler != null)
223 //here we send all data to user event handlers
224 return _accessibilityManagerActionPageRightEventHandler(instance, null);
229 // Callback for AccessibilityManager ActionPageUpSignal
230 private bool OnActionPageUp(IntPtr data)
232 if (_accessibilityManagerActionPageUpEventHandler != null)
234 //here we send all data to user event handlers
235 return _accessibilityManagerActionPageUpEventHandler(instance, null);
241 // Callback for AccessibilityManager ActionPageDownSignal
242 private bool OnActionPageDown(IntPtr data)
244 if (_accessibilityManagerActionPageDownEventHandler != null)
246 //here we send all data to user event handlers
247 return _accessibilityManagerActionPageDownEventHandler(instance, null);
253 // Callback for AccessibilityManager ActionMoveToFirstSignal
254 private bool OnActionMoveToFirst(IntPtr data)
256 if (_accessibilityManagerActionMoveToFirstEventHandler != null)
258 //here we send all data to user event handlers
259 return _accessibilityManagerActionMoveToFirstEventHandler(instance, null);
264 // Callback for AccessibilityManager ActionMoveToLastSignal
265 private bool OnActionMoveToLast(IntPtr data)
267 if (_accessibilityManagerActionMoveToLastEventHandler != null)
269 //here we send all data to user event handlers
270 return _accessibilityManagerActionMoveToLastEventHandler(instance, null);
275 // Callback for AccessibilityManager ActionReadFromTopSignal
276 private bool OnActionReadFromTop(IntPtr data)
278 if (_accessibilityManagerActionReadFromTopEventHandler != null)
280 //here we send all data to user event handlers
281 return _accessibilityManagerActionReadFromTopEventHandler(instance, null);
286 // Callback for AccessibilityManager ActionReadFromNextSignal
287 private bool OnActionReadFromNext(IntPtr data)
289 if (_accessibilityManagerActionReadFromNextEventHandler != null)
291 //here we send all data to user event handlers
292 return _accessibilityManagerActionReadFromNextEventHandler(instance, null);
297 // Callback for AccessibilityManager ActionZoomSignal
298 private bool OnActionZoom(IntPtr data)
300 if (_accessibilityManagerActionZoomEventHandler != null)
302 //here we send all data to user event handlers
303 return _accessibilityManagerActionZoomEventHandler(instance, null);
308 // Callback for AccessibilityManager ActionReadPauseResumeSignal
309 private bool OnActionReadPauseResume(IntPtr data)
311 if (_accessibilityManagerActionReadPauseResumeEventHandler != null)
313 //here we send all data to user event handlers
314 return _accessibilityManagerActionReadPauseResumeEventHandler(instance, null);
319 // Callback for AccessibilityManager ActionStartStopSignal
320 private bool OnActionStartStop(IntPtr data)
322 if (_accessibilityManagerActionStartStopEventHandler != null)
324 //here we send all data to user event handlers
325 return _accessibilityManagerActionStartStopEventHandler(instance, null);
330 // Callback for AccessibilityManager FocusChangedSignal
331 private void OnFocusChanged(IntPtr view1, IntPtr view2)
333 FocusChangedEventArgs e = new FocusChangedEventArgs();
335 // Populate all members of "e" (FocusChangedEventArgs) with real data
336 e.ViewCurrent = Registry.GetManagedBaseHandleFromNativePtr(view1) as View;
337 e.ViewNext = Registry.GetManagedBaseHandleFromNativePtr(view2) as View;
339 if (_accessibilityManagerFocusChangedEventHandler != null)
341 //here we send all data to user event handlers
342 _accessibilityManagerFocusChangedEventHandler(this, e);
346 // Callback for AccessibilityManager FocusedViewActivatedSignal
347 private void OnFocusedViewActivated(IntPtr view)
349 FocusedViewActivatedEventArgs e = new FocusedViewActivatedEventArgs();
351 // Populate all members of "e" (FocusedViewActivatedEventArgs) with real data
352 e.View = Registry.GetManagedBaseHandleFromNativePtr(view) as View;
354 if (_accessibilityManagerFocusedViewActivatedEventHandler != null)
356 //here we send all data to user event handlers
357 _accessibilityManagerFocusedViewActivatedEventHandler(this, e);
361 // Callback for AccessibilityManager FocusOvershotSignal
362 private void OnFocusOvershot(IntPtr currentFocusedView, AccessibilityManager.FocusOvershotDirection direction)
364 FocusOvershotEventArgs e = new FocusOvershotEventArgs();
366 // Populate all members of "e" (FocusOvershotEventArgs) with real data
367 e.CurrentFocusedView = Registry.GetManagedBaseHandleFromNativePtr(currentFocusedView) as View;
368 e.FocusOvershotDirection = direction;
370 if (_accessibilityManagerFocusOvershotEventHandler != null)
372 //here we send all data to user event handlers
373 _accessibilityManagerFocusOvershotEventHandler(this, e);
378 /// Enumeration for accessibility that needs four information which will be read by screen-reader.
380 /// Reading order : Label -> Trait -> Optional (Value and Hint)
382 /// <since_tizen> 6 </since_tizen>
383 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
384 [EditorBrowsable(EditorBrowsableState.Never)]
385 public enum AccessibilityAttribute
388 /// Simple text which contained in components, such as Ok or Cancel in case of a button
390 /// <since_tizen> 6 </since_tizen>
391 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
392 [EditorBrowsable(EditorBrowsableState.Never)]
395 /// Description of components trait, such as Button in case of a button
397 /// <since_tizen> 6 </since_tizen>
398 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
399 [EditorBrowsable(EditorBrowsableState.Never)]
402 /// Current value of components (Optional)
404 /// <since_tizen> 6 </since_tizen>
405 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
406 [EditorBrowsable(EditorBrowsableState.Never)]
409 /// Hint for action (Optional)
411 /// <since_tizen> 6 </since_tizen>
412 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
413 [EditorBrowsable(EditorBrowsableState.Never)]
416 /// The number of attributes
418 /// <since_tizen> 6 </since_tizen>
419 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
420 [EditorBrowsable(EditorBrowsableState.Never)]
425 /// Enumeration for overshoot direction.
427 /// <since_tizen> 6 </since_tizen>
428 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
429 [EditorBrowsable(EditorBrowsableState.Never)]
430 public enum FocusOvershotDirection
433 /// Try to move previous of the first view
435 /// <since_tizen> 6 </since_tizen>
436 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
437 [EditorBrowsable(EditorBrowsableState.Never)]
440 /// Try to move next of the last view
442 /// <since_tizen> 6 </since_tizen>
443 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
444 [EditorBrowsable(EditorBrowsableState.Never)]
450 /// Creates an AccessibilityManager handle.
452 /// <since_tizen> 6 </since_tizen>
453 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
454 [EditorBrowsable(EditorBrowsableState.Never)]
455 public AccessibilityManager() : this(Interop.AccessibilityManager.new_AccessibilityManager(), true)
457 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
461 /// Gets the singleton of AccessibilityManager object.
463 /// <returns> A handle to the AccessibilityManager </returns>
464 /// <since_tizen> 6 </since_tizen>
465 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
466 [EditorBrowsable(EditorBrowsableState.Never)]
467 public static AccessibilityManager Instance
476 /// Sets the information of the specified view's accessibility attribute.
478 /// <param name="view"> The view to be set with</param>
479 /// <param name="type"> The attribute type the text to be set with</param>
480 /// <param name="text"> The text for the view's accessibility information</param>
481 /// <since_tizen> 6 </since_tizen>
482 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
483 [EditorBrowsable(EditorBrowsableState.Never)]
484 public void SetAccessibilityAttribute(View view, AccessibilityManager.AccessibilityAttribute type, string text)
486 Interop.AccessibilityManager.AccessibilityManager_SetAccessibilityAttribute(swigCPtr, View.getCPtr(view), (int)type, text);
487 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
491 /// Gets the text of the specified view's accessibility attribute.
493 /// <param name="view"> The view to be queried</param>
494 /// <param name="type"> The attribute type to be queried</param>
495 /// <returns> The text of the view's accessibility information </returns>
496 /// <since_tizen> 6 </since_tizen>
497 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
498 [EditorBrowsable(EditorBrowsableState.Never)]
499 public string GetAccessibilityAttribute(View view, AccessibilityManager.AccessibilityAttribute type)
501 string ret = Interop.AccessibilityManager.AccessibilityManager_GetAccessibilityAttribute(swigCPtr, View.getCPtr(view), (int)type);
502 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
507 /// Sets the focus order of the view.
508 /// The focus order of each view in the focus chain is unique.
509 /// If there is another view assigned with the same focus order already, the new view will be inserted to the focus chain with that focus order,
510 /// and the focus order of the original view and all the views followed in the focus chain will be increased accordingly.
511 /// If the focus order assigned to the view is 0, it means that view's focus order is undefined
512 /// (e.g. the view has a description but with no focus order being set yet) and therefore that view is not focusable.
514 /// <param name="view"> the view to be set with</param>
515 /// <param name="order"> the focus order to be set with</param>
516 /// <since_tizen> 6 </since_tizen>
517 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
518 [EditorBrowsable(EditorBrowsableState.Never)]
519 public void SetFocusOrder(View view, uint order)
521 Interop.AccessibilityManager.AccessibilityManager_SetFocusOrder(swigCPtr, View.getCPtr(view), order);
522 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
526 /// Gets the focus order of the view.
527 /// When the focus order is 0, it means the focus order of the view is undefined.
529 /// <param name="view"> the view to be set with</param>
530 /// <returns> The focus order of the view </returns>
531 /// <since_tizen> 6 </since_tizen>
532 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
533 [EditorBrowsable(EditorBrowsableState.Never)]
534 public uint GetFocusOrder(View view)
536 uint ret = Interop.AccessibilityManager.AccessibilityManager_GetFocusOrder(swigCPtr, View.getCPtr(view));
537 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
542 /// Generates a new focus order number which can be used to assign to views
543 /// which need to be appended to the end of the current focus order chain.
544 /// The new number will be an increment over the very last focus order number in the focus chain.
545 /// If the focus chain is empty then the function returns 1,
546 /// else the number returned will be FOLast + 1 where FOLast is the focus order of the very last control in the focus chain.
548 /// <returns> The focus order of the view </returns>
549 /// <since_tizen> 6 </since_tizen>
550 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
551 [EditorBrowsable(EditorBrowsableState.Never)]
552 public uint GenerateNewFocusOrder()
554 uint ret = Interop.AccessibilityManager.AccessibilityManager_GenerateNewFocusOrder(swigCPtr);
555 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
560 /// Gets the view that has the specified focus order.
561 /// It will return an empty handle if no view in the window has the specified focus order.
563 /// <param name="order"> The focus order of the view</param>
564 /// <returns> The view that has the specified focus order or an empty handle if no view in the stage has the specified focus order </returns>
565 /// <since_tizen> 6 </since_tizen>
566 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
567 [EditorBrowsable(EditorBrowsableState.Never)]
568 public View GetViewByFocusOrder(uint order)
570 View ret = new View(Interop.AccessibilityManager.AccessibilityManager_GetActorByFocusOrder(swigCPtr, order), true);
571 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
576 /// Moves the focus to the specified view.
577 /// Only one view can be focused at the same time. The view must have a defined focus order
578 /// and must be focusable, visible and in the window.
580 /// <param name="view"> the view to be set with</param>
581 /// <returns> Whether the focus is successful or not </returns>
582 /// <since_tizen> 6 </since_tizen>
583 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
584 [EditorBrowsable(EditorBrowsableState.Never)]
585 public bool SetCurrentFocusView(View view)
587 bool ret = Interop.AccessibilityManager.AccessibilityManager_SetCurrentFocusActor(swigCPtr, View.getCPtr(view));
588 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
593 /// Gets the current focused view.
595 /// <returns> A handle to the current focused view or an empty handle if no view is focused </returns>
596 /// <since_tizen> 6 </since_tizen>
597 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
598 [EditorBrowsable(EditorBrowsableState.Never)]
599 public View GetCurrentFocusView()
601 View ret = new View(Interop.AccessibilityManager.AccessibilityManager_GetCurrentFocusActor(swigCPtr), true);
602 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
607 /// Gets the focus group of current focused view.
609 /// <returns> A handle to the immediate parent of the current focused view which is also a focus group, or an empty handle if no view is focused </returns>
610 /// <since_tizen> 6 </since_tizen>
611 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
612 [EditorBrowsable(EditorBrowsableState.Never)]
613 public View GetCurrentFocusGroup()
615 View ret = new View(Interop.AccessibilityManager.AccessibilityManager_GetCurrentFocusGroup(swigCPtr), true);
616 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
621 /// Gets the focus order of currently focused view.
623 /// <returns> The focus order of the currently focused view or 0 if no view is in focus </returns>
624 /// <since_tizen> 6 </since_tizen>
625 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
626 [EditorBrowsable(EditorBrowsableState.Never)]
627 public uint GetCurrentFocusOrder()
629 uint ret = Interop.AccessibilityManager.AccessibilityManager_GetCurrentFocusOrder(swigCPtr);
630 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
635 /// Moves the focus to the next focusable view in the focus chain (according to the focus traversal order).
636 /// When the focus movement is wrapped around, the focus will be moved to the first focusable view when it reaches the end of the focus chain.
638 /// <returns> True if the moving was successful </returns>
639 /// <since_tizen> 6 </since_tizen>
640 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
641 [EditorBrowsable(EditorBrowsableState.Never)]
642 public bool MoveFocusForward()
644 bool ret = Interop.AccessibilityManager.AccessibilityManager_MoveFocusForward(swigCPtr);
645 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
650 /// Moves the focus to the previous focusable view in the focus chain (according to the focus traversal order).
651 /// When the focus movement is wrapped around, the focus will be moved to the last focusable view
652 /// when it reaches the beginning of the focus chain.
654 /// <returns> True if the moving was successful </returns>
655 /// <since_tizen> 6 </since_tizen>
656 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
657 [EditorBrowsable(EditorBrowsableState.Never)]
658 public bool MoveFocusBackward()
660 bool ret = Interop.AccessibilityManager.AccessibilityManager_MoveFocusBackward(swigCPtr);
661 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
666 /// Clears the focus from the current focused view if any, so that no view is focused in the focus chain.
667 /// It will emit focus changed signal without current focused view.
669 /// <since_tizen> 6 </since_tizen>
670 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
671 [EditorBrowsable(EditorBrowsableState.Never)]
672 public void ClearFocus()
674 Interop.AccessibilityManager.AccessibilityManager_ClearFocus(swigCPtr);
675 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
679 /// Clears every registered focusable view from focus-manager.
681 /// <since_tizen> 6 </since_tizen>
682 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
683 [EditorBrowsable(EditorBrowsableState.Never)]
684 public new void Reset()
686 Interop.AccessibilityManager.AccessibilityManager_Reset(swigCPtr);
687 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
691 /// Sets whether an view is a focus group that can limit the scope of focus movement to its child views in the focus chain.
693 /// <param name="view"> the view to be set as a focus group</param>
694 /// <param name="isFocusGroup"> Whether to set the view to be a focus group or not</param>
695 /// <since_tizen> 6 </since_tizen>
696 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
697 [EditorBrowsable(EditorBrowsableState.Never)]
698 public void SetFocusGroup(View view, bool isFocusGroup)
700 Interop.AccessibilityManager.AccessibilityManager_SetFocusGroup(swigCPtr, View.getCPtr(view), isFocusGroup);
701 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
705 /// Checks whether the view is set as a focus group or not.
707 /// <param name="view"> the view to be checked</param>
708 /// <returns> Whether the view is set as a focus group </returns>
709 /// <since_tizen> 6 </since_tizen>
710 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
711 [EditorBrowsable(EditorBrowsableState.Never)]
712 public bool IsFocusGroup(View view)
714 bool ret = Interop.AccessibilityManager.AccessibilityManager_IsFocusGroup(swigCPtr, View.getCPtr(view));
715 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
720 /// Sets whether the group mode is enabled or not.
721 /// When the group mode is enabled, the focus movement will be limited to the child views of the current focus group including the current focus group itself.
722 /// The current focus group is the closest ancestor of the current focused view that is set as a focus group.
724 /// <param name="enabled"> Whether the group mode is enabled or not</param>
725 /// <since_tizen> 6 </since_tizen>
726 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
727 [EditorBrowsable(EditorBrowsableState.Never)]
728 public void SetGroupMode(bool enabled)
730 Interop.AccessibilityManager.AccessibilityManager_SetGroupMode(swigCPtr, enabled);
731 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
735 /// Gets whether the group mode is enabled or not.
737 /// <since_tizen> 6 </since_tizen>
738 /// <returns> Whether the group mode is enabled or not. </returns>
739 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
740 [EditorBrowsable(EditorBrowsableState.Never)]
741 public bool GetGroupMode()
743 bool ret = Interop.AccessibilityManager.AccessibilityManager_GetGroupMode(swigCPtr);
744 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
749 /// Sets whether focus will be moved to the beginning of the focus chain when it reaches the end or vice versa.
750 /// When both the wrap mode and the group mode are enabled, focus will be wrapped within the current focus group.
751 /// Focus will not be wrapped in default.
753 /// <param name="wrapped"> Whether the focus movement is wrapped around or not</param>
754 /// <since_tizen> 6 </since_tizen>
755 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
756 [EditorBrowsable(EditorBrowsableState.Never)]
757 public void SetWrapMode(bool wrapped)
759 Interop.AccessibilityManager.AccessibilityManager_SetWrapMode(swigCPtr, wrapped);
760 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
764 /// Gets whether the wrap mode is enabled or not.
766 /// <returns> Whether the wrap mode is enabled or not. </returns>
767 /// <since_tizen> 6 </since_tizen>
768 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
769 [EditorBrowsable(EditorBrowsableState.Never)]
770 public bool GetWrapMode()
772 bool ret = Interop.AccessibilityManager.AccessibilityManager_GetWrapMode(swigCPtr);
773 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
778 /// Sets the focus indicator view.
779 /// This will replace the default focus indicator view in AccessibilityManager and
780 /// will be added to the focused view as a highlight.
782 /// <param name="indicator"> The indicator view to be added</param>
783 /// <since_tizen> 6 </since_tizen>
784 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
785 [EditorBrowsable(EditorBrowsableState.Never)]
786 public void SetFocusIndicatorView(View indicator)
788 Interop.AccessibilityManager.AccessibilityManager_SetFocusIndicatorActor(swigCPtr, View.getCPtr(indicator));
789 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
793 /// Gets the focus indicator view.
795 /// <returns> A handle to the focus indicator view </returns>
796 /// <since_tizen> 6 </since_tizen>
797 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
798 [EditorBrowsable(EditorBrowsableState.Never)]
799 public View GetFocusIndicatorView()
801 View ret = new View(Interop.AccessibilityManager.AccessibilityManager_GetFocusIndicatorActor(swigCPtr), true);
802 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
807 /// Returns the closest ancestor of the given view that is a focus group.
809 /// <param name="view"> The view to be checked for its focus group</param>
810 /// <returns> The focus group the given view belongs to or an empty handle if the given view doesn't belong to any focus group </returns>
811 /// <since_tizen> 6 </since_tizen>
812 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
813 [EditorBrowsable(EditorBrowsableState.Never)]
814 public View GetFocusGroup(View view)
816 View ret = new View(Interop.AccessibilityManager.AccessibilityManager_GetFocusGroup(swigCPtr, View.getCPtr(view)), true);
817 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
822 /// Returns the current position of the read action.
824 /// <returns> The current event position </returns>
825 /// <since_tizen> 6 </since_tizen>
826 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
827 [EditorBrowsable(EditorBrowsableState.Never)]
828 public Vector2 GetReadPosition()
830 Vector2 ret = new Vector2(Interop.AccessibilityManager.AccessibilityManager_GetReadPosition(swigCPtr), true);
831 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
836 /// Enables Accessibility or not.
838 /// <param name="enabled"> True if Accessibility should be enabled.</param>
839 /// This will be public opened later. Before ACR, need to be hidden as inhouse API.
840 [EditorBrowsable(EditorBrowsableState.Never)]
841 public void EnableAccessibility(bool enabled)
843 Interop.AccessibilityManager.EnableAccessibility(swigCPtr, enabled);
844 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
848 /// Queries whether the accessibility(screen-reader) is enabled.
849 /// Basically, the accessibility will be enabled by system setting.
851 /// <returns> True if the accessibility(screen-reader) is enabled. </returns>
852 /// This will be public opened later. Before ACR, need to be hidden as inhouse API.
853 [EditorBrowsable(EditorBrowsableState.Never)]
854 public bool IsEnabled()
856 bool ret = Interop.AccessibilityManager.IsEnabled(swigCPtr);
857 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
861 internal static AccessibilityManager Get()
863 AccessibilityManager ret = new AccessibilityManager(Interop.AccessibilityManager.AccessibilityManager_Get(), true);
864 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
868 // Signals - AccessibilityManagerEvent.cs
869 internal FocusChangedSignal FocusChangedSignal()
871 FocusChangedSignal ret = new FocusChangedSignal(Interop.AccessibilityManager.AccessibilityManager_FocusChangedSignal(swigCPtr), false);
872 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
876 internal AccessibilityFocusOvershotSignal FocusOvershotSignal()
878 AccessibilityFocusOvershotSignal ret = new AccessibilityFocusOvershotSignal(Interop.AccessibilityManager.AccessibilityManager_FocusOvershotSignal(swigCPtr), false);
879 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
883 internal ViewSignal FocusedViewActivatedSignal()
885 ViewSignal ret = new ViewSignal(Interop.AccessibilityManager.AccessibilityManager_FocusedActorActivatedSignal(swigCPtr), false);
886 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
890 internal AccessibilityActionSignal StatusChangedSignal()
892 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_StatusChangedSignal(swigCPtr), false);
893 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
897 internal AccessibilityActionSignal ActionNextSignal()
899 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionNextSignal(swigCPtr), false);
900 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
904 internal AccessibilityActionSignal ActionPreviousSignal()
906 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionPreviousSignal(swigCPtr), false);
907 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
911 internal AccessibilityActionSignal ActionActivateSignal()
913 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionActivateSignal(swigCPtr), false);
914 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
918 internal AccessibilityActionSignal ActionReadSignal()
920 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionReadSignal(swigCPtr), false);
921 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
925 internal AccessibilityActionSignal ActionOverSignal()
927 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionOverSignal(swigCPtr), false);
928 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
932 internal AccessibilityActionSignal ActionReadNextSignal()
934 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionReadNextSignal(swigCPtr), false);
935 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
939 internal AccessibilityActionSignal ActionReadPreviousSignal()
941 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionReadPreviousSignal(swigCPtr), false);
942 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
946 internal AccessibilityActionSignal ActionUpSignal()
948 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionUpSignal(swigCPtr), false);
949 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
953 internal AccessibilityActionSignal ActionDownSignal()
955 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionDownSignal(swigCPtr), false);
956 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
960 internal AccessibilityActionSignal ActionClearFocusSignal()
962 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionClearFocusSignal(swigCPtr), false);
963 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
967 internal AccessibilityActionSignal ActionBackSignal()
969 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionBackSignal(swigCPtr), false);
970 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
974 internal AccessibilityActionSignal ActionScrollUpSignal()
976 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionScrollUpSignal(swigCPtr), false);
977 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
981 internal AccessibilityActionSignal ActionScrollDownSignal()
983 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionScrollDownSignal(swigCPtr), false);
984 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
988 internal AccessibilityActionSignal ActionPageLeftSignal()
990 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionPageLeftSignal(swigCPtr), false);
991 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
995 internal AccessibilityActionSignal ActionPageRightSignal()
997 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionPageRightSignal(swigCPtr), false);
998 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1002 internal AccessibilityActionSignal ActionPageUpSignal()
1004 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionPageUpSignal(swigCPtr), false);
1005 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1009 internal AccessibilityActionSignal ActionPageDownSignal()
1011 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionPageDownSignal(swigCPtr), false);
1012 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1016 internal AccessibilityActionSignal ActionMoveToFirstSignal()
1018 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionMoveToFirstSignal(swigCPtr), false);
1019 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1023 internal AccessibilityActionSignal ActionMoveToLastSignal()
1025 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionMoveToLastSignal(swigCPtr), false);
1026 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1030 internal AccessibilityActionSignal ActionReadFromTopSignal()
1032 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionReadFromTopSignal(swigCPtr), false);
1033 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1037 internal AccessibilityActionSignal ActionReadFromNextSignal()
1039 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionReadFromNextSignal(swigCPtr), false);
1040 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1044 internal AccessibilityActionSignal ActionZoomSignal()
1046 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionZoomSignal(swigCPtr), false);
1047 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1051 internal AccessibilityActionSignal ActionReadPauseResumeSignal()
1053 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionReadPauseResumeSignal(swigCPtr), false);
1054 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1058 internal AccessibilityActionSignal ActionStartStopSignal()
1060 AccessibilityActionSignal ret = new AccessibilityActionSignal(Interop.AccessibilityManager.AccessibilityManager_ActionStartStopSignal(swigCPtr), false);
1061 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1065 internal SWIGTYPE_p_Dali__SignalT_bool_fDali__Toolkit__AccessibilityManager_R_Dali__TouchEvent_const_RF_t ActionScrollSignal()
1067 SWIGTYPE_p_Dali__SignalT_bool_fDali__Toolkit__AccessibilityManager_R_Dali__TouchEvent_const_RF_t ret = new SWIGTYPE_p_Dali__SignalT_bool_fDali__Toolkit__AccessibilityManager_R_Dali__TouchEvent_const_RF_t(Interop.AccessibilityManager.AccessibilityManager_ActionScrollSignal(swigCPtr), false);
1068 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();