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

NAME
       iwidgets::scrolledtext - Create and manipulate a scrolled text widget

SYNOPSIS
       iiwwiiddggeettss::::ssccrroolllleeddtteexxtt pathName ?options?

IINNHHEERRIITTAANNCCEE
       itk::Widget  <-  iwidgets::Labeledwidget <- iwidgets::Scrolledwidget <-
       iwidgets::Scrolledtext

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       aaccttiivveeBBaacckkggrroouunndd               bbaacckkggrroouunndd      bboorrddeerrWWiiddtthhccuurrssoorr
       eexxppoorrttSSeelleeccttiioonn                ffoorreeggrroouunndd      hhiigghhlliigghhttCCoolloorr
       hhiigghhlliigghhttTThhiicckknneessss             iinnsseerrttBBaacckkggrroouunndd
       iinnsseerrttBBoorrddeerrWWiiddtthh              iinnsseerrttOOffffTTiimmee   iinnsseerrttOOnnTTiimmee
       iinnsseerrttWWiiddtthh                    ppaaddXX            ppaaddYY
       rreelliieeff                         sseelleeccttBBaacckkggrroouunndd
       sseelleeccttBBoorrddeerrWWiiddtthh              sseelleeccttFFoorreeggrroouunndd
       sseettGGrriidd

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

AASSSSOOCCIIAATTEEDD OOPPTTIIOONNSS
       aaccttiivveeRReelliieeff    eelleemmeennttBBoorrddeerrWWiiddtthh             jjuummppttrroouugghhCCoolloorr

       See the "scrollbar" widget manual entry for details on the above  asso-
       ciated options.

       ssppaacciinngg11        ssppaacciinngg22       ssppaacciinngg33        ssttaattee
       ttaabbss            wwrraapp

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

IINNHHEERRIITTEEDD OOPPTTIIOONNSS
       ddiissaabblleeddFFoorreeggrroouunndd             llaabbeellBBiittmmaapp     llaabbeellFFoonnttllaabbeellIImmaaggee
       llaabbeellMMaarrggiinn     llaabbeellPPooss       llaabbeellTTeexxtt       llaabbeellVVaarriiaabbllee
       ssttaattee           ssttiicckkyy

       See the "labeledwidget" class manual entry for details on the inherited
       options.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Name:           hheeiigghhtt
       Class:          HHeeiigghhtt
       Command-Line Switch:           -hheeiigghhtt

              Specifies  the  height  of  the scrolled text as an entire unit.
              The value may be specified in any of  the  forms  acceptable  to
              TTkkGGeettPPiixxeellss.   Any additional space needed to display the other
              components such as labels, margins,  and  scrollbars  force  the
              text  to  be  compressed.   A  value of zero along with the same
              value for the width causes the value given for the  visibleitems
              option to be applied which administers geometry constraints in a
              different manner.  The default height is zero.

       Name:           hhssccrroollllMMooddee
       Class:          SSccrroollllMMooddee
       Command-Line Switch:           -hhssccrroollllmmooddee

              Specifies the the display mode to be  used  for  the  horizontal
              scrollbar: ssttaattiicc,, ddyynnaammiicc,, or nnoonnee.  In static mode, the scroll
              bar is displayed at all times.  Dynamic mode displays the scroll
              bar  as required, and none disables the scroll bar display.  The
              default is static.

       Name:           ssbbWWiiddtthh
       Class:          WWiiddtthh
       Command-Line Switch:           -ssbbwwiiddtthh

              Specifies the width of the scrollbar in any of the forms accept-
              able to TTkkGGeettPPiixxeellss.

       Name:           ssccrroollllMMaarrggiinn
       Class:          MMaarrggiinn
       Command-Line Switch:           -ssccrroollllmmaarrggiinn

              Specifies  the  distance  between the text area and scrollbar in
              any of the forms acceptable to TTkkGGeettPPiixxeellss.  The default  is  3
              pixels.

       Name:           tteexxttBBaacckkggrroouunndd
       Class:          BBaacckkggrroouunndd
       Command-Line Switch:           -tteexxttbbaacckkggrroouunndd

              Specifies  the  background color for the text area in any of the
              forms acceptable to TTkkGGeettCCoolloorr.

       Name:           tteexxttFFoonntt
       Class:          FFoonntt
       Command-Line Switch:           -tteexxttffoonntt

              Specifies the font to be used in the scrolled text area.

       Name:           vviissiibblleeiitteemmss
       Class:          VViissiibblleeIItteemmss
       Command-Line Switch:           -vviissiibblleeiitteemmss

              Specifies the widthxheight in characters and lines for the text.
              This option is only administered if the width and height options
              are both set to  zero,  otherwise  they  take  precedence.   The
              default  value  is 80x24.  With the visibleitems option engaged,
              geometry constraints are maintained only on the text.  The  size
              of  the  other  components  such  as labels, margins, and scroll
              bars, are additive and independent, effecting the  overall  size
              of  the scrolled text.  In contrast, should the width and height
              options have non zero values, they are applied to  the  scrolled
              text as a whole.  The text is compressed or expanded to maintain
              the geometry constraints.

       Name:           vvssccrroollllMMooddee
       Class:          SSccrroollllMMooddee
       Command-Line Switch:           -vvssccrroollllmmooddee

              Specifies the the display mode  to  be  used  for  the  vertical
              scrollbar: ssttaattiicc,, ddyynnaammiicc,, or nnoonnee.  In static mode, the scroll
              bar is displayed at all times.  Dynamic mode displays the scroll
              bar  as required, and none disables the scroll bar display.  The
              default is static.

       Name:           wwiiddtthh
       Class:          WWiiddtthh
       Command-Line Switch:           -wwiiddtthh

              Specifies the width of the scrolled text as an entire unit.  The
              value may be specified in any of the forms acceptable to TTkkGGeett-
              PPiixxeellss.  Any additional space needed to display the other compo-
              nents  such as labels, margins, and scrollbars force the text to
              be compressed.  A value of zero along with the  same  value  for
              the height causes the value given for the visibleitems option to
              be applied which administers geometry constraints in a different
              manner.  The default width is zero.




