'\"
|
'\"
|
'\" Copyright (c) 1995 DSC Technologies Corporation
|
'\" Copyright (c) 1995 DSC Technologies Corporation
|
'\"
|
'\"
|
'\" See the file "license.terms" for information on usage and redistribution
|
'\" See the file "license.terms" for information on usage and redistribution
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
'\"
|
'\"
|
'\" @(#) disjointlistbox.n 1.21 94/12/17 16:04:44
|
'\" @(#) disjointlistbox.n 1.21 94/12/17 16:04:44
|
'/"
|
'/"
|
.so man.macros
|
.so man.macros
|
.HS disjointlistbox iwid
|
.HS disjointlistbox iwid
|
.BS
|
.BS
|
'\" Note: do not modify the .SH NAME line immediately below!
|
'\" Note: do not modify the .SH NAME line immediately below!
|
.SH NAME
|
.SH NAME
|
disjointlistbox \- Create and manipulate a disjointlistbox widget
|
disjointlistbox \- Create and manipulate a disjointlistbox widget
|
.SH SYNOPSIS
|
.SH SYNOPSIS
|
\fBdisjointlistbox\fI \fIpathName \fR?\fIoptions\fR?
|
\fBdisjointlistbox\fI \fIpathName \fR?\fIoptions\fR?
|
.SH "INHERITANCE"
|
.SH "INHERITANCE"
|
itk::Widget <- Disjointlistbox
|
itk::Widget <- Disjointlistbox
|
.SH "STANDARD OPTIONS"
|
.SH "STANDARD OPTIONS"
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBactiveBackground\fR \fBselectBorderWidth\fR \fBselectForeground\fR
|
\fBactiveBackground\fR \fBselectBorderWidth\fR \fBselectForeground\fR
|
\fBactiveForeground\fR \fBactiveRelief\fR \fBbackground\fR
|
\fBactiveForeground\fR \fBactiveRelief\fR \fBbackground\fR
|
\fBborderWidth\fR \fBbuttonPlacement\fR \fBclientData\fR
|
\fBborderWidth\fR \fBbuttonPlacement\fR \fBclientData\fR
|
\fBcursor\fR \fBforeground\fR \fBhighlightColor\fR
|
\fBcursor\fR \fBforeground\fR \fBhighlightColor\fR
|
\fBhighlightThickness\fR \fBdisabledForeground\fR \fBelementBorderWidth\fR
|
\fBhighlightThickness\fR \fBdisabledForeground\fR \fBelementBorderWidth\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "options" manual entry for details on the standard options.
|
See the "options" manual entry for details on the standard options.
|
.SH "ASSOCIATED OPTIONS"
|
.SH "ASSOCIATED OPTIONS"
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBlhsButtonLabel\fR \fBrhsButtonLabel\fR
|
\fBlhsButtonLabel\fR \fBrhsButtonLabel\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "button" widget manual entry for details on the above
|
See the "button" widget manual entry for details on the above
|
associated options.
|
associated options.
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBlabelFont\fR \fBlhsLabelText\fR \fBrhsLabelText\fR
|
\fBlabelFont\fR \fBlhsLabelText\fR \fBrhsLabelText\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "label" widget manual entry for details on the above
|
See the "label" widget manual entry for details on the above
|
associated options.
|
associated options.
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBjump\fR \fBtroughColor\fR
|
\fBjump\fR \fBtroughColor\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "scrollbar" widget class manual entry for details on the above
|
See the "scrollbar" widget class manual entry for details on the above
|
associated options.
|
associated options.
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBtextBackground\fR \fBtextFont\fR
|
\fBtextBackground\fR \fBtextFont\fR
|
\fBlhsItems\fR \fBrhsItems\fR
|
\fBlhsItems\fR \fBrhsItems\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "scrolledlistbox" widget manual entry for details on the above
|
See the "scrolledlistbox" widget manual entry for details on the above
|
associated options.
|
associated options.
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBbuttonPlacement\fR
|
Name: \fBbuttonPlacement\fR
|
Class: \fBButtonPlacement\fR
|
Class: \fBButtonPlacement\fR
|
Command-Line Switch: \fB-buttonplacement\fR
|
Command-Line Switch: \fB-buttonplacement\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the placement of the insertion and removal buttons relative to the
|
Specifies the placement of the insertion and removal buttons relative to the
|
scrolledlistbox widgets\fBn\fR,
|
scrolledlistbox widgets\fBn\fR,
|
\fBbottom\fR, or \fBcenter\fR. The default is bottom.
|
\fBbottom\fR, or \fBcenter\fR. The default is bottom.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBlhsLabelText\fR
|
Name: \fBlhsLabelText\fR
|
Class: \fBLabelText\fR
|
Class: \fBLabelText\fR
|
Command-Line Switch: \fB-lhslabeltext\fR
|
Command-Line Switch: \fB-lhslabeltext\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the text for the label of the lhs scrolledlistbox.
|
Specifies the text for the label of the lhs scrolledlistbox.
|
The default is "Available".
|
The default is "Available".
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBrhsLabelText\fR
|
Name: \fBrhsLabelText\fR
|
Class: \fBLabelText\fR
|
Class: \fBLabelText\fR
|
Command-Line Switch: \fB-rhslabeltext\fR
|
Command-Line Switch: \fB-rhslabeltext\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the text for the label of the rhs scrolledlistbox.
|
Specifies the text for the label of the rhs scrolledlistbox.
|
The default is "Available".
|
The default is "Available".
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBlhsButtonLabel\fR
|
Name: \fBlhsButtonLabel\fR
|
Class: \fBLabelText\fR
|
Class: \fBLabelText\fR
|
Command-Line Switch: \fB-lhsbuttonlabel\fR
|
Command-Line Switch: \fB-lhsbuttonlabel\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the text for the button of the lhs scrolledlistbox.
|
Specifies the text for the button of the lhs scrolledlistbox.
|
The default is "Insert >>".
|
The default is "Insert >>".
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBrhsButtonLabel\fR
|
Name: \fBrhsButtonLabel\fR
|
Class: \fBLabelText\fR
|
Class: \fBLabelText\fR
|
Command-Line Switch: \fB-rhsbuttonlabel\fR
|
Command-Line Switch: \fB-rhsbuttonlabel\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the text for the button of the rhs scrolledlistbox.
|
Specifies the text for the button of the rhs scrolledlistbox.
|
The default is "<< Remove".
|
The default is "<< Remove".
|
.LP
|
.LP
|
.BE
|
.BE
|
.SH DESCRIPTION
|
.SH DESCRIPTION
|
.PP
|
.PP
|
The \fBdisjointlistbox\fR command creates a disjoint pair of listboxs
|
The \fBdisjointlistbox\fR command creates a disjoint pair of listboxs
|
similar to the OSF/Motif "Book" printing dialog of the "FrameMaker"
|
similar to the OSF/Motif "Book" printing dialog of the "FrameMaker"
|
program. It is implementation constists of a two Scrolledlistboxs,
|
program. It is implementation constists of a two Scrolledlistboxs,
|
2 buttons, and 2 labels.
|
2 buttons, and 2 labels.
|
|
|
The disjoint behavior of this widget exists between the interaction of
|
The disjoint behavior of this widget exists between the interaction of
|
the two Scrolledlistboxes with one another. That is, a given instance
|
the two Scrolledlistboxes with one another. That is, a given instance
|
of a Disjointlistbox will never exist, without the aid of a hack magician,
|
of a Disjointlistbox will never exist, without the aid of a hack magician,
|
which has Scrolledlistbox widgets with items in common. That means the
|
which has Scrolledlistbox widgets with items in common. That means the
|
relationship between the two is maintained similar to that of disjoint sets.
|
relationship between the two is maintained similar to that of disjoint sets.
|
|
|
Users may transfer items between the two Listbox widgets using the
|
Users may transfer items between the two Listbox widgets using the
|
the two buttons.
|
the two buttons.
|
|
|
Options exists which include the ability to configure the "items" displayed by
|
Options exists which include the ability to configure the "items" displayed by
|
the 2 Scrolledlistboxes and to control the placement of the insertion and
|
the 2 Scrolledlistboxes and to control the placement of the insertion and
|
removal buttons.
|
removal buttons.
|
.SH "METHODS"
|
.SH "METHODS"
|
.PP
|
.PP
|
The \fBdisjointlistbox\fR command creates a new Tcl command whose
|
The \fBdisjointlistbox\fR command creates a new Tcl command whose
|
name is \fIpathName\fR. This command may be used to invoke various
|
name is \fIpathName\fR. This command may be used to invoke various
|
operations on the widget. It has the following general form:
|
operations on the widget. It has the following general form:
|
.DS C
|
.DS C
|
\fIpathName option \fR?\fIarg arg ...\fR?
|
\fIpathName option \fR?\fIarg arg ...\fR?
|
.DE
|
.DE
|
\fIOption\fR and the \fIarg\fRs
|
\fIOption\fR and the \fIarg\fRs
|
determine the exact behavior of the command. The following
|
determine the exact behavior of the command. The following
|
commands are possible for disjointlistbox widgets:
|
commands are possible for disjointlistbox widgets:
|
|
|
.SH "WIDGET-SPECIFIC METHODS"
|
.SH "WIDGET-SPECIFIC METHODS"
|
.TP
|
.TP
|
\fIpathName \fBcget\fR \fIoption\fR
|
\fIpathName \fBcget\fR \fIoption\fR
|
Returns the current value of the configuration option given
|
Returns the current value of the configuration option given
|
by \fIoption\fR.
|
by \fIoption\fR.
|
\fIOption\fR may have any of the values accepted by the \fBdisjointlistbox\fR
|
\fIOption\fR may have any of the values accepted by the \fBdisjointlistbox\fR
|
command.
|
command.
|
.TP
|
.TP
|
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
Query or modify the configuration options of the widget.
|
Query or modify the configuration options of the widget.
|
If no \fIoption\fR is specified, returns a list describing all of
|
If no \fIoption\fR is specified, returns a list describing all of
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
information on the format of this list). If \fIoption\fR is specified
|
information on the format of this list). If \fIoption\fR is specified
|
with no \fIvalue\fR, then the command returns a list describing the
|
with no \fIvalue\fR, then the command returns a list describing the
|
one named option (this list will be identical to the corresponding
|
one named option (this list will be identical to the corresponding
|
sublist of the value returned if no \fIoption\fR is specified). If
|
sublist of the value returned if no \fIoption\fR is specified). If
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
modifies the given widget option(s) to have the given value(s); in
|
modifies the given widget option(s) to have the given value(s); in
|
this case the command returns an empty string.
|
this case the command returns an empty string.
|
\fIOption\fR may have any of the values accepted by the \fBdisjointlistbox\fR
|
\fIOption\fR may have any of the values accepted by the \fBdisjointlistbox\fR
|
command.
|
command.
|
.TP
|
.TP
|
\fIpathName \fBsetlhs\fR
|
\fIpathName \fBsetlhs\fR
|
Set the current contents of the left-most Scrolledlistbox with the input list
|
Set the current contents of the left-most Scrolledlistbox with the input list
|
of items. Removes all (if any) items from the right-most Scrolledlistbox
|
of items. Removes all (if any) items from the right-most Scrolledlistbox
|
which exist in the input list option to maintain the disjoint property
|
which exist in the input list option to maintain the disjoint property
|
between the two
|
between the two
|
.TP
|
.TP
|
\fIpathName \fBsetrhs\fR
|
\fIpathName \fBsetrhs\fR
|
Set the current contents of the right-most Scrolledlistbox with the input list
|
Set the current contents of the right-most Scrolledlistbox with the input list
|
of items. Removes all (if any) items from the left-most Scrolledlistbox
|
of items. Removes all (if any) items from the left-most Scrolledlistbox
|
which exist in the input list option to maintain the disjoint property
|
which exist in the input list option to maintain the disjoint property
|
between the two
|
between the two
|
.TP
|
.TP
|
\fIpathName \fBgetlhs\fR
|
\fIpathName \fBgetlhs\fR
|
Returns the current contents of the left-most Scrolledlistbox
|
Returns the current contents of the left-most Scrolledlistbox
|
.TP
|
.TP
|
\fIpathName \fBgetrhs\fR
|
\fIpathName \fBgetrhs\fR
|
Returns the current contents of the right-most Scrolledlistbox
|
Returns the current contents of the right-most Scrolledlistbox
|
.TP
|
.TP
|
\fIpathName \fBinsertlhs\fR
|
\fIpathName \fBinsertlhs\fR
|
Add the input list of items to the current contents of the left-most
|
Add the input list of items to the current contents of the left-most
|
Scrolledlistbox. Removes all (if any) items from the right-most Scrolledlistbox
|
Scrolledlistbox. Removes all (if any) items from the right-most Scrolledlistbox
|
which exist in the input list option to maintain the disjoint property
|
which exist in the input list option to maintain the disjoint property
|
between the two
|
between the two
|
.TP
|
.TP
|
\fIpathName \fBinsertrhs\fR
|
\fIpathName \fBinsertrhs\fR
|
Add the input list of items to the current contents of the right-most
|
Add the input list of items to the current contents of the right-most
|
Scrolledlistbox. Removes all (if any) items from the left-most Scrolledlistbox
|
Scrolledlistbox. Removes all (if any) items from the left-most Scrolledlistbox
|
which exist in the input list option to maintain the disjoint property
|
which exist in the input list option to maintain the disjoint property
|
between the two.
|
between the two.
|
.TP
|
.TP
|
.SH "COMPONENTS"
|
.SH "COMPONENTS"
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBlhs\fR
|
Name: \fBlhs\fR
|
Class: \fBScrolledlistbox\fR
|
Class: \fBScrolledlistbox\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The lhs component is the scrolledlistbox for the rhs button.
|
The lhs component is the scrolledlistbox for the rhs button.
|
See the "scrolledlistbox" widget manual entry for details on the lhs
|
See the "scrolledlistbox" widget manual entry for details on the lhs
|
component item.
|
component item.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBrhs\fR
|
Name: \fBrhs\fR
|
Class: \fBScrolledlistbox\fR
|
Class: \fBScrolledlistbox\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The rhs component is the scrolledlistbox for the rhs button.
|
The rhs component is the scrolledlistbox for the rhs button.
|
See the "scrolledlistbox" widget manual entry for details on the rhs
|
See the "scrolledlistbox" widget manual entry for details on the rhs
|
component item.
|
component item.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBlhsbutton\fR
|
Name: \fBlhsbutton\fR
|
Class: \fButton\fR
|
Class: \fButton\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The lhsbutton component is the button for users to remove selected items
|
The lhsbutton component is the button for users to remove selected items
|
from the lhs Scrolledlistbox.
|
from the lhs Scrolledlistbox.
|
See the "button" widget manual entry for details on the lhs button component.
|
See the "button" widget manual entry for details on the lhs button component.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBrhsbutton\fR
|
Name: \fBrhsbutton\fR
|
Class: \fBButton\fR
|
Class: \fBButton\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The rhsbutton component is the button for users to remove selected items
|
The rhsbutton component is the button for users to remove selected items
|
from the rhs Scrolledlistbox.
|
from the rhs Scrolledlistbox.
|
See the "button" widget manual entry for details on the rhs button component.
|
See the "button" widget manual entry for details on the rhs button component.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBlhsCount\fR
|
Name: \fBlhsCount\fR
|
Class: \fBLabel\fR
|
Class: \fBLabel\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The lhsCount component is the label for displaying a count of the current items in
|
The lhsCount component is the label for displaying a count of the current items in
|
the Scrolledlistbox.
|
the Scrolledlistbox.
|
See the "Label" widget manual entry for details on the lhsCount label component.
|
See the "Label" widget manual entry for details on the lhsCount label component.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBrhsCount\fR
|
Name: \fBrhsCount\fR
|
Class: \fBLabel\fR
|
Class: \fBLabel\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The rhsCount component is the label for displaying a count of the current items in
|
The rhsCount component is the label for displaying a count of the current items in
|
the Scrolledlistbox.
|
the Scrolledlistbox.
|
See the "Label" widget manual entry for details on the rhsCount label component.
|
See the "Label" widget manual entry for details on the rhsCount label component.
|
.fi
|
.fi
|
.IP
|
.IP
|
.SH EXAMPLE
|
.SH EXAMPLE
|
.DS
|
.DS
|
disjointlistbox .dlb
|
disjointlistbox .dlb
|
pack .dlb -padx 10 -pady 10 -fill both -expand yes
|
pack .dlb -padx 10 -pady 10 -fill both -expand yes
|
.DE
|
.DE
|
.SH AUTHOR(S)
|
.SH AUTHOR(S)
|
John A. Tucker
|
John A. Tucker
|
.DE
|
.DE
|
Anthony Parent
|
Anthony Parent
|
.SH KEYWORDS
|
.SH KEYWORDS
|
disjointlistbox, widget
|
disjointlistbox, widget
|
|
|
