diff options
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility')
11 files changed, 0 insertions, 1184 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/ACC.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/ACC.java deleted file mode 100644 index 79179c52ce..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/ACC.java +++ /dev/null @@ -1,81 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2009 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; - - -/** - * Class ACC contains all the constants used in defining an - * Accessible object. - * - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> - * - * @since 2.0 - */ -public class ACC { - public static final int STATE_NORMAL = 0x00000000; - public static final int STATE_SELECTED = 0x00000002; - public static final int STATE_SELECTABLE = 0x00200000; - public static final int STATE_MULTISELECTABLE = 0x1000000; - public static final int STATE_FOCUSED = 0x00000004; - public static final int STATE_FOCUSABLE = 0x00100000; - public static final int STATE_PRESSED = 0x8; - public static final int STATE_CHECKED = 0x10; - public static final int STATE_EXPANDED = 0x200; - public static final int STATE_COLLAPSED = 0x400; - public static final int STATE_HOTTRACKED = 0x80; - public static final int STATE_BUSY = 0x800; - public static final int STATE_READONLY = 0x40; - public static final int STATE_INVISIBLE = 0x8000; - public static final int STATE_OFFSCREEN = 0x10000; - public static final int STATE_SIZEABLE = 0x20000; - public static final int STATE_LINKED = 0x400000; - - public static final int ROLE_CLIENT_AREA = 0xa; - public static final int ROLE_WINDOW = 0x9; - public static final int ROLE_MENUBAR = 0x2; - public static final int ROLE_MENU = 0xb; - public static final int ROLE_MENUITEM = 0xc; - public static final int ROLE_SEPARATOR = 0x15; - public static final int ROLE_TOOLTIP = 0xd; - public static final int ROLE_SCROLLBAR = 0x3; - public static final int ROLE_DIALOG = 0x12; - public static final int ROLE_LABEL = 0x29; - public static final int ROLE_PUSHBUTTON = 0x2b; - public static final int ROLE_CHECKBUTTON = 0x2c; - public static final int ROLE_RADIOBUTTON = 0x2d; - /** @since 3.5 */ - public static final int ROLE_SPLITBUTTON = 0x3e; - public static final int ROLE_COMBOBOX = 0x2e; - public static final int ROLE_TEXT = 0x2a; - public static final int ROLE_TOOLBAR = 0x16; - public static final int ROLE_LIST = 0x21; - public static final int ROLE_LISTITEM = 0x22; - public static final int ROLE_TABLE = 0x18; - public static final int ROLE_TABLECELL = 0x1d; - public static final int ROLE_TABLECOLUMNHEADER = 0x19; - /** @deprecated use ROLE_TABLECOLUMNHEADER */ - public static final int ROLE_TABLECOLUMN = ROLE_TABLECOLUMNHEADER; - public static final int ROLE_TABLEROWHEADER = 0x1a; - public static final int ROLE_TREE = 0x23; - public static final int ROLE_TREEITEM = 0x24; - public static final int ROLE_TABFOLDER = 0x3c; - public static final int ROLE_TABITEM = 0x25; - public static final int ROLE_PROGRESSBAR = 0x30; - public static final int ROLE_SLIDER = 0x33; - public static final int ROLE_LINK = 0x1e; - - public static final int CHILDID_SELF = -1; - public static final int CHILDID_NONE = -2; - public static final int CHILDID_MULTIPLE = -3; - - public static final int TEXT_INSERT = 0; - public static final int TEXT_DELETE = 1; -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAdapter.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAdapter.java deleted file mode 100644 index 28fac4de4e..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAdapter.java +++ /dev/null @@ -1,129 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2008 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; - - -/** - * This adapter class provides default implementations for the - * methods described by the <code>AccessibleListener</code> interface. - * <p> - * Classes that wish to deal with <code>AccessibleEvent</code>s can - * extend this class and override only the methods that they are - * interested in. - * </p><p> - * 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. - * </p> - * - * @see AccessibleListener - * @see AccessibleEvent - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> - * - * @since 2.0 - */ -public abstract class AccessibleAdapter implements AccessibleListener { - - /** - * Sent when an accessibility client requests the name - * of the control, or the name of a child of the control. - * The default behavior is to do nothing. - * <p> - * Return the name of the control or specified child in the - * <code>result</code> 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. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested name string, or null</li> - * </ul> - */ - 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 default behavior is to do nothing. - * <p> - * 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. - * </p><p> - * Return the help string of the control or specified child in - * the <code>result</code> 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. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested help string, or null</li> - * </ul> - */ - 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. - * The default behavior is to do nothing. - * <p> - * 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. - * </p><p> - * Return the keyboard shortcut string of the control or specified child - * in the <code>result</code> 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. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested keyboard shortcut string (example: "ALT+N"), or null</li> - * </ul> - */ - 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. - * The default behavior is to do nothing. - * <p> - * 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. - * </p><p> - * Return the description of the control or specified child in - * the <code>result</code> 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. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested description string, or null</li> - * </ul> - */ - public void getDescription(AccessibleEvent e) { - } -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlAdapter.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlAdapter.java deleted file mode 100644 index 1dfc71882e..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlAdapter.java +++ /dev/null @@ -1,252 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2008 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; - - -/** - * This adapter class provides default implementations for the - * methods described by the <code>AccessibleControlListener</code> interface. - * <p> - * Classes that wish to deal with <code>AccessibleControlEvent</code>s can - * extend this class and override only the methods that they are - * interested in. - * </p><p> - * 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. - * When returning a child identifier to a client, you may use CHILDID_NONE - * to indicate that no child or control has the required information. - * </p><p> - * Note: This adapter is typically used by implementors of - * a custom control to provide very detailed information about - * the control instance to accessibility clients. - * </p> - * - * @see AccessibleControlListener - * @see AccessibleControlEvent - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> - * - * @since 2.0 - */ -public abstract class AccessibleControlAdapter implements AccessibleControlListener { - - /** - * Sent when an accessibility client requests the identifier - * of the control child at the specified display coordinates. - * The default behavior is to do nothing. - * <p> - * Return the identifier of the child at display point (x, y) - * in the <code>childID</code> field of the event object. - * Return CHILDID_SELF if point (x, y) is in the control itself - * and not in any child. Return CHILDID_NONE if point (x, y) - * is not contained in either the control or any of its children. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>x, y [IN] - the specified point in display coordinates</li> - * <li>childID [Typical OUT] - the ID of the child at point, or CHILDID_SELF, or CHILDID_NONE</li> - * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li> - * </ul> - */ - public void getChildAtPoint(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the location - * of the control, or the location of a child of the control. - * The default behavior is to do nothing. - * <p> - * Return a rectangle describing the location of the specified - * control or child in the <code>x, y, width, and height</code> - * fields of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>x, y, width, height [OUT] - the control or child location in display coordinates</li> - * </ul> - */ - public void getLocation(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the accessible object - * for a child of the control. - * The default behavior is to do nothing. - * <p> - * Return an <code>Accessible</code> for the specified control or - * child in the <code>accessible</code> field of the event object. - * Return null if the specified child does not have its own - * <code>Accessible</code>. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying a child of the control</li> - * <li>accessible [OUT] - an Accessible for the specified childID, or null if one does not exist</li> - * </ul> - */ - public void getChild(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the number of - * children in the control. - * The default behavior is to do nothing. - * <p> - * Return the number of child items in the <code>detail</code> - * field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>detail [OUT] - the number of child items in this control</li> - * </ul> - */ - public void getChildCount(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the default action - * of the control, or the default action of a child of the control. - * The default behavior is to do nothing. - * <p> - * This string is typically a verb describing what the user does to it. - * For example, a Push Button's default action is "Press", a Check Button's - * is "Check" or "UnCheck", and List items have the default action "Double Click". - * </p><p> - * Return a string describing the default action of the specified - * control or child in the <code>result</code> field of the event object. - * Returning null tells the client to use the platform default action string. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested default action string, or null</li> - * </ul> - */ - public void getDefaultAction(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the identity of - * the child or control that has keyboard focus. - * The default behavior is to do nothing. - * <p> - * Return the identifier of the child that has focus in the - * <code>childID</code> field of the event object. - * Return CHILDID_SELF if the control itself has keyboard focus. - * Return CHILDID_NONE if neither the control nor any of its children has focus. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [Typical OUT] - the ID of the child with focus, or CHILDID_SELF, or CHILDID_NONE</li> - * <li>accessible [Optional OUT] - the accessible object for a child may be returned instead of its childID</li> - * </ul> - */ - public void getFocus(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the role - * of the control, or the role of a child of the control. - * The default behavior is to do nothing. - * <p> - * Return a role constant (constant defined in ACC beginning with ROLE_) - * that describes the role of the specified control or child in the - * <code>detail</code> field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>detail [OUT] - a role constant describing the role of the control or child</li> - * </ul> - */ - public void getRole(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the identity of - * the child or control that is currently selected. - * The default behavior is to do nothing. - * <p> - * Return the identifier of the selected child in the - * <code>childID</code> field of the event object. - * Return CHILDID_SELF if the control itself is selected. - * Return CHILDID_MULTIPLE if multiple children are selected, and return an array of childIDs in the <code>children</code> field. - * Return CHILDID_NONE if neither the control nor any of its children are selected. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [Typical OUT] - the ID of the selected child, or CHILDID_SELF, or CHILDID_MULTIPLE, or CHILDID_NONE</li> - * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li> - * </ul> - */ - public void getSelection(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the state - * of the control, or the state of a child of the control. - * The default behavior is to do nothing. - * <p> - * Return a state mask (mask bit constants defined in ACC beginning with STATE_) - * that describes the current state of the specified control or child in the - * <code>detail</code> field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>detail [OUT] - a state mask describing the current state of the control or child</li> - * </ul> - */ - public void getState(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the value - * of the control, or the value of a child of the control. - * The default behavior is to do nothing. - * <p> - * Many controls do not return a value. Examples of controls - * that do are: Combo returns the text string, Text returns - * its contents, ProgressBar returns a string representing a - * percentage, and Tree items return a string representing - * their level in the tree. - * </p><p> - * Return a string describing the value of the specified control - * or child in the <code>result</code> field of the event object. - * Returning null tells the client to use the platform value string. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested value string, or null</li> - * </ul> - */ - public void getValue(AccessibleControlEvent e) { - } - - /** - * Sent when an accessibility client requests the children of the control. - * The default behavior is to do nothing. - * <p> - * Return the children as an array of childIDs in the <code>children</code> - * field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>children [Typical OUT] - an array of childIDs</li> - * <li>accessible [Optional OUT] - an array of accessible objects for the children may be returned instead of the childIDs</li> - * </ul> - */ - public void getChildren(AccessibleControlEvent e) { - } -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlEvent.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlEvent.java deleted file mode 100644 index c814b21cc0..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlEvent.java +++ /dev/null @@ -1,70 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2008 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.SWTEventObject; - -/** - * Instances of this class are sent as a result of - * accessibility clients sending messages to controls - * asking for detailed information about the implementation - * of the control instance. Typically, only implementors - * of custom controls need to listen for this event. - * <p> - * Note: The meaning of each field depends on the - * message that was sent. - * </p> - * - * @see AccessibleControlListener - * @see AccessibleControlAdapter - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> - * - * @since 2.0 - */ -public class AccessibleControlEvent extends SWTEventObject { - public int childID; // IN/OUT - public Accessible accessible; // OUT - public int x, y; // IN/OUT - public int width, height; // OUT - public int detail; // IN/OUT - public String result; // OUT - public Object children[]; // [OUT] - - static final long serialVersionUID = 3257281444169529141L; - -/** - * Constructs a new instance of this class. - * - * @param source the object that fired the event - */ -public AccessibleControlEvent(Object source) { - super(source); -} - -/** - * Returns a string containing a concise, human-readable - * description of the receiver. - * - * @return a string representation of the event - */ -public String toString () { - return "AccessibleControlEvent {childID=" + childID + //$NON-NLS-1$ - " accessible=" + accessible + //$NON-NLS-1$ - " x=" + x + //$NON-NLS-1$ - " y=" + y + //$NON-NLS-1$ - " width=" + width + //$NON-NLS-1$ - " height=" + height + //$NON-NLS-1$ - " detail=" + detail + //$NON-NLS-1$ - " result=" + result + //$NON-NLS-1$ - "}"; //$NON-NLS-1$ -} -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlListener.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlListener.java deleted file mode 100644 index 537f57bab4..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleControlListener.java +++ /dev/null @@ -1,233 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2006 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. - * <p> - * After creating an instance of a class that implements - * this interface it can be added to a control using the - * <code>addAccessibleControlListener</code> method and removed - * using the <code>removeAccessibleControlListener</code> method. - * When a client requests information the appropriate method - * will be invoked. - * </p><p> - * 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. - * </p><p> - * Note: This interface is typically used by implementors of - * a custom control to provide very detailed information about - * the control instance to accessibility clients. - * </p> - * - * @see AccessibleControlAdapter - * @see AccessibleControlEvent - * - * @since 2.0 - */ -public interface AccessibleControlListener extends SWTEventListener { - - /** - * Sent when an accessibility client requests the identifier - * of the control child at the specified display coordinates. - * <p> - * Return the identifier of the child at display point (x, y) - * in the <code>childID</code> field of the event object. - * Return CHILDID_SELF if point (x, y) is in the control itself - * and not in any child. Return CHILDID_NONE if point (x, y) - * is not contained in either the control or any of its children. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>x, y [IN] - the specified point in display coordinates</li> - * <li>childID [Typical OUT] - the ID of the child at point, or CHILDID_SELF, or CHILDID_NONE</li> - * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li> - * </ul> - */ - public void getChildAtPoint(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the location - * of the control, or the location of a child of the control. - * <p> - * Return a rectangle describing the location of the specified - * control or child in the <code>x, y, width, and height</code> - * fields of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>x, y, width, height [OUT] - the control or child location in display coordinates</li> - * </ul> - */ - public void getLocation(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the accessible object - * for a child of the control. - * <p> - * Return an <code>Accessible</code> for the specified control or - * child in the <code>accessible</code> field of the event object. - * Return null if the specified child does not have its own - * <code>Accessible</code>. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying a child of the control</li> - * <li>accessible [OUT] - an Accessible for the specified childID, or null if one does not exist</li> - * </ul> - */ - public void getChild(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the number of - * children in the control. - * <p> - * Return the number of child items in the <code>detail</code> - * field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>detail [OUT] - the number of child items in this control</li> - * </ul> - */ - public void getChildCount(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the default action - * of the control, or the default action of a child of the control. - * <p> - * This string is typically a verb describing what the user does to it. - * For example, a Push Button's default action is "Press", a Check Button's - * is "Check" or "UnCheck", and List items have the default action "Double Click". - * </p><p> - * Return a string describing the default action of the specified - * control or child in the <code>result</code> field of the event object. - * Returning null tells the client to use the platform default action string. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested default action string, or null</li> - * </ul> - */ - public void getDefaultAction(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the identity of - * the child or control that has keyboard focus. - * <p> - * Return the identifier of the child that has focus in the - * <code>childID</code> field of the event object. - * Return CHILDID_SELF if the control itself has keyboard focus. - * Return CHILDID_NONE if neither the control nor any of its children has focus. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [Typical OUT] - the ID of the child with focus, or CHILDID_SELF, or CHILDID_NONE</li> - * <li>accessible [Optional OUT] - the accessible object for a child may be returned instead of its childID</li> - * </ul> - */ - public void getFocus(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the role - * of the control, or the role of a child of the control. - * <p> - * Return a role constant (constant defined in ACC beginning with ROLE_) - * that describes the role of the specified control or child in the - * <code>detail</code> field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>detail [OUT] - a role constant describing the role of the control or child</li> - * </ul> - */ - public void getRole(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the identity of - * the child or control that is currently selected. - * <p> - * Return the identifier of the selected child in the - * <code>childID</code> field of the event object. - * Return CHILDID_SELF if the control itself is selected. - * Return CHILDID_MULTIPLE if multiple children are selected, and return an array of childIDs in the <code>children</code> field. - * Return CHILDID_NONE if neither the control nor any of its children are selected. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [Typical OUT] - the ID of the selected child, or CHILDID_SELF, or CHILDID_MULTIPLE, or CHILDID_NONE</li> - * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li> - * </ul> - */ - public void getSelection(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the state - * of the control, or the state of a child of the control. - * <p> - * Return a state mask (mask bit constants defined in ACC beginning with STATE_) - * that describes the current state of the specified control or child in the - * <code>detail</code> field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>detail [OUT] - a state mask describing the current state of the control or child</li> - * </ul> - */ - public void getState(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the value - * of the control, or the value of a child of the control. - * <p> - * Many controls do not return a value. Examples of controls - * that do are: Combo returns the text string, Text returns - * its contents, ProgressBar returns a string representing a - * percentage, and Tree items return a string representing - * their level in the tree. - * </p><p> - * Return a string describing the value of the specified control - * or child in the <code>result</code> field of the event object. - * Returning null tells the client to use the platform value string. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested value string, or null</li> - * </ul> - */ - public void getValue(AccessibleControlEvent e); - - /** - * Sent when an accessibility client requests the children of the control. - * <p> - * Return the children as an array of childIDs in the <code>children</code> - * field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>children [Typical OUT] - an array of childIDs</li> - * <li>children [Optional OUT] - an array of accessible objects for the children may be returned instead of the childIDs</li> - * </ul> - */ - public void getChildren(AccessibleControlEvent e); -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEvent.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEvent.java deleted file mode 100644 index a0a31aed4f..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEvent.java +++ /dev/null @@ -1,68 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2008 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.SWTEventObject; - -/** - * Instances of this class are sent as a result of - * accessibility clients sending messages to controls - * asking for information about the control instance. - * <p> - * Note: The meaning of the result field depends - * on the message that was sent. - * </p> - * - * @see AccessibleListener - * @see AccessibleAdapter - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> - * - * @since 2.0 - */ -public class AccessibleEvent extends SWTEventObject { - /** - * The value of this field is set by an accessibility client - * before the accessible listener method is called. - * ChildID can be CHILDID_SELF, representing the control itself, - * or a 0-based integer representing a specific child of the control. - */ - public int childID; - - /** - * The value of this field must be set in the accessible listener - * method before returning. - * What to set it to depends on the listener method called, and - * the childID specified by the client. - */ - public String result; - - static final long serialVersionUID = 3257567304224026934L; - -/** - * Constructs a new instance of this class. - * - * @param source the object that fired the event - */ -public AccessibleEvent(Object source) { - super(source); -} - -/** - * Returns a string containing a concise, human-readable - * description of the receiver. - * - * @return a string representation of the event - */ -public String toString () { - return "AccessibleEvent {childID=" + childID + " result=" + result + "}"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ -} -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleListener.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleListener.java deleted file mode 100644 index e54c7ead7a..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleListener.java +++ /dev/null @@ -1,126 +0,0 @@ -/******************************************************************************* - * 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. - * <p> - * After creating an instance of a class that implements - * this interface it can be added to a control using the - * <code>addAccessibleListener</code> method and removed - * using the <code>removeAccessibleListener</code> method. - * When a client requests information, the appropriate method - * will be invoked. - * </p><p> - * 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. - * </p> - * - * @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. - * <p> - * Return the name of the control or specified child in the - * <code>result</code> 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. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested name string, or null</li> - * </ul> - */ - 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. - * <p> - * 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. - * </p><p> - * Return the help string of the control or specified child in - * the <code>result</code> 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. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested help string, or null</li> - * </ul> - */ - 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. - * <p> - * 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. - * </p><p> - * Return the keyboard shortcut string of the control or specified child - * in the <code>result</code> 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. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested keyboard shortcut string (example: "ALT+N"), or null</li> - * </ul> - */ - 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. - * <p> - * 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. - * </p><p> - * Return the description of the control or specified child in - * the <code>result</code> 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. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying the control or one of its children</li> - * <li>result [OUT] - the requested description string, or null</li> - * </ul> - */ - public void getDescription(AccessibleEvent e); -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextAdapter.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextAdapter.java deleted file mode 100644 index 3038e3736f..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextAdapter.java +++ /dev/null @@ -1,76 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2008 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; - - -/** - * This adapter class provides default implementations for the - * methods described by the <code>AccessibleTextListener</code> interface. - * <p> - * Classes that wish to deal with <code>AccessibleTextEvent</code>s can - * extend this class and override only the methods that they are - * interested in. - * </p><p> - * 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. - * When returning a child identifier to a client, you may use CHILDID_NONE - * to indicate that no child or control has the required information. - * </p><p> - * Note: This adapter is typically used by implementors of - * a custom control to provide very detailed information about - * the control instance to accessibility clients. - * </p> - * - * @see AccessibleTextListener - * @see AccessibleTextEvent - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> - * - * @since 3.0 - */ -public abstract class AccessibleTextAdapter implements AccessibleTextListener { - - /** - * Sent when an accessibility client requests the current character offset - * of the text caret. - * The default behavior is to do nothing. - * <p> - * Return the caret offset in the <code>offset</code> - * field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying a child of the control</li> - * <li>offset [OUT] - the current offset of the text caret</li> - * </ul> - */ - public void getCaretOffset (AccessibleTextEvent e) { - } - - /** - * Sent when an accessibility client requests the range of the current - * text selection. - * The default behavior is to do nothing. - * <p> - * Return the selection start offset and non-negative length in the - * <code>offset</code> and <code>length</code> fields of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying a child of the control</li> - * <li>offset [OUT] - the offset of the current text selection</li> - * <li>length [OUT] - the length of the current text selection</li> - * </ul> - */ - public void getSelectionRange (AccessibleTextEvent e) { - } -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextEvent.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextEvent.java deleted file mode 100644 index 30e99eb7dd..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextEvent.java +++ /dev/null @@ -1,60 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2008 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.*; - -/** - * Instances of this class are sent as a result of - * accessibility clients sending messages to controls - * asking for detailed information about the implementation - * of the control instance. Typically, only implementors - * of custom controls need to listen for this event. - * <p> - * Note: The meaning of each field depends on the - * message that was sent. - * </p> - * - * @see AccessibleTextListener - * @see AccessibleTextAdapter - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> - * - * @since 3.0 - */ -public class AccessibleTextEvent extends SWTEventObject { - public int childID; // IN - public int offset, length; // OUT - - static final long serialVersionUID = 3977019530868308275L; - -/** - * Constructs a new instance of this class. - * - * @param source the object that fired the event - */ -public AccessibleTextEvent (Object source) { - super (source); -} - -/** - * Returns a string containing a concise, human-readable - * description of the receiver. - * - * @return a string representation of the event - */ -public String toString () { - return "AccessibleTextEvent {childID=" + childID + //$NON-NLS-1$ - " offset=" + offset + //$NON-NLS-1$ - " length=" + length + //$NON-NLS-1$ - "}"; //$NON-NLS-1$ -} -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextListener.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextListener.java deleted file mode 100644 index 8169e724df..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextListener.java +++ /dev/null @@ -1,75 +0,0 @@ -/******************************************************************************* - * 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. - * <p> - * After creating an instance of a class that implements - * this interface it can be added to a control using the - * <code>addAccessibleTextListener</code> method and removed - * using the <code>removeAccessibleTextListener</code> method. - * When a client requests information the appropriate method - * will be invoked. - * </p><p> - * 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. - * </p><p> - * Note: This interface is typically used by implementors of - * a custom control to provide very detailed information about - * the control instance to accessibility clients. - * </p> - * - * @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. - * <p> - * Return the caret offset in the <code>offset</code> - * field of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying a child of the control</li> - * <li>offset [OUT] - the current offset of the text caret</li> - * </ul> - */ - public void getCaretOffset (AccessibleTextEvent e); - - /** - * Sent when an accessibility client requests the range of the current - * text selection. - * <p> - * Return the selection start offset and non-negative length in the - * <code>offset</code> and <code>length</code> fields of the event object. - * </p> - * - * @param e an event object containing the following fields:<ul> - * <li>childID [IN] - an identifier specifying a child of the control</li> - * <li>offset [OUT] - the offset of the current text selection</li> - * <li>length [OUT] - the length of the current text selection</li> - * </ul> - */ - public void getSelectionRange (AccessibleTextEvent e); -} diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/package.html b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/package.html deleted file mode 100644 index ab6a590d3f..0000000000 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/package.html +++ /dev/null @@ -1,14 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> - <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> - <meta name="Author" content="IBM"> - <title>Package-level Javadoc</title> -</head> -<body> -SWT Accessibility. -<h2> -Package Specification</h2> -This package contains the classes that support platform accessibility. -</body> -</html> |