zProgBar
============================================================================

	Summary  A view class for displaying progress bar indicators.

	Remarks  zProgBar is a rather simple progress bar indicator class. It
	         is very generalized and can be used for anything. There are
	         some caveats, so please be sure to read the notes in the header
	         file. I had to sacrifice some accuracy in order to be able to
	         use the class within the ProBoard SDK limitation (no floating
	         point). To use the zProgBar class, you need to tell it the size
	         of the complete job in bytes (for example, if you will be
	         reading a file, you need to tell it the total size of the file).
	         It also needs to know where to put the bar and how big it should
	         make it (note that it is perfectly ok to have a thermometer that
	         is several lines high, and if this is the case, every update
	         will simultaneously work on all lines, i.e. it will not wrap
	         to thenext line, but rather use them all at the same time). You
	         can also specify the foreground and background character /
	         attribute combination it should use. These have defaults which
	         may or may not suit your needs.


	ZPROGBAR::ZPROGBAR
	------------------------------------------------------------------------

		Summary  Initializes the progress bar indicator object.

		Syntax   zProgBar(zRect &r, ushort fg = _barfg, ushort bg = _barbg),

		Remarks  Here you will specify the size of the thermometer box the
		         bar should use. Note that this is given in absolute screen
		         coordinates with the upper left corner being at (1,1). This
		         is compatible with <conio.h> and the ProBoard SDK. Also
		         note that for this to work, your height should at least be
		         one character. The 'fg' and 'bg' are the character/attribute
		         combinations you can use to change the defaults. Note that
		         the format of the short integer is: the attribute (conio.h
		         compatible) stuffed in the high byte and the character
		         itself - in the low byte. The constants _barfg and _barbg
		         are initialized as follows:

                   static const ushort _barfg = 0x0700 | ('' & 0x00ff);
                   static const ushort _barbg = 0x0700 | ('' & 0x00ff);

                 You can use them as normal color/char attributes too.


	ZPROGBAR::SETTOTAL
	------------------------------------------------------------------------

		Summary  Sets the size of the total job measured by the bar.

		Syntax   void setTotal(ulong aTotal);

		Remarks  This function MUST be called for the whole class to work
		         correctly. It will set the total job size to the 'aTotal'
		         parameter. This indicates the size of the completed task.
		         For example, if you are processing a file, this would be
		         the total file size.


	ZPROGBAR::UPDATE
	------------------------------------------------------------------------

		Summary  Updates the thermometer bar with a new step.

		Syntax   void update(ulong aStep);

		Remarks  This is the principal function of the class. For each
		         iteration, call it with the size of the step just completed.
		         For example, if you are reading a file into a buffer, call
		         this with the nuber of bytes you just read. If you are
		         processing records, call it with the number of records you
		         just processed in this step. This function will change the
		         color and the cursor location. If you require to do some
		         other output while it is working, make sure you send the
		         cursor to the appropriate position and change the color to
		         the desired attribute. Generally, the user will only see the
		         indicator, so I felt it was not necessary to do this within
                 the class.


	ZPROGBAR::GETPERCENT
	------------------------------------------------------------------------

		Summary  Returns the current percentage of the task completed.

		Syntax   short getPerCent() const;

		Remarks  Returns the total percentage of the completed job. This is
		         useful for additional statistics display apart from the
		         progress bar. The value will be between 0 and 100.

