org.eclipse.swt.accessibility.AccessibleListener 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.SWTEventListener;

/**
 * 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
 * addAccessibleListener method and removed
 * using the removeAccessibleListener 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.
 * 
 *
 * @see AccessibleAdapter
 * @see AccessibleEvent
 * 
 * @since 2.0
 */
public interface AccessibleListener extends SWTEventListener {

	/**
	 * Sent when an accessibility client requests the name
	 * of the control, or the name of a child of the control.
	 * 
	 * Return the name of the control or specified child in the
	 * result field of the event object. Returning
	 * an empty string tells the client that the control or child
	 * does not have a name, and returning null tells the client
	 * to use the platform name.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 *    childID [IN] - an identifier specifying the control or one of its children
	 *    result [OUT] - the requested name string, or null
	 * 
	 */
	public void getName(AccessibleEvent e);

	/**
	 * Sent when an accessibility client requests the help string
	 * of the control, or the help string of a child of the control.
	 * 
	 * The information in this property should be similar to the help
	 * provided by toolTipText. It describes what the control or child
	 * does or how to use it, as opposed to getDescription, which
	 * describes appearance.
	 * 

	 * Return the help string of the control or specified child in
	 * the result field of the event object. Returning
	 * an empty string tells the client that the control or child
	 * does not have a help string, and returning null tells the
	 * client to use the platform help string.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 *    childID [IN] - an identifier specifying the control or one of its children
	 *    result [OUT] - the requested help string, or null
	 * 
	 */
	public void getHelp(AccessibleEvent e);

	/**
	 * Sent when an accessibility client requests the keyboard shortcut
	 * of the control, or the keyboard shortcut of a child of the control.
	 * 
	 * A keyboard shortcut can either be a mnemonic, or an accelerator.
	 * As a general rule, if the control or child can receive keyboard focus,
	 * then you should expose its mnemonic, and if it cannot receive keyboard
	 * focus, then you should expose its accelerator.
	 * 

	 * Return the keyboard shortcut string of the control or specified child
	 * in the result field of the event object. Returning an
	 * empty string tells the client that the control or child does not
	 * have a keyboard shortcut string, and returning null tells the client
	 * to use the platform keyboard shortcut string.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 *    childID [IN] - an identifier specifying the control or one of its children
	 *    result [OUT] - the requested keyboard shortcut string (example: "ALT+N"), or null
	 * 
	 */
	public void getKeyboardShortcut(AccessibleEvent e);

	/**
	 * Sent when an accessibility client requests a description
	 * of the control, or a description of a child of the control.
	 * 
	 * This is a textual description of the control or child's visual
	 * appearance, which is typically only necessary if it cannot be
	 * determined from other properties such as role.
	 * 

	 * Return the description of the control or specified child in
	 * the result field of the event object. Returning
	 * an empty string tells the client that the control or child
	 * does not have a description, and returning null tells the
	 * client to use the platform description.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 *    childID [IN] - an identifier specifying the control or one of its children
	 *    result [OUT] - the requested description string, or null
	 * 
	 */
	public void getDescription(AccessibleEvent e);
}