#include <qbwaitcallback.h>
Inheritance diagram for QBWaitCallback:
Public Member Functions | |
GWEN_TYPE_UINT64 | getProgressPos () const |
GWEN_TYPE_UINT64 | getProgressTotal () const |
time_t | lastCalled () const |
time_t | lastEntered () const |
void | setDistance (int d) |
int | nestingLevel () const |
GWEN_TYPE_UINT32 | flags () const |
int | getDistance () const |
Functions Called by Gwenhywfar | |
These are functions internally called by Gwenhywfar. You should never call one of these functions from within your own code ! | |
virtual QBWaitCallback * | instantiate () |
virtual GWEN_WAITCALLBACK_RESULT | checkAbort (unsigned int level) |
virtual void | log (unsigned int level, GWEN_LOGGER_LEVEL loglevel, const char *s) |
QBWaitCallback (const char *id) | |
virtual | ~QBWaitCallback () |
int | registerCallback () |
int | unregisterCallback () |
const char * | getId () const |
const char * | getText () const |
const char * | getUnits () const |
Protected Member Functions | |
GWEN_WAITCALLBACK * | cCallback () |
Definition at line 26 of file qbwaitcallback.h.
|
Constructor. Please note that this callback is freed by Gwenhywfar, you should never try to free this callback yourself once it has been registered. |
|
|
|
|
|
Checks whether the user wants to abort the current action. This function is optional.
Reimplemented in QBProgressCallback. |
|
|
|
|
|
Returns the Id of this callback. |
|
Returns the current progress position (as set by GWEN_WaitCallback_SetProgressPos). This can be used by the callback context to correctly display a progress bar. |
|
Returns the progress total (as set by GWEN_WaitCallback_SetProgressTotal). This can be used by the callback context to correctly display a progress bar. |
|
|
|
|
|
Uses this callback as a template to instantiate a new one. For GUI callbacks this function can be used to open a window (such as progress dialogs etc). Reimplemented in QBFastCallback, QBProgressCallback, and QBSimpleCallback. |
|
Returns the time when the callback function was last called (or 0 if it has never been called) |
|
Returns the time when the callback context was last entered (or 0 if it never has been). |
|
Logs a message to this callback. A GUI program could use this function to write the given string to an open window. This function is optional.
Reimplemented in QBProgressCallback. |
|
|
|
Registers this callback with Gwenhywfar. After having registered this callback its method instantiate() will be called by Gwenhywfar whenever a callback of this type is entered via GWEN_WaitCallback_Enter. You must unregister this callback before exiting from the calling application/library. |
|
Sets the proposed distance in milliseconds between two calls to the callback. This value is never enforced by the callback mechanism itself. |
|
You must call this member in order to make a clean shutdown of your program/library. |