Mercurial > projects > dwt2

comparison org.eclipse.swt.win32.win32.x86/src/org/eclipse/swt/accessibility/AccessibleAdapter.d @ 0:6dd524f61e62

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add dwt win and basic java stuff
author Frank Benoit <benoit@tionex.de>
date Mon, 02 Mar 2009 14:44:16 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:6dd524f61e62
1 /*******************************************************************************
2 * Copyright (c) 2000, 2008 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 * Port to the D programming language:
11 * Frank Benoit <benoit@tionex.de>
12 *******************************************************************************/
13 module org.eclipse.swt.accessibility.AccessibleAdapter;
14
15 import org.eclipse.swt.accessibility.AccessibleListener;
16 import org.eclipse.swt.accessibility.AccessibleEvent;
17
18 /**
19 * This adapter class provides default implementations for the
20 * methods described by the <code>AccessibleListener</code> interface.
21 * <p>
22 * Classes that wish to deal with <code>AccessibleEvent</code>s can
23 * extend this class and override only the methods that they are
24 * interested in.
25 * </p><p>
26 * Note: Accessibility clients use child identifiers to specify
27 * whether they want information about a control or one of its children.
28 * Child identifiers are increasing integers beginning with 0.
29 * The identifier CHILDID_SELF represents the control itself.
30 * </p>
31 *
32 * @see AccessibleListener
33 * @see AccessibleEvent
34 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
35 *
36 * @since 2.0
37 */
38 public abstract class AccessibleAdapter : AccessibleListener {
39
40 /**
41 * Sent when an accessibility client requests the name
42 * of the control, or the name of a child of the control.
43 * The default behavior is to do nothing.
44 * <p>
45 * Return the name of the control or specified child in the
46 * <code>result</code> field of the event object. Returning
47 * an empty string tells the client that the control or child
48 * does not have a name, and returning null tells the client
49 * to use the platform name.
50 * </p>
51 *
52 * @param e an event object containing the following fields:<ul>
53 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
54 * <li>result [OUT] - the requested name string, or null</li>
55 * </ul>
56 */
57 public void getName(AccessibleEvent e) {
58 }
59
60 /**
61 * Sent when an accessibility client requests the help string
62 * of the control, or the help string of a child of the control.
63 * The default behavior is to do nothing.
64 * <p>
65 * The information in this property should be similar to the help
66 * provided by toolTipText. It describes what the control or child
67 * does or how to use it, as opposed to getDescription, which
68 * describes appearance.
69 * </p><p>
70 * Return the help string of the control or specified child in
71 * the <code>result</code> field of the event object. Returning
72 * an empty string tells the client that the control or child
73 * does not have a help string, and returning null tells the
74 * client to use the platform help string.
75 * </p>
76 *
77 * @param e an event object containing the following fields:<ul>
78 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
79 * <li>result [OUT] - the requested help string, or null</li>
80 * </ul>
81 */
82 public void getHelp(AccessibleEvent e) {
83 }
84
85 /**
86 * Sent when an accessibility client requests the keyboard shortcut
87 * of the control, or the keyboard shortcut of a child of the control.
88 * The default behavior is to do nothing.
89 * <p>
90 * A keyboard shortcut can either be a mnemonic, or an accelerator.
91 * As a general rule, if the control or child can receive keyboard focus,
92 * then you should expose its mnemonic, and if it cannot receive keyboard
93 * focus, then you should expose its accelerator.
94 * </p><p>
95 * Return the keyboard shortcut string of the control or specified child
96 * in the <code>result</code> field of the event object. Returning an
97 * empty string tells the client that the control or child does not
98 * have a keyboard shortcut string, and returning null tells the client
99 * to use the platform keyboard shortcut string.
100 * </p>
101 *
102 * @param e an event object containing the following fields:<ul>
103 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
104 * <li>result [OUT] - the requested keyboard shortcut string (example: "ALT+N"), or null</li>
105 * </ul>
106 */
107 public void getKeyboardShortcut(AccessibleEvent e) {
108 }
109
110 /**
111 * Sent when an accessibility client requests a description
112 * of the control, or a description of a child of the control.
113 * The default behavior is to do nothing.
114 * <p>
115 * This is a textual description of the control or child's visual
116 * appearance, which is typically only necessary if it cannot be
117 * determined from other properties such as role.
118 * </p><p>
119 * Return the description of the control or specified child in
120 * the <code>result</code> field of the event object. Returning
121 * an empty string tells the client that the control or child
122 * does not have a description, and returning null tells the
123 * client to use the platform description.
124 * </p>
125 *
126 * @param e an event object containing the following fields:<ul>
127 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
128 * <li>result [OUT] - the requested description string, or null</li>
129 * </ul>
130 */
131 public void getDescription(AccessibleEvent e) {
132 }
133 }