aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorPo Lu2022-05-28 10:30:45 +0800
committerPo Lu2022-05-28 10:30:45 +0800
commit79ae40c8e4dac5898d68c92f26f625ac400b960c (patch)
treeeb08c34839a2db02b823846f51566eea86022358 /src
parentb52f36a33d84fad94deb2469d5b9f1bb96e2a920 (diff)
downloademacs-79ae40c8e4dac5898d68c92f26f625ac400b960c.tar.gz
emacs-79ae40c8e4dac5898d68c92f26f625ac400b960c.zip
Improve documentation on what callers of `x-begin-drag' should do
* doc/lispref/frames.texi (Drag and Drop): * src/xfns.c (Fx_begin_drag): Improve documentation of how the chosen action should be performed.
Diffstat (limited to 'src')
-rw-r--r--src/xfns.c9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/xfns.c b/src/xfns.c
index 60b22ff145d..9f218d2b7fe 100644
--- a/src/xfns.c
+++ b/src/xfns.c
@@ -6792,8 +6792,9 @@ buttons are released, then return the action chosen by the target, or
6792starts when the mouse is pressed on FRAME, and the contents of the 6792starts when the mouse is pressed on FRAME, and the contents of the
6793selection `XdndSelection' will be sent to the X window underneath the 6793selection `XdndSelection' will be sent to the X window underneath the
6794mouse pointer (the drop target) when the mouse button is released. 6794mouse pointer (the drop target) when the mouse button is released.
6795ACTION is a symbol which tells the target what the source will do, and 6795
6796can be one of the following: 6796ACTION is a symbol which tells the target what it should do, and can
6797be one of the following:
6797 6798
6798 - `XdndActionCopy', which means to copy the contents from the drag 6799 - `XdndActionCopy', which means to copy the contents from the drag
6799 source (FRAME) to the drop target. 6800 source (FRAME) to the drop target.
@@ -6805,6 +6806,10 @@ can be one of the following:
6805`XdndActionPrivate' is also a valid return value, and means that the 6806`XdndActionPrivate' is also a valid return value, and means that the
6806drop target chose to perform an unspecified or unknown action. 6807drop target chose to perform an unspecified or unknown action.
6807 6808
6809The source is also expected to cooperate with the target to perform
6810the action chosen by the target. For example, callers should delete
6811the buffer text that was dragged if `XdndActionMove' is returned.
6812
6808There are also some other valid values of ACTION that depend on 6813There are also some other valid values of ACTION that depend on
6809details of both the drop target's implementation details and that of 6814details of both the drop target's implementation details and that of
6810Emacs. For that reason, they are not mentioned here. Consult 6815Emacs. For that reason, they are not mentioned here. Consult