CProgressBar Class Reference

#include <ProgressBar.h>

Inheritance diagram for CProgressBar:

Public Member Functions
virtual bool16	WasCancelled (bool8 setGlobalErrorState=kTrue)=0
virtual void	Abort ()=0
virtual void	DisableChildProgressBars (bool16 disable)=0
virtual bool16	WasRegisterSuccessful ()=0
virtual void	SetPosition (int32 newPosition)

Detailed Description

Abstract baseclass for stack based Progress bar objects.

Member Function Documentation

virtual void CProgressBar::Abort ( )

pure virtual

Call this anytime during the tasks to immediately terminate the entire progress bar process. Usually called when an error condition is encountered during one of the sub tasks.

Implemented in DocWindowProgressBar, BaseProgressBar, and CInterruptOnlyProgressImpl.

virtual void CProgressBar::DisableChildProgressBars ( bool16  disable )

pure virtual

Call this passing kTrue to keep any subsequent progress bars from subdividing your progress bar.

Implemented in DocWindowProgressBar, BaseProgressBar, and CInterruptOnlyProgressImpl.

virtual void CProgressBar::SetPosition ( int32  newPosition )

virtual

Call this to set the position of the progressbar to a location within the specified range.

Reimplemented in DocWindowProgressBar, BaseProgressBar, and CInterruptOnlyProgressImpl.

virtual bool16 CProgressBar::WasCancelled ( bool8  setGlobalErrorState = kTrue )

pure virtual

Check this to see if the user cancelled the action.

Implemented in DocWindowProgressBar, BaseProgressBar, and CInterruptOnlyProgressImpl.

virtual bool16 CProgressBar::WasRegisterSuccessful ( )

pure virtual

Was the registration of this progress bar was successful. Not usually necessary to call this. Reasons for failure include another progress bar calling DisableChildProgressBars().

Implemented in DocWindowProgressBar, BaseProgressBar, and CInterruptOnlyProgressImpl.