diff options
author | Eli Zaretskii <eliz@gnu.org> | 2022-06-03 14:50:11 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2022-06-03 14:50:11 +0300 |
commit | dc7623a59e5e90d310cb1c338790a3df5f90e891 (patch) | |
tree | 22c5f4b83a86a84e42fd216964fa263e546ccfdb /lisp/dnd.el | |
parent | ca2e7409dcd694742704e424c3f6f5bc5f230f25 (diff) | |
download | emacs-dc7623a59e5e90d310cb1c338790a3df5f90e891.tar.gz emacs-dc7623a59e5e90d310cb1c338790a3df5f90e891.tar.bz2 emacs-dc7623a59e5e90d310cb1c338790a3df5f90e891.zip |
; Improve documentation of new drag-and-drop APIs
* lisp/dnd.el (dnd-begin-text-drag, dnd-begin-file-drag):
* doc/lispref/frames.texi (Drag and Drop): Improve wording of
documentation of 'dnd-begin-text-drag' and 'dnd-begin-file-drag'.
Diffstat (limited to 'lisp/dnd.el')
-rw-r--r-- | lisp/dnd.el | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/lisp/dnd.el b/lisp/dnd.el index c5d5788dc49..14d80ac6c57 100644 --- a/lisp/dnd.el +++ b/lisp/dnd.el @@ -313,10 +313,10 @@ in that list instead." "Begin dragging TEXT from FRAME. Initate a drag-and-drop operation allowing the user to drag text from Emacs to another program (the drop target), then block until -the drop happens or is cancelled. +the drop is completed or is cancelled. -Return the action that the drop target actually performed, which -can be one of the following symbols: +If the drop completed, return the action that the drop target +actually performed, which can be one of the following symbols: - `copy', which means TEXT was inserted by the drop target. @@ -331,13 +331,13 @@ Return nil if the drop was cancelled. TEXT is a string containing text that will be inserted by the program where the drop happened. FRAME is the frame where the -mouse is currently held down, or nil (which means to use the -current frame). ACTION is one of the symbols `copy' or `move', +mouse is currently held down, or nil, which stands for the +current frame. ACTION is one of the symbols `copy' or `move', where `copy' means that the text should be inserted by the drop -target, and `move' means the the same as copy, but in addition +target, and `move' means the the same as `copy', but in addition the caller might have to delete TEXT from its source after this -function returns. If ALLOW-SAME-FRAME is nil, any drops on FRAME -itself will be ignored. +function returns. If ALLOW-SAME-FRAME is nil, ignore any drops +on FRAME itself. This function might return immediately if no mouse buttons are currently being held down. It should only be called upon a @@ -367,7 +367,7 @@ currently being held down. It should only be called upon a (defun dnd-begin-file-drag (file &optional frame action allow-same-frame) "Begin dragging FILE from FRAME. -Initate a drag-and-drop operation allowing the user to drag files +Initate a drag-and-drop operation allowing the user to drag a file from Emacs to another program (the drop target), then block until the drop happens or is cancelled. @@ -387,17 +387,17 @@ can be one of the following symbols: Return nil if the drop was cancelled. -FILE is the file name that will be inserted by the program where -the drop happened. If it is a remote file, a temporary copy will -be made. FRAME is the frame where the mouse is currently held -down, or nil (which means to use the current frame). ACTION is -one of the symbols `copy', `move' or `link', where `copy' means -that the file should be opened or copied by the drop target, -`move' means the drop target should move the file to another -location, and `link' means the drop target should create a -symbolic link to FILE. It is an error to specify `link' as the -action if FILE is a remote file. If ALLOW-SAME-FRAME is nil, any -drops on FRAME itself will be ignored. +FILE is the file name that will be sent to the program where the +drop happened. If it is a remote file, Emacs will make a +temporary copy and pass that. FRAME is the frame where the mouse +is currently held down, or nil (which means to use the current +frame). ACTION is one of the symbols `copy', `move' or `link', +where `copy' means that the file should be opened or copied by +the drop target, `move' means the drop target should move the +file to another location, and `link' means the drop target should +create a symbolic link to FILE. It is an error to specify `link' +as the action if FILE is a remote file. If ALLOW-SAME-FRAME is +nil, any drops on FRAME itself will be ignored. This function might return immediately if no mouse buttons are currently being held down. It should only be called upon a |