Up

# NSImageRep

### Authors

Adam Fedor (`fedor@colorado.edu`)

> Abstract representation of an image.

Copyright: (C) 1996 Free Software Foundation, Inc.

# Software documentation for the NSImageRep class

## NSImageRep : NSObject

> Declared in:
>   AppKit/NSImageRep.h

> Conforms to:
>   NSCoding
>   NSCopying

Availability: OpenStep
Description forthcoming.

Instance Variables
Method summary

- +canInitWithData:
- +canInitWithPasteboard:
- +imageFileTypes
- +imagePasteboardTypes
- +imageRepClassForData:
- +imageRepClassForFileType:
- +imageRepClassForPasteboardType:
- +imageRepWithContentsOfFile:
- +imageRepWithContentsOfURL:
- +imageRepWithPasteboard:
- +imageRepsWithContentsOfFile:
- +imageRepsWithContentsOfURL:
- +imageRepsWithPasteboard:
- +imageUnfilteredFileTypes
- +imageUnfilteredPasteboardTypes
- +registerImageRepClass:
- +registeredImageRepClasses
- +unregisterImageRepClass:
- -bitsPerSample
- -colorSpaceName
- -draw
- -drawAtPoint:
- -drawInRect:
- -drawInRect:fromRect:operation:fraction:respectFlipped:hints:
- -hasAlpha
- -isOpaque
- -pixelsHigh
- -pixelsWide
- -setAlpha:
- -setBitsPerSample:
- -setColorSpaceName:
- -setOpaque:
- -setPixelsHigh:
- -setPixelsWide:
- -setSize:
- -size

### canInitWithData:

+ (BOOL) canInitWithData: (NSData*)data;
Availability: OpenStep
Returns `NO`. It is the subclass' responsibility to implement this method.

See Also:

- [NSBitmapImageRep +canInitWithData:]

### canInitWithPasteboard:

+ (BOOL) canInitWithPasteboard: (NSPasteboard*)pasteboard;
Availability: OpenStep
Description forthcoming.

### imageFileTypes

+ (NSArray*) imageFileTypes;
Availability: OpenStep
Returns array produced by calling -imageUnfilteredFileTypes .

### imagePasteboardTypes

+ (NSArray*) imagePasteboardTypes;
Availability: OpenStep
Description forthcoming.

### imageRepClassForData:

+ (Class) imageRepClassForData: (NSData*)data;
Availability: OpenStep
Description forthcoming.

### imageRepClassForFileType:

+ (Class) imageRepClassForFileType: (NSString*)type;
Availability: OpenStep
Description forthcoming.

### imageRepClassForPasteboardType:

+ (Class) imageRepClassForPasteboardType: (NSString*)type;
Availability: OpenStep
Description forthcoming.

### imageRepWithContentsOfFile:

+ (id) imageRepWithContentsOfFile: (NSString*)filename;
Availability: OpenStep
Returns a NSImageRep with the contents of filename.

### imageRepWithContentsOfURL:

+ (id) imageRepWithContentsOfURL: (NSURL*)anURL;
Availability: MacOS-X 10.0.0
Description forthcoming.

### imageRepWithPasteboard:

+ (id) imageRepWithPasteboard: (NSPasteboard*)pasteboard;
Availability: OpenStep
Description forthcoming.

### imageRepsWithContentsOfFile:

+ (NSArray*) imageRepsWithContentsOfFile: (NSString*)filename;
Availability: OpenStep
Returns an array of newly allocated NSImageRep objects with the contents of filename.

### imageRepsWithContentsOfURL:

+ (NSArray*) imageRepsWithContentsOfURL: (NSURL*)anURL;
Availability: MacOS-X 10.0.0
Description forthcoming.

### imageRepsWithPasteboard:

+ (NSArray*) imageRepsWithPasteboard: (NSPasteboard*)pasteboard;
Availability: OpenStep
Description forthcoming.

### imageUnfilteredFileTypes

+ (NSArray*) imageUnfilteredFileTypes;
Availability: OpenStep
Returns `nil`. It is the subclass' responsibility to implement this method.

