\doxysection{pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard Class Reference}
\hypertarget{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard}{}\label{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard}\index{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}}
Inheritance diagram for pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a2f59416e2488afa65588f8f11a4cc8a0}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, keylist=settings.\+KEYLIST, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a8e4be01e26de86ed177f04f16f18467c}{timeout}}=settings.\+KEYTIMEOUT)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a2cee7d194adce12904db37d7d0f43fef}{set\+\_\+keylist}} (self, keylist=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_af7fc03d7d6ec3d4628a7d0aa0dac28e5}{set\+\_\+timeout}} (self, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a8e4be01e26de86ed177f04f16f18467c}{timeout}}=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_ae29f55a8fd1e73f496f725fac7294f71}{get\+\_\+key}} (self, keylist=\textquotesingle{}default\textquotesingle{}, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a8e4be01e26de86ed177f04f16f18467c}{timeout}}=\textquotesingle{}default\textquotesingle{}, flush=False)
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard}{pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard}}}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_af92d5eaf7feca81f320f9ea92f4cb31e}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
dict \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_af7d7bebff922feb4d38a2d95fca4f0fc}{key\+\_\+codes}} = \{\}
\item 
list \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a143f8276a03db6380d38313fa908c942}{klist}} = None
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a8e4be01e26de86ed177f04f16f18467c}{timeout}} = timeout
\end{DoxyCompactItemize}


\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a2f59416e2488afa65588f8f11a4cc8a0}\index{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a2f59416e2488afa65588f8f11a4cc8a0} 
pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{keylist}{ = {\ttfamily settings.KEYLIST}, }\item[{}]{timeout}{ = {\ttfamily settings.KEYTIMEOUT}}\end{DoxyParamCaption})}



\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_ae29f55a8fd1e73f496f725fac7294f71}\index{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}!get\_key@{get\_key}}
\index{get\_key@{get\_key}!pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}}
\doxysubsubsection{\texorpdfstring{get\_key()}{get\_key()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_ae29f55a8fd1e73f496f725fac7294f71} 
pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard.\+get\+\_\+key (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{keylist}{ = {\ttfamily \textquotesingle{}default\textquotesingle{}}, }\item[{}]{timeout}{ = {\ttfamily \textquotesingle{}default\textquotesingle{}}, }\item[{}]{flush}{ = {\ttfamily False}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Wait for keyboard input
        
        arguments

        None
        
        keyword arguments

        keylist --  list of keys that are allowed (e.g.
                    ['1','a','enter']), None to allow all keys or
                    'default' to use klist property (default = 'default')
        timeout --  time in milliseconds after which None is returned
                    when no keypress is registered (default = None);
                    None for no timeout or 'default' to use the timeout
                    property (default = 'default')
        flush       --  Boolean indicating if all input from before
                    calling get_key should be ignored, if set to
                    False keypresses from before calling this
                    function will be registered, otherwise every
                    keyboard input from before calling this function
                    will be flushed (default = False)
        
        returns

        key, presstime  --  key is a string, indicating which button has
                        been pressed or None when no key has been
                        pressed
                        presstime is the time (measured from
                        expbegintime) a keypress or a timeout occured
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a7f515fc4d3efa8bd55c5a857113080f9}{pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard}}.

\Hypertarget{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a2cee7d194adce12904db37d7d0f43fef}\index{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}!set\_keylist@{set\_keylist}}
\index{set\_keylist@{set\_keylist}!pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}}
\doxysubsubsection{\texorpdfstring{set\_keylist()}{set\_keylist()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a2cee7d194adce12904db37d7d0f43fef} 
pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard.\+set\+\_\+keylist (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{keylist}{ = {\ttfamily None}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Set a list of accepted keys
        
        arguments

        None
        
        keyword arguments

        keylist --  list of keys that are allowed (e.g.
                    ['1','a','enter']) or None to allow all keys
                    (default = None)
        
        returns

        None        --  sets klist property
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a23da38910f247c5b6fc1e1b254f3a118}{pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard}}.

\Hypertarget{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_af7fc03d7d6ec3d4628a7d0aa0dac28e5}\index{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}!set\_timeout@{set\_timeout}}
\index{set\_timeout@{set\_timeout}!pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}}
\doxysubsubsection{\texorpdfstring{set\_timeout()}{set\_timeout()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_af7fc03d7d6ec3d4628a7d0aa0dac28e5} 
pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard.\+set\+\_\+timeout (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{timeout}{ = {\ttfamily None}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Set a timeout (in milliseconds)
        
        arguments

        None
        
        keyword arguments

        timeout --  time in milliseconds after which None is returned
                    on a call to get_key method when no keypress is
                    registered (default = None)
        
        returns
        
        None    --  sets timeout property
\end{DoxyVerb}
 

Reimplemented from \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a557383d490f06812e911cc9acdb38d94}{pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard}}.



\doxysubsection{Member Data Documentation}
\Hypertarget{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_af7d7bebff922feb4d38a2d95fca4f0fc}\index{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}!key\_codes@{key\_codes}}
\index{key\_codes@{key\_codes}!pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}}
\doxysubsubsection{\texorpdfstring{key\_codes}{key\_codes}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_af7d7bebff922feb4d38a2d95fca4f0fc} 
dict pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard.\+key\+\_\+codes = \{\}}

\Hypertarget{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a143f8276a03db6380d38313fa908c942}\index{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}!klist@{klist}}
\index{klist@{klist}!pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}}
\doxysubsubsection{\texorpdfstring{klist}{klist}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a143f8276a03db6380d38313fa908c942} 
list pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard.\+klist = None}

\Hypertarget{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a8e4be01e26de86ed177f04f16f18467c}\index{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}!timeout@{timeout}}
\index{timeout@{timeout}!pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard@{pygaze.\_keyboard.pygamekeyboard.PyGameKeyboard}}
\doxysubsubsection{\texorpdfstring{timeout}{timeout}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a8e4be01e26de86ed177f04f16f18467c} 
pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard.\+timeout = timeout}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
C\+:/\+Users/lurax/eyetracking\+Tobii/pygaze/\+\_\+keyboard/\mbox{\hyperlink{pygamekeyboard_8py}{pygamekeyboard.\+py}}\end{DoxyCompactItemize}