DESCRIPTION
       The  iiwwiiddggeettss::::ssccrroolllleeddtteexxtt command creates a scrolled text widget with
       additional options to manage the scrollbars.  This includes options  to
       control  the  method in which the scrollbars are displayed, i.e. stati-
       cally or  dynamically.  Options also exist for adding a  label  to  the
       scrolled  text  area  and  controlling  its position.  Import/export of
       methods are provided for file I/O.


MMEETTHHOODDSS
       The iiwwiiddggeettss::::ssccrroolllleeddtteexxtt command creates a new Tcl command whose name
       is  pathName.  This command may be used to invoke various operations 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 scrolledtext widgets:

AASSSSOOCCIIAATTEEDD MMEETTHHOODDSS
       bbbbooxx            ccoommppaarree        ddeebbuugg           ddeelleettee
       ddlliinneeiinnffoo       ggeett            iimmaaggee           iinnddeexx
       iinnsseerrtt          mmaarrkk           ssccaann            sseeaarrcchh
       sseeee             ttaagg            wwiinnddooww          xxvviieeww
       yyvviieeww

       See the "text" manual entry for details on the standard methods.


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::::ssccrroolllleeddtteexxtt command.

       pathName cchhiillddssiittee
              Returns the child site widget path name.

       pathName cclleeaarr
              Clear the text area of all characters.

       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::::ssccrroolllleeddtteexxtt command.

       pathName iimmppoorrtt filename ?index?
              Load  the text from a file into the text area at the index.  The
              filename must exist.

       pathName eexxppoorrtt filename
              Write text to a file.  If  filename  exists  then  contents  are
              replaced with text widget contents.


CCOOMMPPOONNEENNTTSS
       Name:           tteexxtt
       Class:          TTeexxtt

              The  text  component  is the text widget.  See the "text" widget
              manual entry for details on the text component item.

       Name:           hhoorriizzssbb
       Class:          SSccrroollllbbaarr

              The horizsb component is the horizontal  scroll  bar.   See  the
              "scrollbar"  widget manual entry for details on the horizsb com-
              ponent item.

       Name:           vveerrttssbb
       Class:          SSccrroollllbbaarr

              The vertsb component  is  the  vertical  scroll  bar.   See  the
              "scrollbar" widget manual entry for details on the vertsb compo-
              nent item.


EEXXAAMMPPLLEE
               package require Iwidgets 4.0
               option add *textBackground white

               iwidgets::scrolledtext .st -hscrollmode dynamic -labeltext "Password File"

               pack .st -padx 10 -pady 10 -fill both -expand yes

               .st import /etc/passwd


AUTHOR       Mark L. Ulferts

KKEEYYWWOORRDDSS
       scrolledtext, text, widget



Tk                                                   iwidgets::scrolledtext(1)