CPTimer Class Reference
[Foundation]

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

List of all members.

Public Member Functions

(void) - fire [implementation]
(CPDate- fireDate [implementation]
(id) - initWithFireDate:interval:callback:repeats: [implementation]
(id) - initWithFireDate:interval:invocation:repeats: [implementation]
(id) - initWithFireDate:interval:target:selector:userInfo:repeats: [implementation]
(void) - invalidate [implementation]
(BOOL) - isValid [implementation]
(void) - setFireDate: [implementation]
(CPTimeInterval) - timeInterval [implementation]
(id) - userInfo [implementation]

Static Public Member Functions

(CPTimer+ scheduledTimerWithTimeInterval:callback:repeats: [implementation]
(CPTimer+ scheduledTimerWithTimeInterval:invocation:repeats: [implementation]
(CPTimer+ scheduledTimerWithTimeInterval:target:selector:userInfo:repeats: [implementation]
(CPTimer+ timerWithTimeInterval:callback:repeats: [implementation]
(CPTimer+ timerWithTimeInterval:invocation:repeats: [implementation]
(CPTimer+ timerWithTimeInterval:target:selector:userInfo:repeats: [implementation]

Detailed Description

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

Definition at line 34 of file CPTimer.j.


Member Function Documentation

- (void) fire   [implementation]

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

Definition at line 193 of file CPTimer.j.

- (CPDate) fireDate   [implementation]

Returns the date at which the receiver will fire.

Definition at line 177 of file CPTimer.j.

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

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

Definition at line 150 of file CPTimer.j.

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

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

Definition at line 112 of file CPTimer.j.

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

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

Definition at line 131 of file CPTimer.j.

- (void) invalidate   [implementation]

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

Definition at line 224 of file CPTimer.j.

- (BOOL) isValid   [implementation]

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

Definition at line 216 of file CPTimer.j.

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

Returns a new NSTimer object and adds it to the current NSRunLoop object in the default mode.

Definition at line 75 of file CPTimer.j.

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

Returns a new NSTimer object and adds it to the current NSRunLoop object in the default mode.

Definition at line 49 of file CPTimer.j.

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

Returns a new NSTimer object and adds it to the current NSRunLoop object in the default mode.

Definition at line 62 of file CPTimer.j.

- (void) setFireDate: (CPDate aDate   [implementation]

Resets the receiver to fire next at a given date.

Definition at line 185 of file CPTimer.j.

- (CPTimeInterval) timeInterval   [implementation]

Returns the receiver’s time interval.

Definition at line 169 of file CPTimer.j.

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

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

Definition at line 104 of file CPTimer.j.

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

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

Definition at line 88 of file CPTimer.j.

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

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

Definition at line 96 of file CPTimer.j.

- (id) userInfo   [implementation]

Returns the receiver's userInfo object.

Definition at line 235 of file CPTimer.j.


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

Generated on Fri Apr 9 11:04:22 2010 for Cappuccino API by  doxygen 1.6.1