diff runtime/doc/popup.txt @ 17051:221d4b82bc0b v8.1.1525

patch 8.1.1525: cannot move a popup window with the mouse commit https://github.com/vim/vim/commit/b53fb31a1e27a806396e38592055cfb3ebf43cf9 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Jun 13 23:59:52 2019 +0200 patch 8.1.1525: cannot move a popup window with the mouse Problem: Cannot move a popup window with the mouse. Solution: Add the "drag" property and make it possible to drag a popup window by its border.
author Bram Moolenaar <Bram@vim.org>
date Fri, 14 Jun 2019 00:00:08 +0200
parents 6400d1ad5e4b
children dacd46fbaa90
line wrap: on
line diff
--- a/runtime/doc/popup.txt
+++ b/runtime/doc/popup.txt
@@ -95,7 +95,7 @@ IMPLEMENTATION:
 - For the "moved" property also include mouse movement?
 - When selecting text in the popup with modeless selection, do not select
   outside of the popup and don't select the border or padding.
-- Allow the user to drag the popup window when the "dragging" property is set.
+- Add test for dragging the popup window.
 - Make redrawing more efficient and avoid flicker:
     - put popup menu also put in popup_mask?
 - Invoke filter with character before mapping?
@@ -277,7 +277,7 @@ popup_menu({text}, {options})				 *popup
 
 
 popup_move({id}, {options})					*popup_move()*
-		Move popup {id} to the position speficied with {options}.
+		Move popup {id} to the position specified with {options}.
 		{options} may contain the items from |popup_create()| that
 		specify the popup position: "line", "col", "pos", "maxheight",
 		"minheight", "maxwidth" and "minwidth".
@@ -293,6 +293,7 @@ popup_notification({text}, {options})			
 				\ 'time': 3000,
 				\ 'tab': -1,
 				\ 'zindex': 200,
+				\ 'drag': 1,
 				\ 'highlight': 'WarningMsg',
 				\ 'border': [],
 				\ 'padding': [0,1,0,1],
@@ -409,9 +410,13 @@ The second argument of |popup_create()| 
 			{only -1 and 0 are implemented}
 	title		Text to be displayed above the first item in the
 			popup, on top of any border.  If there is no top
-			border on line of padding is added to put the title on.
+			border one line of padding is added to put the title
+			on.
 			{not implemented yet}
 	wrap		TRUE to make the lines wrap (default TRUE).
+	drag		TRUE to allow the popup to be dragged with the mouse
+			by grabbing at at the border.  Has no effect if the
+			popup does not have a border.
 	highlight	Highlight group name to use for the text, stored in
 			the 'wincolor' option.
 	padding		List with numbers, defining the padding
@@ -442,7 +447,7 @@ The second argument of |popup_create()| 
 			By default a double line is used all around when
 			'encoding' is "utf-8", otherwise ASCII characters are
 			used.
-	zindex		Priority for the popup, default 50.  Mininum value is
+	zindex		Priority for the popup, default 50.  Minimum value is
 			1, maximum value is 32000.
 	time		Time in milliseconds after which the popup will close.
 			When omitted |popup_close()| must be used.