2016-01-30 07:48:16 -05:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "UTF-8" >
< title > KeyEvent< / title >
< base target = "class-frame" >
< link href = "../assets/css/docs.css" rel = "stylesheet" type = "text/css" >
< script src = "../assets/js/paper.js" > < / script >
< script src = "../assets/js/jquery.js" > < / script >
< script src = "../assets/js/codemirror.js" > < / script >
< script src = "../assets/js/docs.js" > < / script >
< / head >
< body >
< article class = "reference" >
< div class = "reference-class" >
< h1 > KeyEvent< / h1 >
< p > Extends < b > < a href = "../classes/Event.html" > < tt > Event< / tt > < / a > < / b > < / p >
< p > The KeyEvent object is received by the < a href = "../classes/Tool.html" > < tt > Tool< / tt > < / a > ’ s keyboard handlers < a href = "../classes/Tool.html#onkeydown" > < tt > tool.onKeyDown< / tt > < / a > , < a href = "../classes/Tool.html#onkeyup" > < tt > tool.onKeyUp< / tt > < / a > . The KeyEvent object is the only parameter passed to these functions and contains information about the keyboard event.< / p >
< / div >
<!-- ================================ properties =========================== -->
< div class = "reference-members" >
< h2 > Properties< / h2 >
< div id = "type" class = "member" >
< div class = "member-link" >
< a name = "type" href = "#type" > < tt > < b > type< / b > < / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > The type of mouse event.< / p >
< ul class = "member-list" >
< h4 > Values:< / h4 >
< li > < tt > 'keydown'< / tt > , < tt > 'keyup'< / tt > < / li >
< / ul >
< ul class = "member-list" >
< h4 > Type:< / h4 >
< li >
< tt > String< / tt >
< / li >
< / ul >
< / div >
< / div >
< / div >
< div id = "character" class = "member" >
< div class = "member-link" >
< a name = "character" href = "#character" > < tt > < b > character< / b > < / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > The character representation of the key that caused this key event, taking into account the current key-modifiers (e.g. shift, control, caps-lock, etc.)< / p >
< ul class = "member-list" >
< h4 > Type:< / h4 >
< li >
< tt > String< / tt >
< / li >
< / ul >
< / div >
< / div >
< / div >
< div id = "key" class = "member" >
< div class = "member-link" >
< a name = "key" href = "#key" > < tt > < b > key< / b > < / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > The key that caused this key event, either as a lower-case character or special key descriptor.< / p >
< ul class = "member-list" >
< h4 > Values:< / h4 >
< li > < tt > 'enter'< / tt > , < tt > 'space'< / tt > , < tt > 'shift'< / tt > , < tt > 'control'< / tt > , < tt > 'alt'< / tt > , < tt > 'meta'< / tt > , < tt > 'caps-lock'< / tt > , < tt > 'left'< / tt > , < tt > 'up'< / tt > , < tt > 'right'< / tt > , < tt > 'down'< / tt > , < tt > 'escape'< / tt > , < tt > 'delete'< / tt > , … < / li >
< / ul >
< ul class = "member-list" >
< h4 > Type:< / h4 >
< li >
< tt > String< / tt >
< / li >
< / ul >
< / div >
< / div >
< / div >
< / div >
<!-- ============================== methods ================================ -->
< div class = "reference-members" >
< h2 > Methods< / h2 >
< div id = "tostring" class = "member" >
< div class = "member-link" >
< a name = "tostring" href = "#tostring" > < tt > < b > toString< / b > ()< / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< ul class = "member-list" >
< h4 > Returns:< / h4 >
< li >
< tt > < tt > String< / tt > < / tt > — a string representation of the key event
< / li >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / ul >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / div >
< / div >
< / div >
< / div >
<!-- =========================== inherited properties ====================== -->
< div class = "reference-members" > < h2 > Properties inherited from < a href = "../classes/Event.html" > < tt > Event< / tt > < / a > < / h2 >
< div id = "timestamp" class = "member" >
< div class = "member-link" >
< a name = "timestamp" href = "#timestamp" > < tt > < b > timeStamp< / b > < / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > The time at which the event was created, in milliseconds since the epoch.< / p >
< p > Read only.< / p >
< ul class = "member-list" >
< h4 > Type:< / h4 >
< li >
< tt > Number< / tt >
< / li >
< / ul >
< / div >
< / div >
< / div >
< div id = "modifiers" class = "member" >
< div class = "member-link" >
< a name = "modifiers" href = "#modifiers" > < tt > < b > modifiers< / b > < / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > The current state of the keyboard modifiers.< / p >
< p > Read only.< / p >
< ul class = "member-list" >
< h4 > Type:< / h4 >
< li >
< tt > object< / tt >
< / li >
< / ul >
< ul class = "member-list" >
< h4 > See also:< / h4 >
< li > < tt > < a href = "../classes/Key.html#modifiers" > < tt > Key.modifiers< / tt > < / a > < / tt > < / li >
< / ul >
< / div >
< / div >
< / div >
< / div >
<!-- =========================== inherited methods ========================= -->
< div class = "reference-members" > < h2 > Methods inherited from < a href = "../classes/Event.html" > < tt > Event< / tt > < / a > < / h2 >
< div id = "preventdefault" class = "member" >
< div class = "member-link" >
< a name = "preventdefault" href = "#preventdefault" > < tt > < b > preventDefault< / b > ()< / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > Cancels the event if it is cancelable, without stopping further propagation of the event.< / p >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / div >
< / div >
< / div >
< div id = "stoppropagation" class = "member" >
< div class = "member-link" >
< a name = "stoppropagation" href = "#stoppropagation" > < tt > < b > stopPropagation< / b > ()< / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > Prevents further propagation of the current event.< / p >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / div >
< / div >
< / div >
< div id = "stop" class = "member" >
< div class = "member-link" >
< a name = "stop" href = "#stop" > < tt > < b > stop< / b > ()< / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > Cancels the event if it is cancelable, and stops stopping further propagation of the event. This is has the same effect as calling both < a href = "../classes/Event.html#stoppropagation" > < tt > stopPropagation< / tt > < / a > () and < a href = "../classes/Event.html#preventdefault" > < tt > preventDefault< / tt > < / a > ().< / p >
< p > Any handler can also return < code > false< / code > to indicate that < code > stop()< / code > should be called right after.< / p >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / div >
< / div >
< / div >
< / div >
<!-- =========================== copyright notice ========================== -->
< p class = "footer" >
2016-07-09 15:11:46 -04:00
Paper.js v0.10.2 (develop)< br >
2017-01-01 08:43:42 -05:00
Copyright © 2011—2017 < a href = "http://www.lehni.org" target = "_blank" > Jü rg Lehni< / a > & < a href = "http://www.jonathanpuckey.com" target = "_blank" > Jonathan Puckey< / a > . All Rights Reserved.< / p >
2016-01-30 07:48:16 -05:00
< div class = "content-end" > < / div >
< / article >
< / body >
