[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / IAccessibleObject.cs
old mode 100755 (executable)
new mode 100644 (file)
index f1488ff..92cba84
  * limitations under the License.
  */
 
+using System;
+
 namespace ElmSharp.Accessible
 {
     /// <summary>
-    /// IAccessibleObject is a interface which defines properties and methods of accessible object.
+    /// IAccessibleObject is an interface, which defines the properties and methods of an accessible object.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public interface IAccessibleObject
     {
+        /// <summary>
+        /// Gets or sets the reading information types of an accessible object.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         ReadingInfoType ReadingInfoType { get; set; }
+
+        /// <summary>
+        /// Gets or sets the role of the object in an accessibility domain.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         AccessRole Role { get; set; }
+
+        /// <summary>
+        /// Gets or sets the highlightable of the given widget.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         bool CanHighlight { get; set; }
+
+        /// <summary>
+        /// 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.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         string TranslationDomain { get; set; }
+
+        /// <summary>
+        /// Gets or sets an accessible name of the object.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets contextual information about the object.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the delegate for <see cref="IAccessibleObject.Name"/>.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         AccessibleInfoProvider NameProvider { get; set; }
+
+        /// <summary>
+        /// Gets or sets the delegate for <see cref="IAccessibleObject.Description"/>.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         AccessibleInfoProvider DescriptionProvider { get; set; }
+
+        /// <summary>
+        /// 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 <see cref="FlowsTo"/> from object A to B) do not append relation <see cref="FlowsFrom"/> from object B to object A.
+        /// </summary>
+        /// <param name="relation">The relationship between the source object and target object of a given type.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         void AppendRelation(IAccessibleRelation relation);
+
+        /// <summary>
+        /// Removes the relationship between two accessible objects.
+        /// </summary>
+        /// <param name="relation">The relationship between the source object and target object of a given type.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         void RemoveRelation(IAccessibleRelation relation);
+
+        /// <summary>
+        /// Highlights the accessible widget.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         void Highlight();
+
+        /// <summary>
+        /// Clears the highlight of the accessible widget.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         void Unhighlight();
     }
 }