Celartem::ProcessCallback Class Reference

#include <pxl_callback.h>

Inheritance diagram for Celartem::ProcessCallback:

[legend]

List of all members.

Public Member Functions
virtual bool	callback (size_t inPercentage)=0

---

Detailed Description

ProcessCallback is a general form for periodically report the progress status of the process.
For caller of ProcessCallback instance, in the first call of callback function, inPercentage must be 0 and in the final call of the function, it must be 100. For implementer of classes which inherit this class, you can assume 0 and 100 for the first and the final calls.

Definition at line 25 of file pxl_callback.h.

---

Member Function Documentation

virtual bool Celartem::ProcessCallback::callback

(

size_t

inPercentage

)

[pure virtual]

ProcessCallback is a general form for periodically report the progress status of the process. You can also throw some exception from the callback function to terminate the process; although the process is terminated by the exception, the system can go on without any unrecoverable problem.

Parameters:

inPercentage

This parameter indicates the current process status. The value must be in 0-100.

Returns:

true if you want to continue the process, false if you want to cancel(terminate) the process.

---

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

• pxl_callback.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:11 2008.