X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=info%2Flispref.info-17;h=37d9cc3f96807cd5bc5ff2de0cb83db2d0103c23;hb=9dab7627f5aa4b82bc092df9dacb1c401ced0e5e;hp=85e2c101c91bd8d075db2fe2505c1091c769280a;hpb=82da33b61c3e2dd2937db17b75b2838188793053;p=chise%2Fxemacs-chise.git- diff --git a/info/lispref.info-17 b/info/lispref.info-17 index 85e2c10..37d9cc3 100644 --- a/info/lispref.info-17 +++ b/info/lispref.info-17 @@ -1,5 +1,5 @@ -This is Info file ../info/lispref.info, produced by Makeinfo version -1.68 from the input file lispref/lispref.texi. +This is ../info/lispref.info, produced by makeinfo version 4.0 from +lispref/lispref.texi. INFO-DIR-SECTION XEmacs Editor START-INFO-DIR-ENTRY @@ -134,7 +134,7 @@ value at the end, like this: is the nearest character equivalent to it (or `nil' if there is no character equivalent). `last-command-char' is the character that `self-insert-command' will insert in the buffer. Remember that - there is *not* a one-to-one mapping between keyboard events and + there is _not_ a one-to-one mapping between keyboard events and XEmacs characters: many keyboard events have no corresponding character, and when the Mule feature is available, most characters can not be input on standard keyboards, except possibly with help @@ -184,7 +184,7 @@ command binding of the key sequence. For information about how exactly the XEmacs command loop works, *Note Reading Input::. - - Function: eventp OBJECT + - Function: eventp object This function returns non-`nil' if EVENT is an input event. * Menu: @@ -305,7 +305,7 @@ button-release event modifiers Which modifier keys were pressed. The special business - mentioned above for the shift key does *not* apply to mouse + mentioned above for the shift key does _not_ apply to mouse events. x @@ -325,7 +325,7 @@ pointer-motion event modifiers Which modifier keys were pressed. The special business - mentioned above for the shift key does *not* apply to mouse + mentioned above for the shift key does _not_ apply to mouse events. misc-user event @@ -346,7 +346,7 @@ misc-user event modifiers Which modifier keys were pressed. The special business - mentioned above for the shift key does *not* apply to mouse + mentioned above for the shift key does _not_ apply to mouse events. x @@ -390,7 +390,7 @@ eval event The object to pass to the function. The function and object are set when the event is created. - - Function: event-type EVENT + - Function: event-type event Return the type of EVENT. This will be a symbol; one of @@ -432,39 +432,39 @@ Event Predicates The following predicates return whether an object is an event of a particular type. - - Function: key-press-event-p OBJECT + - Function: key-press-event-p object This is true if OBJECT is a key-press event. - - Function: button-event-p OBJECT OBJECT + - Function: button-event-p object object This is true if OBJECT is a mouse button-press or button-release event. - - Function: button-press-event-p OBJECT + - Function: button-press-event-p object This is true if OBJECT is a mouse button-press event. - - Function: button-release-event-p OBJECT + - Function: button-release-event-p object This is true if OBJECT is a mouse button-release event. - - Function: motion-event-p OBJECT + - Function: motion-event-p object This is true if OBJECT is a mouse motion event. - - Function: mouse-event-p OBJECT + - Function: mouse-event-p object This is true if OBJECT is a mouse button-press, button-release or motion event. - - Function: eval-event-p OBJECT + - Function: eval-event-p object This is true if OBJECT is an eval event. - - Function: misc-user-event-p OBJECT + - Function: misc-user-event-p object This is true if OBJECT is a misc-user event. - - Function: process-event-p OBJECT + - Function: process-event-p object This is true if OBJECT is a process event. - - Function: timeout-event-p OBJECT + - Function: timeout-event-p object This is true if OBJECT is a timeout event. - - Function: event-live-p OBJECT + - Function: event-live-p object This is true if OBJECT is any event that has not been deallocated.  @@ -497,18 +497,18 @@ Frame-Level Event Position Info The following functions return frame-level information about where a mouse event occurred. - - Function: event-frame EVENT + - Function: event-frame event This function returns the "channel" or frame that the given mouse motion, button press, button release, or misc-user event occurred in. This will be `nil' for non-mouse events. - - Function: event-x-pixel EVENT + - Function: event-x-pixel event This function returns the X position in pixels of the given mouse event. The value returned is relative to the frame the event occurred in. This will signal an error if the event is not a mouse event. - - Function: event-y-pixel EVENT + - Function: event-y-pixel event This function returns the Y position in pixels of the given mouse event. The value returned is relative to the frame the event occurred in. This will signal an error if the event is not a @@ -523,14 +523,14 @@ Window-Level Event Position Info The following functions return window-level information about where a mouse event occurred. - - Function: event-window EVENT + - Function: event-window event Given a mouse motion, button press, button release, or misc-user event, compute and return the window on which that event occurred. This may be `nil' if the event occurred in the border or over a toolbar. The modeline is considered to be within the window it describes. - - Function: event-buffer EVENT + - Function: event-buffer event Given a mouse motion, button press, button release, or misc-user event, compute and return the buffer of the window on which that event occurred. This may be `nil' if the event occurred in the @@ -539,13 +539,13 @@ a mouse event occurred. `event-window' and then calling `window-buffer' on the result if it is a window. - - Function: event-window-x-pixel EVENT + - Function: event-window-x-pixel event This function returns the X position in pixels of the given mouse event. The value returned is relative to the window the event occurred in. This will signal an error if the event is not a mouse-motion, button-press, button-release, or misc-user event. - - Function: event-window-y-pixel EVENT + - Function: event-window-y-pixel event This function returns the Y position in pixels of the given mouse event. The value returned is relative to the window the event occurred in. This will signal an error if the event is not a @@ -560,35 +560,35 @@ Event Text Position Info The following functions return information about the text (including the modeline) that a mouse event occurred over or near. - - Function: event-over-text-area-p EVENT + - Function: event-over-text-area-p event Given a mouse-motion, button-press, button-release, or misc-user event, this function returns `t' if the event is over the text area of a window. Otherwise, `nil' is returned. The modeline is not considered to be part of the text area. - - Function: event-over-modeline-p EVENT + - Function: event-over-modeline-p event Given a mouse-motion, button-press, button-release, or misc-user event, this function returns `t' if the event is over the modeline of a window. Otherwise, `nil' is returned. - - Function: event-x EVENT + - Function: event-x event This function returns the X position of the given mouse-motion, button-press, button-release, or misc-user event in characters. This is relative to the window the event occurred over. - - Function: event-y EVENT + - Function: event-y event This function returns the Y position of the given mouse-motion, button-press, button-release, or misc-user event in characters. This is relative to the window the event occurred over. - - Function: event-point EVENT + - Function: event-point event This function returns the character position of the given mouse-motion, button-press, button-release, or misc-user event. If the event did not occur over a window, or did not occur over text, then this returns `nil'. Otherwise, it returns an index into the buffer visible in the event's window. - - Function: event-closest-point EVENT + - Function: event-closest-point event This function returns the character position of the given mouse-motion, button-press, button-release, or misc-user event. If the event did not occur over a window or over text, it returns @@ -611,23 +611,23 @@ Event Glyph Position Info The following functions return information about the glyph (if any) that a mouse event occurred over. - - Function: event-over-glyph-p EVENT + - Function: event-over-glyph-p event Given a mouse-motion, button-press, button-release, or misc-user event, this function returns `t' if the event is over a glyph. Otherwise, `nil' is returned. - - Function: event-glyph-extent EVENT + - Function: event-glyph-extent event If the given mouse-motion, button-press, button-release, or misc-user event happened on top of a glyph, this returns its extent; else `nil' is returned. - - Function: event-glyph-x-pixel EVENT + - Function: event-glyph-x-pixel event Given a mouse-motion, button-press, button-release, or misc-user event over a glyph, this function returns the X position of the pointer relative to the upper left of the glyph. If the event is not over a glyph, it returns `nil'. - - Function: event-glyph-y-pixel EVENT + - Function: event-glyph-y-pixel event Given a mouse-motion, button-press, button-release, or misc-user event over a glyph, this function returns the Y position of the pointer relative to the upper left of the glyph. If the event is @@ -639,12 +639,12 @@ File: lispref.info, Node: Event Toolbar Position Info, Next: Other Event Posit Event Toolbar Position Info ........................... - - Function: event-over-toolbar-p EVENT + - Function: event-over-toolbar-p event Given a mouse-motion, button-press, button-release, or misc-user event, this function returns `t' if the event is over a toolbar. Otherwise, `nil' is returned. - - Function: event-toolbar-button EVENT + - Function: event-toolbar-button event If the given mouse-motion, button-press, button-release, or misc-user event happened on top of a toolbar button, this function returns the button. Otherwise, `nil' is returned. @@ -655,7 +655,7 @@ File: lispref.info, Node: Other Event Position Info, Prev: Event Toolbar Posit Other Event Position Info ......................... - - Function: event-over-border-p EVENT + - Function: event-over-border-p event Given a mouse-motion, button-press, button-release, or misc-user event, this function returns `t' if the event is over an internal toolbar. Otherwise, `nil' is returned. @@ -669,39 +669,39 @@ Accessing the Other Contents of Events The following functions allow access to the contents of events other than the position info described in the previous section. - - Function: event-timestamp EVENT + - Function: event-timestamp event This function returns the timestamp of the given event object. - - Function: event-device EVENT + - Function: event-device event This function returns the device that the given event occurred on. - - Function: event-key EVENT + - Function: event-key event This function returns the Keysym of the given key-press event. This will be the ASCII code of a printing character, or a symbol. - - Function: event-button EVENT + - Function: event-button event This function returns the button-number of the given button-press or button-release event. - - Function: event-modifiers EVENT + - Function: event-modifiers event This function returns a list of symbols, the names of the modifier keys which were down when the given mouse or keyboard event was produced. - - Function: event-modifier-bits EVENT + - Function: event-modifier-bits event This function returns a number representing the modifier keys which were down when the given mouse or keyboard event was produced. - - Function: event-function EVENT + - Function: event-function event This function returns the callback function of the given timeout, misc-user, or eval event. - - Function: event-object EVENT + - Function: event-object event This function returns the callback function argument of the given timeout, misc-user, or eval event. - - Function: event-process EVENT + - Function: event-process event This function returns the process of the given process event.  @@ -716,7 +716,7 @@ as an argument and fill in the fields of this event; or they make accept either an event object or `nil', creating the event object first in the latter case. - - Function: make-event &optional TYPE PLIST + - Function: make-event &optional type plist This function creates a new event structure. If no arguments are specified, the created event will be empty. To specify the event type, use the TYPE argument. The allowed types are `empty', @@ -770,7 +770,7 @@ latter case. The event timestamp, a non-negative integer. Allowed for all types of events. - *WARNING*: the event object returned by this function may be a + _WARNING_: the event object returned by this function may be a reused one; see the function `deallocate-event'. The events created by `make-event' can be used as non-interactive @@ -782,28 +782,28 @@ latter case. ;; Create an empty event. (make-event) => # - + ;; Try creating a key-press event. (make-event 'key-press) error--> Undefined key for keypress event - + ;; Creating a key-press event, try 2 (make-event 'key-press '(key home)) => # - + ;; Create a key-press event of dubious fame. (make-event 'key-press '(key escape modifiers (meta alt control shift))) => # - + ;; Create a M-button1 event at coordinates defined by variables ;; X and Y. (make-event 'button-press `(button 1 modifiers (meta) x ,x y ,y)) => # - + ;; Create a similar button-release event. (make-event 'button-release `(button 1 modifiers (meta) x ,x y ,x)) => # - + ;; Create a mouse-motion event. (make-event 'motion '(x 20 y 30)) => # @@ -831,13 +831,13 @@ latter case. (append '(modifiers nil) (event-properties EVENT))) - - Function: copy-event EVENT1 &optional EVENT2 + - Function: copy-event event1 &optional event2 This function makes a copy of the given event object. If a second argument is given, the first event is copied into the second and the second is returned. If the second argument is not supplied (or is `nil') then a new event will be made. - - Function: deallocate-event EVENT + - Function: deallocate-event event This function allows the given event structure to be reused. You *MUST NOT* use this event object after calling this function with it. You will lose. It is not necessary to call this function, as @@ -855,7 +855,7 @@ Converting Events events and other ways of representing keys. These are useful when working with ASCII strings and with keymaps. - - Function: character-to-event CH &optional EVENT DEVICE + - Function: character-to-event ch &optional event device This function converts a numeric ASCII value to an event structure, replete with modifier bits. CH is the character to convert, and EVENT is the event object to fill in. This function contains @@ -878,8 +878,8 @@ working with ASCII strings and with keymaps. strictly inverse functions, since events contain much more information than the ASCII character set can encode. - - Function: event-to-character EVENT &optional ALLOW-EXTRA-MODIFIERS - ALLOW-META ALLOW-NON-ASCII + - Function: event-to-character event &optional allow-extra-modifiers + allow-meta allow-non-ascii This function returns the closest ASCII approximation to EVENT. If the event isn't a keypress, this returns `nil'. @@ -904,7 +904,7 @@ working with ASCII strings and with keymaps. ambiguous, as both use the high bit; and will be indistinguishable. - - Function: events-to-keys EVENTS &optional NO-MICE + - Function: events-to-keys events &optional no-mice Given a vector of event objects, this function returns a vector of key descriptors, or a string (if they all fit in the ASCII range). Optional arg NO-MICE means that button events are not allowed. @@ -944,7 +944,7 @@ Key Sequence Input `read-key-sequence'; for example, `describe-key' uses it to read the key to describe. - - Function: read-key-sequence PROMPT + - Function: read-key-sequence prompt This function reads a sequence of keystrokes or mouse clicks and returns it as a vector of events. It keeps reading events until it has accumulated a full key sequence; that is, enough to specify @@ -994,7 +994,7 @@ single event. These functions often make a distinction between actions), and other events, which serve as communication between XEmacs and the window system. - - Function: next-event &optional EVENT PROMPT + - Function: next-event &optional event prompt This function reads and returns the next available event from the window system or terminal driver, waiting if necessary until an event is available. Pass this object to `dispatch-event' to @@ -1007,7 +1007,7 @@ and the window system. In most cases, the function `next-command-event' is more appropriate. - - Function: next-command-event &optional EVENT + - Function: next-command-event &optional event This function returns the next available "user" event from the window system or terminal driver. Pass this object to `dispatch-event' to handle it. If an event object is supplied, it @@ -1041,7 +1041,7 @@ and the window system. compatibility with Emacs 18, and is most likely the wrong thing for you to be using: consider using `next-command-event' instead. - - Function: enqueue-eval-event FUNCTION OBJECT + - Function: enqueue-eval-event function object This function adds an eval event to the back of the queue. The eval event will be the next event read after all pending events. @@ -1051,7 +1051,7 @@ File: lispref.info, Node: Dispatching an Event, Next: Quoted Character Input, Dispatching an Event -------------------- - - Function: dispatch-event EVENT + - Function: dispatch-event event Given an event object returned by `next-event', this function executes it. This is the basic function that makes XEmacs respond to user input; it also deals with notifications from the window @@ -1068,7 +1068,7 @@ specify a character, and allow the user to specify a control or meta character conveniently, either literally or as an octal character code. The command `quoted-insert' uses this function. - - Function: read-quoted-char &optional PROMPT + - Function: read-quoted-char &optional prompt This function is like `read-char', except that if the first character read is an octal digit (0-7), it reads up to two more octal digits (but stopping if a non-octal digit is found) and @@ -1163,7 +1163,7 @@ input. - Variable: last-input-char If the value of `last-input-event' is a keyboard event, then this is the nearest ASCII equivalent to it. Remember that there is - *not* a 1:1 mapping between keyboard events and ASCII characters: + _not_ a 1:1 mapping between keyboard events and ASCII characters: the set of keyboard events is much larger, so writing code that examines this variable to determine what key has been typed is bad practice, unless you are certain that it will be one of a small @@ -1201,7 +1201,7 @@ input comes in, while `sleep-for' pauses without updating the screen. two arguments to specify the time (one integer and one float value), instead of a single argument that can be either an integer or a float. - - Function: sit-for SECONDS &optional NODISP + - Function: sit-for seconds &optional nodisp This function performs redisplay (provided there is no pending input from the user), then waits SECONDS seconds, or until input is available. The result is `t' if `sit-for' waited the full time @@ -1224,7 +1224,7 @@ instead of a single argument that can be either an integer or a float. The usual purpose of `sit-for' is to give the user time to read text that you display. - - Function: sleep-for SECONDS + - Function: sleep-for seconds This function simply pauses for SECONDS seconds without updating the display. This function pays no attention to available input. It returns `nil'.