progressbar.Widget Class Reference

Inheritance diagram for progressbar.Widget:

Public Member Functions
def	update (self, pbar)

Static Public Attributes
	TIME_SENSITIVE

Static Private Attributes
	__slots__

Detailed Description

The base class for all widgets

The ProgressBar will call the widget's update value when the widget should
be updated. The widget's size may change between calls, but the widget may
display incorrectly if the size changes drastically and repeatedly.

The boolean TIME_SENSITIVE informs the ProgressBar that it should be
updated more often because it is time sensitive.

Definition at line 17 of file progressbar.py.

Member Function Documentation

update()

def progressbar.Widget.update	(		self,
			pbar
	)

Updates the widget.

pbar - a reference to the calling ProgressBar

Definition at line 32 of file progressbar.py.

Referenced by progressbar.ProgressBar.__next__(), MatrixUtil.Matrix.__setitem__(), MatrixUtil.Steps.__setitem__(), progressbar.ProgressBar.finish(), and MatrixUtil.Steps.overwrite().

    def update(self, pbar):
        '''Updates the widget.

        pbar - a reference to the calling ProgressBar
        '''

Member Data Documentation

__slots__

progressbar.Widget.__slots__

staticprivate

Definition at line 29 of file progressbar.py.

TIME_SENSITIVE

progressbar.Widget.TIME_SENSITIVE

static

Definition at line 28 of file progressbar.py.