org.eclipse.swt.accessibility.AccessibleValueListener Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2009, 2010 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 which implement this interface provide methods
* that handle AccessibleValue events.
*
* After creating an instance of a class that implements
* this interface it can be added to an accessible using the
* addAccessibleValueListener
method and removed using
* the removeAccessibleValueListener
method.
*
*
* @see AccessibleValueAdapter
* @see AccessibleValueEvent
*
* @since 3.6
*/
public interface AccessibleValueListener extends SWTEventListener {
/**
* Returns the value of this object as a number.
*
* @param e an event object containing the following fields:
* - [out] value - the number that is the current value of this object
*
*/
public void getCurrentValue(AccessibleValueEvent e);
/**
* Sets the value of this object to the given number.
*
* The argument is clipped to the valid interval whose upper and lower
* bounds are returned by getMaximumValue and getMinimumValue,
* i.e. if it is lower than the minimum value the new value will be the minimum,
* and if it is greater than the maximum then the new value will be the maximum.
*
* @param e an event object containing the following fields:
* - [in/out] value - on input, the number that will be the new value of this object
*
- on output, set to null if the value cannot be set
*
*/
public void setCurrentValue(AccessibleValueEvent e);
/**
* Returns the maximum value that can be represented by this object.
*
* @param e an event object containing the following fields:
* - [out] value - the number that is the maximum value that this object can represent.
* If this object has no upper bound then null is returned.
*
*/
public void getMaximumValue(AccessibleValueEvent e);
/**
* Returns the minimum value that can be represented by this object.
*
* @param e an event object containing the following fields:
* - [out] value - the number that is the minimum value that this object can represent.
* If this object has no lower bound then null is returned.
*
*/
public void getMinimumValue(AccessibleValueEvent e);
}