001: /*******************************************************************************
002: * Copyright (c) 2000, 2006 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.swt.accessibility;
011:
012: import org.eclipse.swt.internal.SWTEventListener;
013:
014: /**
015: * Classes that implement this interface provide methods
016: * that deal with the events that are generated when an
017: * accessibility client sends a message to a control.
018: * <p>
019: * After creating an instance of a class that implements
020: * this interface it can be added to a control using the
021: * <code>addAccessibleControlListener</code> method and removed
022: * using the <code>removeAccessibleControlListener</code> method.
023: * When a client requests information the appropriate method
024: * will be invoked.
025: * </p><p>
026: * Note: Accessibility clients use child identifiers to specify
027: * whether they want information about a control or one of its children.
028: * Child identifiers are increasing integers beginning with 0.
029: * The identifier CHILDID_SELF represents the control itself.
030: * </p><p>
031: * Note: This interface is typically used by implementors of
032: * a custom control to provide very detailed information about
033: * the control instance to accessibility clients.
034: * </p>
035: *
036: * @see AccessibleControlAdapter
037: * @see AccessibleControlEvent
038: *
039: * @since 2.0
040: */
041: public interface AccessibleControlListener extends SWTEventListener {
042:
043: /**
044: * Sent when an accessibility client requests the identifier
045: * of the control child at the specified display coordinates.
046: * <p>
047: * Return the identifier of the child at display point (x, y)
048: * in the <code>childID</code> field of the event object.
049: * Return CHILDID_SELF if point (x, y) is in the control itself
050: * and not in any child. Return CHILDID_NONE if point (x, y)
051: * is not contained in either the control or any of its children.
052: * </p>
053: *
054: * @param e an event object containing the following fields:<ul>
055: * <li>x, y [IN] - the specified point in display coordinates</li>
056: * <li>childID [Typical OUT] - the ID of the child at point, or CHILDID_SELF, or CHILDID_NONE</li>
057: * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li>
058: * </ul>
059: */
060: public void getChildAtPoint(AccessibleControlEvent e);
061:
062: /**
063: * Sent when an accessibility client requests the location
064: * of the control, or the location of a child of the control.
065: * <p>
066: * Return a rectangle describing the location of the specified
067: * control or child in the <code>x, y, width, and height</code>
068: * fields of the event object.
069: * </p>
070: *
071: * @param e an event object containing the following fields:<ul>
072: * <li>childID [IN] - an identifier specifying the control or one of its children</li>
073: * <li>x, y, width, height [OUT] - the control or child location in display coordinates</li>
074: * </ul>
075: */
076: public void getLocation(AccessibleControlEvent e);
077:
078: /**
079: * Sent when an accessibility client requests the accessible object
080: * for a child of the control.
081: * <p>
082: * Return an <code>Accessible</code> for the specified control or
083: * child in the <code>accessible</code> field of the event object.
084: * Return null if the specified child does not have its own
085: * <code>Accessible</code>.
086: * </p>
087: *
088: * @param e an event object containing the following fields:<ul>
089: * <li>childID [IN] - an identifier specifying a child of the control</li>
090: * <li>accessible [OUT] - an Accessible for the specified childID, or null if one does not exist</li>
091: * </ul>
092: */
093: public void getChild(AccessibleControlEvent e);
094:
095: /**
096: * Sent when an accessibility client requests the number of
097: * children in the control.
098: * <p>
099: * Return the number of child items in the <code>detail</code>
100: * field of the event object.
101: * </p>
102: *
103: * @param e an event object containing the following fields:<ul>
104: * <li>detail [OUT] - the number of child items in this control</li>
105: * </ul>
106: */
107: public void getChildCount(AccessibleControlEvent e);
108:
109: /**
110: * Sent when an accessibility client requests the default action
111: * of the control, or the default action of a child of the control.
112: * <p>
113: * This string is typically a verb describing what the user does to it.
114: * For example, a Push Button's default action is "Press", a Check Button's
115: * is "Check" or "UnCheck", and List items have the default action "Double Click".
116: * </p><p>
117: * Return a string describing the default action of the specified
118: * control or child in the <code>result</code> field of the event object.
119: * Returning null tells the client to use the platform default action string.
120: * </p>
121: *
122: * @param e an event object containing the following fields:<ul>
123: * <li>childID [IN] - an identifier specifying the control or one of its children</li>
124: * <li>result [OUT] - the requested default action string, or null</li>
125: * </ul>
126: */
127: public void getDefaultAction(AccessibleControlEvent e);
128:
129: /**
130: * Sent when an accessibility client requests the identity of
131: * the child or control that has keyboard focus.
132: * <p>
133: * Return the identifier of the child that has focus in the
134: * <code>childID</code> field of the event object.
135: * Return CHILDID_SELF if the control itself has keyboard focus.
136: * Return CHILDID_NONE if neither the control nor any of its children has focus.
137: * </p>
138: *
139: * @param e an event object containing the following fields:<ul>
140: * <li>childID [Typical OUT] - the ID of the child with focus, or CHILDID_SELF, or CHILDID_NONE</li>
141: * <li>accessible [Optional OUT] - the accessible object for a child may be returned instead of its childID</li>
142: * </ul>
143: */
144: public void getFocus(AccessibleControlEvent e);
145:
146: /**
147: * Sent when an accessibility client requests the role
148: * of the control, or the role of a child of the control.
149: * <p>
150: * Return a role constant (constant defined in ACC beginning with ROLE_)
151: * that describes the role of the specified control or child in the
152: * <code>detail</code> field of the event object.
153: * </p>
154: *
155: * @param e an event object containing the following fields:<ul>
156: * <li>childID [IN] - an identifier specifying the control or one of its children</li>
157: * <li>detail [OUT] - a role constant describing the role of the control or child</li>
158: * </ul>
159: */
160: public void getRole(AccessibleControlEvent e);
161:
162: /**
163: * Sent when an accessibility client requests the identity of
164: * the child or control that is currently selected.
165: * <p>
166: * Return the identifier of the selected child in the
167: * <code>childID</code> field of the event object.
168: * Return CHILDID_SELF if the control itself is selected.
169: * Return CHILDID_MULTIPLE if multiple children are selected, and return an array of childIDs in the <code>children</code> field.
170: * Return CHILDID_NONE if neither the control nor any of its children are selected.
171: * </p>
172: *
173: * @param e an event object containing the following fields:<ul>
174: * <li>childID [Typical OUT] - the ID of the selected child, or CHILDID_SELF, or CHILDID_MULTIPLE, or CHILDID_NONE</li>
175: * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li>
176: * </ul>
177: */
178: public void getSelection(AccessibleControlEvent e);
179:
180: /**
181: * Sent when an accessibility client requests the state
182: * of the control, or the state of a child of the control.
183: * <p>
184: * Return a state mask (mask bit constants defined in ACC beginning with STATE_)
185: * that describes the current state of the specified control or child in the
186: * <code>detail</code> field of the event object.
187: * </p>
188: *
189: * @param e an event object containing the following fields:<ul>
190: * <li>childID [IN] - an identifier specifying the control or one of its children</li>
191: * <li>detail [OUT] - a state mask describing the current state of the control or child</li>
192: * </ul>
193: */
194: public void getState(AccessibleControlEvent e);
195:
196: /**
197: * Sent when an accessibility client requests the value
198: * of the control, or the value of a child of the control.
199: * <p>
200: * Many controls do not return a value. Examples of controls
201: * that do are: Combo returns the text string, Text returns
202: * its contents, ProgressBar returns a string representing a
203: * percentage, and Tree items return a string representing
204: * their level in the tree.
205: * </p><p>
206: * Return a string describing the value of the specified control
207: * or child in the <code>result</code> field of the event object.
208: * Returning null tells the client to use the platform value string.
209: * </p>
210: *
211: * @param e an event object containing the following fields:<ul>
212: * <li>childID [IN] - an identifier specifying the control or one of its children</li>
213: * <li>result [OUT] - the requested value string, or null</li>
214: * </ul>
215: */
216: public void getValue(AccessibleControlEvent e);
217:
218: /**
219: * Sent when an accessibility client requests the children of the control.
220: * <p>
221: * Return the children as an array of childIDs in the <code>children</code>
222: * field of the event object.
223: * </p>
224: *
225: * @param e an event object containing the following fields:<ul>
226: * <li>children [Typical OUT] - an array of childIDs</li>
227: * <li>children [Optional OUT] - an array of accessible objects for the children may be returned instead of the childIDs</li>
228: * </ul>
229: */
230: public void getChildren(AccessibleControlEvent e);
231: }
|