adding prevent default functionality for key

Author: lauren mccarthy

lib/p5.js

@@ -1,4 +1,4 @@
-/*! p5.js v0.3.10 November 01, 2014 */
+/*! p5.js v0.3.10 November 03, 2014 */
 var shim = function (require) {
     window.requestDraw = function () {
       return window.requestAnimationFrame || window.webkitRequestAnimationFrame || window.mozRequestAnimationFrame || window.oRequestAnimationFrame || window.msRequestAnimationFrame || function (callback, element) {
@@ -3001,7 +3001,10 @@ var inputkeyboard = function (require, core) {
       this._setProperty('key', key);
       var keyPressed = this.keyPressed || window.keyPressed;
       if (typeof keyPressed === 'function' && !e.charCode) {
-        keyPressed(e);
+        var executeDefault = keyPressed(e);
+        if (executeDefault === false) {
+          e.preventDefault();
+        }
       }
     };
     p5.prototype.onkeyup = function (e) {
@@ -3015,15 +3018,21 @@ var inputkeyboard = function (require, core) {
       this._setProperty('key', key);
       this._setProperty('keyCode', e.which);
       if (typeof keyReleased === 'function') {
-        keyReleased(e);
+        var executeDefault = keyReleased(e);
+        if (executeDefault === false) {
+          e.preventDefault();
+        }
       }
     };
     p5.prototype.onkeypress = function (e) {
       this._setProperty('keyCode', e.which);
       this._setProperty('key', String.fromCharCode(e.which));
       var keyTyped = this.keyTyped || window.keyTyped;
       if (typeof keyTyped === 'function') {
-        keyTyped(e);
+        var executeDefault = keyTyped(e);
+        if (executeDefault === false) {
+          e.preventDefault();
+        }
       }
     };
     return p5;

lib/p5.min.js

@@ -68,7 +68,10 @@ define(function (require) {
    * Because of how operating systems handle key repeats, holding down a key
    * may cause multiple calls to keyTyped() (and keyReleased() as well). The
    * rate of repeat is set by the operating system and how each computer is
-   * configured.
+   * configured.<br><br>
+   * Browsers may have different default
+   * behaviors attached to various key events. To prevent any default
+   * behavior for this event, add "return false" to the end of the method.
    *
    * @method keyPressed
    * @example
@@ -101,6 +104,7 @@ define(function (require) {
    *   } else if (keyCode === RIGHT_ARROW) {
    *     value = 0;
    *   }
+   *   return false; // prevent any default behavior
    * }
    * </code>
    * </div>
@@ -116,12 +120,18 @@ define(function (require) {
     this._setProperty('key', key);
     var keyPressed = this.keyPressed || window.keyPressed;
     if (typeof keyPressed === 'function' && !e.charCode) {
-      keyPressed(e);
+      var executeDefault = keyPressed(e);
+      if(executeDefault === false) {
+        e.preventDefault();
+      }
     }
   };
    /**
    * The keyReleased() function is called once every time a key is released.
-   * See key and keyCode for more information.
+   * See key and keyCode for more information.<br><br>
+   * Browsers may have different default
+   * behaviors attached to various key events. To prevent any default
+   * behavior for this event, add "return false" to the end of the method.
    *
    * @method keyReleased
    * @example
@@ -138,6 +148,7 @@ define(function (require) {
    *   } else {
    *     value = 0;
    *   }
+   *   return false; // prevent any default behavior
    * }
    * </code>
    * </div>
@@ -153,7 +164,10 @@ define(function (require) {
     this._setProperty('key', key);
     this._setProperty('keyCode', e.which);
     if (typeof keyReleased === 'function') {
-      keyReleased(e);
+      var executeDefault = keyReleased(e);
+      if(executeDefault === false) {
+        e.preventDefault();
+      }
     }
   };
 
@@ -164,7 +178,10 @@ define(function (require) {
    * <br><br>
    * Because of how operating systems handle key repeats, holding down a key
    * will cause multiple calls to keyTyped(), the rate is set by the operating
-   * system and how each computer is configured.
+   * system and how each computer is configured.<br><br>
+   * Browsers may have different default
+   * behaviors attached to various key events. To prevent any default
+   * behavior for this event, add "return false" to the end of the method.
    *
    * @method keyTyped
    * @example
@@ -181,6 +198,7 @@ define(function (require) {
    *   } else if (key === 'b') {
    *     value = 0;
    *   }
+   *   return false; // prevent any default behavior
    * }
    * </code>
    * </div>
@@ -190,7 +208,10 @@ define(function (require) {
     this._setProperty('key', String.fromCharCode(e.which));
     var keyTyped = this.keyTyped || window.keyTyped;
     if (typeof keyTyped === 'function') {
-      keyTyped(e);
+      var executeDefault = keyTyped(e);
+      if(executeDefault === false) {
+        e.preventDefault();
+      }
     }
   };
 

src/input/keyboard.js

@@ -144,7 +144,7 @@ define(function (require) {
 
   /**
    * The mouseMoved() function is called every time the mouse moves and a mouse
-   * button is not pressed.
+   * button is not pressed.<br><br>
    * Browsers may have different default
    * behaviors attached to various mouse events. To prevent any default
    * behavior for this event, add `return false` to the end of the method.
@@ -184,7 +184,7 @@ define(function (require) {
   /**
    * The mouseDragged() function is called once every time the mouse moves and
    * a mouse button is pressed. If no mouseDragged() function is defined, the
-   * touchMoved() function will be called instead if it is defined.
+   * touchMoved() function will be called instead if it is defined.<br><br>
    * Browsers may have different default
    * behaviors attached to various mouse events. To prevent any default
    * behavior for this event, add `return false` to the end of the method.
@@ -253,7 +253,7 @@ define(function (require) {
    * is pressed. The mouseButton variable (see the related reference entry)
    * can be used to determine which button has been pressed. If no 
    * mousePressed() function is defined, the touchStarted() function will be
-   * called instead if it is defined.
+   * called instead if it is defined.<br><br>
    * Browsers may have different default
    * behaviors attached to various mouse events. To prevent any default
    * behavior for this event, add `return false` to the end of the method.
@@ -313,7 +313,7 @@ define(function (require) {
   /**
    * The mouseReleased() function is called every time a mouse button is
    * released. If no mouseReleased() function is defined, the touchEnded()
-   * function will be called instead if it is defined.
+   * function will be called instead if it is defined.<br><br>
    * Browsers may have different default
    * behaviors attached to various mouse events. To prevent any default
    * behavior for this event, add `return false` to the end of the method.
@@ -373,7 +373,7 @@ define(function (require) {
 
   /**
    * The mouseClicked() function is called once after a mouse button has been
-   * pressed and then released.
+   * pressed and then released.<br><br>
    * Browsers may have different default
    * behaviors attached to various mouse events. To prevent any default
    * behavior for this event, add `return false` to the end of the method.
@@ -425,7 +425,7 @@ define(function (require) {
    * The event.wheelDelta or event.detail property returns negative values if
    * the mouse wheel if rotated up or away from the user and positive in the
    * other direction. On OS X with "natural" scrolling enabled, the values are
-   * opposite.
+   * opposite.<br><br>
    * Browsers may have different default
    * behaviors attached to various mouse events. To prevent any default
    * behavior for this event, add `return false` to the end of the method.