PDF::ProgressMonitor Class Reference

Progress monitor for tracking the progress of an operation. More...

#include <pdfsdk/cxx/progress_monitor.h>

Public Member Functions
const PDProgressMonitor *	monitor () const
void *	userdata ()
virtual void	BeginOperation (double start, double end)
	Called when an operation begins.
virtual void	EndOperation ()
	Called when an operation ends.
virtual void	SetCurrentValue (double value)
	Called to set the current value of the progress.
virtual bool	IsCanceled () const
	Check if the operation has been canceled.

Detailed Description

Progress monitor for tracking the progress of an operation.

Member Function Documentation

BeginOperation()

virtual void PDF::ProgressMonitor::BeginOperation ( double start, double end )

inlinevirtual

Called when an operation begins.

Parameters

start	The starting value of the progress.
end	The ending value of the progress.

IsCanceled()

virtual bool PDF::ProgressMonitor::IsCanceled ( ) const

inlinevirtual

Check if the operation has been canceled.

Returns

true if the operation has been canceled, false otherwise.

SetCurrentValue()

virtual void PDF::ProgressMonitor::SetCurrentValue ( double value )

inlinevirtual

Called to set the current value of the progress.

Parameters

value

The current value of the progress.

---

The documentation for this class was generated from the following file:

• include/pdfsdk/cxx/progress_monitor.h