/*
* Copyright(c) 2023 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
using System;
using System.ComponentModel;
using Tizen.NUI.BaseComponents;
namespace Tizen.NUI.Accessibility
{
///
/// Interface representing objects which can store a set of selected items.
///
[EditorBrowsable(EditorBrowsableState.Never)]
public interface IAtspiSelection
{
///
/// Gets the number of selected children.
///
/// The number of selected children (zero if none)
[EditorBrowsable(EditorBrowsableState.Never)]
int AccessibilityGetSelectedChildrenCount();
///
/// Gets a specific selected child.
///
///
/// selectedChildIndex refers to the list of selected children, not the list of all children.
///
/// The index of the selected child
/// The selected child or nullptr if index is invalid
[EditorBrowsable(EditorBrowsableState.Never)]
View AccessibilityGetSelectedChild(int selectedChildIndex);
///
/// Selects a child.
///
/// The index of the child
/// True on success, false otherwise
[EditorBrowsable(EditorBrowsableState.Never)]
bool AccessibilitySelectChild(int childIndex);
///
/// Deselects a selected child.
///
/// The index of the selected child
/// True on success, false otherwise
[EditorBrowsable(EditorBrowsableState.Never)]
bool AccessibilityDeselectSelectedChild(int selectedChildIndex);
///
/// Checks whether a child is selected.
///
/// The index of the child
/// < True if given child is selected, false otherwise /returns>
[EditorBrowsable(EditorBrowsableState.Never)]
bool AccessibilityIsChildSelected(int childIndex);
///
/// Selects all children.
///
/// True on success, false otherwise
[EditorBrowsable(EditorBrowsableState.Never)]
bool AccessibilitySelectAll();
///
/// Deselects all children.
///
/// True on success, false otherwise
[EditorBrowsable(EditorBrowsableState.Never)]
bool AccessibilityClearSelection();
///
/// Deselects a child.
///
/// The index of the child.
/// True on success, false otherwise
[EditorBrowsable(EditorBrowsableState.Never)]
bool AccessibilityDeselectChild(int childIndex);
}
}