Mac Developer Library

Developer

Quartz Framework Reference IKSlideshow Class Reference

Options
Deployment Target:

On This Page
Language:

IKSlideshow

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

Inheritance


Conforms To


Import Statement


import Quartz @import Quartz;

Availability


Available in OS X v10.5 and later.
  • Returns a shared instance of a slideshow.

    Declaration

    Swift

    class func sharedSlideshow() -> IKSlideshow!

    Objective-C

    + (IKSlideshow *)sharedSlideshow

    Return Value

    A slideshow object.

    Import Statement

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Returns the index of the current slideshow item.

    Declaration

    Swift

    func indexOfCurrentSlideshowItem() -> Int

    Objective-C

    - (NSUInteger)indexOfCurrentSlideshowItem

    Return Value

    The index of the current item in the slideshow.

    Import Statement

    import Quartz

    Availability

    Available in OS X v10.5 and later.

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

    Declaration

    Swift

    class func canExportToApplication(_ applicationBundleIdentifier: String!) -> Bool

    Objective-C

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

    Import Statement

    import Quartz

    Availability

    Available in OS X v10.5 and later.

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

    Declaration

    Swift

    class func exportSlideshowItem(_ item: AnyObject!, toApplication applicationBundleIdentifier: String!)

    Objective-C

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

    Import Statement

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Identifiers for exporting slideshow items to an application.

    Declaration

    Swift

    let IK_iPhotoBundleIdentifier: NSString! let IK_ApertureBundleIdentifier: NSString! let IK_MailBundleIdentifier: NSString!

    Objective-C

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

    Constants

    • IK_iPhotoBundleIdentifier

      IK_iPhotoBundleIdentifier

      The iPhoto application—com.apple.iPhoto.

      Available in OS X v10.5 and later.

    • IK_ApertureBundleIdentifier

      IK_ApertureBundleIdentifier

      The Aperature application—com.apple.Aperture.

      Available in OS X v10.6 and later.

    • IK_MailBundleIdentifier

      IK_MailBundleIdentifier

      The Mail application—com.apple.mail.

      Available in OS X v10.6 and later.

    Import Statement

  • The kind of items in the slideshow.

    Declaration

    Swift

    let IKSlideshowModeImages: NSString! let IKSlideshowModePDF: NSString! let IKSlideshowModeOther: NSString!

    Objective-C

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

    Constants

    • IKSlideshowModeImages

      IKSlideshowModeImages

      All items in the slideshow are images.

      Available in OS X v10.5 and later.

    • IKSlideshowModePDF

      IKSlideshowModePDF

      All items in the slideshow are PDF documents.

      Available in OS X v10.5 and later.

    • IKSlideshowModeOther

      IKSlideshowModeOther

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

      Available in OS X v10.5 and later.

    Import Statement

  • Keys for slideshow options.

    Declaration

    Swift

    let IKSlideshowWrapAround: NSString! let IKSlideshowStartPaused: NSString! let IKSlideshowStartIndex: NSString! let IKSlideshowPDFDisplayBox: NSString! let IKSlideshowPDFDisplayMode: NSString! let IKSlideshowPDFDisplaysAsBook: NSString! let IKSlideshowScreen: NSString! let IKSlideshowAudioFile: NSString!

    Objective-C

    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

      IKSlideshowWrapAround

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

      Available in OS X v10.5 and later.

    • IKSlideshowStartPaused

      IKSlideshowStartPaused

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

      Available in OS X v10.5 and later.

    • IKSlideshowStartIndex

      IKSlideshowStartIndex

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

      Available in OS X v10.5 and later.

    • IKSlideshowPDFDisplayBox

      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.

      Available in OS X v10.5 and later.

    • IKSlideshowPDFDisplayMode

      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.

      Available in OS X v10.5 and later.

    • IKSlideshowPDFDisplaysAsBook

      IKSlideshowPDFDisplaysAsBook

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

      Available in OS X v10.5 and later.

    • IKSlideshowScreen

      IKSlideshowScreen

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

      Available in OS X v10.6 and later.

    • IKSlideshowAudioFile

      IKSlideshowAudioFile

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

      Available in OS X v10.6 and later.

    Import Statement