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

/*******************************************************************************
 * Copyright (c) 2000, 2007 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.SWTEventListener;

/**
 * This listener is invoked when a new offset is required based on the current
 * offset and a movement type.
 *
 * @see org.eclipse.swt.SWT#MOVEMENT_WORD
 * @see org.eclipse.swt.SWT#MOVEMENT_WORD_END 
 * @see org.eclipse.swt.SWT#MOVEMENT_WORD_START
 * @see org.eclipse.swt.SWT#MOVEMENT_CHAR
 * @see org.eclipse.swt.SWT#MOVEMENT_CLUSTER
 * 
 * @since 3.3
 */
public interface MovementListener extends SWTEventListener {
/**
 * This method is called when a new offset is required based on the current
 * offset and a movement type.
 * 
 * 
 * The following event fields are used:

 * event.lineOffset line start offset (input)
 * event.lineText line text (input)
 * event.movement the movement type (input)
 * event.offset the current offset (input)
 * event.newOffset the new offset (input, output)
 * 
 *
 * @param event the event
 * 
 * @see MovementEvent
 * @see StyledText#addWordMovementListener(MovementListener)
 */
public void getNextOffset (MovementEvent event);
/**
 * This method is called when a new offset is required based on the current
 * offset and a movement type.
 * 
 * 
 * The following event fields are used:

 * event.lineOffset line start offset (input)
 * event.lineText line text (input)
 * event.movement the movement type (input)
 * event.offset the current offset (input)
 * event.newOffset the new offset (input, output)
 * 
 *
 * @param event the event
 * 
 * @see MovementEvent
 * @see StyledText#addWordMovementListener(MovementListener)
 */
public void getPreviousOffset (MovementEvent event);

}