aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/avoid.el
diff options
context:
space:
mode:
Diffstat (limited to 'lisp/avoid.el')
-rw-r--r--lisp/avoid.el15
1 files changed, 7 insertions, 8 deletions
diff --git a/lisp/avoid.el b/lisp/avoid.el
index c864d48e9ce..038927105ec 100644
--- a/lisp/avoid.el
+++ b/lisp/avoid.el
@@ -76,7 +76,7 @@
76 76
77;;;###autoload 77;;;###autoload
78(defcustom mouse-avoidance-mode nil 78(defcustom mouse-avoidance-mode nil
79 "Activate mouse avoidance mode. 79 "Activate Mouse Avoidance mode.
80See function `mouse-avoidance-mode' for possible values. 80See function `mouse-avoidance-mode' for possible values.
81Setting this variable directly does not take effect; 81Setting this variable directly does not take effect;
82use either \\[customize] or the function `mouse-avoidance-mode'." 82use either \\[customize] or the function `mouse-avoidance-mode'."
@@ -85,8 +85,7 @@ use either \\[customize] or the function `mouse-avoidance-mode'."
85 (mouse-avoidance-mode (or value 'none))) 85 (mouse-avoidance-mode (or value 'none)))
86 :initialize 'custom-initialize-default 86 :initialize 'custom-initialize-default
87 :type '(choice (const :tag "none" nil) (const banish) (const jump) 87 :type '(choice (const :tag "none" nil) (const banish) (const jump)
88 (const animate) (const exile) (const proteus) 88 (const animate) (const exile) (const proteus))
89 )
90 :group 'avoid 89 :group 'avoid
91 :require 'avoid 90 :require 'avoid
92 :version "20.3") 91 :version "20.3")
@@ -94,7 +93,7 @@ use either \\[customize] or the function `mouse-avoidance-mode'."
94 93
95(defcustom mouse-avoidance-nudge-dist 15 94(defcustom mouse-avoidance-nudge-dist 15
96 "Average distance that mouse will be moved when approached by cursor. 95 "Average distance that mouse will be moved when approached by cursor.
97Only applies in Mouse-Avoidance mode `jump' and its derivatives. 96Only applies in Mouse Avoidance mode `jump' and its derivatives.
98For best results make this larger than `mouse-avoidance-threshold'." 97For best results make this larger than `mouse-avoidance-threshold'."
99 :type 'integer 98 :type 'integer
100 :group 'avoid) 99 :group 'avoid)
@@ -112,7 +111,7 @@ For best results make this larger than `mouse-avoidance-threshold'."
112(defcustom mouse-avoidance-threshold 5 111(defcustom mouse-avoidance-threshold 5
113 "Mouse-pointer's flight distance. 112 "Mouse-pointer's flight distance.
114If the cursor gets closer than this, the mouse pointer will move away. 113If the cursor gets closer than this, the mouse pointer will move away.
115Only applies in mouse-avoidance-modes `animate' and `jump'." 114Only applies in Mouse Avoidance modes `animate' and `jump'."
116 :type 'integer 115 :type 'integer
117 :group 'avoid) 116 :group 'avoid)
118 117
@@ -183,7 +182,7 @@ Acceptable distance is defined by `mouse-avoidance-threshold'."
183 mouse-avoidance-threshold)))))) 182 mouse-avoidance-threshold))))))
184 183
185(defun mouse-avoidance-banish-destination () 184(defun mouse-avoidance-banish-destination ()
186 "The position to which Mouse-Avoidance mode `banish' moves the mouse. 185 "The position to which Mouse Avoidance mode `banish' moves the mouse.
187You can redefine this if you want the mouse banished to a different corner." 186You can redefine this if you want the mouse banished to a different corner."
188 (let* ((pos (window-edges))) 187 (let* ((pos (window-edges)))
189 (cons (- (nth 2 pos) 2) 188 (cons (- (nth 2 pos) 2)
@@ -333,7 +332,7 @@ redefine this function to suit your own tastes."
333 332
334;;;###autoload 333;;;###autoload
335(defun mouse-avoidance-mode (&optional mode) 334(defun mouse-avoidance-mode (&optional mode)
336 "Set cursor avoidance mode to MODE. 335 "Set Mouse Avoidance mode to MODE.
337MODE should be one of the symbols `banish', `exile', `jump', `animate', 336MODE should be one of the symbols `banish', `exile', `jump', `animate',
338`cat-and-mouse', `proteus', or `none'. 337`cat-and-mouse', `proteus', or `none'.
339 338
@@ -353,7 +352,7 @@ Effects of the different modes:
353 352
354Whenever the mouse is moved, the frame is also raised. 353Whenever the mouse is moved, the frame is also raised.
355 354
356\(see `mouse-avoidance-threshold' for definition of \"too close\", 355\(See `mouse-avoidance-threshold' for definition of \"too close\",
357and `mouse-avoidance-nudge-dist' and `mouse-avoidance-nudge-var' for 356and `mouse-avoidance-nudge-dist' and `mouse-avoidance-nudge-var' for
358definition of \"random distance\".)" 357definition of \"random distance\".)"
359 (interactive 358 (interactive