Mac Developer Library

Developer

IKPictureTaker Class Reference

Options
Deployment Target:

On This Page
Language:

IKPictureTaker

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.

  • Returns a shared IKPictureTaker instance, creating it if necessary.

    Declaration

    + (IKPictureTaker *)pictureTaker

    Return Value

    An IKPictureTaker object.

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

    Declaration

    - (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.

  • Opens a picture taker pane.

    Declaration

    - (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.

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

    Declaration

    - (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.

  • Opens a modal picture taker dialog.

    Declaration

    - (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.

  • Set the image input for the picture taker.

    Declaration

    - (void)setInputImage:(NSImage *)image

    Parameters

    image

    An NSImage object.

    Discussion

    The input image is never modified by the picture taker.

    See Also

    – inputImage

  • Returns the input image associated with the picture taker.

    Declaration

    - (NSImage *)inputImage

    Return Value

    The input image.

    Discussion

    The input image is never modified by the picture taker.

  • Returns the edited image.

    Declaration

    - (NSImage *)outputImage

    Return Value

    The edited image.

  • Controls whether the receiver enables video mirroring during snapshots.

    Declaration

    - (void)setMirroring:(BOOL)b

    Parameters

    b

    The default setting is YEStrue.

  • Returns whether video mirroring is enabled during snapshots.

    Declaration

    - (BOOL)mirroring

    Return Value

    Returns YES if video mirroring is enabled, NO otherwise.

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

    Declaration

    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 YEStrue.

    • 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 YEStrue.

    • 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 YEStrue.

    • IKPictureTakerAllowsEditingKey

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

    • IKPictureTakerShowEffectsKey

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

    • IKPictureTakerInformationalTextKey

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

    • IKPictureTakerImageTransformsKey

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

    • IKPictureTakerOutputImageMaxSizeKey

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

    • IKPictureTakerCropAreaSizeKey

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

    • 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 NOfalse. 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.

    • 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."

    • 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 NOfalse