annotate dwt/accessibility/AccessibleEvent.d @ 123:63a09873578e

Fixed compile errors
author Jacob Carlborg <doob@me.com>
date Thu, 15 Jan 2009 23:08:54 +0100
parents d8635bb48c7c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
45
d8635bb48c7c Merge with SWT 3.5
Jacob Carlborg <doob@me.com>
parents: 36
diff changeset
1 /*******************************************************************************
d8635bb48c7c Merge with SWT 3.5
Jacob Carlborg <doob@me.com>
parents: 36
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
7 *
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
8 * Contributors:
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
10 *
13
f565d3a95c0a Ported dwt.internal
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents: 0
diff changeset
11 * Port to the D programming language:
45
d8635bb48c7c Merge with SWT 3.5
Jacob Carlborg <doob@me.com>
parents: 36
diff changeset
12 * Jacob Carlborg <doob@me.com>
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
13 *******************************************************************************/
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
14 module dwt.accessibility.AccessibleEvent;
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
15
36
db5a898b2119 Fixed a lot of compile errors
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents: 13
diff changeset
16 import dwt.internal.DWTEventObject;
db5a898b2119 Fixed a lot of compile errors
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents: 13
diff changeset
17
db5a898b2119 Fixed a lot of compile errors
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents: 13
diff changeset
18 import tango.text.convert.Format;
db5a898b2119 Fixed a lot of compile errors
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents: 13
diff changeset
19
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
20 import dwt.dwthelper.utils;
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
21
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
22 /**
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
23 * Instances of this class are sent as a result of
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
24 * accessibility clients sending messages to controls
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
25 * asking for information about the control instance.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
26 * <p>
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
27 * Note: The meaning of the result field depends
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
28 * on the message that was sent.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
29 * </p>
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
30 *
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
31 * @see AccessibleListener
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
32 * @see AccessibleAdapter
45
d8635bb48c7c Merge with SWT 3.5
Jacob Carlborg <doob@me.com>
parents: 36
diff changeset
33 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
34 *
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
35 * @since 2.0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
36 */
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
37 public class AccessibleEvent : DWTEventObject {
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
38 /**
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
39 * The value of this field is set by an accessibility client
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
40 * before the accessible listener method is called.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
41 * ChildID can be CHILDID_SELF, representing the control itself,
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
42 * or a 0-based integer representing a specific child of the control.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
43 */
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
44 public int childID;
123
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
45
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
46 /**
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
47 * The value of this field must be set in the accessible listener
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
48 * method before returning.
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
49 * What to set it to depends on the listener method called, and
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
50 * the childID specified by the client.
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
51 */
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
52 public String result;
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
53
123
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
54 static const long serialVersionUID = 3257567304224026934L;
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
55
123
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
56 /**
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
57 * Constructs a new instance of this class.
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
58 *
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
59 * @param source the object that fired the event
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
60 */
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
61 public this (Object source) {
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
62 super(source);
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
63 }
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
64
123
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
65 /**
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
66 * Returns a string containing a concise, human-readable
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
67 * description of the receiver.
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
68 *
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
69 * @return a string representation of the event
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
70 */
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
71 public String toString () {
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
72 return Format("AccessibleEvent {childID={}{}{}{}" , childID , " result=" , result , "}"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
73 }
123
63a09873578e Fixed compile errors
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
74 }