feedback

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



______________________________________________________________________________

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

SYNOPSIS
       feedback pathName ?options?

INHERITANCE
       itk::Widget <- Labeledwidget <- Feedback

STANDARD OPTIONS
       background      cursor         foreground      highlightColor
       highlightThickness

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

INHERITED OPTIONS
       labelBitmap     labelFont      labelImage      labelMargin
       labelPos        labelText      labelVariable

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

WIDGET-SPECIFIC OPTIONS
       Name:           barcolor
       Class:          BarColor
       Command-Line Switch:           -barcolor

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

       Name:           barheight
       Class:          BarHeight
       Command-Line Switch:           -barheight

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

       Name:           troughColor
       Class:          TroughColor
       Command-Line Switch:           -troughcolor

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

       Name:           steps
       Class:          Steps
       Command-Line Switch:           -steps

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



DESCRIPTION
       The feedback command creates a widget to display feedback on  the  cur-
       rent  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.


METHODS
       The  feedback 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:


WIDGET-SPECIFIC METHODS
       pathName cget option
              Returns the current value of the configuration option  given  by
              option.   Option  may  have  any  of  the values accepted by the
              scrolledhtml command.

       pathName configure ?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 Tk_ConfigureInfo 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 feedback command.

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

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


EXAMPLE
               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
               }


ACKNOWLEDGEMENTS
       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

KEYWORDS
       feedback, widget



Tk                                                                 feedback(1)