\doxysection{pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard Class Reference}
\hypertarget{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard}{}\label{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard}\index{pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}}
Inheritance diagram for pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_ae516e3fd7bb7f83e22bcbe4cd6b8dcd7}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, keylist=settings.\+KEYLIST, timeout=settings.\+KEYTIMEOUT)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a696668403d3dcec3395ca11a9c77482b}{set\+\_\+keylist}} (self, keylist=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a573d0ba70bc13fd3791ff908b5868cac}{set\+\_\+timeout}} (self, timeout=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a6bc52b598aa47696f6bcaeb29bbd6cc6}{get\+\_\+key}} (self, keylist=u \textquotesingle{}default\textquotesingle{}, timeout=u \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 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a7e38ab7e69dd1347cb6d6825a7afc911}{experiment}} = settings.\+osexperiment
\item 
\mbox{\hyperlink{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a97d298eeaada1169da65395cbf723878}{keyboard}}
\end{DoxyCompactItemize}


\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_ae516e3fd7bb7f83e22bcbe4cd6b8dcd7}\index{pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_ae516e3fd7bb7f83e22bcbe4cd6b8dcd7} 
pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard.\+\_\+\+\_\+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_1oskeyboard_1_1_o_s_keyboard_a6bc52b598aa47696f6bcaeb29bbd6cc6}\index{pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}!get\_key@{get\_key}}
\index{get\_key@{get\_key}!pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}}
\doxysubsubsection{\texorpdfstring{get\_key()}{get\_key()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a6bc52b598aa47696f6bcaeb29bbd6cc6} 
pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard.\+get\+\_\+key (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{keylist}{ = {\ttfamily u\textquotesingle{}default\textquotesingle{}}, }\item[{}]{timeout}{ = {\ttfamily u\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_1oskeyboard_1_1_o_s_keyboard_a696668403d3dcec3395ca11a9c77482b}\index{pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}!set\_keylist@{set\_keylist}}
\index{set\_keylist@{set\_keylist}!pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}}
\doxysubsubsection{\texorpdfstring{set\_keylist()}{set\_keylist()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a696668403d3dcec3395ca11a9c77482b} 
pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard.\+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_1oskeyboard_1_1_o_s_keyboard_a573d0ba70bc13fd3791ff908b5868cac}\index{pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}!set\_timeout@{set\_timeout}}
\index{set\_timeout@{set\_timeout}!pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}}
\doxysubsubsection{\texorpdfstring{set\_timeout()}{set\_timeout()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a573d0ba70bc13fd3791ff908b5868cac} 
pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard.\+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_1oskeyboard_1_1_o_s_keyboard_a7e38ab7e69dd1347cb6d6825a7afc911}\index{pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}!experiment@{experiment}}
\index{experiment@{experiment}!pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}}
\doxysubsubsection{\texorpdfstring{experiment}{experiment}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a7e38ab7e69dd1347cb6d6825a7afc911} 
pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard.\+experiment = settings.\+osexperiment}

\Hypertarget{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a97d298eeaada1169da65395cbf723878}\index{pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}!keyboard@{keyboard}}
\index{keyboard@{keyboard}!pygaze.\_keyboard.oskeyboard.OSKeyboard@{pygaze.\_keyboard.oskeyboard.OSKeyboard}}
\doxysubsubsection{\texorpdfstring{keyboard}{keyboard}}
{\footnotesize\ttfamily \label{classpygaze_1_1__keyboard_1_1oskeyboard_1_1_o_s_keyboard_a97d298eeaada1169da65395cbf723878} 
pygaze.\+\_\+keyboard.\+oskeyboard.\+OSKeyboard.\+keyboard}

{\bfseries Initial value\+:}
\begin{DoxyCode}{0}
\DoxyCodeLine{=\ \ keyboard(self.experiment,\ keylist=keylist,}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \ \ \ \ timeout=timeout)}

\end{DoxyCode}


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