\doxysection{pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+Keyboard Class Reference}
\hypertarget{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard}{}\label{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard}\index{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}}
Inheritance diagram for pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+Keyboard\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a289a9492c4cc3cde4aeb88656fe81431}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, keylist=settings.\+KEYLIST, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_ab1d1c099f836fae6871db9420d03d8e7}{timeout}}=settings.\+KEYTIMEOUT)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a0d55ed8b8d40d32f9605ad78e0039b0d}{set\+\_\+keylist}} (self, keylist=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_aa62f28514156d4d11eaa21c3686c13b5}{set\+\_\+timeout}} (self, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_ab1d1c099f836fae6871db9420d03d8e7}{timeout}}=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_afd9291c08de1f89eae424d412caaed45}{get\+\_\+key}} (self, keylist=\textquotesingle{}default\textquotesingle{}, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_ab1d1c099f836fae6871db9420d03d8e7}{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_1psychopykeyboard_1_1_psycho_py_keyboard_a10d87590aed4da9e9a42007abf25c6cf}{keymap}}
\item 
list \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a06a188bc17c6d6d68968f4e5aa5a4153}{klist}} = None
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_ab1d1c099f836fae6871db9420d03d8e7}{timeout}} = timeout
\end{DoxyCompactItemize}


\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a289a9492c4cc3cde4aeb88656fe81431}\index{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a289a9492c4cc3cde4aeb88656fe81431} 
pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+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_1psychopykeyboard_1_1_psycho_py_keyboard_afd9291c08de1f89eae424d412caaed45}\index{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}!get\_key@{get\_key}}
\index{get\_key@{get\_key}!pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}}
\doxysubsubsection{\texorpdfstring{get\_key()}{get\_key()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_afd9291c08de1f89eae424d412caaed45} 
pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+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_1psychopykeyboard_1_1_psycho_py_keyboard_a0d55ed8b8d40d32f9605ad78e0039b0d}\index{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}!set\_keylist@{set\_keylist}}
\index{set\_keylist@{set\_keylist}!pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}}
\doxysubsubsection{\texorpdfstring{set\_keylist()}{set\_keylist()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a0d55ed8b8d40d32f9605ad78e0039b0d} 
pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+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_1psychopykeyboard_1_1_psycho_py_keyboard_aa62f28514156d4d11eaa21c3686c13b5}\index{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}!set\_timeout@{set\_timeout}}
\index{set\_timeout@{set\_timeout}!pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}}
\doxysubsubsection{\texorpdfstring{set\_timeout()}{set\_timeout()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_aa62f28514156d4d11eaa21c3686c13b5} 
pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+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_1psychopykeyboard_1_1_psycho_py_keyboard_a10d87590aed4da9e9a42007abf25c6cf}\index{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}!keymap@{keymap}}
\index{keymap@{keymap}!pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}}
\doxysubsubsection{\texorpdfstring{keymap}{keymap}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a10d87590aed4da9e9a42007abf25c6cf} 
dict pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+Keyboard.\+keymap}

{\bfseries Initial value\+:}
\begin{DoxyCode}{0}
\DoxyCodeLine{=\ \ \{}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'!'}\ :\ \textcolor{stringliteral}{'exclamation'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'"{}'}\ :\ \textcolor{stringliteral}{'doublequote'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'\#'}\ :\ \textcolor{stringliteral}{'hash'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'\$'}\ :\ \textcolor{stringliteral}{'dollar'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'\&'}\ :\ \textcolor{stringliteral}{'ampersand'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'\(\backslash\)''}\ :\ \textcolor{stringliteral}{'quoteleft'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'('}\ :\ \textcolor{keywordtype}{None},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{')'}\ :\ \textcolor{keywordtype}{None},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'*'}\ :\ \textcolor{stringliteral}{'asterisk'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'+'}\ :\ \textcolor{stringliteral}{'plus'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{','}\ :\ \textcolor{stringliteral}{'comma'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'-\/'}\ :\ \textcolor{stringliteral}{'minus'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'.'}\ :\ \textcolor{keywordtype}{None},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'/'}\ :\ \textcolor{stringliteral}{'slash'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{':'}\ :\ \textcolor{stringliteral}{'colin'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{';'}\ :\ \textcolor{stringliteral}{'semicolon'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'='}\ :\ \textcolor{stringliteral}{'equal'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'>'}\ :\ \textcolor{stringliteral}{'greater'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'?'}\ :\ \textcolor{stringliteral}{'question'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'@'}\ :\ \textcolor{stringliteral}{'at'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'['}\ :\ \textcolor{stringliteral}{'bracketleft'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'\(\backslash\)\(\backslash\)'}\ :\ \textcolor{stringliteral}{'backslash'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{']'}\ :\ \textcolor{stringliteral}{'bracketright'},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'\string^'}\ :\ \textcolor{keywordtype}{None},}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{'\_'}\ :\ \textcolor{stringliteral}{'underscore'}}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \}}

\end{DoxyCode}
\Hypertarget{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a06a188bc17c6d6d68968f4e5aa5a4153}\index{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}!klist@{klist}}
\index{klist@{klist}!pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}}
\doxysubsubsection{\texorpdfstring{klist}{klist}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a06a188bc17c6d6d68968f4e5aa5a4153} 
list pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+Keyboard.\+klist = None}

\Hypertarget{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_ab1d1c099f836fae6871db9420d03d8e7}\index{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}!timeout@{timeout}}
\index{timeout@{timeout}!pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard@{pygaze.\_keyboard.psychopykeyboard.PsychoPyKeyboard}}
\doxysubsubsection{\texorpdfstring{timeout}{timeout}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_ab1d1c099f836fae6871db9420d03d8e7} 
pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+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{psychopykeyboard_8py}{psychopykeyboard.\+py}}\end{DoxyCompactItemize}
