Mercurial > emacs
changeset 72404:705d28578f2d
* commands.texi (Reading One Event): Explain idleness in
`read-event'.
| author | Chong Yidong <cyd@stupidchicken.com> |
|---|---|
| date | Tue, 15 Aug 2006 22:28:02 +0000 |
| parents | fe2a38afd46e |
| children | 8006b4a1c703 |
| files | lispref/commands.texi |
| diffstat | 1 files changed, 9 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/commands.texi Tue Aug 15 19:59:08 2006 +0000 +++ b/lispref/commands.texi Tue Aug 15 22:28:02 2006 +0000 @@ -2229,6 +2229,15 @@ If @var{seconds} is @code{nil}, @code{read-event} waits as long as necessary for input to arrive. +If @var{seconds} is @code{nil}, Emacs is considered idle while waiting +for user input to arrive. Idle timers---those created with +@code{run-with-idle-timer} (@pxref{Timers})---can run during this +period. However, if @var{seconds} is non-@code{nil}, the state of +idleness remains unchanged. If Emacs is non-idle when +@code{read-event} is called, it remains non-idle throughout the +operation of @code{read-event}; if Emacs is idle (which can happen if +the call happens inside an idle timer), it remains idle. + If @code{read-event} gets an event that is defined as a help character, then in some cases @code{read-event} processes the event directly without returning. @xref{Help Functions}. Certain other events, called