通讯编程

开发平台：
Visual C++

listbox.n：源码内容
							'"
'" Copyright (c) 1990 The Regents of the University of California.
'" Copyright (c) 1994-1997 Sun Microsystems, Inc.
'"
'" See the file "license.terms" for information on usage and redistribution
'" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'" 
'" RCS: @(#) $Id: listbox.n,v 1.9.2.1 2004/10/28 10:19:29 dkf Exp $
'" 
.so man.macros
.TH listbox n 8.4 Tk "Tk Built-In Commands"
.BS
'" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
listbox - Create and manipulate listbox widgets
.SH SYNOPSIS
fBlistboxfR fIpathName fR?fIoptionsfR?
.SO
-activestyle	-height	-selectforeground
-background	-highlightbackground	-setgrid
-borderwidth	-highlightcolor	-state
-cursor	-highlightthickness	-takefocus
-disabledforeground	-relief	-width
-exportselection	-selectbackground	-xscrollcommand
-font	-selectborderwidth	-yscrollcommand
-foreground
.SE
.SH "WIDGET-SPECIFIC OPTIONS"
.VS 8.4
.OP -activestyle activeStyle ActiveStyle
Specifies the style in which to draw the active element.  This must be
one of fBdotboxfR (show a focus ring around the active element),
fBnonefR (no special indication of active element) or
fBunderlinefR (underline the active element).
The default is fBunderlinefR.
.VS 8.4
.OP -height height Height
Specifies the desired height for the window, in lines.
If zero or less, then the desired height for the window is made just
large enough to hold all the elements in the listbox.
.OP -listvariable listVariable Variable
Specifies the name of a variable.  The value of the variable is a list to
be displayed inside the widget; if the variable value changes then the
widget will automatically update itself to reflect the new value.  Attempts
to assign a variable with an invalid list value to fB-listvariablefR
will cause an error.  Attempts to unset a variable in use as a
fB-listvariablefR will fail but will not generate an error.
.OP -selectmode selectMode SelectMode
Specifies one of several styles for manipulating the selection.
The value of the option may be arbitrary, but the default bindings
expect it to be either fBsinglefR, fBbrowsefR, fBmultiplefR,
or fBextendedfR;  the default value is fBbrowsefR.
.OP -state state State
Specifies one of two states for the listbox:  fBnormalfR or fBdisabledfR.
If the listbox is disabled then items may not be inserted or deleted,
items are drawn in the fB-disabledforegroundfR color, and selection
cannot be modified and is not shown (though selection information is retained).
.OP -width width Width
Specifies the desired width for the window in characters.
If the font doesn't have a uniform width then the width of the
character ``0'' is used in translating from character units to
screen units.
If zero or less, then the desired width for the window is made just
large enough to hold all the elements in the listbox.
.BE
.SH DESCRIPTION
.PP
The fBlistboxfR command creates a new window (given by the
fIpathNamefR argument) and makes it into a listbox widget.
Additional
options, described above, may be specified on the command line
or in the option database
to configure aspects of the listbox such as its colors, font,
text, and relief.  The fBlistboxfR command returns its
fIpathNamefR argument.  At the time this command is invoked,
there must not exist a window named fIpathNamefR, but
fIpathNamefR's parent must exist.
.PP
A listbox is a widget that displays a list of strings, one per line.
When first created, a new listbox has no elements.
Elements may be added or deleted using widget commands described
below.  In addition, one or more elements may be selected as described
below.
If a listbox is exporting its selection (see fBexportSelectionfR
option), then it will observe the standard X11 protocols
for handling the selection.
Listbox selections are available as type fBSTRINGfR;
the value of the selection will be the text of the selected elements, with
newlines separating the elements.
.PP
It is not necessary for all the elements to be
displayed in the listbox window at once;  commands described below
may be used to change the view in the window.  Listboxes allow
scrolling in both directions using the standard fBxScrollCommandfR
and fByScrollCommandfR options.
They also support scanning, as described below.
.SH "INDICES"
.PP
Many of the widget commands for listboxes take one or more indices
as arguments.
An index specifies a particular element of the listbox, in any of
the following ways:
.TP 12
fInumberfR
Specifies the element as a numerical index, where 0 corresponds
to the first element in the listbox.
.TP 12
fBactivefR
Indicates the element that has the location cursor.  This element
will be displayed as specified by fB-activestylefR when the listbox
has the keyboard focus, and it is specified with the fBactivatefR
widget command.
.TP 12
fBanchorfR
Indicates the anchor point for the selection, which is set with the
fBselection anchorfR widget command.
.TP 12
fBendfR
Indicates the end of the listbox.
.VS 8.0
For most commands this refers to the last element in the listbox,
but for a few commands such as fBindexfR and fBinsertfR
it refers to the element just after the last one.
.VE
.TP 12
fB@fIxfB,fIyfR
Indicates the element that covers the point in the listbox window
specified by fIxfR and fIyfR (in pixel coordinates).  If no
element covers that point, then the closest element to that
point is used.
.LP
In the widget command descriptions below, arguments named fIindexfR,
fIfirstfR, and fIlastfR always contain text indices in one of
the above forms.
.SH "WIDGET COMMAND"
.PP
The fBlistboxfR command creates a new Tcl command whose
name is fIpathNamefR.  This
command may be used to invoke various
operations on the widget.  It has the following general form:
.CS
fIpathName option fR?fIarg arg ...fR?
.CE
fIOptionfR and the fIargfRs
determine the exact behavior of the command.  The following
commands are possible for listbox widgets:
.TP
fIpathName fBactivatefR fIindexfR
Sets the active element to the one indicated by fIindexfR.
.VS 8.0
If fIindexfR is outside the range of elements in the listbox
then the closest element is activated.
.VE
The active element is drawn as specified by fB-activestylefR when the
widget has the input focus, and its index may be retrieved with the
index fBactivefR.
.TP
fIpathName fBbboxfR fIindexfR
Returns a list of four numbers describing the bounding box of
the text in the element given by fIindexfR.
The first two elements of the list give the x and y coordinates
of the upper-left corner of the screen area covered by the text
(specified in pixels relative to the widget) and the last two
elements give the width and height of the area, in pixels.
If no part of the element given by fIindexfR is visible on the
screen,
.VS 8.0
or if fIindexfR refers to a non-existent element,
.VE
then the result is an empty string;  if the element is
partially visible, the result gives the full area of the element,
including any parts that are not visible.
.TP
fIpathName fBcgetfR fIoptionfR
Returns the current value of the configuration option given
by fIoptionfR.
fIOptionfR may have any of the values accepted by the fBlistboxfR
command.
.TP
fIpathName fBconfigurefR ?fIoptionfR? ?fIvalue option value ...fR?
Query or modify the configuration options of the widget.
If no fIoptionfR is specified, returns a list describing all of
the available options for fIpathNamefR (see fBTk_ConfigureInfofR for
information on the format of this list).  If fIoptionfR is specified
with no fIvaluefR, then the command returns a list describing the
one named option (this list will be identical to the corresponding
sublist of the value returned if no fIoptionfR is specified).  If
one or more fIoption-valuefR pairs are specified, then the command
modifies the given widget option(s) to have the given value(s);  in
this case the command returns an empty string.
fIOptionfR may have any of the values accepted by the fBlistboxfR
command.
.TP
fIpathName fBcurselectionfR
Returns a list containing the numerical indices of
all of the elements in the listbox that are currently selected.
If there are no elements selected in the listbox then an empty
string is returned.
.TP
fIpathName fBdelete fIfirst fR?fIlastfR?
Deletes one or more elements of the listbox.  fIFirstfR and fIlastfR
are indices specifying the first and last elements in the range
to delete.  If fIlastfR isn't specified it defaults to
fIfirstfR, i.e. a single element is deleted.
.TP
fIpathName fBget fIfirstfR ?fIlastfR?
If fIlastfR is omitted, returns the contents of the listbox
element indicated by fIfirstfR,
.VS 8.0
or an empty string if fIfirstfR refers to a non-existent element.
.VE
If fIlastfR is specified, the command returns a list whose elements
are all of the listbox elements between fIfirstfR and fIlastfR,
inclusive.
Both fIfirstfR and fIlastfR may have any of the standard
forms for indices.
.TP
fIpathName fBindex fIindexfR
Returns the integer index value that corresponds to fIindexfR.
.VS 8.0
If fIindexfR is fBendfR the return value is a count of the number
of elements in the listbox (not the index of the last element).
.VE
.TP
fIpathName fBinsert fIindex fR?fIelement element ...fR?
Inserts zero or more new elements in the list just before the
element given by fIindexfR.  If fIindexfR is specified as
fBendfR then the new elements are added to the end of the
list.  Returns an empty string.
.TP
fIpathName fBitemcget fIindex optionfR
Returns the current value of the item configuration option given
by fIoptionfR. fIOptionfR may have any of the values accepted 
by the fBlistbox itemconfigurefR command.
.TP
fIpathName fBitemconfigure fIindexfR ?fIoptionfR? ?fIvaluefR? ?fIoption value ...fR?
Query or modify the configuration options of an item in the listbox.
If no fIoptionfR is specified, returns a list describing all of
the available options for the item (see fBTk_ConfigureInfofR for
information on the format of this list).  If fIoptionfR is specified
with no fIvaluefR, then the command returns a list describing the
one named option (this list will be identical to the corresponding
sublist of the value returned if no fIoptionfR is specified).  If
one or more fIoption-valuefR pairs are specified, then the command
modifies the given widget option(s) to have the given value(s);  in
this case the command returns an empty string. The following options
are currently supported for items:
.RS
.TP
fB-background fIcolorfR
fIColorfR specifies the background color to use when displaying the 
item. It may have any of the forms accepted by fBTk_GetColorfR.
.TP
fB-foreground fIcolorfR
fIColorfR specifies the foreground color to use when displaying the
item. It may have any of the forms accepted by fBTk_GetColorfR.
.TP
fB-selectbackground fIcolorfR
fIcolorfR specifies the background color to use when displaying the
item while it is selected. It may have any of the forms accepted by
fBTk_GetColorfR.
.TP
fB-selectforeground fIcolorfR
fIcolorfR specifies the foreground color to use when displaying the
item while it is selected. It may have any of the forms accepted by
fBTk_GetColorfR.
.RE
.TP
fIpathName fBnearest fIyfR
Given a y-coordinate within the listbox window, this command returns
the index of the (visible) listbox element nearest to that y-coordinate.
.TP
fIpathName fBscanfR fIoption argsfR
This command is used to implement scanning on listboxes.  It has
two forms, depending on fIoptionfR:
.RS
.TP
fIpathName fBscan mark fIx yfR
Records fIxfR and fIyfR and the current view in the listbox
window;  used in conjunction with later fBscan dragtofR commands.
Typically this command is associated with a mouse button press in
the widget.  It returns an empty string.
.TP
fIpathName fBscan dragto fIx yfR.
This command computes the difference between its fIxfR and fIyfR
arguments and the fIxfR and fIyfR arguments to the last
fBscan markfR command for the widget.
It then adjusts the view by 10 times the
difference in coordinates.  This command is typically associated
with mouse motion events in the widget, to produce the effect of
dragging the list at high speed through the window.  The return
value is an empty string.
.RE
.TP
fIpathName fBsee fIindexfR
Adjust the view in the listbox so that the element given by fIindexfR
is visible.
If the element is already visible then the command has no effect;
if the element is near one edge of the window then the listbox
scrolls to bring the element into view at the edge;  otherwise
the listbox scrolls to center the element.
.TP
fIpathName fBselection fIoption argfR
This command is used to adjust the selection within a listbox.  It
has several forms, depending on fIoptionfR:
.RS
.TP
fIpathName fBselection anchor fIindexfR
Sets the selection anchor to the element given by fIindexfR.
.VS 8.0
If fIindexfR refers to a non-existent element, then the closest
element is used.
.VE
The selection anchor is the end of the selection that is fixed
while dragging out a selection with the mouse.
The index fBanchorfR may be used to refer to the anchor
element.
.TP
fIpathName fBselection clear fIfirst fR?fIlastfR?
If any of the elements between fIfirstfR and fIlastfR
(inclusive) are selected, they are deselected.
The selection state is not changed for elements outside
this range.
.TP
fIpathName fBselection includes fIindexfR
Returns 1 if the element indicated by fIindexfR is currently
selected, 0 if it isn't.
.TP
fIpathName fBselection set fIfirst fR?fIlastfR?
Selects all of the elements in the range between
fIfirstfR and fIlastfR, inclusive, without affecting
the selection state of elements outside that range.
.RE
.TP
fIpathName fBsizefR
Returns a decimal string indicating the total number of elements
in the listbox.
.TP
fIpathName fBxview fIargsfR
This command is used to query and change the horizontal position of the
information in the widget's window.  It can take any of the following
forms:
.RS
.TP
fIpathName fBxviewfR
Returns a list containing two elements.
Each element is a real fraction between 0 and 1;  together they describe
the horizontal span that is visible in the window.
For example, if the first element is .2 and the second element is .6,
20% of the listbox's text is off-screen to the left, the middle 40% is visible
in the window, and 40% of the text is off-screen to the right.
These are the same values passed to scrollbars via the fB-xscrollcommandfR
option.
.TP
fIpathName fBxviewfR fIindexfR
Adjusts the view in the window so that the character position given by
fIindexfR is displayed at the left edge of the window.
Character positions are defined by the width of the character fB0fR.
.TP
fIpathName fBxview movetofI fractionfR
Adjusts the view in the window so that fIfractionfR of the
total width of the listbox text is off-screen to the left.
fIfractionfR must be a fraction between 0 and 1.
.TP
fIpathName fBxview scroll fInumber whatfR
This command shifts the view in the window left or right according to
fInumberfR and fIwhatfR.
fINumberfR must be an integer.
fIWhatfR must be either fBunitsfR or fBpagesfR or an abbreviation
of one of these.
If fIwhatfR is fBunitsfR, the view adjusts left or right by
fInumberfR character units (the width of the fB0fR character)
on the display;  if it is fBpagesfR then the view adjusts by
fInumberfR screenfuls.
If fInumberfR is negative then characters farther to the left
become visible;  if it is positive then characters farther to the right
become visible.
.RE
.TP
fIpathName fByview fI?argsfR?
This command is used to query and change the vertical position of the
text in the widget's window.
It can take any of the following forms:
.RS
.TP
fIpathName fByviewfR
Returns a list containing two elements, both of which are real fractions
between 0 and 1.
The first element gives the position of the listbox element at the
top of the window, relative to the listbox as a whole (0.5 means
it is halfway through the listbox, for example).
The second element gives the position of the listbox element just after
the last one in the window, relative to the listbox as a whole.
These are the same values passed to scrollbars via the fB-yscrollcommandfR
option.
.TP
fIpathName fByviewfR fIindexfR
Adjusts the view in the window so that the element given by
fIindexfR is displayed at the top of the window.
.TP
fIpathName fByview movetofI fractionfR
Adjusts the view in the window so that the element given by fIfractionfR
appears at the top of the window.
fIFractionfR is a fraction between 0 and 1;  0 indicates the first
element in the listbox, 0.33 indicates the element one-third the
way through the listbox, and so on.
.TP
fIpathName fByview scroll fInumber whatfR
This command adjusts the view in the window up or down according to
fInumberfR and fIwhatfR.
fINumberfR must be an integer.
fIWhatfR must be either fBunitsfR or fBpagesfR.
If fIwhatfR is fBunitsfR, the view adjusts up or down by
fInumberfR lines;  if it is fBpagesfR then
the view adjusts by fInumberfR screenfuls.
If fInumberfR is negative then earlier elements
become visible;  if it is positive then later elements
become visible.
.RE
.SH "DEFAULT BINDINGS"
.PP
Tk automatically creates class bindings for listboxes that give them
Motif-like behavior.  Much of the behavior of a listbox is determined
by its fBselectModefR option, which selects one of four ways
of dealing with the selection.
.PP
If the selection mode is fBsinglefR or fBbrowsefR, at most one
element can be selected in the listbox at once.
In both modes, clicking button 1 on an element selects
it and deselects any other selected item.
In fBbrowsefR mode it is also possible to drag the selection
with button 1.
.PP
If the selection mode is fBmultiplefR or fBextendedfR,
any number of elements may be selected at once, including discontiguous
ranges.  In fBmultiplefR mode, clicking button 1 on an element
toggles its selection state without affecting any other elements.
In fBextendedfR mode, pressing button 1 on an element selects
it, deselects everything else, and sets the anchor to the element
under the mouse;  dragging the mouse with button 1
down extends the selection to include all the elements between
the anchor and the element under the mouse, inclusive.
.PP
Most people will probably want to use fBbrowsefR mode for
single selections and fBextendedfR mode for multiple selections;
the other modes appear to be useful only in special situations.
.PP
Any time the selection changes in the listbox, the virtual event
fB<<ListboxSelect>>fR will be generated.  It is easiest to bind
to this event to be made aware of any changes to listbox selection.
.PP
In addition to the above behavior, the following additional behavior
is defined by the default bindings:
.IP [1]
In fBextendedfR mode, the selected range can be adjusted by pressing
button 1 with the Shift key down:  this modifies the selection to
consist of the elements between the anchor and the element under
the mouse, inclusive.
The un-anchored end of this new selection can also be dragged with
the button down.
.IP [2]
In fBextendedfR mode, pressing button 1 with the Control key down
starts a toggle operation: the anchor is set to the element under
the mouse, and its selection state is reversed.  The selection state
of other elements isn't changed.
If the mouse is dragged with button 1 down, then the selection state
of all elements between the anchor and the element under the mouse
is set to match that of the anchor element;  the selection state of
all other elements remains what it was before the toggle operation
began.
.IP [3]
If the mouse leaves the listbox window with button 1 down, the window
scrolls away from the mouse, making information visible that used
to be off-screen on the side of the mouse.
The scrolling continues until the mouse re-enters the window, the
button is released, or the end of the listbox is reached.
.IP [4]
Mouse button 2 may be used for scanning.
If it is pressed and dragged over the listbox, the contents of
the listbox drag at high speed in the direction the mouse moves.
.IP [5]
If the Up or Down key is pressed, the location cursor (active
element) moves up or down one element.
If the selection mode is fBbrowsefR or fBextendedfR then the
new active element is also selected and all other elements are
deselected.
In fBextendedfR mode the new active element becomes the
selection anchor.
.IP [6]
In fBextendedfR mode, Shift-Up and Shift-Down move the location
cursor (active element) up or down one element and also extend
the selection to that element in a fashion similar to dragging
with mouse button 1.
.IP [7]
The Left and Right keys scroll the listbox view left and right
by the width of the character fB0fR.
Control-Left and Control-Right scroll the listbox view left and
right by the width of the window.
Control-Prior and Control-Next also scroll left and right by
the width of the window.
.IP [8]
The Prior and Next keys scroll the listbox view up and down
by one page (the height of the window).
.IP [9]
The Home and End keys scroll the listbox horizontally to
the left and right edges, respectively.
.IP [10]
Control-Home sets the location cursor to the first element in
the listbox, selects that element, and deselects everything else
in the listbox.
.IP [11]
Control-End sets the location cursor to the last element in
the listbox, selects that element, and deselects everything else
in the listbox.
.IP [12]
In fBextendedfR mode, Control-Shift-Home extends the selection
to the first element in the listbox and Control-Shift-End extends
the selection to the last element.
.IP [13]
In fBmultiplefR mode, Control-Shift-Home moves the location cursor
to the first element in the listbox and Control-Shift-End moves
the location cursor to the last element.
.IP [14]
The space and Select keys make a selection at the location cursor
(active element) just as if mouse button 1 had been pressed over
this element.
.IP [15]
In fBextendedfR mode, Control-Shift-space and Shift-Select
extend the selection to the active element just as if button 1
had been pressed with the Shift key down.
.IP [16]
In fBextendedfR mode, the Escape key cancels the most recent
selection and restores all the elements in the selected range
to their previous selection state.
.IP [17]
Control-slash selects everything in the widget, except in
fBsinglefR and fBbrowsefR modes, in which case it selects
the active element and deselects everything else.
.IP [18]
Control-backslash deselects everything in the widget, except in
fBbrowsefR mode where it has no effect.
.IP [19]
The F16 key (labelled Copy on many Sun workstations) or Meta-w
copies the selection in the widget to the clipboard, if there is
a selection.
.PP
The behavior of listboxes can be changed by defining new bindings for
individual widgets or by redefining the class bindings.
.SH KEYWORDS
listbox, widget

						