Function: read--potential-mouse-event

read--potential-mouse-event is a byte-compiled function defined in subr.el.gz.

Signature

(read--potential-mouse-event)

Documentation

Read an event that might be a mouse event.

This function exists for backward compatibility in code packaged with Emacs. Do not call it directly in your own packages.

Source Code

;; Defined in /usr/src/emacs/lisp/subr.el.gz
;; FIXME: Once there's a safe way to transition away from read-event,
;; callers to this function should be updated to that way and this
;; function should be deleted.
(defun read--potential-mouse-event ()
  "Read an event that might be a mouse event.

This function exists for backward compatibility in code packaged
with Emacs.  Do not call it directly in your own packages."
  ;; `xterm-mouse-mode' events must go through `read-key' as they
  ;; are decoded via `input-decode-map'.
  (if (or xterm-mouse-mode
          ;; If a touch screen is being employed, then mouse events
          ;; are subject to translation as well.
          touch-screen-events-received)
      (read-key nil
                ;; Normally `read-key' discards all mouse button
                ;; down events.  However, we want them here.
                t)
    (read-event)))