apple.uikit.protocol

Interface UILargeContentViewerItem

All Known Implementing Classes:

ARCoachingOverlayView, ARSCNView, ARSKView, ASAuthorizationAppleIDButton, AVRoutePickerView, BCChatButton, CAInterAppAudioSwitcherView, CAInterAppAudioTransportView, CLLocationButton, CPWindow, GLKView, HKActivityRingView, HMCameraView, INUIAddVoiceShortcutButton, LPLinkView, MKAnnotationView, MKCircleView, MKCompassButton, MKMapView, MKMarkerAnnotationView, MKOverlayPathView, MKOverlayView, MKPinAnnotationView, MKPolygonView, MKPolylineView, MKScaleView, MKUserLocationView, MKUserTrackingButton, MPVolumeView, MSStickerBrowserView, MSStickerView, MTKView, PDFThumbnailView, PDFView, PHLivePhotoView, PKAddPassButton, PKCanvasView, PKPaymentButton, RPSystemBroadcastPickerView, SCNView, SKView, UIActionSheet, UIActivityIndicatorView, UIAlertView, UIButton, UICollectionReusableView, UICollectionView, UICollectionViewCell, UICollectionViewListCell, UIColorWell, UIControl, UIDatePicker, UIEventAttributionView, UIImageView, UIInputView, UILabel, UIListContentView, UINavigationBar, UIPageControl, UIPickerView, UIPopoverBackgroundView, UIProgressView, UIRefreshControl, UIScrollView, UISearchBar, UISearchTextField, UISegmentedControl, UISlider, UIStackView, UIStepper, UISwitch, UITabBar, UITableView, UITableViewCell, UITableViewHeaderFooterView, UITextField, UITextView, UIToolbar, UIView, UIVisualEffectView, UIWebView, UIWindow, WKWebView

public interface UILargeContentViewerItem

The large content viewer allow users with relevant settings to view content at a larger size. For example, users with an accessibility content size category can long press on a tab bar button to view a larger version. The viewer should not be used as a replacement for proper Dynamic Type support in general. It is intended only for use with items that must remain small due to unavoidable design constraints. For example, buttons in a tab bar remain small to leave more room for the main content.

Method Summary

Modifier and Type	Method and Description
UIImage	largeContentImage() Returns an image that should be shown in the large content viewer.
UIEdgeInsets	largeContentImageInsets() Returns insets appropriate for positioning the image in the viewer so that it appears visually centered.
java.lang.String	largeContentTitle() Returns a title that should be shown in the large content viewer.
boolean	scalesLargeContentImage() Returns whether the image should be scaled to a larger size appropriate for the viewer.
boolean	showsLargeContentViewer() Returns whether the item shows the large content viewer.

Method Detail

largeContentImage

UIImage largeContentImage()

Returns an image that should be shown in the large content viewer.

largeContentImageInsets

UIEdgeInsets largeContentImageInsets()

Returns insets appropriate for positioning the image in the viewer so that it appears visually centered.

largeContentTitle

java.lang.String largeContentTitle()

Returns a title that should be shown in the large content viewer.

scalesLargeContentImage

boolean scalesLargeContentImage()

Returns whether the image should be scaled to a larger size appropriate for the viewer. If not, the image will be shown at its intrinsic size. For best results when scaling, use a PDF asset with its "Preserve Vector Data" checkbox checked.

showsLargeContentViewer

boolean showsLargeContentViewer()

Returns whether the item shows the large content viewer. In general, only views that cannot scale for the full range of Dynamic Type sizes should return YES. For this property to take effect, the item or an ancestor view must have a UILargeContentViewerInteraction.