Up

NSImage

Authors

Adam Fedor (fedor@colorado.edu)
Load, manipulate and display images

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


Contents -

  1. Software documentation for the NSImage class
  2. Software documentation for the NSBundle(NSImageAdditions) category
  3. Software documentation for the GSImageDelegateProtocol protocol

Software documentation for the NSImage class

NSImage : NSObject

Declared in:
AppKit/NSImage.h
Conforms to:
NSCoding
NSCopying
Standards:

Description forthcoming.


Instance Variables

Method summary

_standardImageWithName: 

+ (NSImage*) _standardImageWithName: (NSString*)name;

Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.


canInitWithPasteboard: 

+ (BOOL) canInitWithPasteboard: (NSPasteboard*)pasteboard;

Description forthcoming.


imageFileTypes 

+ (NSArray*) imageFileTypes;

Description forthcoming.


imageNamed: 

+ (id) imageNamed: (NSString*)aName;

Description forthcoming.


imagePasteboardTypes 

+ (NSArray*) imagePasteboardTypes;

Description forthcoming.


imageUnfilteredFileTypes 

+ (NSArray*) imageUnfilteredFileTypes;

Description forthcoming.


imageUnfilteredPasteboardTypes 

+ (NSArray*) imageUnfilteredPasteboardTypes;

Description forthcoming.


TIFFRepresentation 

- (NSData*) TIFFRepresentation;

Description forthcoming.


TIFFRepresentationUsingCompression: factor: 

- (NSData*) TIFFRepresentationUsingCompression: (NSTIFFCompression)comp factor: (float)aFloat;

Description forthcoming.


addRepresentation: 

- (void) addRepresentation: (NSImageRep*)imageRep;

Description forthcoming.


addRepresentations: 

- (void) addRepresentations: (NSArray*)imageRepArray;

Description forthcoming.


backgroundColor 

- (NSColor*) backgroundColor;

Description forthcoming.


bestRepresentationForDevice: 

- (NSImageRep*) bestRepresentationForDevice: (NSDictionary*)deviceDescription;

Description forthcoming.


cacheDepthMatchesImageDepth 

- (BOOL) cacheDepthMatchesImageDepth;

Description forthcoming.


cacheMode 

- (NSImageCacheMode) cacheMode;

Description forthcoming.


compositeToPoint: fromRect: operation: 

- (void) compositeToPoint: (NSPoint)aPoint fromRect: (NSRect)aRect operation: (NSCompositingOperation)op;

Description forthcoming.


compositeToPoint: fromRect: operation: fraction: 

- (void) compositeToPoint: (NSPoint)aPoint fromRect: (NSRect)srcRect operation: (NSCompositingOperation)op fraction: (float)delta;

Description forthcoming.


compositeToPoint: operation: 

- (void) compositeToPoint: (NSPoint)aPoint operation: (NSCompositingOperation)op;

Description forthcoming.


compositeToPoint: operation: fraction: 

- (void) compositeToPoint: (NSPoint)aPoint operation: (NSCompositingOperation)op fraction: (float)delta;

Description forthcoming.


delegate 

- (id) delegate;

Description forthcoming.


dissolveToPoint: fraction: 

- (void) dissolveToPoint: (NSPoint)aPoint fraction: (float)aFloat;

Description forthcoming.


dissolveToPoint: fromRect: fraction: 

- (void) dissolveToPoint: (NSPoint)aPoint fromRect: (NSRect)aRect fraction: (float)aFloat;

Description forthcoming.


drawAtPoint: fromRect: operation: fraction: 

- (void) drawAtPoint: (NSPoint)point fromRect: (NSRect)srcRect operation: (NSCompositingOperation)op fraction: (float)delta;

Calls -drawAtPoint:fromRect:operation:fraction: with dstRect given by point and the size of srcRect.


drawInRect: fromRect: operation: fraction: 

- (void) drawInRect: (NSRect)dstRect fromRect: (NSRect)srcRect operation: (NSCompositingOperation)op fraction: (float)fraction;

Takes the part of the receiver given by srcRect and draws it in dstRect in the current coordinate system, transforming the image as necessary.

The image is drawn as if it was drawn to a cleared window, then dissolved using the fraction delta to another cleared window, and finally composited using op to the destination.

Note that compositing and dissolving doesn't work on all devices (printers, in particular).


drawRepresentation: inRect: 

- (BOOL) drawRepresentation: (NSImageRep*)imageRep inRect: (NSRect)aRect;

Description forthcoming.


initByReferencingFile: 

- (id) initByReferencingFile: (NSString*)fileName;

Description forthcoming.


initWithBitmapHandle: 

