CPImage Class Reference
[AppKit]

List of all members.

Public Member Functions

(id) - delegate [implementation]
(void) - encodeWithCoder: [implementation]
(CPString- filename [implementation]
(id) - init [implementation]
(id) - initByReferencingFile:size: [implementation]
(id) - initWithCoder: [implementation]
(id) - initWithContentsOfFile: [implementation]
(id) - initWithContentsOfFile:size: [implementation]
(BOOL) - isNinePartImage [implementation]
(BOOL) - isThreePartImage [implementation]
(void) - load [implementation]
(unsigned) - loadStatus [implementation]
(CPString- name [implementation]
(void) - setDelegate: [implementation]
(void) - setName: [implementation]
(void) - setSize: [implementation]
(CGSize) - size [implementation]

Static Public Member Functions

(id) + imageNamed: [implementation]

Detailed Description

CPImage is used to represent images in the Cappuccino framework. It supports loading all image types supported by the browser.

Delegate Methods

-(void)imageDidLoad:(CPImage)image; Called when the specified image has finished loading.

Parameters:
image the image that loaded

-(void)imageDidError:(CPImage)image; Called when the specified image had an error loading.

Parameters:
image the image with the loading error

-(void)imageDidAbort:(CPImage)image; Called when the image loading was aborted.

Parameters:
image the image that was aborted

Definition at line 91 of file CPImage.j.


Member Function Documentation

- (id) delegate   [implementation]

Returns the receiver's delegate

Definition at line 238 of file CPImage.j.

- (void) encodeWithCoder: (CPCoder aCoder   [implementation]

Writes the image data from memory into the coder.

Parameters:
aCoder the coder to which the data will be written

Definition at line 385 of file CPImage.j.

- (CPString) filename   [implementation]

Returns the path of the file associated with this image.

Definition at line 165 of file CPImage.j.

+ (id) imageNamed: (CPString aName   [implementation]

Definition at line 187 of file CPImage.j.

- (id) init   [implementation]

Definition at line 103 of file CPImage.j.

- (id) initByReferencingFile: (CPString aFilename
size: (CGSize)  aSize 
[implementation]

Initializes the image, by associating it with a filename. The image denoted in aFilename is not actually loaded. It will be loaded once needed.

Parameters:
aFilename the file containing the image
aSize the image's size
Returns:
the initialized image

Definition at line 116 of file CPImage.j.

- (id) initWithCoder: (CPCoder aCoder   [implementation]

Initializes the image with data from a coder.

Parameters:
aCoder the coder from which to read the image data
Returns:
the initialized image

Definition at line 376 of file CPImage.j.

- (id) initWithContentsOfFile: (CPString aFilename   [implementation]

Initializes the receiver with the contents of the specified image file. The method loads the data into memory.

Parameters:
aFilename the file name of the image
Returns:
the initialized image

Definition at line 152 of file CPImage.j.

- (id) initWithContentsOfFile: (CPString aFilename
size: (CGSize)  aSize 
[implementation]

Initializes the image. Loads the specified image into memory.

Parameters:
aFilename the image to load
aSize the size of the image
Returns:
the initialized image.

Definition at line 136 of file CPImage.j.

- (BOOL) isNinePartImage   [implementation]

Definition at line 319 of file CPImage.j.

- (BOOL) isThreePartImage   [implementation]

Definition at line 314 of file CPImage.j.

- (void) load   [implementation]

Loads the image data from the file into memory. You should not call this method directly. Instead use one of the initializers.

Definition at line 257 of file CPImage.j.

- (unsigned) loadStatus   [implementation]

Returns the load status, which will be CPImageLoadStatusCompleted if the image data has already been loaded.

Definition at line 246 of file CPImage.j.

- (CPString) name   [implementation]

Definition at line 221 of file CPImage.j.

- (void) setDelegate: (id)  aDelegate   [implementation]

Sets the receiver's delegate.

Parameters:
the delegate

Definition at line 230 of file CPImage.j.

- (void) setName: (CPString aName   [implementation]

Definition at line 208 of file CPImage.j.

- (void) setSize: (CGSize)  aSize   [implementation]

Sets the size of the image.

Parameters:
the size of the image

Definition at line 174 of file CPImage.j.

- (CGSize) size   [implementation]

Returns the size of the image

Definition at line 182 of file CPImage.j.


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

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