1 /*******************************************************************************
2  * Copyright (c) 2000, 2008 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  * Port to the D programming language:
11  *     Frank Benoit <benoit@tionex.de>
12  *******************************************************************************/
13 module org.eclipse.swt.custom.LineBackgroundListener;
14 
15 import org.eclipse.swt.internal.SWTEventListener;
16 import org.eclipse.swt.custom.LineBackgroundEvent;
17 
18 /**
19  * Classes which implement this interface provide a method
20  * that can provide the background color for a line that
21  * is to be drawn.
22  *
23  * @see LineBackgroundEvent
24  * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
25  */
26 public interface LineBackgroundListener : SWTEventListener {
27 
28 /**
29  * This method is called when a line is about to be drawn in order to get its
30  * background color.
31  * <p>
32  * The following event fields are used:<ul>
33  * <li>event.lineOffset line start offset (input)</li>
34  * <li>event.lineText line text (input)</li>
35  * <li>event.lineBackground line background color (output)</li>
36  * </ul>
37  *
38  * @param event the given event
39  * @see LineBackgroundEvent
40  */
41 public void lineGetBackground(LineBackgroundEvent event);
42 }