src/Tizen.NUI/src/public/Accessibility/IAtspiEditableText.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
  21 namespace Tizen.NUI.Accessibility
  22 {
  23     /// <summary>
  24     /// Interface representing objects which can store editable texts.
  25     /// </summary>
  26     [EditorBrowsable(EditorBrowsableState.Never)]
  27     public interface IAtspiEditableText : IAtspiText
  28     {
  29         /// <summary>
  30         /// Copies text in range to system clipboard.
  31         /// </summary>
  32         /// <param name="startPosition"> The index of first character </param>
  33         /// <param name="endPosition"> The index of first character after the last one expected </param>
  34         /// <returns> True on success, false otherwise </returns>
  35         [EditorBrowsable(EditorBrowsableState.Never)]
  36         bool AccessibilityCopyText(int startPosition, int endPosition);
  37
  38         /// <summary>
  39         /// Cuts text in range to system clipboard.
  40         /// </summary>
  41         /// <param name="startPosition"> The index of first character </param>
  42         /// <param name="endPosition"> The index of first character after the last one expected </param>
  43         /// <returns> True on success, false otherwise </returns>
  44         [EditorBrowsable(EditorBrowsableState.Never)]
  45         bool AccessibilityCutText(int startPosition, int endPosition);
  46
  47         /// <summary>
  48         /// Inserts text at startPosition.
  49         /// </summary>
  50         /// <param name="startPosition"> The index of first character </param>
  51         /// <param name="text"> The text content </param>
  52         /// <returns> True on success, false otherwise </returns>
  53         [EditorBrowsable(EditorBrowsableState.Never)]
  54         bool AccessibilityInsertText(int startPosition, string text);
  55
  56         /// <summary>
  57         /// Replaces text with content.
  58         /// </summary>
  59         /// <param name="newContents"> The text content </param>
  60         /// <returns> True on success, false otherwise </returns>
  61         [EditorBrowsable(EditorBrowsableState.Never)]
  62         bool AccessibilitySetTextContents(string newContents);
  63
  64         /// <summary>
  65         /// Deletes text in range.
  66         /// </summary>
  67         /// <param name="startPosition"> The index of first character </param>
  68         /// <param name="endPosition"> The index of first character after the last one expected </param>
  69         /// <returns> True on success, false otherwise </returns>
  70         [EditorBrowsable(EditorBrowsableState.Never)]
  71         bool AccessibilityDeleteText(int startPosition, int endPosition);
  72     }
  73 }