bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/events/SegmentListener.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2016s 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  *     Lars Vogel <Lars.Vogel@vogella.com> - Bug 502576
  14  *******************************************************************************/
  15 package org.eclipse.swt.events;
  16
  17 import org.eclipse.swt.internal.*;
  18
  19 /**
  20  * This listener interface may be implemented in order to receive
  21  * SegmentEvents.
  22  * @see SegmentEvent
  23  *
  24  * @since 3.8
  25  */
  26 @FunctionalInterface
  27 public interface SegmentListener extends SWTEventListener {
  28
  29 /**
  30  * This method is called when text content is being modified.
  31  * <p>
  32  * The following event fields are used:<ul>
  33  * <li>event.lineText text content (input)</li>
  34  * <li>event.segments text offsets for segment characters (output)</li>
  35  * <li>event.segmentsChars characters that should be inserted (output, optional)</li>
  36  * </ul>
  37  *
  38  * @param event the given event
  39  * @see SegmentEvent
  40  */
  41 void getSegments(SegmentEvent event);
  42
  43 }