Class: Rex::Ui::ProgressTracker

This module tracks the progress of an arbitrary task in a generic fashion. The actual implementation is left up to the thing that derives from this module.

Methods

abort error new range= reset start= status step step_status

Attributes

pos	[RW]	The current position in the progress.
start	[R]	The start of the progress.
stop	[RW]	The last position in the progress.

Public Class methods

new()

Public Instance methods

abort(msg = nil)

Progress has been aborted, the reason is supplied in msg.

error(msg = nil)

An error occurred that may result in aborting the progress.

range=(rng)

Sets start and step using a range.

reset(n = self.start)

Resets the current step location.

start=(start)

Sets the start and resets the position.

status(msg = nil)

Passes a generic status message that isn‘t necessarily associated with a step event.

step(status = nil, n = 1)

Steps with a given message and step size.

step_status(msg = nil)

Updates the status associated with the current step.