InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CInterruptOnlyProgressImpl Class Reference
Inheritance diagram for CInterruptOnlyProgressImpl:
CProgressBar

Public Member Functions

virtual bool16 WasCancelled (bool8 setGlobalErrorState=kTrue)
 
virtual void Abort ()
 
virtual void DisableChildProgressBars (bool16)
 
virtual bool16 WasRegisterSuccessful ()
 
virtual void SetPosition (int32)
 

Member Function Documentation

virtual void CInterruptOnlyProgressImpl::Abort ()
inlinevirtual

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.

Implements CProgressBar.

virtual void CInterruptOnlyProgressImpl::DisableChildProgressBars (bool16 disable)
inlinevirtual

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

Implements CProgressBar.

virtual void CInterruptOnlyProgressImpl::SetPosition (int32 newPosition)
inlinevirtual

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

Reimplemented from CProgressBar.

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

Check this to see if the user cancelled the action.

Implements CProgressBar.

virtual bool16 CInterruptOnlyProgressImpl::WasRegisterSuccessful ()
inlinevirtual

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

Implements CProgressBar.