Class Accessibility

Definition

Namespace:

Tizen.NUI.Accessibility

Assembly:

Tizen.NUI.dll

Accessibility provides Dali-ATSPI interface which has functionality of Screen-Reader and general accessibility.

public static class Accessibility

Inheritance

object

Accessibility

Properties

IsEnabled

Flag to check whether the state of Accessibility is enabled or not.

Declaration

public static bool IsEnabled { get; }

Property Value

Type	Description
bool

Remarks

Getter returns true if Accessibility is enabled, false otherwise.

IsScreenReaderEnabled

Flag to check whether the state of Screen Reader is enabled or not.

Declaration

public static bool IsScreenReaderEnabled { get; }

Property Value

Type	Description
bool

Remarks

Getter returns true if Screen Reader is enabled, false otherwise.

Methods

BridgeDisableAutoInit()

Blocks auto-initialization of AT-SPI bridge.

Declaration

public static void BridgeDisableAutoInit()

Remarks

Use this only if your application starts before DBus does, and call it early in Main(). When DBus is ready, call BridgeEnableAutoInit().

BridgeEnableAutoInit()

Re-enables auto-initialization of AT-SPI bridge.

Declaration

public static void BridgeEnableAutoInit()

Remarks

Normal applications do not have to call this function. The AT-SPI bridge is initialized on demand.

ClearCurrentlyHighlightedView()

Clear highlight.

Declaration

public static bool ClearCurrentlyHighlightedView()

Returns

Type	Description
bool	true if the highlight was cleared successfully, otherwise false.

GetCurrentlyHighlightedView()

Get highligted View.

Declaration

public static View GetCurrentlyHighlightedView()

Returns

Type	Description
View	The currently highlighted view.

GetHighlightFrameView()

Get View that is used to highlight widget.

Declaration

public static View GetHighlightFrameView()

Returns

Type	Description
View

PauseResume(bool)

To make Say be paused or resumed.

Declaration

public static void PauseResume(bool pause)

Parameters

Type	Name	Description
bool	pause	true to be paused, false to be resumed.

ResetCustomHighlightOverlay(View)

Resets the custom highlight overlay This functionality is only applicable when the CustomHighlight Overlay is a child of the scene-view.

Declaration

public static void ResetCustomHighlightOverlay(View view)

Parameters

Type	Name	Description
View	view

Say(string, bool)

Start to speak.

Declaration

public static void Say(string sentence, bool discardable)

Parameters

Type	Name	Description
string	sentence	Content to be spoken.
bool	discardable	true to be stopped and discarded when other Say is triggered.

SetCustomHighlightOverlay(View, Position2D, Size2D)

Sets a custom highlight overlay at the specified position and size. This functionality is only applicable when the CustomHighlight Overlay is a child of the scene-view. In other words, the position and size of the highlight indicator can only be set if the CustomHighlight Overlay is part of the scene-view.

Declaration

public static void SetCustomHighlightOverlay(View view, Position2D position, Size2D size)

Parameters

Type	Name	Description
View	view	The view to set the overlay
Position2D	position	A Position2D representing the position of the overlay
Size2D	size	A Size2D representing the size of the overlay

SetHighlightFrameView(View)

Set view that will be used to highlight widget.

Declaration

public static void SetHighlightFrameView(View view)

Parameters

Type	Name	Description
View	view

StopReading(bool)

Cancels anything screen-reader is reading / has queued to read.

Declaration

public static void StopReading(bool alsoNonDiscardable)

Parameters

Type	Name	Description
bool	alsoNonDiscardable	whether to cancel non-discardable readings as well.

SuppressScreenReader(bool)

Suppress reading of screen-reader.

Declaration

public static bool SuppressScreenReader(bool suppress)

Parameters

Type	Name	Description
bool	suppress	whether to suppress reading of screen-reader.

Returns

Type	Description
bool

Events

Disabled

Triggered whenever the value of IsEnabled would change from true to false

Declaration

public static event EventHandler Disabled

Event Type

Type	Description
EventHandler

Enabled

Triggered whenever the value of IsEnabled would change from false to true

Declaration

public static event EventHandler Enabled

Event Type

Type	Description
EventHandler

SayFinished

When Say is finished, this event is triggered

Declaration

public static event EventHandler<SayFinishedEventArgs> SayFinished

Event Type

Type	Description
EventHandler<><SayFinishedEventArgs>

ScreenReaderDisabled

Triggered whenever the value of IsScreenReaderEnabled would change from true to false

Declaration

public static event EventHandler ScreenReaderDisabled

Event Type

Type	Description
EventHandler

ScreenReaderEnabled

Triggered whenever the value of IsScreenReaderEnabled would change from false to true

Declaration

public static event EventHandler ScreenReaderEnabled

Event Type

Type	Description
EventHandler