Mercurial > projects > dwt-linux
annotate dwt/events/KeyEvent.d @ 259:c0d810de7093
Update SWT 3.4M7 to 3.4
| author | Frank Benoit <benoit@tionex.de> |
|---|---|
| date | Sun, 29 Jun 2008 14:33:38 +0200 |
| parents | 380bad9f6852 |
| children | 6f57d3b9947c |
| rev | line source |
|---|---|
| 72 | 1 /******************************************************************************* |
| 259 | 2 * Copyright (c) 2000, 2008 IBM Corporation and others. |
| 1 | 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 | |
| 72 | 10 * Port to the D programming language: |
| 11 * Frank Benoit <benoit@tionex.de> | |
| 1 | 12 *******************************************************************************/ |
|
10
63c023465156
moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents:
9
diff
changeset
|
13 module dwt.events.KeyEvent; |
| 1 | 14 |
| 238 | 15 import dwt.dwthelper.utils; |
| 16 | |
| 1 | 17 |
|
10
63c023465156
moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents:
9
diff
changeset
|
18 import dwt.widgets.Event; |
|
63c023465156
moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents:
9
diff
changeset
|
19 import dwt.events.TypedEvent; |
| 1 | 20 |
| 21 import tango.text.convert.Format; | |
| 22 | |
| 23 /** | |
| 24 * Instances of this class are sent as a result of | |
| 25 * keys being pressed and released on the keyboard. | |
| 26 * <p> | |
| 27 * When a key listener is added to a control, the control | |
| 28 * will take part in widget traversal. By default, all | |
| 29 * traversal keys (such as the tab key and so on) are | |
| 30 * delivered to the control. In order for a control to take | |
| 31 * part in traversal, it should listen for traversal events. | |
| 32 * Otherwise, the user can traverse into a control but not | |
| 33 * out. Note that native controls such as table and tree | |
| 34 * implement key traversal in the operating system. It is | |
| 35 * not necessary to add traversal listeners for these controls, | |
| 36 * unless you want to override the default traversal. | |
| 37 * </p> | |
| 259 | 38 * |
| 1 | 39 * @see KeyListener |
| 40 * @see TraverseListener | |
| 259 | 41 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> |
| 1 | 42 */ |
| 43 | |
| 44 public class KeyEvent : TypedEvent { | |
| 45 | |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
46 /** |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
47 * the character represented by the key that was typed. |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
48 * This is the final character that results after all modifiers have been |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
49 * applied. For example, when the user types Ctrl+A, the character value |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
50 * is 0x01. It is important that applications do not attempt to modify the |
| 71 | 51 * character value based on a stateMask (such as DWT.CTRL) or the resulting |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
52 * character will not be correct. |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
53 */ |
| 93 | 54 public wchar character = '\0'; |
| 1 | 55 |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
56 /** |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
57 * the key code of the key that was typed, |
| 71 | 58 * as defined by the key code constants in class <code>DWT</code>. |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
59 * When the character field of the event is ambiguous, this field |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
60 * contains the unicode value of the original character. For example, |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
61 * typing Ctrl+M or Return both result in the character '\r' but the |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
62 * keyCode field will also contain '\r' when Return was typed. |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
63 * |
| 71 | 64 * @see dwt.DWT |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
65 */ |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
66 public int keyCode; |
| 1 | 67 |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
68 /** |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
69 * the state of the keyboard modifier keys at the time |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
70 * the event was generated, as defined by the key code |
| 71 | 71 * constants in class <code>DWT</code>. |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
72 * |
| 71 | 73 * @see dwt.DWT |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
74 */ |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
75 public int stateMask; |
| 1 | 76 |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
77 /** |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
78 * A flag indicating whether the operation should be allowed. |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
79 * Setting this field to <code>false</code> will cancel the operation. |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
80 */ |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
81 public bool doit; |
| 1 | 82 |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
83 static final long serialVersionUID = 3256442491011412789L; |
| 1 | 84 |
| 85 /** | |
| 86 * Constructs a new instance of this class based on the | |
| 87 * information in the given untyped event. | |
| 88 * | |
| 89 * @param e the untyped event containing the information | |
| 90 */ | |
| 91 public this(Event e) { | |
|
59
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
92 super(e); |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
93 this.character = e.character; |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
94 this.keyCode = e.keyCode; |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
95 this.stateMask = e.stateMask; |
|
8cec8f536af3
All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
96 this.doit = e.doit; |
| 1 | 97 } |
| 98 | |
| 99 /** | |
| 100 * Returns a string containing a concise, human-readable | |
| 101 * description of the receiver. | |
| 102 * | |
| 103 * @return a string representation of the event | |
| 104 */ | |
| 238 | 105 public override String toString() { |
| 1 | 106 return Format( "{} character={} keyCode={} stateMask={} doit={}}", |
| 107 super.toString[ 0 .. $-2 ], | |
| 108 character, keyCode, stateMask, doit ); | |
| 109 } | |
| 110 } |