bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/custom/BidiSegmentListener.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2016 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.custom;
  15
  16 import org.eclipse.swt.internal.*;
  17
  18 /**
  19  * This listener interface may be implemented in order to receive
  20  * BidiSegmentEvents.
  21  * @see BidiSegmentEvent
  22  */
  23 @FunctionalInterface
  24 public interface BidiSegmentListener extends SWTEventListener {
  25
  26 /**
  27  * This method is called when a line needs to be reordered for
  28  * measuring or rendering in a bidi locale.
  29  * <p>
  30  * The following event fields are used:<ul>
  31  * <li>event.lineOffset line start offset (input)</li>
  32  * <li>event.lineText line text (input)</li>
  33  * <li>event.segments text segments that should be reordered separately (output)</li>
  34  * <li>event.segmentsChars characters that should be inserted (output, optional)</li>
  35  * </ul>
  36  *
  37  * @param event the given event
  38  * @see BidiSegmentEvent
  39  */
  40 public void lineGetSegments(BidiSegmentEvent event);
  41
  42 }
  43