API  0.9.7
 All Classes Files Functions Variables Macros Groups Pages
CPTimer Class Reference

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

#import <CPTimer.h>

+ Inheritance diagram for CPTimer:

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
implementation

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

Definition at line 188 of file CPTimer.j.

- (CPDate) fireDate
implementation

Returns the date at which the receiver will fire.

Definition at line 172 of file CPTimer.j.

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

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 145 of file CPTimer.j.

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

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 107 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 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 126 of file CPTimer.j.

- (void) invalidate
implementation

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

Definition at line 219 of file CPTimer.j.

- (BOOL) isValid
implementation

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

Definition at line 211 of file CPTimer.j.

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

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

Definition at line 71 of file CPTimer.j.

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

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

Definition at line 47 of file CPTimer.j.

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

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

Definition at line 59 of file CPTimer.j.

- (void) setFireDate: (CPDate aDate
implementation

Resets the receiver to fire next at a given date.

Definition at line 180 of file CPTimer.j.

- (CPTimeInterval) timeInterval
implementation

Returns the receiver’s time interval.

Definition at line 164 of file CPTimer.j.

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

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

Definition at line 99 of file CPTimer.j.

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

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

Definition at line 83 of file CPTimer.j.

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

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

Definition at line 91 of file CPTimer.j.

- (id) userInfo
implementation

Returns the receiver's userInfo object.

Definition at line 230 of file CPTimer.j.


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