IKPictureTaker Class Reference

Inherits from
Conforms to
Framework
System/Library/Frameworks/Quartz.framework/ImageKit.framework
Availability
Available in OS X v10.5 and later.
Declared in
IKPictureTaker.h
ImageKitDeprecated.h
Related sample code

Overview

The IKPictureTaker class represents a panel that allows users to choose images by browsing the file system. The picture taker panel provides an Open Recent menu, supports image cropping, and supports taking snapshots from an iSight or other digital camera.

Tasks

Creating And Displaying The Picture Taker

Getting and Setting Images

Getting and Setting Mirroring

Class Methods

pictureTaker

Returns a shared IKPictureTaker instance, creating it if necessary.

+ (IKPictureTaker *)pictureTaker
Return Value

An IKPictureTaker object.

Availability
  • Available in OS X v10.5 and later.
Related Sample Code
Declared In
IKPictureTaker.h

Instance Methods

beginPictureTakerSheetForWindow:withDelegate:didEndSelector:contextInfo:

Opens a picture taker as a sheet whose parent is the specified window.

- (void)beginPictureTakerSheetForWindow:(NSWindow *)aWindow withDelegate:(id)delegate didEndSelector:(SEL)didEndSelector contextInfo:(void *)contextInfo
Parameters
aWindow

The parent window of the picture taker sheet.

delegate

The object that will invoke the selector didEndSelector when the picture taker session terminates.

didEndSelector

The selector to invoke when the picture taker session terminates.

contextInfo

Any data that must be passed as an argument to the delegate through didEndSelector after the picture taker session terminates.

Discussion

The didEndSelector method should have the following signature:

- (void)pictureTakerDidEnd:(IKPictureTaker *)sheet returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo;

The returnCode value is set to NSOKButton if the user validates, or to NSCancelButton if the user cancels.

Availability
  • Available in OS X v10.5 and later.
Declared In
IKPictureTaker.h

beginPictureTakerWithDelegate:didEndSelector:contextInfo:

Opens a picture taker pane.

- (void)beginPictureTakerWithDelegate:(id)delegate didEndSelector:(SEL)didEndSelector contextInfo:(void *)contextInfo
Parameters
delegate

The object that will invoke the selector didEndSelector when the picture taker session terminates.

didEndSelector

The selector to invoke when the picture taker session terminates.

contextInfo

Any data that must be passed as an argument to the delegate through didEndSelector after the picture taker session terminates.

Discussion

The didEndSelector method should have the following signature:

- (void)pictureTakerDidEnd:(IKPictureTaker *)sheet returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo;

The returnCode value is set to NSOKButton if the user validates, or to NSCancelButton if the user cancels.

Availability
  • Available in OS X v10.5 and later.
Related Sample Code
Declared In
IKPictureTaker.h

inputImage

Returns the input image associated with the picture taker.

- (NSImage *)inputImage
Return Value

The input image.

Discussion

The input image is never modified by the picture taker.

Availability
  • Available in OS X v10.5 and later.
Declared In
IKPictureTaker.h

mirroring

Returns whether video mirroring is enabled during snapshots.

- (BOOL)mirroring
Return Value

Returns YES if video mirroring is enabled, NO otherwise.

Availability
  • Available in OS X v10.5 and later.
Declared In
IKPictureTaker.h

outputImage

Returns the edited image.

- (NSImage *)outputImage
Return Value

The edited image.

Availability
  • Available in OS X v10.5 and later.
Related Sample Code
Declared In
IKPictureTaker.h

popUpRecentsMenuForView:withDelegate:didEndSelector:contextInfo:

Displays the Open Recent popup menu associated with the picture taker.

- (void)popUpRecentsMenuForView:(NSView *)aView withDelegate:(id)delegate didEndSelector:(SEL)didEndSelector contextInfo:(void *)contextInfo
Parameters
delegate

The object that will invoke the selector didEndSelector when the picture taker session terminates.

didEndSelector

The selector to invoke when the picture taker session terminates.

contextInfo

Any data that must be passed as an argument to the delegate through didEndSelector after the picture taker session terminates.

Discussion

The didEndSelector method should have the following signature:

- (void)pictureTakerDidEnd:(IKPictureTaker *)sheet returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo;

