Main Page | Modules | Data Structures

Irmo Callback


Typedefs

typedef _IrmoCallback IrmoCallback
 Callback object.

typedef void(* IrmoCallbackCallback )(IrmoCallback *callback, void *user_data)
 Function invoked for watching callbacks.


Functions

void irmo_callback_unset (IrmoCallback *callback)
 Unset a callback watch.

IrmoCallbackirmo_callback_watch_destroy (IrmoCallback *callback, IrmoCallbackCallback func, void *user_data)
 Set a callback for when a IrmoCallback is destroyed.


Detailed Description

Various parts of the library allow callback watches to be placed on particular events. When the event occurs, the callback function will be invoked. These watches are represented by a IrmoCallback object.

Typedef Documentation

typedef struct _IrmoCallback IrmoCallback
 

Callback object.

When a new callback watch is created, an IrmoCallback object is returned representing the watch. The watch can be unset with irmo_callback_unset

typedef void(* IrmoCallbackCallback)(IrmoCallback *callback, void *user_data)
 

Function invoked for watching callbacks.

See irmo_callback_watch_destroy.


Function Documentation

void irmo_callback_unset IrmoCallback callback  ) 
 

Unset a callback watch.

Unsets a watch on a callback object.

Parameters:
callback The callback to destroy.

IrmoCallback* irmo_callback_watch_destroy IrmoCallback callback,
IrmoCallbackCallback  func,
void *  user_data
 

Set a callback for when a IrmoCallback is destroyed.

This invokes a callback when a callback object is destroyed, either from being explicitely unset or if the object it is watching is destroyed.

This is mostly useful when writing language bindings so that the language can know when to free a callback context.

Parameters:
callback The callback to watch
func Function to invoke
user_data Extra data to pass to the function.
Returns:
A new callback object representing the watch.


Generated on Tue Dec 30 04:04:46 2003 for Irmo by doxygen 1.3.4