Variable: mouse-avoidance-banish-position

mouse-avoidance-banish-position is a customizable variable defined in avoid.el.gz.

Value

((frame-or-window . frame)
 (side . right)
 (side-pos . 3)
 (top-or-bottom . top)
 (top-or-bottom-pos . 0))

Documentation

Position to which Mouse Avoidance mode banish moves the mouse.

An alist where keywords mean: FRAME-OR-WINDOW: banish the mouse to corner of frame or window. SIDE: banish the mouse on right or left corner of frame or window. SIDE-POS: Distance from right or left edge of frame or window. TOP-OR-BOTTOM: banish the mouse to top or bottom of frame or window. TOP-OR-BOTTOM-POS: Distance from top or bottom edge of frame or window.

This variable was added, or its default value changed, in Emacs 24.3.

Probably introduced at or before Emacs version 24.3.

Source Code

;; Defined in /usr/src/emacs/lisp/avoid.el.gz
(defcustom mouse-avoidance-banish-position '((frame-or-window . frame)
                                             (side . right)
                                             (side-pos . 3)
                                             (top-or-bottom . top)
                                             (top-or-bottom-pos . 0))
  "Position to which Mouse Avoidance mode `banish' moves the mouse.
An alist where keywords mean:
FRAME-OR-WINDOW: banish the mouse to corner of frame or window.
SIDE: banish the mouse on right or left corner of frame or window.
SIDE-POS: Distance from right or left edge of frame or window.
TOP-OR-BOTTOM: banish the mouse to top or bottom of frame or window.
TOP-OR-BOTTOM-POS: Distance from top or bottom edge of frame or window."
  :group   'avoid
  :version "24.3"
  :type    '(alist :key-type symbol :value-type (choice symbol integer))
  :options '((frame-or-window symbol) (side symbol) (side-pos integer)
             (top-or-bottom symbol) (top-or-bottom-pos integer)))