Retro/pcjs
Watch
1
0
Fork
You've already forked pcjs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Consolidated /docs into /pubs

Browse source
This commit is contained in:
Jeff Parsons 2017-09-12 11:28:18 -07:00 • committed by Jeff Parsons
commit 71d117fa02
106 changed files with 350 additions and 317 deletions
Download patch file Download diff file Expand all files Collapse all files

73
docs/pcx86/keyboard/README.md
View file

@ -1,73 +0,0 @@
---
layout: page
title: PCx86 <keyboard> Element
permalink: /docs/pcx86/keyboard/
---
PCx86 Keyboard Component
------------------------
Format
------
```xml
<keyboard>...</keyboard>
```
Purpose
-------
Creates an instance of the Keyboard component, which maps JavaScript key events (or other control events) to
IBM PC keyboard scan codes.
Attributes
----------
* *model* (optional)
* us83: US keyboard with 83-key layout (default)
* us84: US keyboard with 84-key layout
* us101: US keyboard with 101-key layout
Also supports the attributes of *[Component](/docs/pcx86/component/)*.
Bindings
--------
* *esc*, *ctrl-c*, *ctrl-alt-del*, *left-arrow*, *up-arrow*, *right-arrow*, *down-arrow*, *f1*, *f2*, *f3*, *f4*, *f5*, *f6*, *f7*, *f8*, *f9*, *f10*, ...
For use with a control of type button (or other control that supports the "onclick" event), to simulate the
corresponding key press(es).
* The Keyboard component also provides keyDown, keyUp, and keyPress bindings to any control that supports the
corresponding "keyDown", "keyUp", and "keyPress" events. However, the Video component automatically binds its canvas
element to them, so they are generally unavailable for other components to use.
* TODO: Provide a complete set of bindings for all possible keys, and controls that display "soft keyboards" appropriate
for the specified model.
Example
-------
```xml
<keyboard id="keyboard" model="us83"/>
```
See [/devices/pcx86/keyboard/us83-softkeys.xml](/devices/pcx86/keyboard/us83-softkeys.xml) for an example that provides a
complete "soft keyboard".
Output
------
```html
<div id="..." class="pc-keyboard pc-component">
<div class="pc-container">
<div class="pcx86-keyboard" data-value="id:'...',name:'...',model:'...',...">
</div>
</div>
</div>
```
Also, if any controls are defined, another &lt;div&gt; of class="pc-controls" is created in the container &lt;div&gt;,
with each control inside a &lt;div&gt; of class="pc-control".
[Return to [PCx86 Documentation](..)]