TechnologiesUI & App Frameworks

QuickLookUI

iOSmacOStvOSwatchOSvisionOS

QuickLookUI provides AppKit user interface for previewing documents and files inline on macOS, including PDF and Quick Look preview controllers. You embed a QLPreviewView to show a preview of an item conforming to QLPreviewItem directly within your window, choosing a QLPreviewViewStyle for its presentation, or present the shared QLPreviewPanel and supply content through QLPreviewPanelDataSource and QLPreviewPanelDelegate. To generate previews for your own document types, you implement a QLPreviewProvider or QLPreviewingController and return preview content using QLPreviewReply and QLPreviewReplyAttachment in response to a QLFilePreviewRequest.

Inline Previews 2

Embed a preview of a file directly within your window's view hierarchy.

  • Cl
    QLPreviewViewmacOS 10.6+
    A Quick Look preview of an item that you can embed into your view hierarchy.
  • En
    QLPreviewViewStylemacOS 10.7+
    Styles for a Preview View.

The Preview Panel 3

Present the shared full-screen Quick Look panel and supply its content.

  • Cl
    QLPreviewPanelmacOS 10.6+
    A class that implements the Quick Look preview panel to display a preview of
  • Pr
    QLPreviewPanelDataSource
    A protocol that the Quick Look preview panel uses to access the contents of
  • Pr
    QLPreviewPanelDelegate
    A protocol for the delegate of the Quick Look preview panel.

Preview Items 1

Describe the items your app makes available for previewing.

  • Pr
    QLPreviewItemmacOS 10.6+
    A protocol that defines a set of properties you implement to make a preview of your application’s content.

Generating Previews 3

Implement an extension that produces preview content for your document types.

  • Cl
    QLPreviewProvidermacOS 12.0+
    @abstract Data-based preview extensions should subclass QLPreviewProvider in their principal object. The subclass should conform to QLPreviewingController.
  • Pr
    QLPreviewingController
    A protocol for implementing a custom controller to create previews of files.
  • Cl
    QLFilePreviewRequestmacOS 12.0+
    @abstract This class contains information about the preview that should be provided.

Preview Replies 2

Return generated preview content and its associated attachments.

  • Cl
    QLPreviewReplymacOS 12.0+
    @abstract To provide a data-based preview, you have to return a QLPreviewReply object.
  • Cl
    QLPreviewReplyAttachmentmacOS 12.0+
    @abstract QLPreviewReplyAttachment is used to provide data for attachment in html data-based previews.

Type Aliases 1

  • Ty
    QLPreviewItemLoadingBlock
    A type that defines a block used to load a Quick Look preview item.

Extends 2

NSURLNSObject
← UI & App Frameworks