Update of /cvsroot/python/python/dist/src/Doc/lib
In directory slayer.i.sourceforge.net:/tmp/cvs-serv808
Modified Files:
libcurses.tex
Log Message:
Document .timeout() method and .typeahead() function
Index: libcurses.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcurses.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** libcurses.tex 2000/05/23 16:46:04 1.4
--- libcurses.tex 2000/06/21 01:42:51 1.5
***************
*** 343,346 ****
--- 343,358 ----
\end{funcdesc}
+ \begin{funcdesc}{typeahead}{fd}
+ Specifies that the file descriptor \var{fd} be used for typeahead
+ checking. If \var{fd} is -1, then no typeahead checking is done.
+
+ The curses library does ``line-breakout optimization'' by looking for
+ typeahead periodically while updating the screen. If input is found,
+ and it is coming from a tty, the current update is postponed until
+ refresh or doupdate is called again, allowing faster response to
+ commands typed in advance. This function allows specifying a different
+ file descriptor for typeahead checking.
+ \end{funcdesc}
+
\begin{funcdesc}{unctrl}{ch}
Returns a string which is a printable representation of the character
***************
*** 779,782 ****
--- 791,804 ----
Touches all locations in ancestors of the window that have been changed in
the window.
+ \end{methoddesc}
+
+ \begin{methoddesc}{timeout}{delay}
+ Sets blocking or non-blocking read behaviour for the window. If
+ \var{delay} is negative, blocking read is used, which will wait
+ indefinitely for input). If \var{delay} is zero, then non-blocking
+ read is used, and -1 will be returned by \method{getch()} if no input
+ is waiting. If \var{delay} is positive, then \method{getch()} will
+ block for \var{delay} milliseconds, and return -1 if there is still no
+ input at the end of that time.
\end{methoddesc}