on-timer

Generic Function

Package: common-graphics

Arguments: timer

This function returns the value of the on-timer event property of the argument timer. The value should be a function object or a function name (a symbol naming a function). The function is invoked after timer's interval has elapsed (assuming that the default timer method has not been overridden). The function should take a single argument, which is the timer itself. Its returned values are not used. The default value is nil, and so a timer will not do anything when its interval has elapsed unless it is given a custom on-timer function (or a timer method is added for it).

An on-timer function can be specified with the :on-timer intitarg when creating a timer instance with make-instance and setf can be used with on-timer to set or change the on-timer function of a timer.

See About the Common Graphics timer facility in cgide.htm. See also About event handling in the IDE in that document.

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Copyright (c) 1998-2000, Franz Inc. Berkeley, CA., USA. All rights reserved.

Created 2000.10.5.