DESIGN (xvwidgets) functions


LIBRARY ROUTINE

xvw_add_timeout - add a timeout to an object

LIBRARY CALL

void xvw_add_timeout(
   xvobject   object,
   double     interval,
   void     (*routine)(xvobject, kaddr, int *),
   kaddr      client_data)

INPUT

OUTPUT

none

RETURN VALUE

none

DESCRIPTION

Adds a timeout to a GUI or visual object. After the specified interval of time has elapsed, the timeout will be called. Since the X Toolkit cannot support timeouts on gadgets, we support them by placing the timeout on the parent and then directing the dispatch of the timeout directly.

The timeout can be associated with an object, so that it will be automatically removed when the object is destroyed. If NULL is passed for the object, then the timeout is added to the global file detection list.

An timeout must be declared in the following form: void timeout( xvobject object, kaddr client_data, int *stop_timer)

object - If xvw_add_timeout() is called with a particular xvobject, that object will be passed into the timeout.

client_data - The pointer to the client data, used to pass parameters from the application to the timeout.

stop_timer - By default, the timeout will be invoked again after the specified time interval passes once more. To stop the timeout from being called after the next time interval is up, set the stop_timer to TRUE, as in: *stop_timer = TRUE;

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

none

FILES

$DESIGN/objects/library/xvwidgets/src/timeout.c

SEE ALSO

xvwidgets(3)

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.