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

NAME
       iwidgets::feedback - Create and manipulate a feedback widget to display
       feedback on the current status of an ongoing operation to the user.

SYNOPSIS
       iiwwiiddggeettss::::ffeeeeddbbaacckk pathName ?options?

IINNHHEERRIITTAANNCCEE
       itk::Widget <- iwidgets::Labeledwidget <- iwidgets::Feedback

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       bbaacckkggrroouunndd      ccuurrssoorr         ffoorreeggrroouunndd      hhiigghhlliigghhttCCoolloorr
       hhiigghhlliigghhttTThhiicckknneessss

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

IINNHHEERRIITTEEDD OOPPTTIIOONNSS
       llaabbeellBBiittmmaapp     llaabbeellFFoonntt      llaabbeellIImmaaggee      llaabbeellMMaarrggiinn
       llaabbeellPPooss        llaabbeellTTeexxtt      llaabbeellVVaarriiaabbllee   ssttiicckkyy

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

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Name:           bbaarrccoolloorr
       Class:          BBaarrCCoolloorr
       Command-Line Switch:           -bbaarrccoolloorr

              Specifies  the  color  of  the  status  bar, in any of the forms
              acceptable to TTkkGGeettCCoolloorr.  The default is DodgerBlue.

       Name:           bbaarrhheeiigghhtt
       Class:          BBaarrHHeeiigghhtt
       Command-Line Switch:           -bbaarrhheeiigghhtt

              Specifies the height of the status bar,  in  any  of  the  forms
              acceptable to TTkkGGeettPPiixxeellss. The default is 20.

       Name:           ttrroouugghhCCoolloorr
       Class:          TTrroouugghhCCoolloorr
       Command-Line Switch:           -ttrroouugghhccoolloorr

              Specifies  the  color of the frame in which the status bar sits,
              in any of the forms acceptable to TTkkGGeettCCoolloorr.  The  default  is
              white.

       Name:           sstteeppss
       Class:          SStteeppss
       Command-Line Switch:           -sstteeppss

              Specifies  the  total  number  of  steps for the status bar. The
              default is 10.



DESCRIPTION
       The iiwwiiddggeettss::::ffeeeeddbbaacckk command creates a widget to display feedback  on
       the  current  status  of  an  ongoing operation to the user. Display is
       given as a percentage and as a thermometer type bar. Options exist  for
       adding a label and controlling its position.


MMEETTHHOODDSS
       The  iiwwiiddggeettss::::ffeeeeddbbaacckk 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:


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
              ssccrroolllleeddhhttmmll 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::::ffeeeeddbbaacckk command.

       pathName rreesseett
              Reset the current number of steps completed to 0, and configures
              the percentage complete label text to 0%

       pathName sstteepp ?inc?
              Increase  the  current  number  of steps completed by the amount
              specified by inc. Inc defaults to 1.


EEXXAAMMPPLLEE
               package require Iwidgets 4.0
               iwidgets::feedback .fb -labeltext "Status" -steps 20
               pack .fb -padx 10 -pady 10 -fill both -expand yes

               for {set i 0} {$i < 20} {incr i} {
                   .fb step
                   after 500
               }


AACCKKNNOOWWLLEEDDGGEEMMEENNTTSS
       Sam Shen

              This code is based largely on  his  feedback.tcl  code  from  tk
              inspect.  The  original feedback code is copyright 1995 Lawrence
              Berkeley Laboratory.


AUTHOR       Kris Raney

KKEEYYWWOORRDDSS
       feedback, widget



Tk                                                       iwidgets::feedback(1)