Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(331)

Unified Diff: sdk/lib/html/dart2js/html_dart2js.dart

Issue 171203003: Improve KeyEvent documentation. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
Download patch
« no previous file with comments | « no previous file | sdk/lib/html/dartium/html_dartium.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sdk/lib/html/dart2js/html_dart2js.dart
diff --git a/sdk/lib/html/dart2js/html_dart2js.dart b/sdk/lib/html/dart2js/html_dart2js.dart
index 3ba754358e30fd00c8f540658956156953930bd4..535a296193176c15ddb06d31b6f739cf2ccc410e 100644
--- a/sdk/lib/html/dart2js/html_dart2js.dart
+++ b/sdk/lib/html/dart2js/html_dart2js.dart
@@ -35471,6 +35471,21 @@ class _HistoryCrossFrame implements HistoryBase {
* KeyEvent tries to provide a higher level, more polished keyboard event
* information on top of the "raw" [KeyboardEvent].
*
+ * The mechanics of using KeyEvents is a little different from the underlying
+ * [KeyboardEvent]. To use KeyEvents, you need to create a stream and then add
+ * KeyEvents to the stream, rather than using the [EventTarget.dispatchEvent].
+ * Here's an example usage:
+ *
+ * // Initialize a stream for the KeyEvents:
+ * var stream = KeyEvent.keyPressEvent.forTarget(document.body);
+ * // Start listening to the stream of KeyEvents.
+ * stream.listen((keyEvent) =>
+ * window.console.log('KeyPress event detected ${keyEvent.charCode}'));
+ * ...
+ * // Add a new KeyEvent of someone pressing the 'A' key to the stream so
+ * // listeners can know a KeyEvent happened.
+ * stream.add(new KeyEvent('keypress', keyCode: 65, charCode: 97));
+ *
* This class is very much a work in progress, and we'd love to get information
* on how we can make this class work with as many international keyboards as
* possible. Bugs welcome!
« no previous file with comments | « no previous file | sdk/lib/html/dartium/html_dartium.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698