org.eclipse.swt.custom.LineBackgroundListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2016 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.custom;

import org.eclipse.swt.internal.*;

/**
 * Classes which implement this interface provide a method
 * that can provide the background color for a line that
 * is to be drawn.
 *
 * @see LineBackgroundEvent
 * @see Sample code and further information
 */
@FunctionalInterface
public interface LineBackgroundListener extends SWTEventListener {

/**
 * This method is called when a line is about to be drawn in order to get its
 * background color.
 * 
 * The following event fields are used:

 * event.lineOffset line start offset (input)
 * event.lineText line text (input)
 * event.lineBackground line background color (output)
 * 
 *
 * @param event the given event
 * @see LineBackgroundEvent
 */
public void lineGetBackground(LineBackgroundEvent event);
}