Some keyboard documentation

git-svn-id: http://www.villavu.com/repositories/merlijn/mufasa@244 3f818213-9676-44b0-a9b4-5e4c4e03d09d

Doc/mufasa_ps_handbook.tex

@@ -80,23 +80,69 @@ specified x, y coordinate.
 
 \section{Keyboard}
 
+The Keyboard functions in Mufasa are listed here.
+Most of them are quite basic, and can use some improvement.
+
 \subsection{Types}
 
-Types ofzo?
+Most of the low level Keyboard functions use Virtual Keys.
 
-\subsection{Exported Vk Keys}
+\subsection{Virtual Keys}
 
-Hier dus een lijst
+List of VK Keys here
 
 \subsection{KeyDown}
 
+\textbf{procedure} {\color{blue}{KeyDown}}({\color{typeRed}
+{key: }}{\color{typeGreen}{Word}});
+
+KeyDown sends a request to the Operating System to ``fake'' an event that
+causes the Key to be ``down''.
+``key'' can be any Virtual Key\footnote{See the section on Virtual Keys}.
+
+\subsubsection{Common pitfalls}
+
+Don't forget that certain keys may require that shift, or another key
+is down as well.
+
 \subsection{KeyUp}
 
+KeyUp sends a request to the Operating System to ``fake'' an event that
+causes the Key to be ``up''.
+``key'' can be any Virtual Key.
+
+\textbf{procedure} {\color{blue}{KeyUp}}({\color{typeRed}
+{key: }}{\color{typeGreen}{Word}});
+
 \subsection{PressKey}
 
+\textbf{procedure} {\color{blue}{PressKey}}({\color{typeRed}
+{key: }}{\color{typeGreen}{Word}});
+
+PressKey combines KeyDown and KeyUp, to fake a key press.
+
 \subsection{SendKeys}
 
+\textbf{procedure} {\color{blue}{SendKEys}}({\color{typeRed}
+{s: }}{\color{typeGreen}{String}});
+
+SendKeys takes a string ``s'', and attempts to send it's complete contents to
+the client. It currently only accepts characters ranging from ``A..z''.
+
 \subsection{IsKeyDown}
+\textbf{function} {\color{blue}{PressKey}}({\color{typeRed}
+{key: }}{\color{typeGreen}{Word}}): {\color{typeGreen}{Boolean}};
+
+IsKeyDown returns true if then give VK key is ``down''.
+
+\subsection{Notes}
+
+There is no IsKeyUp, because this can easily be generated by inverting the
+result of IsKeyDown:
+\begin{verbatim}
+    not IsKeyDown (x)
+\end{verbatim}
+
 
 \chapter{Finding Routines}