Show
Ignore:
Timestamp:
07/29/06 07:48:34 (2 years ago)
Author:
miyoshi
Message:

Sync up with Emacs CVS HEAD.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/lispref/commands.texi

    r4111 r4131  
    21662166elsewhere in the event---in the coordinates.  But 
    21672167@code{read-key-sequence} translates this information into imaginary 
    2168 ``prefix keys'', all of which are symbols: @code{header-line}, 
     2168``prefix keys,'' all of which are symbols: @code{header-line}, 
    21692169@code{horizontal-scroll-bar}, @code{menu-bar}, @code{mode-line}, 
    21702170@code{vertical-line}, and @code{vertical-scroll-bar}.  You can define 
    …… 
    22002200None of the three functions below suppresses quitting. 
    22012201 
    2202 @defun read-event &optional prompt inherit-input-method 
     2202@defun read-event &optional prompt inherit-input-method seconds 
    22032203This function reads and returns the next event of command input, waiting 
    22042204if necessary until an event is available.  Events can come directly from 
    …… 
    22212221displayed there.  Otherwise @code{read-event} does not move the cursor. 
    22222222 
     2223If @var{seconds} is non-@code{nil}, it should be a number specifying 
     2224the maximum time to wait for input, in seconds.  If no input arrives 
     2225within that time, @code{read-event} stops waiting and returns 
     2226@code{nil}.  A floating-point value for @var{seconds} means to wait 
     2227for a fractional number of seconds.  Some systems support only a whole 
     2228number of seconds; on these systems, @var{seconds} is rounded down. 
     2229If @var{seconds} is @code{nil}, @code{read-event} waits as long as 
     2230necessary for input to arrive. 
     2231 
    22232232If @code{read-event} gets an event that is defined as a help character, 
    22242233then in some cases @code{read-event} processes the event directly without 
    …… 
    22382247@end defun 
    22392248 
    2240 @defun read-char &optional prompt inherit-input-method 
     2249@defun read-char &optional prompt inherit-input-method seconds 
    22412250This function reads and returns a character of command input.  If the 
    22422251user generates an event which is not a character (i.e. a mouse click or 
    …… 
    22702279@end defun 
    22712280 
    2272 @defun read-char-exclusive &optional prompt inherit-input-method 
     2281@defun read-char-exclusive &optional prompt inherit-input-method seconds 
    22732282This function reads and returns a character of command input.  If the 
    22742283user generates an event which is not a character, 
    …… 
    24112420@defvar unread-command-char 
    24122421This variable holds a character to be read as command input. 
    2413 A value of -1 means ``empty''. 
     2422A value of -1 means ``empty.'' 
    24142423 
    24152424This variable is mostly obsolete now that you can use 
    …… 
    25352544This function performs redisplay (provided there is no pending input 
    25362545from the user), then waits @var{seconds} seconds, or until input is 
    2537 available.  The value is @code{t} if @code{sit-for} waited the full 
    2538 time with no input arriving (see @code{input-pending-p} in @ref{Event 
    2539 Input Misc}).  Otherwise, the value is @code{nil}. 
     2546available.  The usual purpose of @code{sit-for} is to give the user 
     2547time to read text that you display.  The value is @code{t} if 
     2548@code{sit-for} waited the full time with no input arriving 
     2549(@pxref{Event Input Misc}).  Otherwise, the value is @code{nil}. 
    25402550 
    25412551The argument @var{seconds} need not be an integer.  If it is a floating 
    …… 
    25522562the timeout elapses). 
    25532563 
    2554 The usual purpose of @code{sit-for} is to give the user time to read 
    2555 text that you display. 
     2564In batch mode (@pxref{Batch Mode}), @code{sit-for} cannot be 
     2565interrupted, even by input from the standard input descriptor.  It is 
     2566thus equivalent to @code{sleep-for}, which is described below. 
    25562567 
    25572568It is also possible to call @code{sit-for} with three arguments, 
    …… 
    28992910major mode, which should have a command to go back to the previous mode. 
    29002911(The @kbd{e} command in Rmail uses this technique.)  Or, if you wish to 
    2901 give the user different text to edit ``recursively'', create and select 
     2912give the user different text to edit ``recursively,'' create and select 
    29022913a new buffer in a special mode.  In this mode, define a command to 
    29032914complete the processing and go back to the previous buffer.  (The