25
|
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.events.KeyEvent;
|
|
14
|
|
15
|
|
16 import org.eclipse.swt.widgets.Event;
|
|
17 import org.eclipse.swt.events.TypedEvent;
|
|
18
|
|
19 import java.lang.all;
|
|
20
|
|
21 /**
|
|
22 * Instances of this class are sent as a result of
|
|
23 * keys being pressed and released on the keyboard.
|
|
24 * <p>
|
|
25 * When a key listener is added to a control, the control
|
|
26 * will take part in widget traversal. By default, all
|
|
27 * traversal keys (such as the tab key and so on) are
|
|
28 * delivered to the control. In order for a control to take
|
|
29 * part in traversal, it should listen for traversal events.
|
|
30 * Otherwise, the user can traverse into a control but not
|
|
31 * out. Note that native controls such as table and tree
|
|
32 * implement key traversal in the operating system. It is
|
|
33 * not necessary to add traversal listeners for these controls,
|
|
34 * unless you want to override the default traversal.
|
|
35 * </p>
|
|
36 *
|
|
37 * @see KeyListener
|
|
38 * @see TraverseListener
|
|
39 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
|
|
40 */
|
|
41
|
|
42 public class KeyEvent : TypedEvent {
|
|
43
|
|
44 /**
|
|
45 * the character represented by the key that was typed.
|
|
46 * This is the final character that results after all modifiers have been
|
|
47 * applied. For example, when the user types Ctrl+A, the character value
|
|
48 * is 0x01. It is important that applications do not attempt to modify the
|
|
49 * character value based on a stateMask (such as SWT.CTRL) or the resulting
|
|
50 * character will not be correct.
|
|
51 */
|
|
52 public wchar character = '\0';
|
|
53
|
|
54 /**
|
|
55 * the key code of the key that was typed,
|
|
56 * as defined by the key code constants in class <code>SWT</code>.
|
|
57 * When the character field of the event is ambiguous, this field
|
|
58 * contains the unicode value of the original character. For example,
|
|
59 * typing Ctrl+M or Return both result in the character '\r' but the
|
|
60 * keyCode field will also contain '\r' when Return was typed.
|
|
61 *
|
|
62 * @see org.eclipse.swt.SWT
|
|
63 */
|
|
64 public int keyCode;
|
|
65
|
|
66 /**
|
|
67 * the state of the keyboard modifier keys at the time
|
|
68 * the event was generated, as defined by the key code
|
|
69 * constants in class <code>SWT</code>.
|
|
70 *
|
|
71 * @see org.eclipse.swt.SWT
|
|
72 */
|
|
73 public int stateMask;
|
|
74
|
|
75 /**
|
|
76 * A flag indicating whether the operation should be allowed.
|
|
77 * Setting this field to <code>false</code> will cancel the operation.
|
|
78 */
|
|
79 public bool doit;
|
|
80
|
|
81 static final long serialVersionUID = 3256442491011412789L;
|
|
82
|
|
83 /**
|
|
84 * Constructs a new instance of this class based on the
|
|
85 * information in the given untyped event.
|
|
86 *
|
|
87 * @param e the untyped event containing the information
|
|
88 */
|
|
89 public this(Event e) {
|
|
90 super(e);
|
|
91 this.character = e.character;
|
|
92 this.keyCode = e.keyCode;
|
|
93 this.stateMask = e.stateMask;
|
|
94 this.doit = e.doit;
|
|
95 }
|
|
96
|
|
97 /**
|
|
98 * Returns a string containing a concise, human-readable
|
|
99 * description of the receiver.
|
|
100 *
|
|
101 * @return a string representation of the event
|
|
102 */
|
|
103 public override String toString() {
|
|
104 return Format( "{} character={} keyCode={} stateMask={} doit={}}",
|
|
105 super.toString[ 0 .. $-2 ],
|
|
106 character, keyCode, stateMask, doit );
|
|
107 }
|
|
108 }
|