apple.uikit.protocol

Interface UISplitViewControllerDelegate

public interface UISplitViewControllerDelegate

Method Summary

Modifier and Type	Method and Description
default UIViewController	primaryViewControllerForCollapsingSplitViewController(UISplitViewController splitViewController) Return the view controller which is to become the primary view controller after `splitViewController` is collapsed due to a transition to the horizontally-compact size class.
default UIViewController	primaryViewControllerForExpandingSplitViewController(UISplitViewController splitViewController) Return the view controller which is to become the primary view controller after the `splitViewController` is expanded due to a transition to the horizontally-regular size class.
default boolean	splitViewControllerCollapseSecondaryViewControllerOntoPrimaryViewController(UISplitViewController splitViewController, UIViewController secondaryViewController, UIViewController primaryViewController) This method is called when a split view controller is collapsing its children for a transition to a compact-width size class.
default void	splitViewControllerDidCollapse(UISplitViewController svc)
default void	splitViewControllerDidExpand(UISplitViewController svc)
default long	splitViewControllerDisplayModeForExpandingToProposedDisplayMode(UISplitViewController svc, long proposedDisplayMode)
default void	splitViewControllerInteractivePresentationGestureDidEnd(UISplitViewController svc)
default void	splitViewControllerInteractivePresentationGestureWillBegin(UISplitViewController svc)
default void	splitViewControllerPopoverControllerWillPresentViewController(UISplitViewController svc, UIPopoverController pc, UIViewController aViewController) Deprecated.
default long	splitViewControllerPreferredInterfaceOrientationForPresentation(UISplitViewController splitViewController)
default UIViewController	splitViewControllerSeparateSecondaryViewControllerFromPrimaryViewController(UISplitViewController splitViewController, UIViewController primaryViewController) This method is called when a split view controller is separating its child into two children for a transition from a compact-width size class to a regular-width size class.
default boolean	splitViewControllerShouldHideViewControllerInOrientation(UISplitViewController svc, UIViewController vc, long orientation) Deprecated.
default boolean	splitViewControllerShowDetailViewControllerSender(UISplitViewController splitViewController, UIViewController vc, java.lang.Object sender) Override this method to customize the behavior of `showDetailViewController:` on a split view controller.
default boolean	splitViewControllerShowViewControllerSender(UISplitViewController splitViewController, UIViewController vc, java.lang.Object sender) Override this method to customize the behavior of `showViewController:` on a split view controller.
default long	splitViewControllerSupportedInterfaceOrientations(UISplitViewController splitViewController)
default long	splitViewControllerTopColumnForCollapsingToProposedTopColumn(UISplitViewController svc, long proposedTopColumn)
default void	splitViewControllerWillChangeToDisplayMode(UISplitViewController svc, long displayMode) This method allows a client to update any bar button items etc.
default void	splitViewControllerWillHideColumn(UISplitViewController svc, long column)
default void	splitViewControllerWillHideViewControllerWithBarButtonItemForPopoverController(UISplitViewController svc, UIViewController aViewController, UIBarButtonItem barButtonItem, UIPopoverController pc) Deprecated.
default void	splitViewControllerWillShowColumn(UISplitViewController svc, long column)
default void	splitViewControllerWillShowViewControllerInvalidatingBarButtonItem(UISplitViewController svc, UIViewController aViewController, UIBarButtonItem barButtonItem) Deprecated.
default long	targetDisplayModeForActionInSplitViewController(UISplitViewController svc) Called by the gesture AND barButtonItem to determine what they will set the display mode to (and what the displayModeButtonItem's appearance will be.) Return UISplitViewControllerDisplayModeAutomatic to get the default behavior.

Method Detail

primaryViewControllerForCollapsingSplitViewController

default UIViewController primaryViewControllerForCollapsingSplitViewController(UISplitViewController splitViewController)

Return the view controller which is to become the primary view controller after `splitViewController` is collapsed due to a transition to the horizontally-compact size class. If you return `nil`, then the argument will perform its default behavior (i.e. to use its current primary view controller).

primaryViewControllerForExpandingSplitViewController

default UIViewController primaryViewControllerForExpandingSplitViewController(UISplitViewController splitViewController)

Return the view controller which is to become the primary view controller after the `splitViewController` is expanded due to a transition to the horizontally-regular size class. If you return `nil`, then the argument will perform its default behavior (i.e. to use its current primary view controller.)

splitViewControllerCollapseSecondaryViewControllerOntoPrimaryViewController

default boolean splitViewControllerCollapseSecondaryViewControllerOntoPrimaryViewController(UISplitViewController splitViewController,
                                                                                            UIViewController secondaryViewController,
                                                                                            UIViewController primaryViewController)

This method is called when a split view controller is collapsing its children for a transition to a compact-width size class. Override this method to perform custom adjustments to the view controller hierarchy of the target controller. When you return from this method, you're expected to have modified the `primaryViewController` so as to be suitable for display in a compact-width split view controller, potentially using `secondaryViewController` to do so. Return YES to prevent UIKit from applying its default behavior; return NO to request that UIKit perform its default collapsing behavior.

splitViewControllerPopoverControllerWillPresentViewController

@Deprecated
default void splitViewControllerPopoverControllerWillPresentViewController(UISplitViewController svc,
                                                                                       UIPopoverController pc,
                                                                                       UIViewController aViewController)

Deprecated.

Called when the view controller is shown in a popover so the delegate can take action like hiding other popovers.

splitViewControllerSeparateSecondaryViewControllerFromPrimaryViewController

default UIViewController splitViewControllerSeparateSecondaryViewControllerFromPrimaryViewController(UISplitViewController splitViewController,
                                                                                                     UIViewController primaryViewController)

This method is called when a split view controller is separating its child into two children for a transition from a compact-width size class to a regular-width size class. Override this method to perform custom separation behavior. The controller returned from this method will be set as the secondary view controller of the split view controller. When you return from this method, `primaryViewController` should have been configured for display in a regular-width split view controller. If you return `nil`, then `UISplitViewController` will perform its default behavior.

splitViewControllerShouldHideViewControllerInOrientation

@Deprecated
default boolean splitViewControllerShouldHideViewControllerInOrientation(UISplitViewController svc,
                                                                                     UIViewController vc,
                                                                                     long orientation)

Deprecated.

Returns YES if a view controller should be hidden by the split view controller in a given orientation. (This method is only called on the leftmost view controller and only discriminates portrait from landscape.)

splitViewControllerShowDetailViewControllerSender

default boolean splitViewControllerShowDetailViewControllerSender(UISplitViewController splitViewController,
                                                                  UIViewController vc,
                                                                  java.lang.Object sender)

Override this method to customize the behavior of `showDetailViewController:` on a split view controller. Return YES to indicate that you've handled the action yourself; return NO to cause the default behavior to be executed.

splitViewControllerShowViewControllerSender

default boolean splitViewControllerShowViewControllerSender(UISplitViewController splitViewController,
                                                            UIViewController vc,
                                                            java.lang.Object sender)

Override this method to customize the behavior of `showViewController:` on a split view controller. Return YES to indicate that you've handled the action yourself; return NO to cause the default behavior to be executed.

splitViewControllerWillChangeToDisplayMode

default void splitViewControllerWillChangeToDisplayMode(UISplitViewController svc,
                                                        long displayMode)

This method allows a client to update any bar button items etc.

splitViewControllerWillHideViewControllerWithBarButtonItemForPopoverController

@Deprecated
default void splitViewControllerWillHideViewControllerWithBarButtonItemForPopoverController(UISplitViewController svc,
                                                                                                        UIViewController aViewController,
                                                                                                        UIBarButtonItem barButtonItem,
                                                                                                        UIPopoverController pc)

Deprecated.

Called when a button should be added to a toolbar for a hidden view controller. Implementing this method allows the hidden view controller to be presented via a swipe gesture if 'presentsWithGesture' is 'YES' (the default).

splitViewControllerWillShowViewControllerInvalidatingBarButtonItem

@Deprecated
default void splitViewControllerWillShowViewControllerInvalidatingBarButtonItem(UISplitViewController svc,
                                                                                            UIViewController aViewController,
                                                                                            UIBarButtonItem barButtonItem)

Deprecated.

Called when the view is shown again in the split view, invalidating the button and popover controller.

splitViewControllerPreferredInterfaceOrientationForPresentation

default long splitViewControllerPreferredInterfaceOrientationForPresentation(UISplitViewController splitViewController)

splitViewControllerSupportedInterfaceOrientations

default long splitViewControllerSupportedInterfaceOrientations(UISplitViewController splitViewController)

targetDisplayModeForActionInSplitViewController

default long targetDisplayModeForActionInSplitViewController(UISplitViewController svc)

Called by the gesture AND barButtonItem to determine what they will set the display mode to (and what the displayModeButtonItem's appearance will be.) Return UISplitViewControllerDisplayModeAutomatic to get the default behavior.

splitViewControllerDisplayModeForExpandingToProposedDisplayMode

default long splitViewControllerDisplayModeForExpandingToProposedDisplayMode(UISplitViewController svc,
                                                                             long proposedDisplayMode)

splitViewControllerTopColumnForCollapsingToProposedTopColumn

default long splitViewControllerTopColumnForCollapsingToProposedTopColumn(UISplitViewController svc,
                                                                          long proposedTopColumn)

splitViewControllerWillHideColumn

default void splitViewControllerWillHideColumn(UISplitViewController svc,
                                               long column)

splitViewControllerWillShowColumn

default void splitViewControllerWillShowColumn(UISplitViewController svc,
                                               long column)

splitViewControllerDidCollapse

default void splitViewControllerDidCollapse(UISplitViewController svc)

splitViewControllerDidExpand

default void splitViewControllerDidExpand(UISplitViewController svc)

splitViewControllerInteractivePresentationGestureDidEnd

default void splitViewControllerInteractivePresentationGestureDidEnd(UISplitViewController svc)

splitViewControllerInteractivePresentationGestureWillBegin

default void splitViewControllerInteractivePresentationGestureWillBegin(UISplitViewController svc)