/*
- * Copyright(c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright(c) 2021 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
*/
-using global::System;
+using System;
using System.ComponentModel;
using System.Runtime.InteropServices;
using Tizen.NUI.BaseComponents;
-#if (NUI_DEBUG_ON)
-using tlog = Tizen.Log;
-#endif
+using System.Diagnostics.CodeAnalysis;
namespace Tizen.NUI.Accessibility
{
/// <summary>
- /// Accessibility provides Dali-ATSPI interface which has funtionality of Screen-Reader and general accessibility
+ /// Accessibility provides Dali-ATSPI interface which has functionality of Screen-Reader and general accessibility
/// </summary>
// This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [SuppressMessage("Microsoft.Design", "CA1724: Type names should not match namespaces")]
+ [SuppressMessage("Microsoft.Design", "CA1001:Types that own disposable fields should be disposable", Justification = "This is a singleton class and is not disposed")]
[EditorBrowsable(EditorBrowsableState.Never)]
public class Accessibility
{
- #region Constructor, Distructor, Dispose
+ #region Constructor, Destructor, Dispose
private Accessibility()
{
dummy = new View();
dummy.Name = "dali-atspi-singleton";
}
+
+ static Accessibility()
+ {
+ enabledSignalHandler = () =>
+ {
+ Enabled?.Invoke(typeof(Accessibility), EventArgs.Empty);
+ };
+
+ disabledSignalHandler = () =>
+ {
+ Disabled?.Invoke(typeof(Accessibility), EventArgs.Empty);
+ };
+
+ Interop.Accessibility.RegisterEnabledDisabledSignalHandler(enabledSignalHandler, disabledSignalHandler);
+ }
+
/// <summary>
/// destructor. This is HiddenAPI. recommended not to use in public.
/// </summary>
~Accessibility()
{
+ Interop.Accessibility.RegisterEnabledDisabledSignalHandler(null, null);
+
+ Tizen.Log.Debug("NUI", $"Accessibility is destroyed\n");
}
- #endregion Constructor, Distructor, Dispose
+ #endregion Constructor, Destructor, Dispose
#region Property
[EditorBrowsable(EditorBrowsableState.Never)]
public static Accessibility Instance
{
- get => _accessibility;
+ get => accessibility;
}
+
+ /// <summary>
+ /// Flag to check whether the state of Accessibility is enabled or not.
+ /// </summary>
+ /// <remarks>
+ /// Getter returns true if Accessibility is enabled, false otherwise.
+ /// </remarks>
+ /// This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static bool IsEnabled
+ {
+ get
+ {
+ return (bool)Interop.Accessibility.IsEnabled();
+ }
+ }
+
#endregion Property
public bool Say(string sentence, bool discardable)
{
IntPtr callbackIntPtr = IntPtr.Zero;
- if (_sayFinishedEventHandler != null)
+ if (sayFinishedEventHandler != null)
{
- callback = _sayFinishedEventCallback;
+ callback = SayFinishedEventCallback;
callbackIntPtr = Marshal.GetFunctionPointerForDelegate<Delegate>(callback);
}
- bool ret = Interop.Accessibility.AccessibilitySay(View.getCPtr(dummy), sentence, discardable, callbackIntPtr);
+ bool ret = Interop.Accessibility.Say(View.getCPtr(dummy), sentence, discardable, callbackIntPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
[EditorBrowsable(EditorBrowsableState.Never)]
public void PauseResume(bool pause)
{
- Interop.Accessibility.AccessibilityPauseResume(View.getCPtr(dummy), pause);
+ Interop.Accessibility.PauseResume(View.getCPtr(dummy), pause);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- #endregion Method
+ /// <summary>
+ /// Cancels anything screen-reader is reading / has queued to read
+ /// </summary>
+ /// <param name="alsoNonDiscardable">whether to cancel non-discardable readings as well</param>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public void StopReading(bool alsoNonDiscardable)
+ {
+ Interop.Accessibility.StopReading(View.getCPtr(dummy), alsoNonDiscardable);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
- #region Event, Enum, Struct, ETC
/// <summary>
- /// Say Finished event arguments
+ /// Suppress reading of screen-reader
/// </summary>
+ /// <param name="suppress">whether to suppress reading of screen-reader</param>
// This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
[EditorBrowsable(EditorBrowsableState.Never)]
- public class SayFinishedEventArgs : EventArgs
+ public bool SuppressScreenReader(bool suppress)
{
- /// <summary>
- /// The state of Say finished
- /// </summary>
- // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
- [EditorBrowsable(EditorBrowsableState.Never)]
- public SayFinishedStates State
- {
- private set;
- get;
- }
+ bool ret = Interop.Accessibility.SuppressScreenReader(View.getCPtr(dummy), suppress);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ return ret;
+ }
- internal SayFinishedEventArgs(int result)
- {
- State = (SayFinishedStates)(result);
- tlog.Fatal(tag, $"SayFinishedEventArgs Constructor! State={State}");
- }
+ /// <summary>
+ /// Re-enables auto-initialization of AT-SPI bridge
+ /// </summary>
+ /// <remarks>
+ /// Normal applications do not have to call this function. The AT-SPI bridge is initialized on demand.
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static void BridgeEnableAutoInit()
+ {
+ Interop.Accessibility.BridgeEnableAutoInit();
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+
+ /// <summary>
+ /// Blocks auto-initialization of AT-SPI bridge
+ /// </summary>
+ /// <remarks>
+ /// Use this only if your application starts before DBus does, and call it early in Main().
+ /// When DBus is ready, call BridgeEnableAutoInit().
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static void BridgeDisableAutoInit()
+ {
+ Interop.Accessibility.BridgeDisableAutoInit();
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+
+ /// <summary>
+ /// Get View that is used to highlight widget.
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public View GetHighlightFrameView()
+ {
+ var ptr = Interop.ControlDevel.DaliAccessibilityAccessibleGetHighlightActor();
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ if (ptr == IntPtr.Zero)
+ return null;
+ return new View(ptr, true);
+ }
+
+ /// <summary>
+ /// Set view that will be used to highlight widget.
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public void SetHighlightFrameView(View view)
+ {
+ Interop.ControlDevel.DaliAccessibilityAccessibleSetHighlightActor(View.getCPtr(view));
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+
+ /// <summary>
+ /// Get highligted View.
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public View GetCurrentlyHighlightedView()
+ {
+ var ptr = Interop.ControlDevel.DaliAccessibilityAccessibleGetCurrentlyHighlightedActor();
+
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+
+ return this.GetInstanceSafely<View>(ptr);
}
/// <summary>
+ /// Clear highlight.
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool ClearCurrentlyHighlightedView()
+ {
+ var view = GetCurrentlyHighlightedView();
+
+ return view?.ClearAccessibilityHighlight() ?? false;
+ }
+ #endregion Method
+
+
+ #region Event, Enum, Struct, ETC
+ /// <summary>
/// Enum of Say finished event argument status
/// </summary>
// This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
[EditorBrowsable(EditorBrowsableState.Never)]
- public enum SayFinishedStates
+ public enum SayFinishedState
{
/// <summary>
/// Invalid
/// </summary>
// This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
[EditorBrowsable(EditorBrowsableState.Never)]
- Skipped = 3
+ Skipped = 3,
+ /// <summary>
+ /// Paused
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ Paused = 4,
+ /// <summary>
+ /// Resumed
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ Resumed = 5
}
/// <summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler<SayFinishedEventArgs> SayFinished
{
- add => _sayFinishedEventHandler += value;
- remove => _sayFinishedEventHandler -= value;
+ add => sayFinishedEventHandler += value;
+ remove => sayFinishedEventHandler -= value;
}
+
+ /// <summary>
+ /// Triggered whenever the value of IsEnabled would change from false to true
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static event EventHandler Enabled;
+
+ /// <summary>
+ /// Triggered whenever the value of IsEnabled would change from true to false
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static event EventHandler Disabled;
+
#endregion Event, Enum, Struct, ETC
#region Internal
internal void PauseResume(View target, bool pause)
{
- Interop.Accessibility.AccessibilityPauseResume(View.getCPtr(target), pause);
+ Interop.Accessibility.PauseResume(View.getCPtr(target), pause);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
internal bool Say(View target, string sentence, bool discardable)
{
IntPtr callbackIntPtr = IntPtr.Zero;
- if (_sayFinishedEventHandler != null)
+ if (sayFinishedEventHandler != null)
{
- callback = _sayFinishedEventCallback;
+ callback = SayFinishedEventCallback;
callbackIntPtr = Marshal.GetFunctionPointerForDelegate<Delegate>(callback);
}
- bool ret = Interop.Accessibility.AccessibilitySay(View.getCPtr(target), sentence, discardable, callbackIntPtr);
+ bool ret = Interop.Accessibility.Say(View.getCPtr(target), sentence, discardable, callbackIntPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
#region Private
- private static readonly Accessibility _accessibility = new Accessibility();
+ private static readonly Accessibility accessibility = new Accessibility();
- private event EventHandler<SayFinishedEventArgs> _sayFinishedEventHandler;
+ private event EventHandler<SayFinishedEventArgs> sayFinishedEventHandler;
[UnmanagedFunctionPointer(CallingConvention.StdCall)]
- private delegate void _sayFinishedEventCallbackType(int result);
+ private delegate void SayFinishedEventCallbackType(int result);
+
+ private SayFinishedEventCallbackType callback = null;
- private _sayFinishedEventCallbackType callback = null;
+ private static Interop.Accessibility.EnabledDisabledSignalHandler enabledSignalHandler = null;
- private void _sayFinishedEventCallback(int result)
+ private static Interop.Accessibility.EnabledDisabledSignalHandler disabledSignalHandler = null;
+
+ private void SayFinishedEventCallback(int result)
{
- tlog.Fatal(tag, $"_sayFinishedEventCallback(res={result}) called!");
- _sayFinishedEventHandler?.Invoke(this, new SayFinishedEventArgs(result));
+ NUILog.Debug($"sayFinishedEventCallback(res={result}) called!");
+ sayFinishedEventHandler?.Invoke(this, new SayFinishedEventArgs(result));
}
private View dummy;
- private static string tag = "NUITEST";
#endregion Private
}
+
+ /// <summary>
+ /// Say Finished event arguments
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public class SayFinishedEventArgs : EventArgs
+ {
+ /// <summary>
+ /// The state of Say finished
+ /// </summary>
+ // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Accessibility.SayFinishedState State
+ {
+ private set;
+ get;
+ }
+
+ internal SayFinishedEventArgs(int result)
+ {
+ State = (Accessibility.SayFinishedState)(result);
+ NUILog.Debug($"SayFinishedEventArgs Constructor! State={State}");
+ }
+ }
}
projects / platform / core / csapi / tizenfx.git / blobdiff