Arbortext Command Language > Functions by Alphabetical Listing > drag_stop
  
drag_stop
drag_stop (do_cut)
This function stops the drag-and-drop mouse tracking initiated by the drag_start function and helps the user determine whether a paste can be performed or not. The do_cut parameter is a user-defined variable that is set by the function. The value of the specified do_cut variable reflects whether the user had the ctrl key down when they completed the drop. If the ctrl key was down, the user intended to copy the selection; the specified do_cut will be 0. If the ctrl key was up, the user intended to cut the selection, so the specified do_cut will be a 1.
This function returns one of the following values:
0drag_start was not called.
-1 — The mouse pointer has not moved since drag_start was called.
-2 — The mouse pointer is not in a Arbortext Editor window.
-3 — Cut would cause context errors.
-4 — Paste would cause context errors.
If the return code is greater than 0, then the value is the identifier of the window that has focus. This indicates that the cursor is at a valid paste location.
Related Topics
drag_start function