2 '\" Copyright (c) 1990 The Regents of the University of California.
3 '\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 .TH listbox n 8.4 Tk "Tk Built-In Commands"
9 .\" The -*- nroff -*- definitions below are for supplemental macros used
10 .\" in Tcl/Tk manual entries.
12 .\" .AP type name in/out ?indent?
13 .\" Start paragraph describing an argument to a library procedure.
14 .\" type is type of argument (int, etc.), in/out is either "in", "out",
15 .\" or "in/out" to describe whether procedure reads or modifies arg,
16 .\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 .\" needed; use .AS below instead)
20 .\" Give maximum sizes of arguments for setting tab stops. Type and
21 .\" name are examples of largest possible arguments that will be passed
22 .\" to .AP later. If args are omitted, default tab stops are used.
25 .\" Start box enclosure. From here until next .BE, everything will be
26 .\" enclosed in one large box.
29 .\" End of box enclosure.
32 .\" Begin code excerpt.
37 .\" .VS ?version? ?br?
38 .\" Begin vertical sidebar, for use in marking newly-changed parts
39 .\" of man pages. The first argument is ignored and used for recording
40 .\" the version when the .VS was added, so that the sidebars can be
41 .\" found and removed when they reach a certain age. If another argument
42 .\" is present, then a line break is forced before starting the sidebar.
45 .\" End of vertical sidebar.
48 .\" Begin an indented unfilled display.
51 .\" End of indented unfilled display.
54 .\" Start of list of standard options for a Tk widget. The manpage
55 .\" argument defines where to look up the standard options; if
56 .\" omitted, defaults to "options". The options follow on successive
57 .\" lines, in three columns separated by tabs.
60 .\" End of list of standard options for a Tk widget.
62 .\" .OP cmdName dbName dbClass
63 .\" Start of description of a specific option. cmdName gives the
64 .\" option's name as specified in the class command, dbName gives
65 .\" the option's name in the option database, and dbClass gives
66 .\" the option's class in the option database.
69 .\" Print arg1 underlined, then print arg2 normally.
72 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
75 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
76 .\" (for trailing punctuation) and then a closing parenthesis.
78 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
82 .\" # Start an argument description
86 . ie !"\\$2"" .TP \\n()Cu
91 \&\\$1 \\fI\\$2\\fP (\\$3)
104 .\" # define tabbing values for .AP
107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
113 .AS Tcl_Interp Tcl_CreateInterp in/out
114 .\" # BS - start boxed text
115 .\" # ^y = starting y location
123 .if n \l'\\n(.lu\(ul'
126 .\" # BE - end boxed text (draw box now)
131 .ie n \l'\\n(^lu\(ul'
133 .\" Draw four-sided box normally, but don't draw top of
134 .\" box if the box started on an earlier page.
136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
146 .\" # VS - start vertical sidebar
147 .\" # ^Y = starting y location
148 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
152 .ie n 'mc \s12\(br\s0
155 .\" # VE - end of vertical sidebar
163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
170 .\" # Special macro to handle page bottom: finish off current
171 .\" # box/sidebar if in box/sidebar mode, then invoked standard
172 .\" # page bottom macro.
179 .\" Draw three-sided box if this is the box's first page,
180 .\" draw two sides but no top otherwise.
181 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
185 .nr ^x \\n(^tu+1v-\\n(^Yu
186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
199 .\" # DS - begin display
205 .\" # DE - end display
211 .\" # SO - start of list of standard options
213 'ie '\\$1'' .ds So \\fBoptions\\fR
214 'el .ds So \\fB\\$1\\fR
215 .SH "STANDARD OPTIONS"
221 .\" # SE - end of list of standard options
226 See the \\*(So manual entry for details on the standard options.
228 .\" # OP - start of full description for a single option
233 Command-Line Name: \\fB\\$1\\fR
234 Database Name: \\fB\\$2\\fR
235 Database Class: \\fB\\$3\\fR
239 .\" # CS - begin code excerpt
245 .\" # CE - end code excerpt
250 .\" # UL - underline word
254 .\" # QW - apply quotation marks to word
256 .ie '\\*(lq'"' ``\\$1''\\$2
257 .\"" fix emacs highlighting
258 .el \\*(lq\\$1\\*(rq\\$2
260 .\" # PQ - apply parens and quotation marks to word
262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
263 .\"" fix emacs highlighting
264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
266 .\" # QR - quoted range
268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
269 .\"" fix emacs highlighting
270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
272 .\" # MT - "empty" string
277 '\" Note: do not modify the .SH NAME line immediately below!
279 listbox \- Create and manipulate 'listbox' item list widgets
281 \fBlistbox\fR \fIpathName \fR?\fIoptions\fR?
283 \-background \-borderwidth \-cursor
284 \-disabledforeground \-exportselection \-font
285 \-foreground \-highlightbackground \-highlightcolor
286 \-highlightthickness \-relief \-selectbackground
287 \-selectborderwidth \-selectforeground \-setgrid
288 \-takefocus \-xscrollcommand \-yscrollcommand
290 .SH "WIDGET-SPECIFIC OPTIONS"
291 .OP \-activestyle activeStyle ActiveStyle
292 Specifies the style in which to draw the active element. This must be
293 one of \fBdotbox\fR (show a focus ring around the active element),
294 \fBnone\fR (no special indication of active element) or
295 \fBunderline\fR (underline the active element).
296 The default is \fBunderline\fR on Windows, and \fBdotbox\fR elsewhere.
297 .OP \-height height Height
298 Specifies the desired height for the window, in lines.
299 If zero or less, then the desired height for the window is made just
300 large enough to hold all the elements in the listbox.
301 .OP \-listvariable listVariable Variable
302 Specifies the name of a global variable. The value of the variable is a list to
303 be displayed inside the widget; if the variable value changes then the
304 widget will automatically update itself to reflect the new value. Attempts
305 to assign a variable with an invalid list value to \fB\-listvariable\fR
306 will cause an error. Attempts to unset a variable in use as a
307 \fB\-listvariable\fR will fail but will not generate an error.
308 .OP \-selectmode selectMode SelectMode
309 Specifies one of several styles for manipulating the selection.
310 The value of the option may be arbitrary, but the default bindings
311 expect it to be either \fBsingle\fR, \fBbrowse\fR, \fBmultiple\fR,
312 or \fBextended\fR; the default value is \fBbrowse\fR.
313 .OP \-state state State
314 Specifies one of two states for the listbox: \fBnormal\fR or \fBdisabled\fR.
315 If the listbox is disabled then items may not be inserted or deleted,
316 items are drawn in the \fB\-disabledforeground\fR color, and selection
317 cannot be modified and is not shown (though selection information is retained).
318 .OP \-width width Width
319 Specifies the desired width for the window in characters.
320 If the font does not have a uniform width then the width of the character
322 is used in translating from character units to screen units.
323 If zero or less, then the desired width for the window is made just
324 large enough to hold all the elements in the listbox.
328 The \fBlistbox\fR command creates a new window (given by the
329 \fIpathName\fR argument) and makes it into a listbox widget.
331 options, described above, may be specified on the command line
332 or in the option database
333 to configure aspects of the listbox such as its colors, font,
334 text, and relief. The \fBlistbox\fR command returns its
335 \fIpathName\fR argument. At the time this command is invoked,
336 there must not exist a window named \fIpathName\fR, but
337 \fIpathName\fR's parent must exist.
339 A listbox is a widget that displays a list of strings, one per line.
340 When first created, a new listbox has no elements.
341 Elements may be added or deleted using widget commands described
342 below. In addition, one or more elements may be selected as described
344 If a listbox is exporting its selection (see \fB\-exportselection\fR
345 option), then it will observe the standard X11 protocols
346 for handling the selection.
347 Listbox selections are available as type \fBSTRING\fR;
348 the value of the selection will be the text of the selected elements, with
349 newlines separating the elements.
351 It is not necessary for all the elements to be
352 displayed in the listbox window at once; commands described below
353 may be used to change the view in the window. Listboxes allow
354 scrolling in both directions using the standard \fB\-xscrollcommand\fR
355 and \fB\-yscrollcommand\fR options.
356 They also support scanning, as described below.
359 Many of the widget commands for listboxes take one or more indices
361 An index specifies a particular element of the listbox, in any of
366 Specifies the element as a numerical index, where 0 corresponds
367 to the first element in the listbox.
371 Indicates the element that has the location cursor. This element
372 will be displayed as specified by \fB\-activestyle\fR when the listbox
373 has the keyboard focus, and it is specified with the \fBactivate\fR
378 Indicates the anchor point for the selection, which is set with the
379 \fBselection anchor\fR widget command.
383 Indicates the end of the listbox.
384 For most commands this refers to the last element in the listbox,
385 but for a few commands such as \fBindex\fR and \fBinsert\fR
386 it refers to the element just after the last one.
389 Indicates the element that covers the point in the listbox window
390 specified by \fIx\fR and \fIy\fR (in pixel coordinates). If no
391 element covers that point, then the closest element to that
394 In the widget command descriptions below, arguments named \fIindex\fR,
395 \fIfirst\fR, and \fIlast\fR always contain text indices in one of
399 The \fBlistbox\fR command creates a new Tcl command whose
400 name is \fIpathName\fR. This
401 command may be used to invoke various
402 operations on the widget. It has the following general form:
404 \fIpathName option \fR?\fIarg arg ...\fR?
406 \fIOption\fR and the \fIarg\fRs
407 determine the exact behavior of the command. The following
408 commands are possible for listbox widgets:
410 \fIpathName \fBactivate\fR \fIindex\fR
412 Sets the active element to the one indicated by \fIindex\fR.
413 If \fIindex\fR is outside the range of elements in the listbox
414 then the closest element is activated.
415 The active element is drawn as specified by \fB\-activestyle\fR when the
416 widget has the input focus, and its index may be retrieved with the
419 \fIpathName \fBbbox\fR \fIindex\fR
421 Returns a list of four numbers describing the bounding box of
422 the text in the element given by \fIindex\fR.
423 The first two elements of the list give the x and y coordinates
424 of the upper-left corner of the screen area covered by the text
425 (specified in pixels relative to the widget) and the last two
426 elements give the width and height of the area, in pixels.
427 If no part of the element given by \fIindex\fR is visible on the
429 or if \fIindex\fR refers to a non-existent element,
430 then the result is an empty string; if the element is
431 partially visible, the result gives the full area of the element,
432 including any parts that are not visible.
434 \fIpathName \fBcget\fR \fIoption\fR
436 Returns the current value of the configuration option given
438 \fIOption\fR may have any of the values accepted by the \fBlistbox\fR
441 \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
443 Query or modify the configuration options of the widget.
444 If no \fIoption\fR is specified, returns a list describing all of
445 the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
446 information on the format of this list). If \fIoption\fR is specified
447 with no \fIvalue\fR, then the command returns a list describing the
448 one named option (this list will be identical to the corresponding
449 sublist of the value returned if no \fIoption\fR is specified). If
450 one or more \fIoption\-value\fR pairs are specified, then the command
451 modifies the given widget option(s) to have the given value(s); in
452 this case the command returns an empty string.
453 \fIOption\fR may have any of the values accepted by the \fBlistbox\fR
456 \fIpathName \fBcurselection\fR
458 Returns a list containing the numerical indices of
459 all of the elements in the listbox that are currently selected.
460 If there are no elements selected in the listbox then an empty
463 \fIpathName \fBdelete \fIfirst \fR?\fIlast\fR?
465 Deletes one or more elements of the listbox. \fIFirst\fR and \fIlast\fR
466 are indices specifying the first and last elements in the range
467 to delete. If \fIlast\fR is not specified it defaults to
468 \fIfirst\fR, i.e. a single element is deleted.
470 \fIpathName \fBget \fIfirst\fR ?\fIlast\fR?
472 If \fIlast\fR is omitted, returns the contents of the listbox
473 element indicated by \fIfirst\fR,
474 or an empty string if \fIfirst\fR refers to a non-existent element.
475 If \fIlast\fR is specified, the command returns a list whose elements
476 are all of the listbox elements between \fIfirst\fR and \fIlast\fR,
478 Both \fIfirst\fR and \fIlast\fR may have any of the standard
481 \fIpathName \fBindex \fIindex\fR
483 Returns the integer index value that corresponds to \fIindex\fR.
484 If \fIindex\fR is \fBend\fR the return value is a count of the number
485 of elements in the listbox (not the index of the last element).
487 \fIpathName \fBinsert \fIindex \fR?\fIelement element ...\fR?
489 Inserts zero or more new elements in the list just before the
490 element given by \fIindex\fR. If \fIindex\fR is specified as
491 \fBend\fR then the new elements are added to the end of the
492 list. Returns an empty string.
494 \fIpathName \fBitemcget \fIindex option\fR
496 Returns the current value of the item configuration option given
497 by \fIoption\fR. \fIOption\fR may have any of the values accepted
498 by the \fBitemconfigure\fR command.
500 \fIpathName \fBitemconfigure \fIindex\fR ?\fIoption\fR? ?\fIvalue\fR? ?\fIoption value ...\fR?
502 Query or modify the configuration options of an item in the listbox.
503 If no \fIoption\fR is specified, returns a list describing all of
504 the available options for the item (see \fBTk_ConfigureInfo\fR for
505 information on the format of this list). If \fIoption\fR is specified
506 with no \fIvalue\fR, then the command returns a list describing the
507 one named option (this list will be identical to the corresponding
508 sublist of the value returned if no \fIoption\fR is specified). If
509 one or more \fIoption\-value\fR pairs are specified, then the command
510 modifies the given widget option(s) to have the given value(s); in
511 this case the command returns an empty string. The following options
512 are currently supported for items:
515 \fB\-background \fIcolor\fR
517 \fIColor\fR specifies the background color to use when displaying the
518 item. It may have any of the forms accepted by \fBTk_GetColor\fR.
520 \fB\-foreground \fIcolor\fR
522 \fIColor\fR specifies the foreground color to use when displaying the
523 item. It may have any of the forms accepted by \fBTk_GetColor\fR.
525 \fB\-selectbackground \fIcolor\fR
527 \fIcolor\fR specifies the background color to use when displaying the
528 item while it is selected. It may have any of the forms accepted by
531 \fB\-selectforeground \fIcolor\fR
533 \fIcolor\fR specifies the foreground color to use when displaying the
534 item while it is selected. It may have any of the forms accepted by
538 \fIpathName \fBnearest \fIy\fR
540 Given a y-coordinate within the listbox window, this command returns
541 the index of the (visible) listbox element nearest to that y-coordinate.
543 \fIpathName \fBscan\fR \fIoption args\fR
545 This command is used to implement scanning on listboxes. It has
546 two forms, depending on \fIoption\fR:
549 \fIpathName \fBscan mark \fIx y\fR
551 Records \fIx\fR and \fIy\fR and the current view in the listbox
552 window; used in conjunction with later \fBscan dragto\fR commands.
553 Typically this command is associated with a mouse button press in
554 the widget. It returns an empty string.
556 \fIpathName \fBscan dragto \fIx y\fR.
558 This command computes the difference between its \fIx\fR and \fIy\fR
559 arguments and the \fIx\fR and \fIy\fR arguments to the last
560 \fBscan mark\fR command for the widget.
561 It then adjusts the view by 10 times the
562 difference in coordinates. This command is typically associated
563 with mouse motion events in the widget, to produce the effect of
564 dragging the list at high speed through the window. The return
565 value is an empty string.
568 \fIpathName \fBsee \fIindex\fR
570 Adjust the view in the listbox so that the element given by \fIindex\fR
572 If the element is already visible then the command has no effect;
573 if the element is near one edge of the window then the listbox
574 scrolls to bring the element into view at the edge; otherwise
575 the listbox scrolls to center the element.
577 \fIpathName \fBselection \fIoption arg\fR
579 This command is used to adjust the selection within a listbox. It
580 has several forms, depending on \fIoption\fR:
583 \fIpathName \fBselection anchor \fIindex\fR
585 Sets the selection anchor to the element given by \fIindex\fR.
586 If \fIindex\fR refers to a non-existent element, then the closest
588 The selection anchor is the end of the selection that is fixed
589 while dragging out a selection with the mouse.
590 The index \fBanchor\fR may be used to refer to the anchor
593 \fIpathName \fBselection clear \fIfirst \fR?\fIlast\fR?
595 If any of the elements between \fIfirst\fR and \fIlast\fR
596 (inclusive) are selected, they are deselected.
597 The selection state is not changed for elements outside
600 \fIpathName \fBselection includes \fIindex\fR
602 Returns 1 if the element indicated by \fIindex\fR is currently
603 selected, 0 if it is not.
605 \fIpathName \fBselection set \fIfirst \fR?\fIlast\fR?
607 Selects all of the elements in the range between
608 \fIfirst\fR and \fIlast\fR, inclusive, without affecting
609 the selection state of elements outside that range.
612 \fIpathName \fBsize\fR
614 Returns a decimal string indicating the total number of elements
617 \fIpathName \fBxview \fR?\fIargs\fR
619 This command is used to query and change the horizontal position of the
620 information in the widget's window. It can take any of the following
624 \fIpathName \fBxview\fR
626 Returns a list containing two elements.
627 Each element is a real fraction between 0 and 1; together they describe
628 the horizontal span that is visible in the window.
629 For example, if the first element is .2 and the second element is .6,
630 20% of the listbox's text is off-screen to the left, the middle 40% is visible
631 in the window, and 40% of the text is off-screen to the right.
632 These are the same values passed to scrollbars via the \fB\-xscrollcommand\fR
635 \fIpathName \fBxview \fIindex\fR
637 Adjusts the view in the window so that the character position given by
638 \fIindex\fR is displayed at the left edge of the window.
639 Character positions are defined by the width of the character \fB0\fR.
641 \fIpathName \fBxview moveto\fI fraction\fR
643 Adjusts the view in the window so that \fIfraction\fR of the
644 total width of the listbox text is off-screen to the left.
645 \fIfraction\fR must be a fraction between 0 and 1.
647 \fIpathName \fBxview scroll \fInumber what\fR
649 This command shifts the view in the window left or right according to
650 \fInumber\fR and \fIwhat\fR.
651 \fINumber\fR must be an integer.
652 \fIWhat\fR must be either \fBunits\fR or \fBpages\fR or an abbreviation
654 If \fIwhat\fR is \fBunits\fR, the view adjusts left or right by
655 \fInumber\fR character units (the width of the \fB0\fR character)
656 on the display; if it is \fBpages\fR then the view adjusts by
657 \fInumber\fR screenfuls.
658 If \fInumber\fR is negative then characters farther to the left
659 become visible; if it is positive then characters farther to the right
663 \fIpathName \fByview \fR?\fIargs\fR?
665 This command is used to query and change the vertical position of the
666 text in the widget's window.
667 It can take any of the following forms:
670 \fIpathName \fByview\fR
671 Returns a list containing two elements, both of which are real fractions
673 The first element gives the position of the listbox element at the
674 top of the window, relative to the listbox as a whole (0.5 means
675 it is halfway through the listbox, for example).
676 The second element gives the position of the listbox element just after
677 the last one in the window, relative to the listbox as a whole.
678 These are the same values passed to scrollbars via the \fB\-yscrollcommand\fR
681 \fIpathName \fByview \fIindex\fR
683 Adjusts the view in the window so that the element given by
684 \fIindex\fR is displayed at the top of the window.
686 \fIpathName \fByview moveto\fI fraction\fR
688 Adjusts the view in the window so that the element given by \fIfraction\fR
689 appears at the top of the window.
690 \fIFraction\fR is a fraction between 0 and 1; 0 indicates the first
691 element in the listbox, 0.33 indicates the element one-third the
692 way through the listbox, and so on.
694 \fIpathName \fByview scroll \fInumber what\fR
696 This command adjusts the view in the window up or down according to
697 \fInumber\fR and \fIwhat\fR.
698 \fINumber\fR must be an integer.
699 \fIWhat\fR must be either \fBunits\fR or \fBpages\fR.
700 If \fIwhat\fR is \fBunits\fR, the view adjusts up or down by
701 \fInumber\fR lines; if it is \fBpages\fR then
702 the view adjusts by \fInumber\fR screenfuls.
703 If \fInumber\fR is negative then earlier elements
704 become visible; if it is positive then later elements
707 .SH "DEFAULT BINDINGS"
709 Tk automatically creates class bindings for listboxes that give them
710 Motif-like behavior. Much of the behavior of a listbox is determined
711 by its \fB\-selectmode\fR option, which selects one of four ways
712 of dealing with the selection.
714 If the selection mode is \fBsingle\fR or \fBbrowse\fR, at most one
715 element can be selected in the listbox at once.
716 In both modes, clicking button 1 on an element selects
717 it and deselects any other selected item.
718 In \fBbrowse\fR mode it is also possible to drag the selection
720 On button 1, the listbox will also take focus if it has a \fBnormal\fR
721 state and \fB\-takefocus\fR is true.
723 If the selection mode is \fBmultiple\fR or \fBextended\fR,
724 any number of elements may be selected at once, including discontiguous
725 ranges. In \fBmultiple\fR mode, clicking button 1 on an element
726 toggles its selection state without affecting any other elements.
727 In \fBextended\fR mode, pressing button 1 on an element selects
728 it, deselects everything else, and sets the anchor to the element
729 under the mouse; dragging the mouse with button 1
730 down extends the selection to include all the elements between
731 the anchor and the element under the mouse, inclusive.
733 Most people will probably want to use \fBbrowse\fR mode for
734 single selections and \fBextended\fR mode for multiple selections;
735 the other modes appear to be useful only in special situations.
737 Any time the selection changes in the listbox, the virtual event
738 \fB<<ListboxSelect>>\fR will be generated. It is easiest to bind
739 to this event to be made aware of any changes to listbox selection.
741 In addition to the above behavior, the following additional behavior
742 is defined by the default bindings:
744 In \fBextended\fR mode, the selected range can be adjusted by pressing
745 button 1 with the Shift key down: this modifies the selection to
746 consist of the elements between the anchor and the element under
747 the mouse, inclusive.
748 The un-anchored end of this new selection can also be dragged with
751 In \fBextended\fR mode, pressing button 1 with the Control key down
752 starts a toggle operation: the anchor is set to the element under
753 the mouse, and its selection state is reversed. The selection state
754 of other elements is not changed.
755 If the mouse is dragged with button 1 down, then the selection state
756 of all elements between the anchor and the element under the mouse
757 is set to match that of the anchor element; the selection state of
758 all other elements remains what it was before the toggle operation
761 If the mouse leaves the listbox window with button 1 down, the window
762 scrolls away from the mouse, making information visible that used
763 to be off-screen on the side of the mouse.
764 The scrolling continues until the mouse re-enters the window, the
765 button is released, or the end of the listbox is reached.
767 Mouse button 2 may be used for scanning.
768 If it is pressed and dragged over the listbox, the contents of
769 the listbox drag at high speed in the direction the mouse moves.
771 If the Up or Down key is pressed, the location cursor (active
772 element) moves up or down one element.
773 If the selection mode is \fBbrowse\fR or \fBextended\fR then the
774 new active element is also selected and all other elements are
776 In \fBextended\fR mode the new active element becomes the
779 In \fBextended\fR mode, Shift-Up and Shift-Down move the location
780 cursor (active element) up or down one element and also extend
781 the selection to that element in a fashion similar to dragging
784 The Left and Right keys scroll the listbox view left and right
785 by the width of the character \fB0\fR.
786 Control-Left and Control-Right scroll the listbox view left and
787 right by the width of the window.
788 Control-Prior and Control-Next also scroll left and right by
789 the width of the window.
791 The Prior and Next keys scroll the listbox view up and down
792 by one page (the height of the window).
794 The Home and End keys scroll the listbox horizontally to
795 the left and right edges, respectively.
797 Control-Home sets the location cursor to the first element in
798 the listbox, selects that element, and deselects everything else
801 Control-End sets the location cursor to the last element in
802 the listbox, selects that element, and deselects everything else
805 In \fBextended\fR mode, Control-Shift-Home extends the selection
806 to the first element in the listbox and Control-Shift-End extends
807 the selection to the last element.
809 In \fBmultiple\fR mode, Control-Shift-Home moves the location cursor
810 to the first element in the listbox and Control-Shift-End moves
811 the location cursor to the last element.
813 The space and Select keys make a selection at the location cursor
814 (active element) just as if mouse button 1 had been pressed over
817 In \fBextended\fR mode, Control-Shift-space and Shift-Select
818 extend the selection to the active element just as if button 1
819 had been pressed with the Shift key down.
821 In \fBextended\fR mode, the Escape key cancels the most recent
822 selection and restores all the elements in the selected range
823 to their previous selection state.
825 Control-slash selects everything in the widget, except in
826 \fBsingle\fR and \fBbrowse\fR modes, in which case it selects
827 the active element and deselects everything else.
829 Control-backslash deselects everything in the widget, except in
830 \fBbrowse\fR mode where it has no effect.
832 The F16 key (labelled Copy on many Sun workstations) or Meta-w
833 copies the selection in the widget to the clipboard, if there is
836 The behavior of listboxes can be changed by defining new bindings for
837 individual widgets or by redefining the class bindings.
OSDN Git Service
