comparison lisp/mouse.el @ 72077:e345212112f0

(mouse-on-link-p): Doc fix.
author Thien-Thi Nguyen <ttn@gnuvola.org>
date Sun, 23 Jul 2006 21:13:13 +0000
parents baf495881cff
children 3fc22ce89bd1 858cb33ae39d
comparison
equal deleted inserted replaced
72076:3272294d88e3 72077:e345212112f0
775 (mouse-drag-track start-event t)))) 775 (mouse-drag-track start-event t))))
776 776
777 777
778 (defun mouse-on-link-p (pos) 778 (defun mouse-on-link-p (pos)
779 "Return non-nil if POS is on a link in the current buffer. 779 "Return non-nil if POS is on a link in the current buffer.
780 POS must be a buffer position in the current buffer or an mouse 780 POS must be a buffer position in the current buffer or a mouse
781 event location in the selected window, see `event-start'. 781 event location in the selected window (see `event-start').
782 However, if `mouse-1-click-in-non-selected-windows' is non-nil, 782 However, if `mouse-1-click-in-non-selected-windows' is non-nil,
783 POS may be a mouse event location in any window. 783 POS may be a mouse event location in any window.
784 784
785 A clickable link is identified by one of the following methods: 785 A clickable link is identified by one of the following methods:
786 786
796 - If the value is `mouse-face', POS is inside a link if there 796 - If the value is `mouse-face', POS is inside a link if there
797 is a non-nil `mouse-face' property at POS. Return t in this case. 797 is a non-nil `mouse-face' property at POS. Return t in this case.
798 798
799 - If the value is a function, FUNC, POS is inside a link if 799 - If the value is a function, FUNC, POS is inside a link if
800 the call \(FUNC POS) returns non-nil. Return the return value 800 the call \(FUNC POS) returns non-nil. Return the return value
801 from that call. Arg is \(posn-point POS) if POS is a mouse event, 801 from that call. Arg is \(posn-point POS) if POS is a mouse event.
802 802
803 - Otherwise, return the value itself. 803 - Otherwise, return the value itself.
804 804
805 The return value is interpreted as follows: 805 The return value is interpreted as follows:
806 806