aboutsummaryrefslogtreecommitdiffstats
path: root/src/newt/classes
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2012-10-31 21:58:36 +0100
committerSven Gothel <[email protected]>2012-10-31 21:58:36 +0100
commit502847f59ef01c78a85e4ee5453a09d9b83d9a5e (patch)
treee236a7ad679273e3794c0821f690af6bbc68e105 /src/newt/classes
parentc135d638fe820457977747e3d45960da64038d53 (diff)
NEWT KeyEvent API doc: Document Windows shift+non-uppecase_char, commit c135d638fe820457977747e3d45960da64038d53
Diffstat (limited to 'src/newt/classes')
-rw-r--r--src/newt/classes/com/jogamp/newt/event/KeyEvent.java9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/newt/classes/com/jogamp/newt/event/KeyEvent.java b/src/newt/classes/com/jogamp/newt/event/KeyEvent.java
index 927c9aa85..289aa31f6 100644
--- a/src/newt/classes/com/jogamp/newt/event/KeyEvent.java
+++ b/src/newt/classes/com/jogamp/newt/event/KeyEvent.java
@@ -73,7 +73,14 @@ public class KeyEvent extends InputEvent
this.keyChar=keyChar;
}
- /** Returns the character matching the {@link #getKeyCode() virtual key code}, if exist. */
+ /**
+ * Returns the character matching the {@link #getKeyCode() virtual key code}, if exist.
+ * <p>
+ * <b>Disclaimer</b>: Only valid on all platforms at {@link KeyListener#keyTyped(KeyEvent)}.
+ * Precisely, on the Windows platform we currently cannot deliver the proper character
+ * in case of shifted keys where no uppercase exists, e.g. 'shift + 1' doesn't produce '!'.
+ * </p>
+ */
public char getKeyChar() {
return keyChar;
}