org.eclipse.swt.accessibility.AccessibleTextListener Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.swt.win32.win32.x86 Show documentation

SWT is an open source widget toolkit for Java designed to provide efficient, portable access to the user-interface facilities of the operating systems on which it is implemented.

The newest version!

/*******************************************************************************
 * 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
 *******************************************************************************/
package org.eclipse.swt.accessibility;


import org.eclipse.swt.internal.*;

/**
 * Classes that implement this interface provide methods
 * that deal with the events that are generated when an
 * accessibility client sends a message to a control.
 * 
 * After creating an instance of a class that implements
 * this interface it can be added to a control using the
 * addAccessibleTextListener method and removed
 * using the removeAccessibleTextListener method.
 * When a client requests information the appropriate method
 * will be invoked.
 * 

 * Note: Accessibility clients use child identifiers to specify
 * whether they want information about a control or one of its children.
 * Child identifiers are increasing integers beginning with 0.
 * The identifier CHILDID_SELF represents the control itself.
 * 

 * Note: This interface is typically used by implementors of
 * a custom control to provide very detailed information about
 * the control instance to accessibility clients.
 * 
 *
 * @see AccessibleTextAdapter
 * @see AccessibleTextEvent
 * 
 * @since 3.0
 */
public interface AccessibleTextListener extends SWTEventListener {
	
	/**
	 * Sent when an accessibility client requests the current character offset
	 * of the text caret.
	 * 
	 * Return the caret offset in the offset
	 * field of the event object.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 *    childID [IN] - an identifier specifying a child of the control
	 *    offset [OUT] - the current offset of the text caret
	 * 
	 */
	public void getCaretOffset (AccessibleTextEvent e);

	/**
	 * Sent when an accessibility client requests the range of the current
	 * text selection.
	 * 
	 * Return the selection start offset and non-negative length in the
	 * offset and length fields of the event object.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 *    childID [IN] - an identifier specifying a child of the control
	 *    offset [OUT] - the offset of the current text selection
	 *    length [OUT] - the length of the current text selection
	 * 
	 */
	public void getSelectionRange (AccessibleTextEvent e);
}