Mercurial > projects > dwt-linux

comparison dwt/accessibility/AccessibleTextAdapter.d @ 42:787b5413b0ce

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
accessibility package
author Frank Benoit <benoit@tionex.de>
date Fri, 11 Jan 2008 05:07:22 +0100
parents
children 8cec8f536af3
comparison
equal deleted inserted replaced
41:c83c51423d03 42:787b5413b0ce
1 /*******************************************************************************
2 * Copyright (c) 2000, 2003 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
11 module dwt.accessibility.AccessibleTextAdapter;
12
13 import dwt.accessibility.AccessibleTextEvent;
14 import dwt.accessibility.AccessibleTextListener;
15
16 /**
17 * This adapter class provides default implementations for the
18 * methods described by the <code>AccessibleTextListener</code> interface.
19 * <p>
20 * Classes that wish to deal with <code>AccessibleTextEvent</code>s can
21 * extend this class and override only the methods that they are
22 * interested in.
23 * </p><p>
24 * Note: Accessibility clients use child identifiers to specify
25 * whether they want information about a control or one of its children.
26 * Child identifiers are increasing integers beginning with 0.
27 * The identifier CHILDID_SELF represents the control itself.
28 * When returning a child identifier to a client, you may use CHILDID_NONE
29 * to indicate that no child or control has the required information.
30 * </p><p>
31 * Note: This adapter is typically used by implementors of
32 * a custom control to provide very detailed information about
33 * the control instance to accessibility clients.
34 * </p>
35 *
36 * @see AccessibleTextListener
37 * @see AccessibleTextEvent
38 *
39 * @since 3.0
40 */
41 public abstract class AccessibleTextAdapter : AccessibleTextListener {
42
43 /**
44 * Sent when an accessibility client requests the current character offset
45 * of the text caret.
46 * The default behavior is to do nothing.
47 * <p>
48 * Return the caret offset in the <code>offset</code>
49 * field of the event object.
50 * </p>
51 *
52 * @param e an event object containing the following fields:<ul>
53 * <li>childID [IN] - an identifier specifying a child of the control</li>
54 * <li>offset [OUT] - the current offset of the text caret</li>
55 * </ul>
56 */
57 public void getCaretOffset (AccessibleTextEvent e) {
58 }
59
60 /**
61 * Sent when an accessibility client requests the range of the current
62 * text selection.
63 * The default behavior is to do nothing.
64 * <p>
65 * Return the selection start offset and non-negative length in the
66 * <code>offset</code> and <code>length</code> fields of the event object.
67 * </p>
68 *
69 * @param e an event object containing the following fields:<ul>
70 * <li>childID [IN] - an identifier specifying a child of the control</li>
71 * <li>offset [OUT] - the offset of the current text selection</li>
72 * <li>length [OUT] - the length of the current text selection</li>
73 * </ul>
74 */
75 public void getSelectionRange (AccessibleTextEvent e) {
76 }
77 }