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

   1 /*
   2  * Copyright(c) 2023 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 using Tizen.NUI.BaseComponents;
  21
  22 namespace Tizen.NUI.Accessibility
  23 {
  24     /// <summary>
  25     /// Interface representing objects which can store a set of selected items.
  26     /// </summary>
  27     [EditorBrowsable(EditorBrowsableState.Never)]
  28     public interface IAtspiSelection
  29     {
  30         /// <summary>
  31         /// Gets the number of selected children.
  32         /// </summary>
  33         /// <returns> The number of selected children (zero if none) </returns>
  34         [EditorBrowsable(EditorBrowsableState.Never)]
  35         int AccessibilityGetSelectedChildrenCount();
  36
  37         /// <summary>
  38         /// Gets a specific selected child.
  39         /// </summary>
  40         /// <remarks>
  41         /// <c>selectedChildIndex</c> refers to the list of selected children, not the list of all children.
  42         /// </remarks>
  43         /// <param name="selectedChildIndex"> The index of the selected child </param>
  44         /// <returns> The selected child or nullptr if index is invalid </returns>
  45         [EditorBrowsable(EditorBrowsableState.Never)]
  46         View AccessibilityGetSelectedChild(int selectedChildIndex);
  47
  48         /// <summary>
  49         /// Selects a child.
  50         /// </summary>
  51         /// <param name="childIndex"> The index of the child </param>
  52         /// <returns> True on success, false otherwise </returns>
  53         [EditorBrowsable(EditorBrowsableState.Never)]
  54         bool AccessibilitySelectChild(int childIndex);
  55
  56         /// <summary>
  57         /// Deselects a selected child.
  58         /// </summary>
  59         /// <param name="selectedChildIndex"> The index of the selected child </param>
  60         /// <returns> True on success, false otherwise </returns>
  61         [EditorBrowsable(EditorBrowsableState.Never)]
  62         bool AccessibilityDeselectSelectedChild(int selectedChildIndex);
  63
  64         /// <summary>
  65         /// Checks whether a child is selected.
  66         /// </summary>
  67         /// <param name="childIndex"> The index of the child </param>
  68         /// <returns>< True if given child is selected, false otherwise /returns>
  69         [EditorBrowsable(EditorBrowsableState.Never)]
  70         bool AccessibilityIsChildSelected(int childIndex);
  71
  72         /// <summary>
  73         /// Selects all children.
  74         /// </summary>
  75         /// <returns> True on success, false otherwise </returns>
  76         [EditorBrowsable(EditorBrowsableState.Never)]
  77         bool AccessibilitySelectAll();
  78
  79         /// <summary>
  80         /// Deselects all children.
  81         /// </summary>
  82         /// <returns> True on success, false otherwise </returns>
  83         [EditorBrowsable(EditorBrowsableState.Never)]
  84         bool AccessibilityClearSelection();
  85
  86         /// <summary>
  87         /// Deselects a child.
  88         /// </summary>
  89         /// <param name="childIndex"> The index of the child. </param>
  90         /// <returns> True on success, false otherwise </returns>
  91         [EditorBrowsable(EditorBrowsableState.Never)]
  92         bool AccessibilityDeselectChild(int childIndex);
  93     }
  94 }