/*******************************************************************************
 * Copyright (c) 2000, 2005 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
 *     
 * Port to the D programming language:
 *     Jacob Carlborg <jacob.carlborg@gmail.com>
 *******************************************************************************/
module dwt.custom.BidiSegmentListener;

import dwt.custom.BidiSegmentEvent;
import dwt.internal.DWTEventListener;

/**
 * This listener interface may be implemented in order to receive
 * BidiSegmentEvents.
 * @see BidiSegmentEvent
 */
public interface BidiSegmentListener : DWTEventListener {

    /**
     * This method is called when a line needs to be reordered for 
     * measuring or rendering in a bidi locale. 
     * <p>
     * The following event fields are used:<ul>
     * <li>event.lineOffset line start offset (input)</li>
     * <li>event.lineText line text (input)</li>
     * <li>event.segments text segments that should be reordered 
     *  separately. (output)</li> 
     * </ul>
     *
     * @param event the given event
     *  separately. (output)
     * @see BidiSegmentEvent
     */
    public void lineGetSegments (BidiSegmentEvent event);

}