bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/custom/PaintObjectListener.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
  17 import org.eclipse.swt.internal.*;
  18 /**
  19  * This listener is invoked when an object needs to be drawn.
  20  *
  21  * @since 3.2
  22  */
  23 @FunctionalInterface
  24 public interface PaintObjectListener extends SWTEventListener {
  25 /**
  26  * This method is called when an object needs to be drawn.
  27  *
  28  * <p>
  29  * The following event fields are used:<ul>
  30  * <li>event.x the x location (input)</li>
  31  * <li>event.y the y location (input)</li>
  32  * <li>event.ascent the line ascent (input)</li>
  33  * <li>event.descent the line descent (input)</li>
  34  * <li>event.gc the gc (input)</li>
  35  * <li>event.style the style (input)</li>
  36  * </ul>
  37  *
  38  * @param event the event
  39  *
  40  * @see PaintObjectEvent
  41  * @see StyledText#addPaintObjectListener(PaintObjectListener)
  42  */
  43 public void paintObject(PaintObjectEvent event);
  44 }