package openfl.events {
/**
 * 	A KeyboardEvent object id dispatched in response to user input through a
 * 	keyboard. There are two types of keyboard events:
 * 	`KeyboardEvent.KEY_DOWN` and `KeyboardEvent.KEY_UP`
 * 
 * 	Because mappings between keys and specific characters vary by device and
 * 	operating system, use the TextEvent event type for processing character
 * 	input.
 * 
 * 	To listen globally for key events, listen on the Stage for the capture
 * 	and target or bubble phase.
 * 
 * 	@see [Capturing keyboard input](https://books.openfl.org/openfl-developers-guide/keyboard-input/capturing-keyboard-input.html)
 * 	@see `openfl.ui.Keyboard`
 * 
 * @externs
 */
public class KeyboardEvent extends openfl.events.Event {
	/**
	 * 		Creates an Event object that contains specific information about keyboard
	 * 		events. Event objects are passed as parameters to event listeners.
	 * 
	 * 		@param type             The type of the event. Possible values are:
	 * 								`KeyboardEvent.KEY_DOWN` and
	 * 								`KeyboardEvent.KEY_UP`
	 * 		@param bubbles          Determines whether the Event object participates
	 * 								in the bubbling stage of the event flow.
	 * 		@param cancelable       Determines whether the Event object can be
	 * 								canceled.
	 * 		@param charCodeValue    The character code value of the key pressed or
	 * 								released. The character code values returned are
	 * 								English keyboard values. For example, if you press
	 * 								Shift+3, the `Keyboard.charCode()`
	 * 								property returns # on a Japanese keyboard, just as
	 * 								it does on an English keyboard.
	 * 		@param keyCodeValue     The key code value of the key pressed or released.
	 * 		@param keyLocationValue The location of the key on the keyboard.
	 * 		@param ctrlKeyValue     On Windows, indicates whether the Ctrl key is
	 * 								activated. On Mac, indicates whether either the
	 * 								Ctrl key or the Command key is activated.
	 * 		@param altKeyValue      Indicates whether the Alt key modifier is
	 * 								activated (Windows only).
	 * 		@param shiftKeyValue    Indicates whether the Shift key modifier is
	 * 								activated.
	 * 		@param commandKeyValue  Indicates whether the Command key modifier is
	 * 								activated.
	 * 	
	 */
	public function KeyboardEvent(type:String, bubbles:Boolean = undefined, cancelable:Boolean = undefined, charCodeValue:int = undefined, keyCodeValue:int = undefined, keyLocationValue:Object = undefined, ctrlKeyValue:Boolean = undefined, altKeyValue:Boolean = undefined, shiftKeyValue:Boolean = undefined, controlKeyValue:Boolean = undefined, commandKeyValue:Boolean = undefined) {
		super(undefined, undefined, undefined);
	}
	/**
	 * 		The `KeyboardEvent.KEY_DOWN` constant defines the value of the `type`
	 * 		property of a `keyDown` event object.
	 * 		This event has the following properties:
	 * 
	 * 		| Property | Value |
	 * 		| --- | --- |
	 * 		| `bubbles` | `true` |
	 * 		| `cancelable` | `true` in AIR, `false` in Flash Player; in AIR, canceling this event prevents the character from being entered into a text field. |
	 * 		| `charCode` | The character code value of the key pressed or released. |
	 * 		| `commandKey` | `true` on Mac if the Command key is active. Otherwise, `false` |
	 * 		| `controlKey` | `true` on Windows and Linux if the Ctrl key is active. `true` on Mac if either the Control key is active. Otherwise, `false` |
	 * 		| `ctrlKey` | `true` on Windows and Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`. |
	 * 		| `currentTarget` | The object that is actively processing the Event object with an event listener. |
	 * 		| `keyCode` | The key code value of the key pressed or released. |
	 * 		| `keyLocation` | The location of the key on the keyboard. |
	 * 		| `shiftKey` | `true` if the Shift key is active; `false` if it is inactive. |
	 * 		| `target` | The InteractiveObject instance with focus. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event. |
	 * 	
	 */
	public static const KEY_DOWN:String = "keyDown";
	/**
	 * 		The `KeyboardEvent.KEY_UP` constant defines the value of the `type`
	 * 		property of a `keyUp` event object.
	 * 		This event has the following properties:
	 * 
	 * 		| Property | Value |
	 * 		| --- | --- |
	 * 		| `bubbles` | `true` |
	 * 		| `cancelable` | `false`; there is no default behavior to cancel. |
	 * 		| `charCode` | Contains the character code value of the key pressed or released. |
	 * 		| `commandKey` | `true` on Mac if the Command key is active. Otherwise, `false` |
	 * 		| `controlKey` | `true` on Windows and Linux if the Ctrl key is active. `true` on Mac if either the Control key is active. Otherwise, `false` |
	 * 		| `ctrlKey` | `true` on Windows if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`. |
	 * 		| `currentTarget` | The object that is actively processing the Event object with an event listener. |
	 * 		| `keyCode` | The key code value of the key pressed or released. |
	 * 		| `keyLocation` | The location of the key on the keyboard. |
	 * 		| `shiftKey` | `true` if the Shift key is active; `false` if it is inactive. |
	 * 		| `target` | The InteractiveObject instance with focus. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event. |
	 * 	
	 */
	public static const KEY_UP:String = "keyUp";
	/**
	 * 		Indicates whether the Alt key is active (`true`) or inactive
	 * 		(`false`) on Windows; indicates whether the Option key is
	 * 		active on Mac OS.
	 * 	
	 */
	public var altKey:Boolean;
	/**
	 * 		Contains the character code value of the key pressed or released. The
	 * 		character code values are English keyboard values. For example, if you
	 * 		press Shift+3, `charCode` is # on a Japanese keyboard, just as
	 * 		it is on an English keyboard.
	 * 
	 * 		**Note:** When an input method editor (IME) is running,
	 * 		`charCode` does not report accurate character codes.
	 * 	
	 */
	public var charCode:int;
	/**
	 * 		Indicates whether the Command key is active (`true`) or inactive
	 * 		(`false`). Supported for Mac OS only. On Mac OS, the `commandKey`
	 * 		property has the same value as the `ctrlKey` property.
	 * 	
	 */
	public var commandKey:Boolean;
	/**
	 * 		Indicates whether the Control key is active (`true`) or inactive
	 * 		(`false`). On Windows and Linux, this is also true when the Ctrl key
	 * 		is active.
	 * 	
	 */
	public var controlKey:Boolean;
	/**
	 * 		On Windows and Linux, indicates whether the Ctrl key is active
	 * 		(`true`) or inactive (`false`); On Mac OS, indicates
	 * 		whether either the Ctrl key or the Command key is active.
	 * 	
	 */
	public var ctrlKey:Boolean;
	/**
	 * 		The key code value of the key pressed or released.
	 * 
	 * 		**Note:** When an input method editor (IME) is running,
	 * 		`keyCode` does not report accurate key codes.
	 * 	
	 */
	public var keyCode:int;
	/**
	 * 		Indicates the location of the key on the keyboard. This is useful for
	 * 		differentiating keys that appear more than once on a keyboard. For
	 * 		example, you can differentiate between the left and right Shift keys by
	 * 		the value of this property: `KeyLocation.LEFT` for the left and
	 * 		`KeyLocation.RIGHT` for the right. Another example is
	 * 		differentiating between number keys pressed on the standard keyboard
	 * 		(`KeyLocation.STANDARD`) versus the numeric keypad
	 * 		(`KeyLocation.NUM_PAD`).
	 * 	
	 */
	public var keyLocation:int;
	/**
	 * 		Indicates whether the Shift key modifier is active (`true`) or
	 * 		inactive (`false`).
	 * 	
	 */
	public var shiftKey:Boolean;
	override public function clone():openfl.events.KeyboardEvent { return null; }
	override public function toString():String { return null; }
	/**
	 * 		Instructs OpenFL to render after processing of this event completes, if
	 * 		the display list has been modified.
	 * 	
	 */
	public function updateAfterEvent():void {}
}
}