Variable: x-dnd-test-function

x-dnd-test-function is a customizable variable defined in x-dnd.el.gz.

Value

x-dnd-default-test-function

Documentation

Function to be used by drag-and-drop to determine whether to accept a drop.

The function takes three arguments: WINDOW, ACTION, and TYPES. WINDOW is where the window under the mouse is when the function is called. WINDOW may be a frame if the mouse isn't over a real window (e.g., menu bar, tool bar, scroll bar, etc.). ACTION is the suggested action from the drag and drop source, one of the symbols move, copy, link or ask. TYPES is a vector of available types for the drop. Each element of TYPES should either be a string (containing the name of the type's X atom), or a symbol, whose name will be used.

The function shall return nil to reject the drop or a cons with two values, the wanted action as car and the wanted type as cdr. The wanted action can be copy, move, link, ask or private.

The default value for this variable is x-dnd-default-test-function.

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

View in manual

Source Code

;; Defined in /usr/src/emacs/lisp/x-dnd.el.gz
;;; Customizable variables
(defcustom x-dnd-test-function #'x-dnd-default-test-function
  "Function to be used by drag-and-drop to determine whether to accept a drop.
The function takes three arguments: WINDOW, ACTION, and TYPES.
WINDOW is where the window under the mouse is when the function is called.
WINDOW may be a frame if the mouse isn't over a real window (e.g., menu
bar, tool bar, scroll bar, etc.).
ACTION is the suggested action from the drag and drop source, one of the
symbols `move', `copy', `link' or `ask'.
TYPES is a vector of available types for the drop.
Each element of TYPES should either be a string (containing the
name of the type's X atom), or a symbol, whose name will be used.

The function shall return nil to reject the drop or a cons with
two values, the wanted action as `car' and the wanted type as `cdr'.
The wanted action can be `copy', `move', `link', `ask' or `private'.

The default value for this variable is `x-dnd-default-test-function'."
  :version "22.1"
  :type 'symbol
  :group 'x)