\doxysection{pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard Class Reference}
\hypertarget{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard}{}\label{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard}\index{pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}}
Inheritance diagram for pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=0.793201cm]{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_af92d5eaf7feca81f320f9ea92f4cb31e}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a23da38910f247c5b6fc1e1b254f3a118}{set\+\_\+keylist}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a557383d490f06812e911cc9acdb38d94}{set\+\_\+timeout}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a7f515fc4d3efa8bd55c5a857113080f9}{get\+\_\+key}} (self)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\begin{DoxyVerb}A keyboard for collecting responses\end{DoxyVerb}
 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_af92d5eaf7feca81f320f9ea92f4cb31e}\index{pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_af92d5eaf7feca81f320f9ea92f4cb31e} 
pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Initializes the Keyboard object
        
        arguments

        None
        
        keyword arguments

        keylist --  list of keys that are allowed, e.g. ['1','a','enter']
                    for the 1, A and Enter keys (default =
                    KEYLIST)
        timeout --  time in milliseconds after which None is returned
                    on a call to the get_key method when no keypress is
                    registered (default = KEYTIMEOUT)
\end{DoxyVerb}
 

\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a7f515fc4d3efa8bd55c5a857113080f9}\index{pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}!get\_key@{get\_key}}
\index{get\_key@{get\_key}!pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}}
\doxysubsubsection{\texorpdfstring{get\_key()}{get\_key()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a7f515fc4d3efa8bd55c5a857113080f9} 
pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard.\+get\+\_\+key (\begin{DoxyParamCaption}\item[{}]{self}{}\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 in \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a6bc52b598aa47696f6bcaeb29bbd6cc6}{pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard}}, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_afd9291c08de1f89eae424d412caaed45}{pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+Keyboard}}, and \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_ae29f55a8fd1e73f496f725fac7294f71}{pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard}}.

\Hypertarget{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a23da38910f247c5b6fc1e1b254f3a118}\index{pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}!set\_keylist@{set\_keylist}}
\index{set\_keylist@{set\_keylist}!pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}}
\doxysubsubsection{\texorpdfstring{set\_keylist()}{set\_keylist()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a23da38910f247c5b6fc1e1b254f3a118} 
pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard.\+set\+\_\+keylist (\begin{DoxyParamCaption}\item[{}]{self}{}\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 in \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a696668403d3dcec3395ca11a9c77482b}{pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard}}, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_a0d55ed8b8d40d32f9605ad78e0039b0d}{pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+Keyboard}}, and \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_a2cee7d194adce12904db37d7d0f43fef}{pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard}}.

\Hypertarget{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a557383d490f06812e911cc9acdb38d94}\index{pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}!set\_timeout@{set\_timeout}}
\index{set\_timeout@{set\_timeout}!pygaze.\_keyboard.basekeyboard.BaseKeyboard@{pygaze.\_keyboard.basekeyboard.BaseKeyboard}}
\doxysubsubsection{\texorpdfstring{set\_timeout()}{set\_timeout()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1basekeyboard_1_1_base_keyboard_a557383d490f06812e911cc9acdb38d94} 
pygaze.\+\_\+keyboard.\+basekeyboard.\+Base\+Keyboard.\+set\+\_\+timeout (\begin{DoxyParamCaption}\item[{}]{self}{}\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 in \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a573d0ba70bc13fd3791ff908b5868cac}{pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard}}, \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1psychopykeyboard_1_1_psycho_py_keyboard_aa62f28514156d4d11eaa21c3686c13b5}{pygaze.\+\_\+keyboard.\+psychopykeyboard.\+Psycho\+Py\+Keyboard}}, and \mbox{\hyperlink{classpygaze_1_1__keyboard_1_1pygamekeyboard_1_1_py_game_keyboard_af7fc03d7d6ec3d4628a7d0aa0dac28e5}{pygaze.\+\_\+keyboard.\+pygamekeyboard.\+Py\+Game\+Keyboard}}.



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