View source for Keyboard (Chili Framework)

With <code>Keyboard</code>, you can get the current state of depressed keys, and you can pop key press and release events out of an <code>Event</code> queue contained in <code>Keyboard</code>. You can also turn autorepeat on/off. Whopee. (''Note: the ''<code>kbd</code>'' object lives in ''<code>MainWindow</code>'''s belly.'')

== Members ==
=== KeyIsPressed ===
<code>bool Keyboard::KeyIsPressed( unsigned char keycode ) const</code><br />
Checks to see if a specific key is currently in the pressed state. The function parameter is the virtual key code of the key that you want to check.

=== ReadKey ===
<code>Event Keyboard::ReadKey()</code><br />
Pull a fresh <code>[[#Event]]</code> object out of the key press/release event queue. Erases an event from the queue and returns a copy if there is a key press event in the queue. Returns an invalid Event object if the queue is empty.

=== KeyIsEmpty ===
<code>bool Keyboard::KeyIsEmpty() const</code><br />
Check to see if the key event queue is empty.

== Event ==
<code>class Keyboard::Event</code><br />

Key press and release events are held in a queue in <code>Keyboard</code> in the order they occurred. These events are modeled with their own class because they're precious fucking little snowflakes. You pull them out of the buffer with <code>Keyboard::ReadKey()</code>.

=== Type ===
<code>enum Keyboard::Event::Type</code><br />

This represents the different types of events that can be recorded. The options are <code>Press</code>, <code>Release</code>, and <code>Invalid</code>.

=== IsPress ===
<code>bool Keyboard::Event::IsPress() const</code><br />

Returns <code>true</code> if the event is a press event.

=== IsRelease ===
<code>bool Keyboard::Event::IsRelease() const</code><br />

Returns <code>true</code> if the event is a release event.

=== IsValid ===
<code>bool Keyboard::Event::IsValid() const</code><br />

Returns <code>true</code> if the event is a valid event (reading from an empty buffer will return an invalid event object).

=== GetCode ===
<code>char Keyboard::Event::GetCode() const</code><br />

Gets the virtual key code of the key associated with the <code>Event</code> object.

== Miscellaneous ==
=== Virtual Key Codes ===
The virtual key code for a standard alphanumeric key is just the <code>char</code> literal (capital if alphabetic), e.g. <code>'A'</code> or <code>'9'</code>. Virtual key codes for other keys are defined with <code>#define</code> macros included with <code>Windows.h</code>. Some common ones are:
* <code>VK_SPACE</code>
* <code>VK_SHIFT</code>
* <code>VK_ENTER</code>
* <code>VK_ESCAPE</code>

=== ReadKey vs. ReadChar ===
There are two main differences between the events read with <code>ReadKey()</code> and the <code>char</code> values read with <code>ReadChar()</code>:
# Each key press and release sequence puts two events (press event and release event) into the queue read from by <code>ReadKey()</code>, but the same sequence only puts one <code>char</code> value into the queue read from by <code>ReadChar()</code>.
# The <code>char</code> values read with <code>ReadChar()</code> have the shift modifier applied to them, whereas those read by <code>ReadKey()</code> are just the raw virtual key codes. For example, pressing the <code>'A'</code> key puts the <code>'a'</code> <code>char</code> value in the <code>ReadChar()</code> queue when shift is not pressed and <code>'A'</code> when it is pressed, but it is always <code>'A'</code> for <code>ReadKey()</code>.

== See also ==
* The [[Chili Framework]]