Instance Method

lockFocusOnRepresentation:

Prepares the specified image representation to receive drawing commands.

Declaration

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

Parameters

imageRepresentation

An image representation belonging to the receiver, or nil if you want the receiver to choose which image representation to use.

Discussion

This method sets the current drawing context to the area of the offscreen window used to cache the specified image representation's contents. Subsequent drawing commands are composited to this offscreen window. If the offscreen drawing area already has some content, any new drawing commands are composited with that content. This method does not modify the original image data directly.

If imageRepresentation is nil, this method acts like the lockFocus method, setting the focus to the best representation for the NSImage object.

A successful lockFocusOnRepresentation: message must be balanced with a matching unlockFocus message to the same NSImage object. These messages bracket the code that draws the image.

If lockFocusOnRepresentation: is unable to focus on the specified image representation, it raises an NSImageCacheException.

Special Considerations

This method is deprecated as it did not set up imageRepresentation as a drawing destination, it set the image up as a drawing destination, then drew imageRepresentation into it. You can replace this functionality with the following code fragment:

[image lockFocus];
[imageRepresentation drawInRect:NSMakeRect(0,0,[image size].width, [image size].height)];
 
[image unlockFocus];

See Also

Deprecated Symbols

+ imageFileTypes

Returns an array of strings identifying the image types supported by the registered image representation objects.

Deprecated
+ imageUnfilteredFileTypes

Returns an array of strings identifying the file types supported directly by the registered image representation objects.

Deprecated
+ imagePasteboardTypes

Returns an array of strings identifying the pasteboard types supported directly by the registered image representation objects.

Deprecated
+ imageUnfilteredPasteboardTypes

Returns an array of strings identifying the pasteboard types supported directly by the registered image representation objects.

Deprecated
- bestRepresentationForDevice:

Returns the best representation for the device with the specified characteristics.

Deprecated
- compositeToPoint:operation:

Composites the entire image to the specified point in the current coordinate system.

Deprecated
- compositeToPoint:fromRect:operation:

Composites a portion of the image to the specified point in the current coordinate system.

Deprecated
- compositeToPoint:fromRect:operation:fraction:

Composites a portion of the image at the specified opacity to the current coordinate system.

Deprecated
- compositeToPoint:operation:fraction:

Composites the entire image at the specified opacity in the current coordinate system.

Deprecated
- dissolveToPoint:fraction:

Composites the entire image to the specified location using the source-over operator.

Deprecated
- dissolveToPoint:fromRect:fraction:

Composites a portion of the image to the specified location using the source-over operator.

Deprecated
- setScalesWhenResized:

Sets whether to scale different-sized image representations to fit the image's size.

Deprecated
- scalesWhenResized

Returns a Boolean value indicating whether to scale image representations to fit the image's size.

Deprecated
- setDataRetained:

Sets whether the receiver retains its source image data.

Deprecated
- isDataRetained

Returns a Boolean value indicating whether the receiver retains its source image data.

Deprecated
- setCachedSeparately:

Sets whether each image representation uses a separate offscreen window to cache its contents.

Deprecated
- isCachedSeparately

Returns a Boolean value indicating whether each image representation caches its contents in a separate offscreen window.

Deprecated
- setCacheDepthMatchesImageDepth:

Sets whether the receiver's offscreen window caches use the same bit depth as the image data itself.

Deprecated
- cacheDepthMatchesImageDepth

Returns a Boolean value indicating whether an image's offscreen window caches use the same bit depth as the image data itself.

Deprecated
- setFlipped:

Sets whether the polarity of the y axis is inverted when drawing an image.

Deprecated
- isFlipped

Returns a Boolean value indicating whether the image uses a flipped coordinate system.

Deprecated