iwidgets::disjointlistbox(1) [incr Widgets] iwidgets::disjointlistbox(1)

NAME
       iwidgets::disjointlistbox  -  Create  and  manipulate a disjointlistbox
       widget

SYNOPSIS
       iiwwiiddggeettss::::ddiissjjooiinnttlliissttbbooxx pathName ?options?

IINNHHEERRIITTAANNCCEE
       itk::Widget <- iwidgets::Disjointlistbox

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       aaccttiivveeBBaacckkggrroouunndd    sseelleeccttBBoorrddeerrWWiiddtthh   sseelleeccttFFoorreeggrroouunndd
       aaccttiivveeFFoorreeggrroouunndd    aaccttiivveeRReelliieeff        bbaacckkggrroouunndd
       bboorrddeerrWWiiddtthh         bbuuttttoonnPPllaacceemmeenntt     cclliieennttDDaattaa
       ccuurrssoorr              ffoorreeggrroouunndd          hhiigghhlliigghhttCCoolloorr
       hhiigghhlliigghhttTThhiicckknneessss  ddiissaabblleeddFFoorreeggrroouunndd  eelleemmeennttBBoorrddeerrWWiiddtthh

       See the "options" manual entry for details on the standard options.

AASSSSOOCCIIAATTEEDD OOPPTTIIOONNSS
       llhhssBBuuttttoonnLLaabbeell rrhhssBBuuttttoonnLLaabbeell

       See the "button" widget manual entry for details on the  above  associ-
       ated options.

       llaabbeellFFoonntt llhhssLLaabbeellTTeexxtt rrhhssLLaabbeellTTeexxtt

       See the "label" widget manual entry for details on the above associated
       options.

       jjuummpp ttrroouugghhCCoolloorr

       See the "scrollbar" widget class manual entry for details on the  above
       associated options.

       tteexxttBBaacckkggrroouunndd tteexxttFFoonntt
       llhhssIItteemmss rrhhssIItteemmss

       See  the "scrolledlistbox" widget manual entry for details on the above
       associated options.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Name:           bbuuttttoonnPPllaacceemmeenntt
       Class:          BBuuttttoonnPPllaacceemmeenntt
       Command-Line Switch:           -bbuuttttoonnppllaacceemmeenntt

              Specifies the placement of the  insertion  and  removal  buttons
              relative  to  the  scrolledlistbox  widgetsnn, bboottttoomm, or cceenntteerr.
              The default is bottom.

       Name:           llhhssLLaabbeellTTeexxtt
       Class:          LLaabbeellTTeexxtt
       Command-Line Switch:           -llhhssllaabbeelltteexxtt

              Specifies the text for the label  of  the  lhs  scrolledlistbox.
              The default is "Available".

       Name:           rrhhssLLaabbeellTTeexxtt
       Class:          LLaabbeellTTeexxtt
       Command-Line Switch:           -rrhhssllaabbeelltteexxtt

              Specifies  the  text  for  the label of the rhs scrolledlistbox.
              The default is "Available".

       Name:           llhhssBBuuttttoonnLLaabbeell
       Class:          LLaabbeellTTeexxtt
       Command-Line Switch:           -llhhssbbuuttttoonnllaabbeell

              Specifies the text for the button of  the  lhs  scrolledlistbox.
              The default is "Insert >>".

       Name:           rrhhssBBuuttttoonnLLaabbeell
       Class:          LLaabbeellTTeexxtt
       Command-Line Switch:           -rrhhssbbuuttttoonnllaabbeell

              Specifies  the  text  for the button of the rhs scrolledlistbox.
              The default is "<< Remove".

       ae           lhsSortOption
       ls:          LhsSortOption
       Command-Line Switch:           -llhhssssoorrttooppttiioonn

              Specifies  the  sort  function  to  be  applied   to   the   lhs
              scrolledlistbox  after items are inserted. Accepts the same sort
              options as the scrolledlistbox sort  method  (Tcl's  lsort  com-
              mand).  If  "none" is specified, the inserted items are appended
              to the end of the  list,  and  no  sorting  is  performed.   The
              default is "increasing".

       ae           rhsSortOption
       ls:          RhsSortOption
       Command-Line Switch:           -rrhhssssoorrttooppttiioonn

              Specifies   the   sort   function  to  be  applied  to  the  rhs
              scrolledlistbox after items are inserted. Accepts the same  sort
              options  as  the  scrolledlistbox  sort method (Tcl's lsort com-
              mand). If "none" is specified, the inserted items  are  appended
              to  the  end  of  the  list,  and  no sorting is performed.  The
              default is "increasing".



