File 'gui/progressbar.cls' (part of 'Pool_GuiBase')

Description (short): Progressbar widget
Written by: Andreas Kupries
Description: Generation and maintenance of progressbars
Keywords: progressbar, animated feedback, feedback

Class 'progressbar'

Superclasses

valueManager

Options

barcolor
barwidth
barlength
orientation

Methods

public: SetDimensions ()
TrackBarColor (o oldValue)
TrackBarLength (o oldValue)
TrackBarWidth (o oldValue)
TrackGeometry (w h)
TrackOrientation (o oldValue)
createSubwidgets ()
progressbar ()
setBindings ()
updateDisplay ()

Membervariables

public: pos
barItem
orientation

Options

-barcolor: Color of the bar, defaults to 'red'.
default value: red
-barwidth: width of the bar in pixels for vertical orientation, height else.
default value: 20
-barlength: Length of the bar in pixels (height for vertical orientation).
default value: 100
-orientation: Orientation of the progressbar.
default value: horizontal

Methods

SetDimensions ()

Updates the internal information about the drawn bar. Executed during initialization or changes to the widget orientation.

TrackBarColor (o oldValue)

Configure procedure. Propagates changes to the color of the bar into the display.

Argument: o The changed option.

Argument: oldValue The old value of the option.

TrackBarLength (o oldValue)

Configure procedure. Propagates changes to the length of the bar into the display.

Argument: o The changed option.

Argument: oldValue The old value of the option.

TrackBarWidth (o oldValue)

Configure procedure. Propagates changes to the width of the bar into the display.

Argument: o The changed option.

Argument: oldValue The old value of the option.

TrackGeometry (w h)

Executed for 'Configure' events, i.e. resizing operations. Updates the internal information about the drawn bar, then refreshes the display.

Argument: w New width of the widget.

Argument: h New height of the widget.

TrackOrientation (o oldValue)

Configure procedure. Propagates changes to the orientation of the bar into the display.

Argument: o The changed option.

Argument: oldValue The old value of the option.

createSubwidgets ()

Overrides valueManager:createSubwidgets
Called after object construction. Generates the internal widgets and their layout.

progressbar ()

Constructor. Initializes the value of the inherited option '-value' to zero.

setBindings ()

Overrides valueManager:setBindings
Called after widget construction and layout. Adds the bindings required to make the widget reactive to changes in the enviroment. Here we track changes to the geometry, as imposed by the user or containing geometry managers.

updateDisplay ()

Overrides valueManager:updateDisplay
Method required by the superclass valueManager to propagate changes to the value into the display. Converts the percentage value into a pixelposition and then executes a redraw of the bar.

Membervariables

pos: Pixel position of the bar, derived from the value of option -value.
initial value: 0.0
barItem: Index of the canvas item used as bar.
orientation: Internal orientation code of the bar, derived from the value of option -orientation.

Generated by AutoDoc 2.4 at 09/14/2000, invoked by Andreas Kupries

SetDimensions ()
Updates the internal information about the drawn bar. Executed during initialization or changes to the widget orientation.

TrackBarColor (o oldValue)
Configure procedure. Propagates changes to the color of the bar into the display.
Argument: o	The changed option.
Argument: oldValue	The old value of the option.

TrackBarLength (o oldValue)
Configure procedure. Propagates changes to the length of the bar into the display.
Argument: o	The changed option.
Argument: oldValue	The old value of the option.

TrackBarWidth (o oldValue)
Configure procedure. Propagates changes to the width of the bar into the display.
Argument: o	The changed option.
Argument: oldValue	The old value of the option.

TrackGeometry (w h)
Executed for 'Configure' events, i.e. resizing operations. Updates the internal information about the drawn bar, then refreshes the display.
Argument: w	New width of the widget.
Argument: h	New height of the widget.

TrackOrientation (o oldValue)
Configure procedure. Propagates changes to the orientation of the bar into the display.
Argument: o	The changed option.
Argument: oldValue	The old value of the option.

createSubwidgets ()
Overrides valueManager:createSubwidgets Called after object construction. Generates the internal widgets and their layout.

progressbar ()
Constructor. Initializes the value of the inherited option '-value' to zero.

setBindings ()
Overrides valueManager:setBindings Called after widget construction and layout. Adds the bindings required to make the widget reactive to changes in the enviroment. Here we track changes to the geometry, as imposed by the user or containing geometry managers.

updateDisplay ()
Overrides valueManager:updateDisplay Method required by the superclass valueManager to propagate changes to the value into the display. Converts the percentage value into a pixelposition and then executes a redraw of the bar.