bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/accessibility/AccessibleTextEvent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2017 IBM Corporation and others.
   3  *
   4  * This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License 2.0
   6  * which accompanies this distribution, and is available at
   7  * https://www.eclipse.org/legal/epl-2.0/
   8  *
   9  * SPDX-License-Identifier: EPL-2.0
  10  *
  11  * Contributors:
  12  *     IBM Corporation - initial API and implementation
  13  *******************************************************************************/
  14 package org.eclipse.swt.accessibility;
  15
  16
  17 import java.util.*;
  18
  19 import org.eclipse.swt.graphics.*;
  20
  21 /**
  22  * Instances of this class are sent as a result of
  23  * accessibility clients sending messages to controls
  24  * asking for detailed information about the implementation
  25  * of the control instance. Typically, only implementors
  26  * of custom controls need to listen for this event.
  27  * <p>
  28  * Note: The meaning of each field depends on the
  29  * message that was sent.
  30  * </p>
  31  *
  32  * @see AccessibleTextListener
  33  * @see AccessibleTextAdapter
  34  * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
  35  *
  36  * @since 3.0
  37  */
  38 public class AccessibleTextEvent extends EventObject {
  39         public int childID;                             // IN
  40         public int offset, length;              // OUT
  41         /** @since 3.6 */
  42         public Accessible accessible;
  43
  44         /**
  45          * The value of this field must be set in the accessible text extended listener method
  46          * before returning. What to set it to depends on the listener method called.
  47          * @since 3.6
  48          */
  49         public String result;
  50
  51         /** @since 3.6 */
  52         public int count;
  53         /** @since 3.6 */
  54         public int index;
  55         /** @since 3.6 */
  56         public int start, end;
  57         /** @since 3.6 */
  58         public int type;
  59         /** @since 3.6 */
  60         public int x, y, width, height;
  61         /** @since 3.6 */
  62         public int [] ranges;
  63         /** @since 3.6 */
  64         public Rectangle [] rectangles;
  65
  66         static final long serialVersionUID = 3977019530868308275L;
  67
  68 /**
  69  * Constructs a new instance of this class.
  70  *
  71  * @param source the object that fired the event
  72  */
  73 public AccessibleTextEvent (Object source) {
  74         super (source);
  75 }
  76
  77 /**
  78  * Returns a string containing a concise, human-readable
  79  * description of the receiver.
  80  *
  81  * @return a string representation of the event
  82  */
  83 @Override
  84 public String toString () {
  85         return "AccessibleTextEvent {childID=" + childID +  //$NON-NLS-1$
  86                 " offset=" + offset +  //$NON-NLS-1$
  87                 " length=" + length +  //$NON-NLS-1$
  88                 "}"; //$NON-NLS-1$
  89 }
  90 }