DESCRIPTION
       The iiwwiiddggeettss::::ddiissjjooiinnttlliissttbbooxx command creates a disjoint pair of  list-
       boxs   similar   to   the  OSF/Motif  "Book"  printing  dialog  of  the
       "FrameMaker"  program.   It  is  implementation  constists  of  a   two
       Scrolledlistboxs, 2 buttons, and 2 labels.

       The  disjoint behavior of this widget exists between the interaction of
       the two Scrolledlistboxes with one another.  That is, a given  instance
       of  a Disjointlistbox will never exist, without the aid of a hack magi-
       cian, which has Scrolledlistbox widgets with  items  in  common.   That
       means the relationship between the two is maintained similar to that of
       disjoint sets.

       Users may transfer items between the two Listbox widgets using the  the
       two buttons.

       Options  exists which include the ability to configure the "items" dis-
       played by the 2 Scrolledlistboxes and to control the placement  of  the
       insertion and removal buttons.

MMEETTHHOODDSS
       The  iiwwiiddggeettss::::ddiissjjooiinnttlliissttbbooxx  command creates a new Tcl command whose
       name is pathName.  This command may be used to  invoke  various  opera-
       tions on the widget.  It has the following general form:

              pathName option ?arg arg ...?

       Option  and  the args determine the exact behavior of the command.  The
       following commands are possible for disjointlistbox widgets:


WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS
       pathName ccggeett option
              Returns the current value of the configuration option  given  by
              option.  Option may have any of the values accepted by the iiwwiidd-
              ggeettss::::ddiissjjooiinnttlliissttbbooxx command.

       pathName ccoonnffiigguurree ?option? ?value option value ...?
              Query or modify the configuration options of the widget.  If  no
              option is specified, returns a list describing all of the avail-
              able options for pathName (see TTkkCCoonnffiigguurreeIInnffoo for  information
              on  the  format  of  this list).  If option is specified with no
              value, 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 option is  specified).   If  one  or
              more option-value 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.  Option may have any
              of the values accepted by the iiwwiiddggeettss::::ddiissjjooiinnttlliissttbbooxx command.

       pathName sseettllhhss
              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 which exist in the input list option
              to maintain the disjoint property between the two

       pathName sseettrrhhss
              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 which exist in the input  list  option
              to maintain the disjoint property between the two

       pathName ggeettllhhss
              Returns the current contents of the left-most Scrolledlistbox

       pathName ggeettrrhhss
              Returns the current contents of the right-most Scrolledlistbox

       pathName iinnsseerrttllhhss
              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 which exist in the input list option
              to maintain the disjoint property between the two

       pathName iinnsseerrttrrhhss
              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 which exist in the input  list  option
              to maintain the disjoint property between the two.


       CCOOMMPPOONNEENNTTSS

       Name:           llhhss
       Class:          SSccrroolllleeddlliissttbbooxx

              The  lhs  component  is  the scrolledlistbox for the rhs button.
              See the "scrolledlistbox" widget manual entry for details on the
              lhs component item.

       Name:           rrhhss
       Class:          SSccrroolllleeddlliissttbbooxx

              The  rhs  component  is  the scrolledlistbox for the rhs button.
              See the "scrolledlistbox" widget manual entry for details on the
              rhs component item.

       Name:           llhhssbbuuttttoonn
       Class:          uuttttoonn

              The  lhsbutton  component  is  the  button  for  users to remove
              selected items from the lhs Scrolledlistbox.  See  the  "button"
              widget manual entry for details  on the lhs button component.

       Name:           rrhhssbbuuttttoonn
       Class:          BBuuttttoonn

              The  rhsbutton  component  is  the  button  for  users to remove
              selected items from the rhs Scrolledlistbox.  See  the  "button"
              widget manual entry for details  on the rhs button component.

       Name:           llhhssCCoouunntt
       Class:          LLaabbeell

              The  lhsCount  component  is the label for displaying a count of
              the current items in the Scrolledlistbox.  See the "Label"  wid-
              get manual entry for details  on the lhsCount label component.

       Name:           rrhhssCCoouunntt
       Class:          LLaabbeell

              The  rhsCount  component  is the label for displaying a count of
              the current items in the Scrolledlistbox.  See the "Label"  wid-
              get manual entry for details  on the rhsCount label component.


EEXXAAMMPPLLEE
              package require Iwidgets 4.0
              iwidgets::disjointlistbox .dlb
              pack .dlb -padx 10 -pady 10 -fill both -expand yes


AUTHOR(S)       John A. Tucker

       Anthony Parent

KKEEYYWWOORRDDSS
       disjointlistbox, widget



Tk                                                iwidgets::disjointlistbox(1)