QLPreviewItem Protocol Reference for Mac

Conforms to
Availability
Available in OS X v10.6 and later.
Companion guide
Declared in
QLPreviewItem.h

Overview

The QLPreviewItem protocol declares the methods that the Quick Look preview panel (QLPreviewPanel) uses to access the contents of a given item.

Tasks

Providing the Preview Item URL

Providing Display Information for the Preview Item

Properties

previewItemDisplayState

The display state for the preview item. This property is optional.

@property (readonly) id previewItemDisplayState;
Discussion

The display state is an opaque object used by the preview panel. You typically use the QLPreviewPanel method displayState to retrieve the display state which you save for later use in the preview item. This way you can preserve the display state when the panel moves from/to an other controller.

Availability
  • Available in OS X v10.6 and later.
See Also
Declared In
QLPreviewItem.h

previewItemTitle

The preview item's title. This property is optional.

@property (readonly) NSString *previewItemTitle;
Discussion

If set, this value used as the apparent item title instead of the default item display name.

Availability
  • Available in OS X v10.6 and later.
Declared In
QLPreviewItem.h

previewItemURL

The URL of the item to preview. (required)

@property (readonly) NSURL *previewItemURL;
Discussion

The URL must be a file URL.

The accessor method should return nil if the item is not available for preview (the preview panel will display the “Loading” view).

Availability
  • Available in OS X v10.6 and later.
Declared In
QLPreviewItem.h