Generic Class

NSHostingView

An AppKit view that hosts a SwiftUI view hierarchy.

Declaration

class NSHostingView<Content> : NSView where Content : View

Overview

You use NSHostingView objects to integrate SwiftUI views into your AppKit view hierarchies. A hosting view is an NSView object that manages a single SwiftUI view, which may itself contain other SwiftUI views. Because it is an NSView object, you can integrate it into your existing AppKit view hierarchies to implement portions of your UI. For example, you can use a hosting view to implement a custom control.

A hosting view acts as a bridge between your SwiftUI views and your AppKit interface. During layout, the hosting view reports the content size preferences of your SwiftUI views back to the AppKit layout system so that it can size the view appropriately. The hosting view also coordinates event delivery.

Topics

Creating a Hosting View

init(rootView: Content)

Creates a hosting view object that wraps the specified SwiftUI view.

init?(coder: NSCoder)

Creates a hosting view object from the contents of the specified archive.

init(frame: NSRect)

Initializes and returns a newly allocated AppKit view with a specified frame rectangle.

Getting the Root View

var rootView: Content

The root view of the SwiftUI view hierarchy managed by this view controller.

Configuring the View Layout Behavior

class var requiresConstraintBasedLayout: Bool
var userInterfaceLayoutDirection: NSUserInterfaceLayoutDirection
var isFlipped: Bool
var layerContentsRedrawPolicy: NSView.LayerContentsRedrawPolicy
func updateConstraints()
func layout()

Responding to Mouse Events

func mouseDown(with: NSEvent)
func mouseUp(with: NSEvent)
func otherMouseDown(with: NSEvent)
func otherMouseUp(with: NSEvent)
func rightMouseDown(with: NSEvent)
func rightMouseUp(with: NSEvent)
func mouseEntered(with: NSEvent)
func mouseExited(with: NSEvent)
func mouseDragged(with: NSEvent)
func otherMouseDragged(with: NSEvent)
func rightMouseDragged(with: NSEvent)

Responding to Touch Events

func touchesBegan(with: NSEvent)
func touchesCancelled(with: NSEvent)
func touchesEnded(with: NSEvent)
func touchesMoved(with: NSEvent)

Responding to Gestures

func magnify(with: NSEvent)
func rotate(with: NSEvent)
func scrollWheel(with: NSEvent)

Handling Drag and Drop

func draggingSession(NSDraggingSession, sourceOperationMaskFor: NSDraggingContext) -> NSDragOperation

Providing a Contextual Menu

func menu(for: NSEvent) -> NSMenu?

Responding to Actions

func responds(to: Selector!) -> Bool
func forwardingTarget(for: Selector!) -> Any?

Configuring the Responder Behavior

var acceptsFirstResponder: Bool
var canBecomeKeyView: Bool
var needsPanelToBecomeKey: Bool

Managing the View Hierarchy

func viewWillMove(toWindow: NSWindow?)
func viewDidMoveToWindow()
func viewDidChangeBackingProperties()
func viewDidChangeEffectiveAppearance()
func renewGState()

Modifying the Frame Rectangle

var intrinsicContentSize: NSSize
func setFrameSize(NSSize)

Comparing Views

static func != (NSHostingView<Content>, NSHostingView<Content>) -> Bool
static func == (NSObject, NSObject) -> Bool

Returns a Boolean value indicating whether two values are equal.

Hit Testing in the View

func hitTest(NSPoint) -> NSView?

Managing Accessibility Behaviors

var accessibilityFocusedUIElement: Any?
func accessibilityChildren() -> [Any]?
func accessibilityHitTest(NSPoint) -> Any?

Validating User Interface Items

func validateUserInterfaceItem(NSValidatedUserInterfaceItem) -> Bool

Monitoring Published Changes

func observeValue(forKeyPath: String?, of: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?)

Getting Hash Information

var hashValue: Int

The hash value.

func hash(into: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Instance Properties

var firstBaselineOffsetFromTop: CGFloat
var lastBaselineOffsetFromBottom: CGFloat

Instance Methods

func viewDidMoveToSuperview()

Relationships

Inherits From

Conforms To

See Also

AppKit Hosting

class NSHostingController

An AppKit view controller that hosts a set of Swift UI views.

protocol NSViewControllerRepresentable

A wrapper that you use to integrate an AppKit view controller into your SwiftUI interface.

protocol NSViewRepresentable

A wrapper that you use to integrate an AppKit view into your SwiftUI view hierarchy.