src/ElmSharp/ElmSharp/IAccessibleObject.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 using System;
  18
  19 namespace ElmSharp.Accessible
  20 {
  21     /// <summary>
  22     /// IAccessibleObject is an interface, which defines the properties and methods of an accessible object.
  23     /// </summary>
  24     /// <since_tizen> preview </since_tizen>
  25     [Obsolete("This has been deprecated in API12")]
  26     public interface IAccessibleObject
  27     {
  28         /// <summary>
  29         /// Gets or sets the reading information types of an accessible object.
  30         /// </summary>
  31         /// <since_tizen> preview </since_tizen>
  32         [Obsolete("This has been deprecated in API12")]
  33         ReadingInfoType ReadingInfoType { get; set; }
  34
  35         /// <summary>
  36         /// Gets or sets the role of the object in an accessibility domain.
  37         /// </summary>
  38         /// <since_tizen> preview </since_tizen>
  39         [Obsolete("This has been deprecated in API12")]
  40         AccessRole Role { get; set; }
  41
  42         /// <summary>
  43         /// Gets or sets the highlightable of the given widget.
  44         /// </summary>
  45         /// <since_tizen> preview </since_tizen>
  46         [Obsolete("This has been deprecated in API12")]
  47         bool CanHighlight { get; set; }
  48
  49         /// <summary>
  50         /// Gets or sets the translation domain of the "name" and "description" properties.
  51         /// Translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties.
  52         /// 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.
  53         /// It is the application developer's responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled.
  54         /// </summary>
  55         /// <since_tizen> preview </since_tizen>
  56         [Obsolete("This has been deprecated in API12")]
  57         string TranslationDomain { get; set; }
  58
  59         /// <summary>
  60         /// Gets or sets an accessible name of the object.
  61         /// </summary>
  62         /// <since_tizen> preview </since_tizen>
  63         [Obsolete("This has been deprecated in API12")]
  64         string Name { get; set; }
  65
  66         /// <summary>
  67         /// Gets or sets contextual information about the object.
  68         /// </summary>
  69         /// <since_tizen> preview </since_tizen>
  70         [Obsolete("This has been deprecated in API12")]
  71         string Description { get; set; }
  72
  73         /// <summary>
  74         /// Gets or sets the delegate for <see cref="IAccessibleObject.Name"/>.
  75         /// </summary>
  76         /// <since_tizen> preview </since_tizen>
  77         [Obsolete("This has been deprecated in API12")]
  78         AccessibleInfoProvider NameProvider { get; set; }
  79
  80         /// <summary>
  81         /// Gets or sets the delegate for <see cref="IAccessibleObject.Description"/>.
  82         /// </summary>
  83         /// <since_tizen> preview </since_tizen>
  84         [Obsolete("This has been deprecated in API12")]
  85         AccessibleInfoProvider DescriptionProvider { get; set; }
  86
  87         /// <summary>
  88         /// Defines the relationship between two accessible objects.
  89         /// Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience.
  90         /// AppendRelation API is asymmetric, which means that appending (For example, relation <see cref="FlowsTo"/> from object A to B) do not append relation <see cref="FlowsFrom"/> from object B to object A.
  91         /// </summary>
  92         /// <param name="relation">The relationship between the source object and target object of a given type.</param>
  93         /// <since_tizen> preview </since_tizen>
  94         [Obsolete("This has been deprecated in API12")]
  95         void AppendRelation(IAccessibleRelation relation);
  96
  97         /// <summary>
  98         /// Removes the relationship between two accessible objects.
  99         /// </summary>
 100         /// <param name="relation">The relationship between the source object and target object of a given type.</param>
 101         /// <since_tizen> preview </since_tizen>
 102         [Obsolete("This has been deprecated in API12")]
 103         void RemoveRelation(IAccessibleRelation relation);
 104
 105         /// <summary>
 106         /// Highlights the accessible widget.
 107         /// </summary>
 108         /// <since_tizen> preview </since_tizen>
 109         [Obsolete("This has been deprecated in API12")]
 110         void Highlight();
 111
 112         /// <summary>
 113         /// Clears the highlight of the accessible widget.
 114         /// </summary>
 115         /// <since_tizen> preview </since_tizen>
 116         [Obsolete("This has been deprecated in API12")]
 117         void Unhighlight();
 118     }
 119 }