See Also:

- [NSBitmapImageRep +imageUnfilteredFileTypes]

### imageUnfilteredPasteboardTypes

+ (NSArray*) imageUnfilteredPasteboardTypes;
Availability: OpenStep
Description forthcoming.

### registerImageRepClass:

+ (void) registerImageRepClass: (Class)imageRepClass;
Availability: OpenStep
Description forthcoming.

### registeredImageRepClasses

+ (NSArray*) registeredImageRepClasses;
Availability: OpenStep
Description forthcoming.

### unregisterImageRepClass:

+ (void) unregisterImageRepClass: (Class)imageRepClass;
Availability: OpenStep
Description forthcoming.

### bitsPerSample

- (NSInteger) bitsPerSample;
Availability: OpenStep
Returns the bits per sample of the receiver.

See Also:

- -setBitsPerSample:

### colorSpaceName

- (NSString*) colorSpaceName;
Availability: OpenStep
Description forthcoming.

### draw

- (BOOL) draw;
Availability: OpenStep
Primitive method which must be overridden by subclasses to perform their drawing. They should draw inside a rectangle with an origin at (0, 0) and a size equal to the receiver's size, and they should entirely fill this rectangle, overwriting the destination alpha as well.

### drawAtPoint:

- (BOOL) drawAtPoint: (NSPoint)aPoint;
Availability: OpenStep
Description forthcoming.

### drawInRect:

- (BOOL) drawInRect: (NSRect)aRect;
Availability: OpenStep
Description forthcoming.

### drawInRect: fromRect: operation: fraction: respectFlipped: hints:

- (BOOL) drawInRect: (NSRect)dstRect fromRect: (NSRect)srcRect operation: (NSCompositingOperation)op fraction: (CGFloat)delta respectFlipped: (BOOL)respectFlipped hints: (NSDictionary*)hints;
Availability: MacOS-X 10.6.0
Fallback implementation for subclasses which don't implement their own direct drawing TODO: explain how -draw , -drawInRect: , -drawAtPoint: clear their background

### hasAlpha

- (BOOL) hasAlpha;
Availability: OpenStep
Description forthcoming.

### isOpaque

- (BOOL) isOpaque;
Availability: OpenStep
Description forthcoming.

### pixelsHigh

- (NSInteger) pixelsHigh;
Availability: OpenStep
Description forthcoming.

### pixelsWide

- (NSInteger) pixelsWide;
Availability: OpenStep
Description forthcoming.

### setAlpha:

- (void) setAlpha: (BOOL)flag;
Availability: OpenStep
Description forthcoming.

### setBitsPerSample:

- (void) setBitsPerSample: (NSInteger)anInt;
Availability: OpenStep
Sets the number of bits for each component of a pixel.

See Also:

- -bitsPerSample

### setColorSpaceName:

- (void) setColorSpaceName: (NSString*)aString;
Availability: OpenStep
Description forthcoming.

### setOpaque:

- (void) setOpaque: (BOOL)flag;
Availability: OpenStep
Description forthcoming.

### setPixelsHigh:

- (void) setPixelsHigh: (NSInteger)anInt;
Availability: OpenStep
Description forthcoming.

### setPixelsWide:

- (void) setPixelsWide: (NSInteger)anInt;
Availability: OpenStep
Description forthcoming.

### setSize:

- (void) setSize: (NSSize)aSize;
Availability: OpenStep
Sets the size of the image to aSize.

### size

- (NSSize) size;
Availability: OpenStep
Returns the size of the image.

## Instance Variables for NSImageRep Class

### _bitsPerSample

@protected NSInteger _bitsPerSample;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _colorSpace

@protected NSString* _colorSpace;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _hasAlpha

@protected BOOL _hasAlpha;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _isOpaque

@protected BOOL _isOpaque;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _pixelsHigh

@protected NSInteger _pixelsHigh;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _pixelsWide

@protected NSInteger _pixelsWide;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _size

@protected NSSize _size;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

Up