bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/custom/LineStyleListener.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  * Classes which implement this interface provide a method
  20  * that can provide the style information for a line that
  21  * is to be drawn.
  22  *
  23  * @see LineStyleEvent
  24  * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
  25  */
  26 @FunctionalInterface
  27 public interface LineStyleListener extends SWTEventListener {
  28
  29 /**
  30  * This method is called when a line is about to be drawn in order to get the
  31  * line's style information.
  32  * <p>
  33  * The following event fields are used:<ul>
  34  * <li>event.lineOffset line start offset (input)</li>
  35  * <li>event.lineText line text (input)</li>
  36  * <li>event.styles array of StyleRanges, need to be in order (output)</li>
  37  * </ul>
  38  *
  39  * @param event the given event
  40  * @see LineStyleEvent
  41  */
  42 public void lineGetStyle(LineStyleEvent event);
  43 }