The returnCode value is set to NSOKButton if the user validates, or to NSCancelButton if the user cancels.

Availability
  • Available in OS X v10.5 and later.
Declared In
IKPictureTaker.h

runModal

Opens a modal picture taker dialog.

- (NSInteger)runModal
Return Value

Returns NSOKButton if the user edits or chooses an image; NSCancelButton if the user cancels or does not change the default image.

Availability
  • Available in OS X v10.5 and later.
Declared In
IKPictureTaker.h

setInputImage:

Set the image input for the picture taker.

- (void)setInputImage:(NSImage *)image
Parameters
image

An NSImage object.

Discussion

The input image is never modified by the picture taker.

Availability
  • Available in OS X v10.5 and later.
Related Sample Code
Declared In
IKPictureTaker.h

setMirroring:

Controls whether the receiver enables video mirroring during snapshots.

- (void)setMirroring:(BOOL)b
Parameters
b

The default setting is YES.

Availability
  • Available in OS X v10.5 and later.
Declared In
IKPictureTaker.h

Constants

Picture Taker Keys

Keys for customizing the picture taker appearance and behavior. These values are set by sending the picture taker instance setValue:forKey.

NSString *const IKPictureTakerAllowsVideoCaptureKey;
NSString *const IKPictureTakerAllowsFileChoosingKey;
NSString *const IKPictureTakerShowRecentPictureKey;
NSString *const IKPictureTakerUpdateRecentPictureKey;
NSString *const IKPictureTakerAllowsEditingKey;
NSString *const IKPictureTakerShowEffectsKey;
NSString *const IKPictureTakerInformationalTextKey;
NSString *const IKPictureTakerImageTransformsKey;
NSString *const IKPictureTakerOutputImageMaxSizeKey;
NSString *const IKPictureTakerCropAreaSizeKey;
NSString *const IKPictureTakerShowAddressBookPictureKey;
NSString *const IKPictureTakerShowEmptyPictureKey;
NSString *const IKPictureTakerRemainOpenAfterValidateKey;
Constants
IKPictureTakerAllowsVideoCaptureKey

A key for allowing video capture. The associated value is an NSNumber value (BOOL) whose default value is YES.

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerAllowsFileChoosingKey

A key for allowing the user to choose a file. The associated value is an NSNumber object that contains a BOOL value whose default value is YES.

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerUpdateRecentPictureKey

A key for allowing a recent picture to be updated. The associated value is an NSNumber object that contains a BOOL value whose default value is YES.

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerAllowsEditingKey

A key for allowing image editing. The associated value is an NSNumber object that contains a BOOL value whose default value is YES.

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerShowEffectsKey

A key for showing effects. The associated value is an NSNumber object that contains a BOOL value whose default value is NO.

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerInformationalTextKey

A key for informational text. The associated value is an NSString or NSAttributedString object whose default value is "Drag Image Here".

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerImageTransformsKey

A n image transformation key. The associated value is an NSDictionary object that can be serialized.

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerOutputImageMaxSizeKey

A key for the maximum size of the output image. The associated value is an NSValue object (NSSize).

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerCropAreaSizeKey

A key for the cropping area size. The associated value is an NSValue object (NSSize).

Available in OS X v10.5 and later.

Deprecated in OS X v10.8.

Declared in ImageKitDeprecated.h.

IKPictureTakerShowAddressBookPictureKey

A key for showing the address book picture. The associated value is a Boolean value packages as an NSNumber object. The default value is NO. If set to YES, the picture taker automatically adds the address book image for the Me user at the end of the Recent Pictures pop-up menu.

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerShowEmptyPictureKey

A key for showing an empty picture. The associated value is an NSImage object. The default value is nil. If set to an image, the picture taker automatically shows an image at the end of the Recent Pictures pop-up menu. that means "no picture."

Available in OS X v10.5 and later.

Declared in IKPictureTaker.h.

IKPictureTakerRemainOpenAfterValidateKey

A key that determines if the picture taker should remain open after the user selects done. This allows the application to programmatically dismiss the panel. The associated value is an NSNumber object that contains a BOOL value whose default value is NO

Available in OS X v10.6 and later.

Declared in IKPictureTaker.h.