CPTimer Class Reference

A timer object that can send a message after the given time interval. More...

#import <CPTimer.h>

Inheritance diagram for CPTimer:

List of all members.

Instance Methods
(void)	- fire
(CPDate)	- fireDate
(id)	- initWithFireDate:interval:callback:repeats:
(id)	- initWithFireDate:interval:invocation:repeats:
(id)	- initWithFireDate:interval:target:selector:userInfo:repeats:
(void)	- invalidate
(BOOL)	- isValid
(void)	- setFireDate:
(CPTimeInterval)	- timeInterval
(id)	- userInfo
Class Methods
(CPTimer)	+ scheduledTimerWithTimeInterval:callback:repeats:
(CPTimer)	+ scheduledTimerWithTimeInterval:invocation:repeats:
(CPTimer)	+ scheduledTimerWithTimeInterval:target:selector:userInfo:repeats:
(CPTimer)	+ timerWithTimeInterval:callback:repeats:
(CPTimer)	+ timerWithTimeInterval:invocation:repeats:
(CPTimer)	+ timerWithTimeInterval:target:selector:userInfo:repeats:

---

Detailed Description

A timer object that can send a message after the given time interval.

Definition at line 2 of file CPTimer.h.

---

Method Documentation

- (void) fire

Causes the receiver’s message to be sent to its target.

Definition at line 186 of file CPTimer.j.

- (CPDate) fireDate

Returns the date at which the receiver will fire.

Definition at line 170 of file CPTimer.j.

- (id) initWithFireDate:		(CPDate)	aDate
interval:		(CPTimeInterval)	seconds
callback:		(Function)	aFunction
repeats:		(BOOL)	shouldRepeat

Initializes a new CPTimer that, when added to a run loop, will fire at date and then, if repeats is YES, every seconds after that.

Definition at line 143 of file CPTimer.j.

- (id) initWithFireDate:		(CPDate)	aDate
interval:		(CPTimeInterval)	seconds
invocation:		(CPInvocation)	anInvocation
repeats:		(BOOL)	shouldRepeat

Initializes a new CPTimer that, when added to a run loop, will fire at date and then, if repeats is YES, every seconds after that.

Definition at line 105 of file CPTimer.j.

- (id) initWithFireDate:		(CPDate)	aDate
interval:		(CPTimeInterval)	seconds
target:		(id)	aTarget
selector:		(SEL)	aSelector
userInfo:		(id)	userInfo
repeats:		(BOOL)	shouldRepeat

Initializes a new CPTimer that, when added to a run loop, will fire at date and then, if repeats is YES, every seconds after that.

Definition at line 124 of file CPTimer.j.

- (void) invalidate

Stops the receiver from ever firing again and requests its removal from its CPRunLoop object.

Definition at line 217 of file CPTimer.j.

- (BOOL) isValid

Returns a Boolean value that indicates whether the receiver is currently valid.

Definition at line 209 of file CPTimer.j.

+ (CPTimer) scheduledTimerWithTimeInterval:		(CPTimeInterval)	seconds
callback:		(Function)	aFunction
repeats:		(BOOL)	shouldRepeat

Returns a new CPTimer object and adds it to the current CPRunLoop object in the default mode.

Definition at line 69 of file CPTimer.j.

+ (CPTimer) scheduledTimerWithTimeInterval:		(CPTimeInterval)	seconds
invocation:		(CPInvocation)	anInvocation
repeats:		(BOOL)	shouldRepeat

Returns a new CPTimer object and adds it to the current CPRunLoop object in the default mode.

Definition at line 45 of file CPTimer.j.

+ (CPTimer) scheduledTimerWithTimeInterval:		(CPTimeInterval)	seconds
target:		(id)	aTarget
selector:		(SEL)	aSelector
userInfo:		(id)	userInfo
repeats:		(BOOL)	shouldRepeat

Returns a new CPTimer object and adds it to the current CPRunLoop object in the default mode.

Definition at line 57 of file CPTimer.j.

- (void) setFireDate:

(CPDate)

aDate

Resets the receiver to fire next at a given date.

Definition at line 178 of file CPTimer.j.

- (CPTimeInterval) timeInterval

Returns the receiver’s time interval.

Definition at line 162 of file CPTimer.j.

+ (CPTimer) timerWithTimeInterval:		(CPTimeInterval)	seconds
callback:		(Function)	aFunction
repeats:		(BOOL)	shouldRepeat

Returns a new CPTimer that, when added to a run loop, will fire after seconds.

Definition at line 97 of file CPTimer.j.

+ (CPTimer) timerWithTimeInterval:		(CPTimeInterval)	seconds
invocation:		(CPInvocation)	anInvocation
repeats:		(BOOL)	shouldRepeat

Returns a new CPTimer that, when added to a run loop, will fire after seconds.

Definition at line 81 of file CPTimer.j.

+ (CPTimer) timerWithTimeInterval:		(CPTimeInterval)	seconds
target:		(id)	aTarget
selector:		(SEL)	aSelector
userInfo:		(id)	userInfo
repeats:		(BOOL)	shouldRepeat

Returns a new CPTimer that, when added to a run loop, will fire after seconds.

Definition at line 89 of file CPTimer.j.

- (id) userInfo

Returns the receiver's userInfo object.

Definition at line 228 of file CPTimer.j.

---

The documentation for this class was generated from the following files:

• Foundation/CPTimer.h
• Foundation/CPTimer.j