comparison runtime/doc/netbeans.txt @ 2209:d0ddf7ba1630 vim73

Included the patch to support netbeans in a terminal.
author Bram Moolenaar <bram@vim.org>
date Sat, 22 May 2010 18:28:27 +0200
parents b17bbfa96fa0
children 8c6a66e2b3cc
comparison
equal deleted inserted replaced
2208:495995b9ce7d 2209:d0ddf7ba1630
113 the required features succeeds. 113 the required features succeeds.
114 114
115 In case you do not want the NetBeans interface you can disable it by 115 In case you do not want the NetBeans interface you can disable it by
116 uncommenting a line with "--disable-netbeans" in the Makefile. 116 uncommenting a line with "--disable-netbeans" in the Makefile.
117 117
118 Currently, only GVim is supported in this integration as NetBeans does not 118 Currently the NetBeans interface is supported by Vim running in a terminal and
119 have means to supply a terminal emulator for the Vim command. Furthermore, 119 by GVim when it is run with one of the following GUIs: GTK, GNOME, and Motif.
120 there is only GUI support for GTK, GNOME, and Motif.
121 120
122 If Motif support is required the user must supply XPM libraries. See 121 If Motif support is required the user must supply XPM libraries. See
123 |workshop-xpm| for details on obtaining the latest version of XPM. 122 |workshop-xpm| for details on obtaining the latest version of XPM.
124 123
125 124
148 *E463* 147 *E463*
149 Region is guarded, cannot modify 148 Region is guarded, cannot modify
150 The Vim Controller has defined guarded areas in the text, 149 The Vim Controller has defined guarded areas in the text,
151 which you cannot change. Also sets the current buffer, if 150 which you cannot change. Also sets the current buffer, if
152 necessary. 151 necessary.
152
153 *E532*
154 The defineAnnoType highlighting color name is too long
155 The maximum length of the "fg" or "bg" color argument in the
156 defineAnnoType command is 32 characters.
157 New in version 2.5.
153 158
154 *E656* 159 *E656*
155 Writes of unmodified buffers forbidden 160 Writes of unmodified buffers forbidden
156 Writes of unmodified buffers that were opened from the 161 Writes of unmodified buffers that were opened from the
157 Vim Controller are not possible. 162 Vim Controller are not possible.
234 to save the file so multiple writes were being done. This caused various 239 to save the file so multiple writes were being done. This caused various
235 problems and has been fixed in 2.2. To decrease the likelihood of this 240 problems and has been fixed in 2.2. To decrease the likelihood of this
236 confusion happening again, netbeans_saved() has been renamed to 241 confusion happening again, netbeans_saved() has been renamed to
237 netbeans_save_buffer(). 242 netbeans_save_buffer().
238 243
239 We are now at version 2.4. For the differences between 2.3 and 2.4 search for 244 We are now at version 2.5. For the differences between 2.4 and 2.5 search for
240 "2.4" below. 245 "2.5" below.
241 246
242 The messages are currently sent over a socket. Since the messages are in 247 The messages are currently sent over a socket. Since the messages are in
243 plain UTF-8 text this protocol could also be used with any other communication 248 plain UTF-8 text this protocol could also be used with any other communication
244 mechanism. 249 mechanism.
245 250
302 T true 307 T true
303 F false 308 F false
304 309
305 number Argument with a decimal number. 310 number Argument with a decimal number.
306 311
307 optnum Argument with either a decimal number or "none" (without the 312 color Argument with either a decimal number, "none" (without the
308 quotes). 313 quotes) or the name of a color (without the quotes) defined
314 both in the color list in|highlight-ctermfg| and in the color
315 list in|gui-colors|.
316 New in version 2.5.
309 317
310 offset A number argument that indicates a byte position in a buffer. 318 offset A number argument that indicates a byte position in a buffer.
311 The first byte has offset zero. Line breaks are counted for 319 The first byte has offset zero. Line breaks are counted for
312 how they appear in the file (CR/LF counts for two bytes). 320 how they appear in the file (CR/LF counts for two bytes).
313 Note that a multi-byte character is counted for the number of 321 Note that a multi-byte character is counted for the number of
364 Arguments: 372 Arguments:
365 typeNum number sequence number (not really used) 373 typeNum number sequence number (not really used)
366 typeName string name that identifies this annotation 374 typeName string name that identifies this annotation
367 tooltip string not used 375 tooltip string not used
368 glyphFile string name of icon file 376 glyphFile string name of icon file
369 fg optnum foreground color for line highlighting 377 fg color foreground color for line highlighting
370 bg optnum background color for line highlighting 378 bg color background color for line highlighting
371 Vim will define a sign for the annotation. 379 Vim will define a sign for the annotation.
380 When color is a number, this is the "#rrggbb" Red, Green and
381 Blue values of the color (see |gui-colors|) and the
382 highlighting is only defined for GVim.
383 When color is a name, this color is defined both for Vim
384 running in a color terminal and for GVim.
372 When both "fg" and "bg" are "none" no line highlighting is 385 When both "fg" and "bg" are "none" no line highlighting is
373 used (new in version 2.1). 386 used (new in version 2.1).
374 When "glyphFile" is empty, no text sign is used (new in 387 When "glyphFile" is empty, no text sign is used (new in
375 version 2.1). 388 version 2.1).
376 When "glyphFile" is one or two characters long, a text sign is 389 When "glyphFile" is one or two characters long, a text sign is
430 tell the editor what buffer number it will use for this file. 443 tell the editor what buffer number it will use for this file.
431 Also marks the buffer as initialized. 444 Also marks the buffer as initialized.
432 New in version 2.1. 445 New in version 2.1.
433 446
434 raise Bring the editor to the foreground. 447 raise Bring the editor to the foreground.
448 Only when Vim is run with a GUI.
435 New in version 2.1. 449 New in version 2.1.
436 450
437 removeAnno serNum 451 removeAnno serNum
438 Remove a previously place annotation for this buffer. 452 Remove a previously place annotation for this buffer.
439 "serNum" is the same number used in addAnno. 453 "serNum" is the same number used in addAnno.
519 533
520 showBalloon text 534 showBalloon text
521 Show a balloon (popup window) at the mouse pointer position, 535 Show a balloon (popup window) at the mouse pointer position,
522 containing "text", a string argument. The balloon should 536 containing "text", a string argument. The balloon should
523 disappear when the mouse is moved more than a few pixels. 537 disappear when the mouse is moved more than a few pixels.
538 Only when Vim is run with a GUI.
524 New in version 2.1. 539 New in version 2.1.
525 540
526 specialKeys 541 specialKeys
527 Map a set of keys (mostly function keys) to be passed back 542 Map a set of keys (mostly function keys) to be passed back
528 to the Vim Controller for processing. This lets regular IDE 543 to the Vim Controller for processing. This lets regular IDE
652 667
653 balloonText text 668 balloonText text
654 Used when 'ballooneval' is set and the mouse pointer rests on 669 Used when 'ballooneval' is set and the mouse pointer rests on
655 some text for a moment. "text" is a string, the text under 670 some text for a moment. "text" is a string, the text under
656 the mouse pointer. 671 the mouse pointer.
672 Only when Vim is run with a GUI.
657 New in version 2.1. 673 New in version 2.1.
658 674
659 buttonRelease button lnum col 675 buttonRelease button lnum col
660 Report which button was pressed and the location of the cursor 676 Report which button was pressed and the location of the cursor
661 at the time of the release. Only for buffers that are owned 677 at the time of the release. Only for buffers that are owned
800 ============================================================================== 816 ==============================================================================
801 8. Known problems *netbeans-problems* 817 8. Known problems *netbeans-problems*
802 818
803 NUL bytes are not possible. For editor -> IDE they will appear as NL 819 NUL bytes are not possible. For editor -> IDE they will appear as NL
804 characters. For IDE -> editor they cannot be inserted. 820 characters. For IDE -> editor they cannot be inserted.
821
822 A NetBeans session may be initiated with Vim running in a terminal, and
823 continued later in a GUI environment after running the |:gui|command. In this
824 case, the highlighting defined for the NetBeans annotations may be cleared
825 when the ":gui" command sources .gvimrc and this file loads a colorscheme
826 that runs the command ":highlight clear".
827 New in version 2.5.
805 828
806 829
807 ============================================================================== 830 ==============================================================================
808 9. Debugging NetBeans protocol *netbeans-debugging* 831 9. Debugging NetBeans protocol *netbeans-debugging*
809 832