bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/custom/MovementListener.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2007 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 import org.eclipse.swt.internal.SWTEventListener;
  17
  18 /**
  19  * This listener is invoked when a new offset is required based on the current
  20  * offset and a movement type.
  21  *
  22  * @see org.eclipse.swt.SWT#MOVEMENT_WORD
  23  * @see org.eclipse.swt.SWT#MOVEMENT_WORD_END
  24  * @see org.eclipse.swt.SWT#MOVEMENT_WORD_START
  25  * @see org.eclipse.swt.SWT#MOVEMENT_CHAR
  26  * @see org.eclipse.swt.SWT#MOVEMENT_CLUSTER
  27  *
  28  * @since 3.3
  29  */
  30 public interface MovementListener extends SWTEventListener {
  31 /**
  32  * This method is called when a new offset is required based on the current
  33  * offset and a movement type.
  34  *
  35  * <p>
  36  * The following event fields are used:<ul>
  37  * <li>event.lineOffset line start offset (input)</li>
  38  * <li>event.lineText line text (input)</li>
  39  * <li>event.movement the movement type (input)</li>
  40  * <li>event.offset the current offset (input)</li>
  41  * <li>event.newOffset the new offset (input, output)</li>
  42  * </ul>
  43  *
  44  * @param event the event
  45  *
  46  * @see MovementEvent
  47  * @see StyledText#addWordMovementListener(MovementListener)
  48  */
  49 public void getNextOffset (MovementEvent event);
  50 /**
  51  * This method is called when a new offset is required based on the current
  52  * offset and a movement type.
  53  *
  54  * <p>
  55  * The following event fields are used:<ul>
  56  * <li>event.lineOffset line start offset (input)</li>
  57  * <li>event.lineText line text (input)</li>
  58  * <li>event.movement the movement type (input)</li>
  59  * <li>event.offset the current offset (input)</li>
  60  * <li>event.newOffset the new offset (input, output)</li>
  61  * </ul>
  62  *
  63  * @param event the event
  64  *
  65  * @see MovementEvent
  66  * @see StyledText#addWordMovementListener(MovementListener)
  67  */
  68 public void getPreviousOffset (MovementEvent event);
  69
  70 }