---

IKSlideshow Class Reference

Overview

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

Tasks

Getting Slideshow Data

• – indexOfCurrentSlideshowItem

Reloading Data

• – reloadData
• – reloadSlideshowItemAtIndex:

Exporting Slideshow Items

• + canExportToApplication:
• + exportSlideshowItem:toApplication:

Creating a Shared Instance of a Slideshow

• + sharedSlideshow

Running and Stopping a Slideshow

• – runSlideshowWithDataSource:inMode:options:
• – stopSlideshow:
•   autoPlayDelay  property

Properties

For more about Objective-C properties, see “Properties” in The Objective-C 2.0 Programming Language.

autoPlayDelay

Controls the interval of time before a slideshow starts to play automatically.

@property NSTimeInterval autoPlayDelay;

Availability

• Available in Mac OS X v10.5 and later.

Declared In

IKSlideshow.h

Class Methods

canExportToApplication:

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

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

YES if the slideshow can be exported to the specified application; NO otherwise.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• + exportSlideshowItem:ToApplication:

Declared In

IKSlideshow.h

exportSlideshowItem:toApplication:

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

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

Availability

• Available in Mac OS X v10.5 and later.

See Also

• + canExportToApplication:

Declared In

IKSlideshow.h

sharedSlideshow

Returns a shared instance of a slideshow.

+ (IKSlideshow *)sharedSlideshow

Return Value

A slideshow object.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

IKSlideshow.h

Instance Methods

indexOfCurrentSlideshowItem

Returns the index of the current slideshow item.

- (NSUInteger)indexOfCurrentSlideshowItem

Return Value

The index of the current item in the slideshow.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

IKSlideshow.h

reloadData

Reloads the data for a slideshow.

- (void)reloadData

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – reloadSlideshowItemAtIndex:

Declared In

IKSlideshow.h

reloadSlideshowItemAtIndex:

Reloads the data for a slideshow, starting at the specified index.

- (void)reloadSlideshowItemAtIndex:(NSUInteger)index

Parameters

index

The index that species where to reload the slideshow data.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – reloadData

Declared In

IKSlideshow.h

runSlideshowWithDataSource:inMode:options:

Runs a slideshow that contains the specified kind of items, provided from a data source.

- (void)runSlideshowWithDataSource:(id < IKSlideshowDataSource >)dataSource inMode:(NSString *)slideshowMode options:(NSDictionary *)slideshowOptions

Parameters

dataSource

The data source to use for the slideshow.

slideshowMode

A constant that indicate what kind of items are in the slideshow—IKSlideshowModeImages, IKSlideshowModePDF, or IKSlideshowModeQuickLook. See “Slideshow Modes”.

slideshowOptions

A dictionary of slideshow options. See “Slideshow Option Keys”.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

IKSlideshow.h

stopSlideshow:

Stops a slideshow.

- (void)stopSlideshow:(id)sender

Parameters

sender

The object sending the message to stop the slideshow.

Discussion

This method is invoked when the user clicks a button or issues a stop command.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

IKSlideshow.h

Constants

Bundle Identifiers

Identifiers for exporting slideshow items to an application.

NSString *const IK_iPhotoBundleIdentifier;

Constants

IK_iPhotoBundleIdentifier

The iPhoto application—com.apple.iPhoto.

Available in Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

Declared In

IKSlideshow.h

Slideshow Modes

The kind of items in the slideshow.

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

Constants

IKSlideshowModeImages

All items in the slideshow are images.

Available in Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

IKSlideshowModePDF

All items in the slideshow are PDF documents.

Available in Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

IKSlideshowModeOther

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

Available in Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

Declared In

IKSlideshow.h

Slideshow Option Keys

Keys for slideshow options.

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

Constants

IKSlideshowWrapAround

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

Available in Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

IKSlideshowStartPaused

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

Available in Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

IKSlideshowStartIndex

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

Available in Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

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 Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

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 Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

IKSlideshowPDFDisplaysAsBook

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

Available in Mac OS X v10.5 and later.

Declared in IKSlideshow.h.

Declared In

IKSlideshow.h

---