Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

Long Term Operation Wait Callback

This file contains the definition of a GWEN_WAITCALLBACK. More...

Defines

#define GWEN_WAITCALLBACK_FLAGS_IMMEDIATELY   0x00000002
#define GWEN_WAITCALLBACK_FLAGS_NO_REUSE   0x00000001
#define GWEN_WAITCALLBACK_ID_FAST   "GWEN_WAITCALLBACK_ID_FAST"
#define GWEN_WAITCALLBACK_ID_SIMPLE_PROGRESS   "GWEN_WAITCALLBACK_ID_SIMPLE_PROGRESS"
#define GWEN_WAITCALLBACK_LEVEL_REUSED   9999
#define GWEN_WAITCALLBACK_PROGRESS_NONE   ((GWEN_TYPE_UINT64)(-1))
#define GWEN_WAITCALLBACK_PROGRESS_ONE   ((GWEN_TYPE_UINT64)(-2))

Enumerations

enum  GWEN_WAITCALLBACK_RESULT { GWEN_WaitCallbackResult_Continue = 0, GWEN_WaitCallbackResult_Abort }

Detailed Description

This file contains the definition of a GWEN_WAITCALLBACK.

WaitCallbacks are called during long term operations to give the user the opportunity to abort the operation. The default implementation does nothing. But an application can use such a callback to:

Wait callbacks are organized in callback-contexts which must be entered and left.


Define Documentation

#define GWEN_WAITCALLBACK_FLAGS_IMMEDIATELY   0x00000002
 

Show the progress window immediately (normally some GUIs hold back the windows until after a few seconds to avoid flickering).

#define GWEN_WAITCALLBACK_FLAGS_NO_REUSE   0x00000001
 

Normally Gwen tries to reuse already open WaitCallbacks instead of creating new ones. If this flag is given then a new WaitCallback will be created in any case.

#define GWEN_WAITCALLBACK_ID_FAST   "GWEN_WAITCALLBACK_ID_FAST"
 

Use this callback id for operations which do not need a GUI. Applications should implement this callback without opening a window.

#define GWEN_WAITCALLBACK_ID_SIMPLE_PROGRESS   "GWEN_WAITCALLBACK_ID_SIMPLE_PROGRESS"
 

This id can be used for any simple progress operation. GUI implementations for this callback might choose to show the associated text (GWEN_WaitCallback_GetText) and provide a simple progress bar.

#define GWEN_WAITCALLBACK_LEVEL_REUSED   9999
 

This depth level is used upon entering of a waitcallback which is reused (because there already is a waitcallback with the enter-id). In such a case Gwen calls the the log callback function with this level and the text given to .

#define GWEN_WAITCALLBACK_PROGRESS_NONE   ((GWEN_TYPE_UINT64)(-1))
 

This value tells the callback mechanism that there has been no progress. It is used for keep-alive calls.

#define GWEN_WAITCALLBACK_PROGRESS_ONE   ((GWEN_TYPE_UINT64)(-2))
 

This value increments the progress counter by one.


Enumeration Type Documentation

enum GWEN_WAITCALLBACK_RESULT
 

Result of GWEN_WAITCALLBACK_CHECKABORTFN.

Enumerator:
GWEN_WaitCallbackResult_Continue  tells the caller that it is ok to continue
GWEN_WaitCallbackResult_Abort  tells the caller to abort


Generated on Wed Oct 5 15:12:38 2005 for gwenhywfar by  doxygen 1.4.4