src/Tizen.NUI/src/public/Accessibility/IAtspiValue.cs

   1 /*
   2  * Copyright(c) 2022 Samsung Electronics Co., Ltd.
   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
  18 using System;
  19 using System.ComponentModel;
  20
  21 namespace Tizen.NUI.Accessibility
  22 {
  23     [EditorBrowsable(EditorBrowsableState.Never)]
  24     public interface IAtspiValue
  25     {
  26         [EditorBrowsable(EditorBrowsableState.Never)]
  27         double AccessibilityGetMinimum();
  28
  29         /// <summary>
  30         /// Gets the current numeric value.
  31         /// </summary>
  32         /// <remarks>
  33         /// The application may set the "value_format" attribute to one of the
  34         /// following values in order to customize what is read by the Screen Reader:
  35         /// 1. "percent" (the default) - AccessibilityGetCurrent() normalized as
  36         ///    a percentage of the range [AccessibilityGetMinimum(), AccessibilityGetMaximum()],
  37         /// 2. "number" - AccessibilityGetCurrent() verbatim,
  38         /// 3. "text" - AccessibilityGetValueText() is used instead of AccessibilityGetCurrent()
  39         /// </remarks>
  40         [EditorBrowsable(EditorBrowsableState.Never)]
  41         double AccessibilityGetCurrent();
  42
  43         /// <summary>
  44         /// Gets the formatted current value.
  45         /// </summary>
  46         /// <remarks>
  47         /// This does not have to be AccessibilityGetCurrent() formatted in any
  48         /// particular way, i.e. it may be an arbitrary string, e.g. "small font size"
  49         /// for the numeric value 10.0. The return value of this method is only
  50         /// used if the "value_format" attribute is "text".
  51         /// </remarks>
  52         [EditorBrowsable(EditorBrowsableState.Never)]
  53         string AccessibilityGetValueText();
  54
  55         [EditorBrowsable(EditorBrowsableState.Never)]
  56         double AccessibilityGetMaximum();
  57
  58         [EditorBrowsable(EditorBrowsableState.Never)]
  59         bool AccessibilitySetCurrent(double value);
  60
  61         [EditorBrowsable(EditorBrowsableState.Never)]
  62         double AccessibilityGetMinimumIncrement();
  63     }
  64 }