Mercurial > projects > dwt-mac

comparison dwt/accessibility/AccessibleTextListener.d @ 0:380af2bdd8e5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Upload of whole dwt tree
author Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
date Sat, 09 Aug 2008 17:00:02 +0200
parents
children f565d3a95c0a
comparison
equal deleted inserted replaced
-1:000000000000 0:380af2bdd8e5
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 * Port to the D Programming language:
12 * Jacob Carlborg <jacob.carlborg@gmail.com>
13 *******************************************************************************/
14 module dwt.accessibility.AccessibleTextListener;
15
16 import dwt.accessibility.AccessibleTextEvent;
17 import dwt.dwthelper.utils;
18 import dwt.internal.DWTEventListener;
19
20 /**
21 * Classes that implement this interface provide methods
22 * that deal with the events that are generated when an
23 * accessibility client sends a message to a control.
24 * <p>
25 * After creating an instance of a class that implements
26 * this interface it can be added to a control using the
27 * <code>addAccessibleTextListener</code> method and removed
28 * using the <code>removeAccessibleTextListener</code> method.
29 * When a client requests information the appropriate method
30 * will be invoked.
31 * </p><p>
32 * Note: Accessibility clients use child identifiers to specify
33 * whether they want information about a control or one of its children.
34 * Child identifiers are increasing integers beginning with 0.
35 * The identifier CHILDID_SELF represents the control itself.
36 * </p><p>
37 * Note: This interface is typically used by implementors of
38 * a custom control to provide very detailed information about
39 * the control instance to accessibility clients.
40 * </p>
41 *
42 * @see AccessibleTextAdapter
43 * @see AccessibleTextEvent
44 *
45 * @since 3.0
46 */
47 public interface AccessibleTextListener : DWTEventListener {
48
49 /**
50 * Sent when an accessibility client requests the current character offset
51 * of the text caret.
52 * <p>
53 * Return the caret offset in the <code>offset</code>
54 * field of the event object.
55 * </p>
56 *
57 * @param e an event object containing the following fields:<ul>
58 * <li>childID [IN] - an identifier specifying a child of the control</li>
59 * <li>offset [OUT] - the current offset of the text caret</li>
60 * </ul>
61 */
62 public void getCaretOffset (AccessibleTextEvent e);
63
64 /**
65 * Sent when an accessibility client requests the range of the current
66 * text selection.
67 * <p>
68 * Return the selection start offset and non-negative length in the
69 * <code>offset</code> and <code>length</code> fields of the event object.
70 * </p>
71 *
72 * @param e an event object containing the following fields:<ul>
73 * <li>childID [IN] - an identifier specifying a child of the control</li>
74 * <li>offset [OUT] - the offset of the current text selection</li>
75 * <li>length [OUT] - the length of the current text selection</li>
76 * </ul>
77 */
78 public void getSelectionRange (AccessibleTextEvent e);
79 }