Interface IAccessibleObject

Definition

Namespace:: ElmSharp.Accessible

Assembly:: ElmSharp.dll

IAccessibleObject is an interface, which defines the properties and methods of an accessible object.

public interface IAccessibleObject

Properties

View Source

CanHighlight

Gets or sets the highlightable of the given widget.

Declaration

bool CanHighlight { get; set; }

Property Value

Type	Description
bool

View Source

Description

Gets or sets contextual information about the object.

Declaration

string Description { get; set; }

Property Value

Type	Description
string

View Source

DescriptionProvider

Gets or sets the delegate for Description.

Declaration

AccessibleInfoProvider DescriptionProvider { get; set; }

Property Value

Type	Description
AccessibleInfoProvider

View Source

Name

Gets or sets an accessible name of the object.

Declaration

string Name { get; set; }

Property Value

Type	Description
string

View Source

NameProvider

Gets or sets the delegate for Name.

Declaration

AccessibleInfoProvider NameProvider { get; set; }

Property Value

Type	Description
AccessibleInfoProvider

View Source

ReadingInfoType

Gets or sets the reading information types of an accessible object.

Declaration

ReadingInfoType ReadingInfoType { get; set; }

Property Value

Type	Description
ReadingInfoType

View Source

Role

Gets or sets the role of the object in an accessibility domain.

Declaration

AccessRole Role { get; set; }

Property Value

Type	Description
AccessRole

View Source

TranslationDomain

Gets or sets the translation domain of the "name" and "description" properties. Translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties. When the translation domain is set, values of the "name" and "description" properties will be translated with dgettext function using the current translation domain as "domainname" parameter. It is the application developer's responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled.

Declaration

string TranslationDomain { get; set; }

Property Value

Type	Description
string

Methods

View Source

AppendRelation(IAccessibleRelation)

Defines the relationship between two accessible objects. Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience. AppendRelation API is asymmetric, which means that appending (For example, relation FlowsTo from object A to B) do not append relation FlowsFrom from object B to object A.

Declaration

void AppendRelation(IAccessibleRelation relation)

Parameters

Type	Name	Description
IAccessibleRelation	relation	The relationship between the source object and target object of a given type.

View Source

Highlight()

Highlights the accessible widget.

Declaration

void Highlight()

View Source

RemoveRelation(IAccessibleRelation)

Removes the relationship between two accessible objects.

Declaration

void RemoveRelation(IAccessibleRelation relation)

Parameters

Type	Name	Description
IAccessibleRelation	relation	The relationship between the source object and target object of a given type.

View Source

Unhighlight()

Clears the highlight of the accessible widget.

Declaration

void Unhighlight()