- (id) initWithBitmapHandle: (void*)bitmap;

Description forthcoming.


initWithContentsOfFile: 

- (id) initWithContentsOfFile: (NSString*)fileName;

Description forthcoming.


initWithContentsOfURL: 

- (id) initWithContentsOfURL: (NSURL*)anURL;

Description forthcoming.


initWithData: 

- (id) initWithData: (NSData*)data;

Description forthcoming.


initWithIconHandle: 

- (id) initWithIconHandle: (void*)icon;

Description forthcoming.


initWithPasteboard: 

- (id) initWithPasteboard: (NSPasteboard*)pasteboard;

Description forthcoming.


initWithSize: 

- (id) initWithSize: (NSSize)aSize;

Description forthcoming.


isCachedSeparately 

- (BOOL) isCachedSeparately;

Description forthcoming.


isDataRetained 

- (BOOL) isDataRetained;

Description forthcoming.


isFlipped 

- (BOOL) isFlipped;

Description forthcoming.


isValid 

- (BOOL) isValid;

Description forthcoming.


lockFocus 

- (void) lockFocus;

Description forthcoming.


lockFocusOnRepresentation: 

- (void) lockFocusOnRepresentation: (NSImageRep*)imageRep;

Description forthcoming.


matchesOnMultipleResolution 

- (BOOL) matchesOnMultipleResolution;

Description forthcoming.


name 

- (NSString*) name;

Description forthcoming.


prefersColorMatch 

- (BOOL) prefersColorMatch;

Description forthcoming.


recache 

- (void) recache;

Description forthcoming.


removeRepresentation: 

- (void) removeRepresentation: (NSImageRep*)imageRep;

Description forthcoming.


representations 

- (NSArray*) representations;

Description forthcoming.


scalesWhenResized 

- (BOOL) scalesWhenResized;

Description forthcoming.


setBackgroundColor: 

- (void) setBackgroundColor: (NSColor*)aColor;

Description forthcoming.


setCacheDepthMatchesImageDepth: 

- (void) setCacheDepthMatchesImageDepth: (BOOL)flag;

Description forthcoming.


setCacheMode: 

- (void) setCacheMode: (NSImageCacheMode)mode;

Description forthcoming.


setCachedSeparately: 

- (void) setCachedSeparately: (BOOL)flag;

Description forthcoming.


setDataRetained: 

- (void) setDataRetained: (BOOL)flag;

Description forthcoming.


setDelegate: 

- (void) setDelegate: (id)anObject;

Description forthcoming.


setFlipped: 

- (void) setFlipped: (BOOL)flag;

Description forthcoming.


setMatchesOnMultipleResolution: 

- (void) setMatchesOnMultipleResolution: (BOOL)flag;

Description forthcoming.


setName: 

- (BOOL) setName: (NSString*)aName;

Description forthcoming.


setPrefersColorMatch: 

- (void) setPrefersColorMatch: (BOOL)flag;

Description forthcoming.


setScalesWhenResized: 

- (void) setScalesWhenResized: (BOOL)flag;

Description forthcoming.


setSize: 

- (void) setSize: (NSSize)aSize;

Description forthcoming.


setUsesEPSOnResolutionMismatch: 

- (void) setUsesEPSOnResolutionMismatch: (BOOL)flag;

Description forthcoming.


size 

- (NSSize) size;

Description forthcoming.


unlockFocus 

- (void) unlockFocus;

Description forthcoming.


usesEPSOnResolutionMismatch 

- (BOOL) usesEPSOnResolutionMismatch;

Description forthcoming.




Instance Variables for NSImage Class

_cacheMode

@protected NSImageCacheMode _cacheMode;

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.


_color

@protected NSColor* _color;

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.


_delegate

@protected id _delegate;

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.


_fileName

@protected NSString* _fileName;

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.


_flags

@protected struct __imageFlags _flags;

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.


_lockedView

@protected NSView* _lockedView;

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.


_name

@protected NSString* _name;

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.


_reps

@protected NSMutableArray* _reps;

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;

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.





Software documentation for the NSBundle(NSImageAdditions) category

NSBundle(NSImageAdditions)

Declared in:
AppKit/NSImage.h
Standards:

Description forthcoming.

Method summary

pathForImageResource: 

- (NSString*) pathForImageResource: (NSString*)name;

Description forthcoming.


Software documentation for the GSImageDelegateProtocol protocol

GSImageDelegateProtocol

Declared in:
AppKit/NSImage.h
Standards:

Description forthcoming.

Method summary

imageDidNotDraw: inRect: 

- (NSImage*) imageDidNotDraw: (id)sender inRect: (NSRect)aRect;

Description forthcoming.



Up