Docs (81% documented)

Reference EnlightenPopoverContentViewController Class Reference

EnlightenPopoverContentViewController

open class EnlightenPopoverContentViewController : NSViewController

A view controller that manages a EnlightenDownView for the content of a popover.

Public Stored Properties

progressIndicator
The progress indicator shown when loading the web view resources takes longer than progressIndicatorDelay.
Declaration
Swift

public let progressIndicator: NSProgressIndicator
enlightenPopoverDelegate
The popover’s EnlightenPopoverDelegate delegate.
Declaration
Swift

public weak var enlightenPopoverDelegate: EnlightenPopoverDelegate?
progressIndicatorDelay
The duration, in seconds, to delay showing the progress indicator.
Declaration
Swift

public var progressIndicatorDelay: TimeInterval
isDetachedFromPopover
Whether the content is detached from the popover.
Declaration
Swift

public private(set) var isDetachedFromPopover: Bool { get set }

Public Computed Properties

downView
The EnlightenDownView owned by the view controller.
Declaration
Swift

public var downView: EnlightenDownView { get }
doesCenterAlignContent
Whether the Markdown content should be center aligned.
Declaration
Swift

public var doesCenterAlignContent: Bool { get set }

Initializers


                    
                    
                    init(markdownString:maxWidth:maxHeight:)

Initializes a newly allocated Enlighten popover content view controller.

Throws

Throws a DownErrors if loading the Markdown string fails.

Declaration

Swift

public init(markdownString: String, maxWidth: CGFloat, maxHeight: CGFloat = 500) throws

Parameters

`markdownString`	The Markdown string rendered in the `EnlightenDownView`.
`maxWidth`	The maximum width of the `EnlightenDownView`.
`maxHeight`	The maximum height of the `EnlightenDownView`.

init(coder:)
Undocumented
Declaration
Swift

public required init?(coder: NSCoder)

Layout Methods


                    
                    
                    resetMaxSize(includingHeight:)

Resets the size of the view to the maximum.

Declaration

Swift

open func resetMaxSize(includingHeight: Bool)

Parameters


                                includingHeight

Whether to also reset the height to the maximum.

Progress Indicator Methods

showProgressIndicator()
Shows the progress indicator, if the view controller’s view is in the view hierarchy.
Declaration
Swift

@objc open func showProgressIndicator()
delayShowingProgressIndicator()
Starts the timer that presents the progress indicator after progressIndicatorDelay.
Declaration
Swift

open func delayShowingProgressIndicator()
hideProgressIndicator()
Hides the progress indicator, if it is in the view hierarchy, and invalidates the progress indicator presentation timer.
Declaration
Swift

open func hideProgressIndicator()

Markdown Methods


                    
                    
                    update(markdownString:)

Renders the given CommonMark Markdown string into HTML and updates the EnlightenDownView while keeping the style intact.

Important

Errors thrown during the loading of the Markdown string are passed to the delegate’s EnlightenPopoverDelegate.enlightenPopoverFailedToLoad(downError:) method.

Declaration

Swift

open func update(markdownString: String)

Parameters


                                markdownString

A string containing CommonMark Markdown.

didDownViewLoadSuccessfully()
Called when the Markdown string was loaded successfully.
Declaration
Swift

open func didDownViewLoadSuccessfully()

Popover Notification Methods

didDetachFromPopover()
Invoked when the popover has been released to a detached state.
Declaration
Swift

open func didDetachFromPopover()
didClosePopover()
Invoked when the popover did close.
Declaration
Swift

open func didClosePopover()

URL Scheme Handler Methods


                    
                    
                    webView(_:start:)

Undocumented

Declaration

Swift

public func webView(_ webView: WKWebView, start urlSchemeTask: WKURLSchemeTask)


                    
                    
                    webView(_:stop:)

Undocumented

Declaration

Swift

public func webView(_ webView: WKWebView, stop urlSchemeTask: WKURLSchemeTask)