Instance Method

primaryViewController(forCollapsing:)

Asks the delegate to provide the single view controller to display after the split view interface collapses.

Declaration

optional func primaryViewController(forCollapsing splitViewController: UISplitViewController) -> UIViewController?

Parameters

splitViewController

The split view controller whose interface is collapsing.

Return Value

The new primary view controller to display onscreen.

Discussion

When the split view controller transitions from a horizontally regular to a horizontally compact size class, it calls this method and asks you for the view controller to display when that transition is complete. The view controller you return becomes the new primary view controller of the split view interface.

Use this method to specify which view controller you want displayed in a compact environment. By default, a collapsing split view controller displays its current primary view controller but you can return a different view controller if you want. For example, you might return the secondary view controller if that view controller contains the content you want to display. You might also return a completely different view controller that is better suited for displaying content in a compact environment.

If you implement this method, you should also implement the primaryViewController(forExpanding:) method to handle the expansion of your interface from a horizontally compact to a horizontally regular environment. If you do not implement this method, or if your implementation returns nil, the split view controller chooses its primary view controller as the one to display.

See Also

Collapsing and Expanding the Interface

func splitViewController(UISplitViewController, collapseSecondary: UIViewController, onto: UIViewController) -> Bool

Asks the delegate to adjust the primary view controller and to incorporate the secondary view controller into the collapsed interface.

func primaryViewController(forExpanding: UISplitViewController) -> UIViewController?

Asks the delegate to provide the view controller to display in the primary position when the split view interface expands.

func splitViewController(UISplitViewController, separateSecondaryFrom: UIViewController) -> UIViewController?

Asks the delegate to provide the new secondary view controller for the split view interface.