Mac Developer Library

Developer

IKSlideshow Class Reference

Options
Deployment Target:

On This Page
Language:

IKSlideshow

The IKSlideshow class encapsulates a data source and options for a slideshow.

  • Returns a shared instance of a slideshow.

    Declaration

    + (IKSlideshow *)sharedSlideshow

    Return Value

    A slideshow object.

  • Finds out whether the slideshow can export its contents to an application.

    Declaration

    + (BOOL)canExportToApplication:(NSString *)applicationBundleIdentifier

    Parameters

    applicationBundleIdentifier

    The bundle identifier of the application that you want to export the slideshow to. See “Bundle Identifiers”.

    Return Value

    YEStrue if the slideshow can be exported to the specified application; NOfalse otherwise.

  • Exports a slideshow item to the application that has the provided bundle identifier.

    Declaration

    + (void)exportSlideshowItem:(id)item toApplication:(NSString *)applicationBundleIdentifier

    Parameters

    item

    The item to export

    applicationBundleIdentifier

    The bundle identifier of the application that you want to export the item to.

  • Identifiers for exporting slideshow items to an application.

    Declaration

    NSString *const IK_iPhotoBundleIdentifier; NSString *const IK_ApertureBundleIdentifier; NSString *const IK_MailBundleIdentifier;

    Constants

    • IK_iPhotoBundleIdentifier

      The iPhoto application—com.apple.iPhoto.

    • IK_ApertureBundleIdentifier

      The Aperature application—com.apple.Aperture.

    • IK_MailBundleIdentifier

      The Mail application—com.apple.mail.

  • The kind of items in the slideshow.

    Declaration

    NSString *const IKSlideshowModeImages; NSString *const IKSlideshowModePDF; NSString *const IKSlideshowModeOther;

    Constants

    • IKSlideshowModeImages

      All items in the slideshow are images.

    • IKSlideshowModePDF

      All items in the slideshow are PDF documents.

    • IKSlideshowModeOther

      There are a mixture of items in the slideshow (image, PDF, text, HTML, and so on).

  • Keys for slideshow options.

    Declaration

    NSString *const IKSlideshowWrapAround; NSString *const IKSlideshowStartPaused; NSString *const IKSlideshowStartIndex; NSString *const IKSlideshowPDFDisplayBox; NSString *const IKSlideshowPDFDisplayMode; NSString *const IKSlideshowPDFDisplaysAsBook; NSString *const IKSlideshowScreen; NSString *const IKSlideshowAudioFile;

    Constants

    • IKSlideshowWrapAround

      A key for starting the slideshow over after the last slide shows. The associated value is a Boolean data type.

    • IKSlideshowStartPaused

      A key for starting in a paused state. The associated value is a Boolean data type.

    • IKSlideshowStartIndex

      A key for the slideshow item index. The associated value is an index.

    • IKSlideshowPDFDisplayBox

      A key for the PDF display box. The associated value is a type of display box, such as kPDFDisplayBoxMediaBox or kPDFDisplayBoxMediaBox. See PDFPage Class Reference for more information.

    • IKSlideshowPDFDisplayMode

      A key for the PDF display mode. The associated value is a PDF display mode constant, such as kPDFDisplaySinglePage or kPDFDisplayTwoUp. See PDFView Class Reference for more information.

    • IKSlideshowPDFDisplaysAsBook

      A key for displaying the slideshow as a book. The associated value is a Boolean data type.

    • IKSlideshowScreen

      A key specifying the screen on which the slideshow is displayed. The associated value is an NSScreen object. By default mainScreen is used.

    • IKSlideshowAudioFile

      A key specifying the audio file played during the slideshow. The associated value is an NSURL object.